Skip to content

Latest commit

 

History

History
437 lines (281 loc) · 15.9 KB

listAttributes.rst

File metadata and controls

437 lines (281 loc) · 15.9 KB
Raw

Slipshow API

Table of contents

Slip-specific tags

We list here the custom tags that are specific to slipshow.

slip-slipshow

The root of a slipshow.

slip-slip

A slip.

slip-title

The title of a slip.

slip-body

The body of a slip.

slip-figure

A TikZ figure. This custom element extends the element img, thus it has to be written like this: <img is="slip-figure" figure-name="fig"/>. A figure can be created with npx new-figure, and the name should correspond.

Slip-specific classes

We list here the class that can be given to elements that are specific to slipshow.

unrevealed

Make an element invisible. Can be made visible with :ref:`mk-visible-at` or :ref:`chg-visib-at`.

movable

Make an element move smoothly when moved using the not yet implemented move-element-to.

emphasize

Emphasize the element.

no-flex

If a slip has this class, the content will not be centered vertically. That is, even if there is only one line, it will appear in the top, and not in the middle.

at attributes

Here, we list the attributes that act at predefined steps of the presentation.

mk-visible-at

If an element has attribute mk-visible-at="n", then it will be made visible at step n. It only has an effect if the element is hidden, for instance by mk-hidden-at or the invisible class.

mk-hidden-at

If an element has attribute mk-hidden-at="n", then it will be hidden at step n.

mk-emphasize-at

If an element has attribute mk-emphasize-at="n", then it will be given the emphasize class at step n.

mk-unemphasize-at

If an element has attribute mk-unemphasize-at="n", then it will be removed the emphasize class at step n.

emphasize-at

If an element has attribute emphasize-at="n0 n1 n2 ...", then it will be emphasized exactly at steps n_0, n_1, n_2, ...

chg-visib-at

If an element has attribute chg-visib-at="n0 n1 n2 ...", then it will hidden at step 0, it will be made visible at positive steps n_i, and it will be hidden at negative steps n_j. For instance, chg-visib-at="2 -5 8" will first appear hidden, then visible at step 2, invisible at step 5 and visible again at step 8.

up-at

If an element has attribute up-at="n", then the window will move at step n so that the element appear at the top of the screen.

down-at

If an element has attribute down-at="n", then the window will move at step n so that the element appear at the bottom of the screen.

center-at

If an element has attribute center-at="n", then the window will move at step n so that the element appear at the center of the screen.

focus-at

If an element has attribute focus-at="n", then the window will move at step n so that the element takes all the screen.

unfocus-at

If an element has attribute unfocus-at="n" at step n, and the window was focusing on an element, then the window will return to its original place.

static-at

If an element has attribute static-at="n0 n1 n2 ...", then it will be added to the text flow at positive steps n_i, and removed from the text flow at steps n_j. Note that this does not work by modifying the static css property, but rather by setting the css properties position: absolute and visibility: hidden. This is done so that mathjax can compute the size of the elements that includes math, it cannot when an element is not static.

exec-at

If an element has attribute exec-at="n", then its content will be executed at step n. See :ref:`slip-scripting` for more information on the execution of a script.

figure-next-at

If a slip-figure element has attribute figure-next-at="n1 n2 n3", then the next overlay will be shown at every step n_i. See :ref:`slip-figure` for more information on a figure.

pause attributes

Here, we list all the attributes that are linked with the pause mechanism. At each step of the slipshow, the first pause attribute acts, and is removed. We describe what are the action of each pause attributes.

pause

If an element has a pause attribute, all elements appearing after it will be hidden. A pause attribute, when acting, only disappear, revealing the content of the slip until the next pause attribute. A pause attribute can have a value: if an element has pause="n", then it will take 5 steps to disappear.

step

A step attribute, when acting, only disappear. This does nothing but allows to make a stop in the pause flow. A step attribute can have a value: if an element has step="n", then it will take 5 steps to disappear. This attribute is mostly useful in combinaison with the :ref:`at-unpause-attributes`.

auto-enter

When given focus, a slip with the auto-enter attribute will be entered.

immediate-enter

One step before being given focus, a slip with the immediate-enter attribute will be entered. This is needed so that slips are entered directly, and not after one action.

at-unpause attributes

When an element has focus from the pause mechanism, and its attribute is removed (for instance, after 5 focus if it has pause="5"), we say that the element is unpaused.

up-at-unpause

When an element with the up-at-unpause attribute is unpaused, the window will move so that the element appear at the top of the screen. If the attribute has a value, e.g. up-at-unpause="id", then the element with id id will be put at the top of the screen instead.

down-at-unpause

When an element with the down-at-unpause attribute is unpaused, the window will move so that the element appear at the bottom of the screen. If the attribute has a value, e.g. down-at-unpause="id", then the element with id id will be put at the bottom of the screen instead.

center-at-unpause

When an element with the center-at-unpause attribute is unpaused, the window will move so that the element appear at the center of the screen. If the attribute has a value, e.g. center-at-unpause="id", then the element with id id will be put at the center of the screen instead.

