Actions

An action consists of a name, a set of possible arguments, and an effect. This page describes all possible actions.

Inserting an action in the presentation is done by adding an attribute with the name of the action.

Some content.

{center}

Some other content.

The effect might be different when the attribute is attached to an element.

Some content.

{center}
Some other content.

Arguments can be added to an action. In this case, the attribute is a key-value attribute, the key being the name of the action, and the value containing the arguments.

{#one}
Some content.

{center=one}

Some other content.

An action can have two kinds of arguments: named arguments, and positional ones. Named arguments are of the form ~argument-name:value and positional arguments consist of only their value, not their names. The list of arguments is space-separated.

{#one}
Some content.

{center="~duration:2 ~margin:10 one"}

Some other content.

It is possible to combine multiple actions in a single attribute, and they will be executed in the same step.

{#one}
Some content.

{center="~duration:2 ~margin:10 one" reveal="two three"}

{#two .unrevealed}
Some other content.

{#three .unrevealed}
Some more content.

Actions are executed in “reading order”, from top left to bottom right. The presenter needs to press the “next” key to trigger the next action.

{#one}
Some content.

{center="~duration:2 ~margin:10 one" reveal="two three"}
The action above is executed first.

{#two .unrevealed unreveal="three"}
The action above is executed second.

{#three .unrevealed}
Some more content.

When the auto-continue attribute is included in the attribute set, the next action is executed without requiring the user to press the “next” key.

{reveal="two" auto-continue}
The action above is executed first.

{#two .unrevealed center}
The action above is executed directly after the first one.

Pause attributes 

pause

The pause attribute tells the Slipshow engine to pause the text rendering here. This element, and every element after it (but inside the “pause block”) in the document, will be hidden.

When a pause action is executed, the initially hidden text is displayed.

pause-block

The pause-block attribute tells the Slipshow engine that pauses inside it should not hide content outside of it.

Example:

A

{pause-block}
> B
>
> {pause}
>
> C
>
> {pause}
>
> D

E

will initially display A, B and E, then going a step further will additionally display C, and another step will display D.

step

Introduces a no-op step in the slip it’s in. Takes an optional ~duration:FLOAT argument, whose default value is 0, and which defines the time spent before the action is completed. Useful to exit entered slips, and in conjunction with auto-continue.