1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
blank,"\nblank()\n Renders a blank screen.\n\n Examples\n --------\n > blank();\n\n See Also\n --------\n next, nextSlide, prev, prevSlide, redraw\n\n"
currentSlide,"\ncurrentSlide\n Returns the current presentation slide index.\n\n The returned index is the nominal (i.e., one-based) slide index.\n\n Returns\n -------\n idx: integer\n Current presentation slide index.\n\n Examples\n --------\n > currentSlide\n\n See Also\n --------\n jumpTo, next, numSlides, prev\n\n"
end,"\nend()\n Jumps to the last fragment of the last slide.\n\n Examples\n --------\n > end();\n\n See Also\n --------\n first, jumpTo, last, next, prev\n\n"
first,"\nfirst()\n Jumps to the first slide.\n\n Examples\n --------\n > first();\n\n See Also\n --------\n end, jumpTo, last, next, prev\n\n"
firstFragment,"\nfirstFragment()\n Jumps to the first fragment of the current slide.\n\n Examples\n --------\n > firstFragment();\n\n See Also\n --------\n lastFragment, next, prev\n\n"
jump,"\njump( n )\n Jumps a specified number of slides.\n\n Parameters\n ----------\n n: integer\n Number of slides to jump.\n\n Examples\n --------\n // Jump two slides forward:\n > jump( 2 );\n\n // Jump two slides backward:\n > jump( -2 );\n\n See Also\n --------\n jumpTo, next, prev\n\n"
jumpTo,"\njumpTo( n )\n Jumps to a specified slide, where `n` is the nominal slide number.\n\n Parameters\n ----------\n n: integer\n Nominal slide number (one-based).\n\n Examples\n --------\n > jumpTo( 2 );\n\n See Also\n --------\n jump, next, prev\n\n"
last,"\nlast()\n Jumps to the last slide.\n\n Examples\n --------\n > last();\n\n See Also\n --------\n end, first, jumpTo, next, prev\n\n"
lastFragment,"\nlastFragment()\n Jumps to the last fragment of the current slide.\n\n Examples\n --------\n > lastFragment();\n\n See Also\n --------\n firstFragment, next, prev\n\n"
loadPresentation,"\nloadPresentation( file )\n Loads a presentation from a file.\n\n Relative file paths are resolved relative to the current working directory.\n\n Parameters\n ----------\n file: string\n File path.\n\n Examples\n --------\n > loadPresentation( './path/to/presentation.txt' );\n\n See Also\n --------\n reloadPresentation\n\n"
next,"\nnext()\n Moves the presentation to the next slide or slide fragment.\n\n Examples\n --------\n > next();\n\n See Also\n --------\n first, jumpTo, last, nextSlide, prev\n\n"
nextSlide,"\nnextSlide()\n Moves the presentation to the next slide.\n\n Examples\n --------\n > nextSlide();\n\n See Also\n --------\n first, jumpTo, last, next, prev, prevSlide\n\n"
numSlides,"\nnumSlides\n Returns the presentation length.\n\n Returns\n -------\n len: integer\n Number of slides.\n\n Examples\n --------\n > numSlides\n\n See Also\n --------\n currentSlide, jumpTo, next, prev\n\n"
pres,"\npres()\n Prints presentation help text and shortcuts.\n\n Examples\n --------\n > pres();\n\n See Also\n --------\n help, info\n\n"
prev,"\nprev()\n Moves the presentation to the previous slide or slide fragment.\n\n Examples\n --------\n > prev();\n\n See Also\n --------\n first, jumpTo, last, next, prevSlide\n\n"
prevSlide,"\nprevSlide()\n Moves the presentation to the previous slide.\n\n Examples\n --------\n > prevSlide();\n\n See Also\n --------\n first, jumpTo, last, next, nextSlide, prev\n\n"
redraw,"\nredraw()\n Redraws the current presentation slide.\n\n Examples\n --------\n > redraw();\n\n See Also\n --------\n next, nextSlide, prev, prevSlide, reloadPresentation\n\n"
reloadPresentation,"\nreloadPresentation( file )\n Reloads a presentation.\n\n Examples\n --------\n > reloadPresentation();\n\n See Also\n --------\n loadPresentation, redraw\n\n"
renderSlide,"\nrenderSlide()\n Renders the current presentation slide.\n\n Examples\n --------\n > renderSlide()\n\n See Also\n --------\n load\n\n"
runSlide,"\nrunSlide()\n Runs slide code.\n\n Examples\n --------\n > runSlide()\n\n See Also\n --------\n next, prev\n\n"
unwatch,"\nunwatch( [error] )\n Stops watching a presentation file for changes.\n\n Parameters\n ----------\n error: Error (optional)\n Error object.\n\n Examples\n --------\n > unwatch();\n\n See Also\n --------\n loadPresentation, redraw, reloadPresentation, watch\n\n"
watch,"\nwatch()\n Watches a presentation source file for changes.\n\n \"Renaming\" a source file is *not* tracked. If a source presentation file is\n renamed, watching stops.\n\n Examples\n --------\n > watch();\n\n See Also\n --------\n loadPresentation, redraw, reloadPresentation, unwatch\n\n"
|