focus-at-unpause

When an element with the focus-at-unpause attribute is unpaused, the window will move so that the element takes all the screen. If the attribute has a value, e.g. focus-at-unpause="id", then the element with id id will be the one taking all the screen instead.

unfocus-at-unpause

When an element with the focus-at-unpause attribute is unpaused, and the window was focusing on an element, the window will return to its original place.

exec-at-unpause

When an element with the exec-at-unpause attribute is unpaused, the content of the element will be executed. If the attribute has a value, e.g. exec-at-unpause="id", then the element with id id will be executed instead. See :ref:`slip-scripting` for more information on the execution of a script.

static-at-unpause

When an element with the static-at-unpause attribute is unpaused, the element will be made "static" at unpause. If the attribute has a value, e.g. static-at-unpause="id1 id2 ...", then the element with those ids will be made static at unpause. By "made static" we mean the css styling position:static; visibility:visible will be applied.

unstatic-at-unpause

When an element with the unstatic-at-unpause attribute is unpaused, the element will be made "unstatic" at unpause. If the attribute has a value, e.g. unstatic-at-unpause="id1 id2 ...", then the element with those ids will be made unstatic at unpause. By "made unstatic" we mean the css styling position:absolute; visibility:hidden.

reveal-at-unpause

When an element with the reveal-at-unpause attribute is unpaused, the element will be "revealed" at unpause. If the attribute has a value, e.g. reveal-at-unpause="id1 id2 ...", then the element with those ids will be "revealed" at unpause. By "revealed" we mean the css styling opacity:1 will be applied.

figure-next-at-unpause

When an element with the figure-next-at-unpause attribute is unpaused, the element (provided it is a slip-figure, that is an element <img is="slip-figure"/>) will show the next overlay of the figure. If the attribute has a value, e.g. reveal-at-unpause="id1 id2 ...", then this will happen for every figures with one of those ids. See :ref:`slip-figure` for more information on a figure.

figure-set-at-unpause

When an element with the figure-set-at-unpause="id overlay" attribute is unpaused, the element of id id (provided it is a slip-figure, that is an element <img is="slip-figure"/>) will show the overlay overlay of the figure. See :ref:`slip-figure` for more information on a figure.

enter-at-unpause

When an element with the enter-at-unpause="id" attribute is unpaused, the slip of id id will be entered wen the element with the attribute is unpaused.

Slip scripting

A slip script can be executed either with :ref:`exec-at`, :ref:`exec-at-unpause`, :ref:`setAction`, or :ref:`setNthAction`. It consists of plain javascript, with an additional variable slip containing the slip inside which it is executed.

slip.query

A function that takes a string consisting of a css selector as input. Works as querySelector except that it does not select inside the subslips.

slip.queryAll

A function that takes a string consisting of a css selector as input. Works as querySelectorAll except that it does not select inside the subslips.

slip.delay

An integer telling the time taken by the camera to move when entering this slip.

slip.reveal

A function to "reveal" the elements with class unrevealed. Argument can be either the element to reveal, or a css selector.

slip.downTo

A function to move the camera so that the element appears at the bottom of the view. First argument can be either an element, or a css selector. Second argument is optionnal, and is the margin from the bottom.

slip.centerTo

A function to move the camera so that the element appears at the center of the view. First argument can be either an element, or a css selector.

slip.upTo

A function to move the camera so that the element appears at the top of the view. First argument can be either an element, or a css selector. Second argument is optionnal, and is the margin from the top.

slip.focus

A function to move the camera so that the element takes the entire screen. First argument can be either an element, or a css selector.

slip.unfocus

A function to return the camera to where it was before a focus to an element. No arguments.

slip.setAction

Function to set the action list of a slip. Takes a list of functions as input.

slip.setNthAction

Function to set the n-th action of a slip. Takes an integer n and a function as input.

slip.getEngine

Function with no arguments that returns the engine used by a slip.

engine.getRoot

Returns the "root slip", which is slip containing all the presentation, of an engine.

engine.start

Starts the engine.

engine.restart

Restarts the engine.

engine.getController

Function with no arguments that returns the controller used by an engine.

engine.push(slip); // add the slip to the stack of slips of the engine engine.next();

engine.gotoSlip

Move the window to show the slip. Takes as arguments a Slip, and a js object options with field delay.

engine.push

Function that pushes the slip given as input in the slip stack of the engine.

engine.next

Function with no arguments to make one step in the presentation.

engine.enter

Makes the engine effectively enter the slip given as input. This is equivalent to a gotoSlip followed by a push and a next.

Slipshow.startSlipshow

Create an engine with root slip the element of tag slip-slipshow, starts it, and returns it.

Slipshow.Slip

A slip object constructor. Takes as arguments: the name, the fullName, the actionList, the engine and a js object options with field firstVisit end init that are called respetively when entering the slip, and when initialising the slip.

Slipshow.Engine

An engine object constructor. Takes as arguments: the root of the engine, which can be either an element, a css selector or undefined (and in this case, it defaults to the element with tag slip-slipshow).