17
edits
Changes
Jump to navigation
Jump to search
; <tt>\HighlightStep [''n''] {...}</tt>
: Highlight content on the <tt>''n''</tt><sup>th</sup> step.
; <tt>\SetupSteps [...=...,...=...]</tt>
: Setup global options for generation of steps. Available options:
:; <tt>reserve</tt>
:: <tt>yes, <u>no</u></tt>
:; <tt>defaultsection</tt>
:: <tt><u>Subject</u>, subject, chapter, ...</tt>
===Other settings===
; <tt>\UseStepstrue</tt> and <tt>\UseStepsfalse</tt>
: Enable or disable steps generation.
'''This is work in progress== External Links ==* http://mhd.selfip.info/tex/ - RawSteps module'''s page
→Most important missing features
==Commands==
===Setup===
; <tt>\SetupSteps [...=...,...=...]</tt>
: Setup global options for generation of steps. Available options:
:; <tt>state</tt>
:: <tt><u>start</u></tt>: enable stepping
:: <tt>stop</tt>: disable stepping
:; <tt>reserve</tt>
:: <tt>yes</tt>: when the item is not active, fill with empty space the area it takes when it is active (see section [[#Reserving space|Reserving space]])
:: <tt><u>no</u></tt>: when the item is not active, simply skip its generation
:; <tt>defaultsection</tt>
:: <tt><u>Subject</u>, subject, chapter, ...</tt>
: To disable sectioning commands, set <tt>\SetupSteps[defaultsection=page]</tt>.
===Step block===
; <tt>\StartSteps ''[sectiontype]'' ''[slide title]'' ... \StopSteps</tt>
: The basic command set pair for steps generation. <tt>''sectiontype''</tt> may be any sectioning command, such as <tt>chapter</tt>, <tt>section</tt>, <tt>subject</tt>, etc. ===Basic stepping commands===
; <tt>\NextStep</tt>
: Use this as a separation between two steps.
; <tt>\AllSteps</tt>: Use like <tt>\NextStep</tt>, but the content appears on every step. ===Advanced stepping commands=== ; <tt>\OnSteps [''step-list''] ''[reserve]'' {...}</tt>: Show the content on the specified steps from the comma-separated step list. Use dashes for intervals and <tt>...</tt> to denote the first or the last step. ; <tt>\HighlightSteps [''step-list''] {...}</tt>: Highlight content on the specified steps. ===Alternate stepping commands=== ; <tt>\OnlyStep [''n''] ''[reserve]'' {...}</tt>
: Show content only on the <tt>''n''</tt><sup>th</sup> step.
; <tt>\FromStep [''n''] ''[reserve]'' {...}</tt>
: Show content only from the <tt>''n''</tt><sup>th</sup> step through the last one.
; <tt>\AfterStep [''n''] ''[reserve]'' {...}</tt>
: Show content only from the <tt>''n''+1</tt><sup>st</sup> step through the last one.
; <tt>\UntilStep [''n''] ''[reserve]'' {...}</tt>
: Show content only from the first step through the <tt>''n''</tt><sup>th</sup> one.
===Other settings===
; <tt>\CurrentStepNumber</tt>
: Expands to the index (starting at 1) of the step being rendered.
; <tt>\StepsRegisterNumber[...]</tt> and <tt>\StepsUnregisterNumber[...]</tt>
: Registers/unregisters a number so that it remains unchanged on a step set. E.g. if you're using <tt>\defineenumeration[Theorem][...]</tt>, then use <tt>\StepsRegisterNumber[Theorem]</tt>.
; <tt>\definecolor [highlightcolor] [blue]</tt>
: Color specification for the <tt>\HighlightStep</tt> command.
===Page numbers===
The module supports subpage numbers. To number pages in a format such as: ''1/4, 2a/4, 2b/4, 2c/4, 3a/4, 3b/4, 4/4'', use the following code to generate page numbers:
<texcode>
\pagenumber{\characters\subpagenumber}/\lastpagenumber
</texcode>
==Usage examples==
===Preamble===
The following preamble enables page numbering as shown in [[#Page numbers|Page Numbers]] in an interaction menu:
<texcode>
\usemodule [pre-original]
\usemodule [rsteps]
% interaction menu example:
% page number with alphabetic subpage number
\startinteractionmenu[bottom]
\placelist[chapter] [alternative=bottom,criterium=all,pagenumber=no]
\\
\pagenumber{\characters\subpagenumber}/\lastpagenumber
\stopinteractionmenu
% setup example (default)
\SetupSteps[defaultsection=Subject,reserve=no]
</texcode>
===Sectioning===
The following illustrates different usage schemes of the <tt>\StartSteps ... \StopSteps</tt> pair:
<texcode>
\StartSteps[Topic][Topic Title]
This is a topic slide.
\NextStep
Another step.
\StopSteps
\StartSteps[Subject][Subject Title 1]
This is a subject slide.
\NextStep
Another step.
\StopSteps
\StartSteps[Subject Title 2]
This is a subject (defaultsection) slide as well.
\NextStep
Another step.
\StopSteps
\StartSteps
This slide comprises no section command.
\NextStep
Another step.
\StopSteps
</texcode>
===Advanced stepping===
The following example illustrates the usage of the advanced stepping commands <tt>\OnSteps</tt> and <tt>\HighlightSteps</tt>:
<texcode>
\StartSteps[Advanced stepping (step \CurrentStepNumber)]
\startitemize
\OnSteps[1-3,5]{\item Steps 1, 2, 3 and 5.}
\OnSteps[2-...]{\item From step 2.}
\OnSteps[3] {\item Step 3.}
\OnSteps[...-4]{\item Up to step 4.}
\stopitemize
\StopSteps
\StartSteps[Highlighting (step \CurrentStepNumber)]
\startitemize
\item \HighlightSteps[1,4] {Step 1.}
\item \HighlightSteps[2] {Step 2.}
\item \HighlightSteps[3] {Step 3.}
\item \HighlightSteps[4] {Start over from Step 1.}
\stopitemize
\StopSteps
</texcode>
===Alternate stepping===
The following example illustrates the usage of the alternate stepping commands <tt>\OnlyStep</tt>, <tt>\UntilStep</tt>, <tt>\FromStep</tt>, and <tt>\HighlightStep</tt>:
<texcode>
\StartSteps[Slide Title]
\startitemize
\item This will always appear.
\OnlyStep [2] {\item This appears only on step 2.}
\UntilStep [4] {\item This will change on step 4.}
\FromStep [3] {\item This has changed since step 3.}
\stopitemize
\StopSteps
</texcode>
===Reserving space===
The <tt>reserve</tt> keyword makes the item appear as empty space when it is not active instead of not generating the item at all. It is particularly useful in typesetting equations, as shown by the following example:
<texcode>
\StartSteps[Equations]
\placeformula[eq:divu]
\startformula
\vec\nabla\cdot\vec u = 0
\stopformula
\placeformula[eq:NS]
\startformula
\frac{D\vec u}{Dt} =
\OnSteps[2-...][reserve]{-{\red \frac1\rho \vec\nabla p}}
\OnSteps[3-...][reserve]{+\;{\green \vec g}}
\OnSteps[4-...][reserve]{+\;{\blue \frac1\rho \vec\nabla\cdot S}}
\stopformula
Incompressibility (\in{eq.}[eq:divu]).
Momentum transport (\in{eq.}[eq:NS]):
\startitemize
\OnSteps[2-...]{\item {\red Pressure gradient}}
\OnSteps[3-...]{\item {\green Gravity}}
\OnSteps[4-...]{\item {\blue Stress (viscous, turbulent, Maxwell)}}
\stopitemize
\StopSteps
</texcode>
==Development==
===Most important missing features===
Some ideas are liseted about what should be done to improve the module:
* Enable <tt>\OnlyStep[reserve]</tt> also for text mode, not only for math
* Space reservation could be achieved with a 100% transparent text color....
* Fix some spacing problems [http://archive.contextgarden.net/message/20050607.212822.facbc9b4.html]
===Slides printing===
* implement a sort of "<i>page marking</i>", so that someone can write <tt>\PrintThisSlide</tt> or <tt>\PrintSlides[1-3,5,7-9,13-last]</tt> (maybe <tt>Select[This]Slide</tt> sound better), than only the pages with this "mark" are selected out of the whole document and can be used to be printed out (we have to add some switch to select if we want a presentation or a print-out version of slides)
* connect this with Hans's commands to compose more pages on one sheet of paper (for example to make 2*2, 2*4, ... latouts to be printed)
* in a similar manner, add a possibility to add comments, that, again, are only printed next to the slide if some kind of \printmode and \setupSlideComments[state=on] is selected
===Some ideas that need more time===
These ideas probablt need some more time and are not crucial at the time.
* Enable a sort of switch that would do the same kind of stepping, but with JavaScript instead of raw steps
