| Server IP : 127.0.0.2 / Your IP : 3.140.250.157 Web Server : Apache/2.4.18 (Ubuntu) System : User : www-data ( ) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : disk_free_space,disk_total_space,diskfreespace,dl,exec,fpaththru,getmyuid,getmypid,highlight_file,ignore_user_abord,leak,listen,link,opcache_get_configuration,opcache_get_status,passthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,php_uname,phpinfo,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwnam,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,pclose,popen,proc_open,proc_close,proc_get_status,proc_nice,proc_terminate,shell_exec,source,show_source,system,virtual MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/docutils-doc/docs/user/ |
Upload File : |
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>Easy Slide Shows With reST & S5</title>
<meta name="authors" content="David Goodger & Chris Liechti" />
<meta name="date" content="2006-03-30" />
<link rel="stylesheet" href="../../css/html4css1.css" type="text/css" />
</head>
<body>
<div class="document" id="easy-slide-shows-with-rest-s5">
<h1 class="title">Easy Slide Shows With reST & S5</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Authors:</th>
<td>David Goodger & Chris Liechti</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2006-03-30</td></tr>
</tbody>
</table>
<!-- Definitions of interpreted text roles (classes) for S5/HTML data. -->
<!-- This data file has been placed in the public domain. -->
<!-- Colours
======= -->
<!-- Text Sizes
========== -->
<!-- Display in Slides (Presentation Mode) Only
========================================== -->
<!-- Display in Outline Mode Only
============================ -->
<!-- Display in Print Only
===================== -->
<!-- Display in Handout Mode Only
============================ -->
<!-- Incremental Display
=================== -->
<!-- This document has been placed in the public domain. -->
<div class="handout container">
<p>How to create quick, good-looking presentation slide shows with
<a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id7" id="id8">[1]</a>/<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id11" id="id12">[2]</a> and <a class="reference external" href="http://meyerweb.com/eric/tools/s5/">S5</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id13" id="id14">[3]</a>.</p>
<p>This document serves both as a user manual and as a usage example
of the s5_html.py writer and the rst2s5.py front end.</p>
<p>To view this document as a slide show see
<a class="reference external" href="http://docutils.sf.net/docs/user/slide-shows.s5.html">http://docutils.sf.net/docs/user/slide-shows.s5.html</a> (or <a class="reference external" href="slide-shows.s5.html">your
local copy</a>).</p>
</div>
<div class="contents handout topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id30">Introduction</a></li>
<li><a class="reference internal" href="#features-1" id="id31">Features (1)</a></li>
<li><a class="reference internal" href="#features-2-handouts" id="id32">Features (2): Handouts</a></li>
<li><a class="reference internal" href="#caveats" id="id33">Caveats</a><ul>
<li><a class="reference internal" href="#subsections" id="id34">3. Subsections ...</a></li>
</ul>
</li>
<li><a class="reference internal" href="#generating-a-slide-show-1" id="id35">Generating a Slide Show (1)</a></li>
<li><a class="reference internal" href="#generating-a-slide-show-2" id="id36">Generating a Slide Show (2)</a></li>
<li><a class="reference internal" href="#examples-1" id="id37">Examples (1)</a></li>
<li><a class="reference internal" href="#examples-2-incremental-text" id="id38">Examples (2): Incremental Text</a></li>
<li><a class="reference internal" href="#examples-3-incr-graphics" id="id39">Examples (3): Incr. Graphics</a></li>
<li><a class="reference internal" href="#themes" id="id40">Themes</a></li>
<li><a class="reference internal" href="#example-themes" id="id41">Example Themes</a></li>
<li><a class="reference internal" href="#example-themes-small-text" id="id42">Example Themes: Small Text</a></li>
<li><a class="reference internal" href="#example-themes-large-text" id="id43">Example Themes: Large Text</a></li>
<li><a class="reference internal" href="#example-themes-medium-text" id="id44">Example Themes: Medium Text</a></li>
<li><a class="reference internal" href="#s5-theme-files" id="id45">S5 Theme Files</a></li>
<li><a class="reference internal" href="#making-a-custom-theme" id="id46">Making a Custom Theme</a></li>
<li><a class="reference internal" href="#classes-incremental-1" id="id47">Classes: Incremental (1)</a></li>
<li><a class="reference internal" href="#classes-incremental-2" id="id48">Classes: Incremental (2)</a></li>
<li><a class="reference internal" href="#classes-incremental-3" id="id49">Classes: Incremental (3)</a></li>
<li><a class="reference internal" href="#classes-text-size" id="id50">Classes: Text Size</a></li>
<li><a class="reference internal" href="#classes-alignment" id="id51">Classes: Alignment</a></li>
<li><a class="reference internal" href="#classes-text-colours" id="id52">Classes: Text Colours</a></li>
<li><a class="reference internal" href="#classes-borderless-tables" id="id53">Classes: Borderless Tables</a></li>
<li><a class="reference internal" href="#classes-print-only" id="id54">Classes: Print-Only</a></li>
<li><a class="reference internal" href="#useful-extensions-for-firefox" id="id55">Useful Extensions For Firefox</a></li>
<li><a class="reference internal" href="#to-do" id="id56">To Do</a></li>
<li><a class="reference internal" href="#that-s-all-folks" id="id57">That's All, Folks!</a></li>
</ul>
</div>
<ul class="tiny simple">
<li>S5 themes are designed for full-screen display areas with a 4:3
aspect ratio. If the slide text doesn't fit in your browser window,
try decreasing the text size.</li>
<li>Use the space bar to advance, Page Up/Down & arrow keys to navigate.</li>
<li>Best viewed in <a class="reference external" href="http://www.mozilla.com/firefox/">Firefox</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id16" id="id17">[4]</a>, Safari, and Konqueror. Click the "Ø"
button to switch between presentation & handout/outline modes. Hit
the "C" key to display the navigation controls, or mouse over the
lower right-hand corner.</li>
<li>Functionality is limited in Opera. Switch to full-screen mode (F11
key) to activate Opera Show.</li>
<li>S5 works in Internet Explorer, but it may look ugly.</li>
</ul>
<div class="handout container">
<p>The first slide of a presentation consists of all visible text up
to the first section title. The document title is also added to
the footer of all slides.</p>
<p>The "footer" directive is used to specify part of the slide footer
text. It is currently limited to one short line (one paragraph).</p>
<p>There is no support for the "header" directive in the themes
included with Docutils.</p>
</div>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id30">Introduction</a></h1>
<p class="handout"><tt class="docutils literal">rst2s5.py</tt> is a <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id7" id="id9">[1]</a> front end that outputs HTML for use
with <a class="reference external" href="http://meyerweb.com/eric/tools/s5/">S5</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id13" id="id15">[3]</a>, a "Simple Standards-based Slide Show System" by Eric
Meyer.</p>
<div class="handout topic">
<p class="topic-title first">Installation</p>
<p>Prerequisites: Python and the <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id7" id="id10">[1]</a> package have to be
installed. See the <a class="reference external" href="http://docutils.sourceforge.net/README.html">Docutils README</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id20" id="id21">[6]</a> file for installation
instructions.</p>
</div>
<ul>
<li><p class="first">reStructuredText</p>
<p class="handout">Uses normal reStructuredText as input.</p>
</li>
<li><p class="first">One section per slide</p>
<p class="handout">Each first-level section is converted into a single slide.</p>
</li>
<li><p class="first">XHTML output</p>
<div class="handout container">
<p>Presentations can be viewed using most modern graphical web
browsers. The browser must support CSS, JavaScript, and XHTML.
S5 even works with IE!</p>
<p>S5 was designed to add the functionality of the <a class="reference external" href="http://www.opera.com/support/tutorials/operashow/">Opera Show</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id18" id="id19">[5]</a>
standard (without Opera Show's limitations) to non-Opera
browsers. Unfortunately, most of S5's CSS and JavaScript
extensions don't function in the Opera browser.</p>
</div>
</li>
<li><p class="first">Themes</p>
<p class="handout">A variety of themes are available. See <a class="reference internal" href="#example-themes">Example Themes</a>, below.</p>
</li>
<li><p class="first"><tt class="docutils literal">rst2s5.py</tt></p>
<p class="handout">The front-end tool to generate S5 slide shows.</p>
</li>
</ul>
<div class="handout topic">
<p class="topic-title first">Keyboard Controls</p>
<p>The following apply in any supporting browser besides Opera, which
uses the default Opera Show controls instead.</p>
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Action</th>
<th class="head">Key(s)</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>Go to the next slide</td>
<td><ul class="first last simple">
<li>[Space bar]</li>
<li>[Return]</li>
<li>[Enter]</li>
<li>[Right arrow]</li>
<li>[Down arrow]</li>
<li>[Page down]</li>
<li>Click the left mouse button outside of the control area,
Flash object, or movie</li>
</ul>
</td>
</tr>
<tr><td>Go to the previous slide</td>
<td><ul class="first last simple">
<li>[Left arrow]</li>
<li>[Up arrow]</li>
<li>[Page up]</li>
</ul>
</td>
</tr>
<tr><td>Go to the title (first) slide</td>
<td>[Home]</td>
</tr>
<tr><td>Go to the last slide</td>
<td>[End]</td>
</tr>
<tr><td>Jump directly to a slide</td>
<td>Type the slide number, then hit [Return] or [Enter]</td>
</tr>
<tr><td>Skip forward <em>n</em> slides</td>
<td>Type the number of slides to skip, then hit any "go to next"
key (except [Return] or [Enter])</td>
</tr>
<tr><td>Skip backward <em>n</em> slides</td>
<td>Type the number of slides to skip, then hit any "go to
previous" key</td>
</tr>
<tr><td>Switch between slideshow and outline view</td>
<td><ul class="first last simple">
<li>[T]</li>
<li>Click the Ø button</li>
</ul>
</td>
</tr>
<tr><td>Show/hide slide controls</td>
<td><ul class="first last simple">
<li>[C]</li>
<li>Move the mouse pointer over the control area</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Further details of the S5 user interface can be found at <a class="reference external" href="http://meyerweb.com/eric/tools/s5/">Eric
Meyer's S5 page</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id13" id="id22">[3]</a>.</p>
</div>
</div>
<div class="section" id="features-1">
<h1><a class="toc-backref" href="#id31">Features (1)</a></h1>
<div class="handout container">
The S5/HTML Writer supports all the standard Docutils HTML
features. S5 has been released to the Public Domain.</div>
<p>S5-specific features:</p>
<ul class="incremental">
<li><p class="first">The document title is duplicated on each slide in the S5 footer.</p>
</li>
<li><p class="first">The <tt class="docutils literal">footer</tt> directive may be used to define additional text in
the S5 footer.</p>
<div class="handout container">
<p>But it is limited to one line of text.</p>
<p>This is useful for information such as the date of the
presentation and/or the location. The field in the footer is
left blank if no <tt class="docutils literal">footer</tt> directive is used.</p>
<p>Example:</p>
<pre class="literal-block">
.. footer:: Location - Date
</pre>
<p>There is also a progress indicator (slide counter) in the footer
that can be enabled. It's disabled by default.</p>
</div>
</li>
<li><p class="first">Incremental display.</p>
<p class="handout">An "incremental" class can be assigned to lists and other elements
to get one-item-at-a-time behavior (like this list). Incremental
display does not work in the Opera browser.</p>
</li>
<li><p class="first">Text auto-scaling.</p>
<p class="handout">The text size adjusts relative to the size of your browser window
automatically. You may need to reload the document after resizing
the window. The browser and platform affect the font used; be sure
to test the slide show on the presentation system.</p>
</li>
</ul>
</div>
<div class="section" id="features-2-handouts">
<h1><a class="toc-backref" href="#id32">Features (2): Handouts</a></h1>
<div class="handout container">
<p>The contents of any element with a "class" attribute value of
"handout" are hidden in the slide presentation, and are only
visible when the presentation is printed, or viewed in outline
mode. "Handout"-class elements can appear anywhere in the text, as
often as needed.</p>
<p>This means that the slides and extra handout material can be
combined in one document. The handout can be printed directly from
the browser, and it will contain more than just silly framed
slides. This can be used to provide more detailed information, or
for speaker's notes.</p>
</div>
<ul class="incremental">
<li><p class="first">Use the "class" directive:</p>
<pre class="literal-block">
.. class:: handout
</pre>
<div class="handout container">
<p>The <tt class="docutils literal">.. class:: handout</tt> directive can be used to tag
individual paragraphs and other elements. The "class" directive
applies to the first element immediately following:</p>
<pre class="literal-block">
.. class:: handout
This paragraph will get a
``class="handout"`` attribute.
This paragraph will not be affected.
</pre>
<p>It also applies to multiple elements in the directive content:</p>
<pre class="literal-block">
.. class:: handout
These paragraphs are the content
of the "class" directive. And as such...
Both paragraphs will *individually* receive
``class="handout"`` attributes.
</pre>
</div>
</li>
<li><p class="first">Use the "container" directive:</p>
<pre class="literal-block">
.. container:: handout
</pre>
<div class="handout container">
<p>Arbitrary handout blocks can be created using the <tt class="docutils literal">container</tt>
directive. The content is treated as one.</p>
</div>
</li>
<li><p class="first">Use the "class" option of directives that support it:</p>
<pre class="literal-block">
.. topic:: Extra Material For Handouts
:class: handout
</pre>
</li>
</ul>
<div class="handout container">
<p>The following directives support "class" options:</p>
<ul class="simple">
<li>all admonition directives ("admonition", "note", "hint", etc.)</li>
<li>"image" & "figure"</li>
<li>"topic"</li>
<li>"sidebar"</li>
<li>"line-block"</li>
<li>"parsed-literal"</li>
<li>"rubric"</li>
<li>"compound"</li>
<li>"table", "csv-table", & "list-table"</li>
<li>"target-notes" (more about that below)</li>
<li>"role" (pre-defined; more below)</li>
</ul>
<p>Handout contents are also visible on the screen if the S5 view mode
is toggled from "slide show" to "outline" mode.</p>
</div>
</div>
<div class="section" id="caveats">
<h1><a class="toc-backref" href="#id33">Caveats</a></h1>
<ol class="incremental arabic">
<li><p class="first">Some Docutils features are not supported by some themes.</p>
<div class="handout container">
<p>For example, header rendering is not supported by the themes
supplied with Docutils.</p>
<p>The "header" directive is used to set header text. S5
automatically inserts section/slide titles into the "header"
area of a slide. If both Docutils headers and S5 headers (slide
titles) exist simultaneously, they interfere with each other.</p>
</div>
</li>
<li><p class="first">Care must be taken with the "contents" directive.</p>
<div class="handout container">
<p>The <tt class="docutils literal"><span class="pre">--no-toc-backlinks</span></tt> option is the default for the S5/HTML
writer (<tt class="docutils literal">toc_backlinks=0</tt> setting). Other values for this
setting will change the CSS class of headings such that they
won't show up correctly in the slide show.</p>
<p>Use the <tt class="docutils literal">:class: handout</tt> option on the "contents" directive
to limit the table of contents to the handout/outline mode
only:</p>
<pre class="literal-block">
.. contents::
:class: handout
</pre>
</div>
</li>
</ol>
<div class="incremental section" id="subsections">
<h2><a class="toc-backref" href="#id34">3. Subsections ...</a></h2>
<p>... may be used, sparingly.</p>
<div class="handout container">
<p>Only first-level sections become slides. Not many levels of
subsections can fit on a slide.</p>
<p>Subsections (of any level) work normally in handouts though. Add
"<tt class="docutils literal">.. class:: handout</tt>" before a subsection (or sub-subsection, or
...), and the entire subsection will only appear in the handout.</p>
</div>
</div>
</div>
<div class="section" id="generating-a-slide-show-1">
<h1><a class="toc-backref" href="#id35">Generating a Slide Show (1)</a></h1>
<ol class="incremental arabic">
<li><p class="first">Open a console (terminal, command shell) and go to the folder
containing your file, <tt class="docutils literal">slides.txt</tt>.</p>
</li>
<li><p class="first">Run the command:</p>
<pre class="literal-block">
rst2s5.py slides.txt slides.html
</pre>
</li>
<li><p class="first">Specify an S5 theme with the <tt class="docutils literal"><span class="pre">--theme</span></tt> option.</p>
<p class="handout">Docutils will copy the S5 theme files into a <tt class="docutils literal"><span class="pre">ui/<theme></span></tt> folder
beside the output HTML file. A slide show can also link to an
existing theme using the <tt class="docutils literal"><span class="pre">--theme-url</span></tt> option.</p>
</li>
</ol>
</div>
<div class="section" id="generating-a-slide-show-2">
<h1><a class="toc-backref" href="#id36">Generating a Slide Show (2)</a></h1>
<ol class="incremental arabic" start="4">
<li><p class="first">Include a copy of any linked stylesheet.</p>
<p class="handout">The default Docutils stylesheet, <tt class="docutils literal">html4css1.css</tt>, will normally
be embedded in the output HTML. If you choose to link to a
stylesheet instead of embedding, you must include a copy (suggested
location: in the <tt class="docutils literal">ui/</tt> directory).</p>
</li>
<li><p class="first">Open <tt class="docutils literal">slides.html</tt> in a web browser.</p>
</li>
<li><p class="first">Expand the browser window to full-screen mode, and speak.</p>
<p class="handout">The <a class="reference external" href="http://chrispederick.com/work/webdeveloper/">Web Developer</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id23" id="id24">[7]</a> extension for Firefox is very useful. With
it, you can resize your browser window to the exact dimensions of
the projector you'll be using, so you can test beforehand. There
are many other useful features as well.</p>
</li>
<li><p class="first">Profit!</p>
</li>
</ol>
</div>
<div class="section" id="examples-1">
<h1><a class="toc-backref" href="#id37">Examples (1)</a></h1>
<div class="sidebar">
<p class="first sidebar-title">Hint</p>
<p>Admonitions, tables, sidebars, and other elements can be used in
on-screen presentations in handouts. Images too!</p>
<img alt="sample image" class="last" src="images/happy_monkey.png" />
</div>
<table border="1" class="docutils">
<colgroup>
<col width="31%" />
<col width="31%" />
<col width="38%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">A</th>
<th class="head">B</th>
<th class="head">A or B</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>False</td>
<td>False</td>
<td>False</td>
</tr>
<tr><td>True</td>
<td>False</td>
<td>True</td>
</tr>
<tr><td>False</td>
<td>True</td>
<td>True</td>
</tr>
<tr><td>True</td>
<td>True</td>
<td>True</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="examples-2-incremental-text">
<h1><a class="toc-backref" href="#id38">Examples (2): Incremental Text</a></h1>
<p class="incremental">Paragraphs can be displayed one at a time...</p>
<div class="incremental container">
<p>... or a bunch at a time.</p>
<p>This second paragraph is displayed together with the previous
one by grouping them with the "container" directive.</p>
</div>
<p><span class="incremental">We can also display</span> <span class="incremental">one</span> <span class="incremental">word</span> <span class="incremental">at</span> <span class="incremental">a</span> <span class="incremental">time,</span>
<span class="incremental">or a phrase</span> <span class="incremental">at a time,</span>
<span class="incremental">or even</span> <span class="incremental">o</span><span class="incremental">n</span><span class="incremental">e</span> <span class="incremental">l</span><span class="incremental">e</span><span class="incremental">t</span><span class="incremental">t</span><span class="incremental">e</span><span class="incremental">r</span> <span class="incremental">at a time!</span></p>
<p><span class="incremental">(But the markup ain't pretty.)</span></p>
</div>
<div class="section" id="examples-3-incr-graphics">
<h1><a class="toc-backref" href="#id39">Examples (3): Incr. Graphics</a></h1>
<p>Let's play... Rock, Scissors, Paper</p>
<div class="animation container">
<img alt="images/rsp-empty.png" class="hidden slide-display" src="images/rsp-empty.png" />
<img alt="images/rsp-objects.png" class="incremental hidden slide-display" src="images/rsp-objects.png" />
<img alt="images/rsp-cuts.png" class="incremental hidden slide-display" src="images/rsp-cuts.png" />
<img alt="images/rsp-covers.png" class="incremental hidden slide-display" src="images/rsp-covers.png" />
<img alt="images/rsp-breaks.png" class="incremental hidden slide-display" src="images/rsp-breaks.png" />
<img alt="images/rsp-all.png" class="incremental" src="images/rsp-all.png" />
</div>
</div>
<div class="section" id="themes">
<h1><a class="toc-backref" href="#id40">Themes</a></h1>
<ul class="incremental">
<li><p class="first">Several themes are available, and they're easy to adapt.</p>
<div class="handout container">
<p>Themes from the <a class="reference external" href="http://meyerweb.com/eric/tools/s5/s5blank.zip">S5 tutorial</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id25" id="id26">[8]</a> can be used. These themes are in
the public domain and may be redistributed freely.</p>
<p>Sites with other S5 themes:</p>
<ul class="simple">
<li><a class="reference external" href="http://meyerweb.com/eric/tools/s5/themes/">http://meyerweb.com/eric/tools/s5/themes/</a></li>
<li><a class="reference external" href="http://mozilla.wikicities.com/wiki/Firefox_S5:Designs">http://mozilla.wikicities.com/wiki/Firefox_S5:Designs</a></li>
<li><a class="reference external" href="http://lachy.id.au/dev/mozilla/firefox/s5/">http://lachy.id.au/dev/mozilla/firefox/s5/</a></li>
<li><a class="reference external" href="http://www.openlight.com/Python-S5-Theme.tar.gz">http://www.openlight.com/Python-S5-Theme.tar.gz</a></li>
</ul>
<p>S5 is becoming more popular every day. Do a web search for "S5
theme" and you're bound to find plenty of choices.</p>
</div>
</li>
<li><p class="first">"<tt class="docutils literal"><span class="pre">--theme</span></tt>" option.</p>
<div class="handout container">
<p>The theme can be specified with the "<tt class="docutils literal"><span class="pre">--theme</span></tt>" command-line
option.</p>
<p>Example:</p>
<pre class="literal-block">
rst2s5 --theme big-black slides.txt slides.html
</pre>
<p>The default theme is "default".</p>
</div>
</li>
<li><p class="first">"<tt class="docutils literal">theme</tt>" setting.</p>
<p class="handout">You can set the theme with the "<tt class="docutils literal">theme</tt>" configuration file
setting.</p>
</li>
<li><p class="first">Copied to <tt class="docutils literal"><span class="pre">./ui/<theme>/</span></tt>.</p>
<p class="handout">Themes are copied into a <tt class="docutils literal"><span class="pre">ui/<theme></span></tt> folder inside the folder
containing the presentation.</p>
</li>
<li><p class="first">Link with "<tt class="docutils literal"><span class="pre">--theme-url</span></tt>" option.</p>
<p class="handout">Link to a theme on the same or another web site, using the
"<tt class="docutils literal"><span class="pre">--theme-url</span></tt>" option or "<tt class="docutils literal">theme_url</tt>" configuration file
setting.</p>
</li>
</ul>
</div>
<div class="section" id="example-themes">
<h1><a class="toc-backref" href="#id41">Example Themes</a></h1>
<p class="handout">The default theme, "default", is a simplified version of S5's
default theme. It accommodates up to 13 lines of text.</p>
<p class="center">"default"</p>
<img alt="images/default.png" class="center align-center" src="images/default.png" />
</div>
<div class="section" id="example-themes-small-text">
<h1><a class="toc-backref" href="#id42">Example Themes: Small Text</a></h1>
<p class="handout">The "small-white" and "small-black" themes are simplifications of
the default theme (<strong>small</strong> black text on a <strong>white</strong> background,
and <strong>small</strong> black text on a <strong>white</strong> background, respectively).
They each accommodate up to 15 lines of text.</p>
<table border="1" class="borderless docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<tbody valign="top">
<tr><td><p class="first">"small-white"</p>
<img alt="images/small-white.png" class="last" src="images/small-white.png" />
</td>
<td><p class="first">"small-black"</p>
<img alt="images/small-black.png" class="last" src="images/small-black.png" />
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="example-themes-large-text">
<h1><a class="toc-backref" href="#id43">Example Themes: Large Text</a></h1>
<p class="handout">The "big-white" and "big-black" themes feature very large, bold
text, with no footers. Only five short lines fit in a slide.</p>
<table border="1" class="borderless docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<tbody valign="top">
<tr><td><p class="first">"big-white"</p>
<img alt="images/big-white.png" class="last" src="images/big-white.png" />
</td>
<td><p class="first">"big-black"</p>
<img alt="images/big-black.png" class="last" src="images/big-black.png" />
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="example-themes-medium-text">
<h1><a class="toc-backref" href="#id44">Example Themes: Medium Text</a></h1>
<p class="handout">The "medium-white" and "medium-black" themes feature medium-sized
text. Up to 8 lines of text are accommodated.</p>
<table border="1" class="borderless docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<tbody valign="top">
<tr><td><p class="first">"medium-white"</p>
<img alt="images/medium-white.png" class="last" src="images/medium-white.png" />
</td>
<td><p class="first">"medium-black"</p>
<img alt="images/medium-black.png" class="last" src="images/medium-black.png" />
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="s5-theme-files">
<h1><a class="toc-backref" href="#id45">S5 Theme Files</a></h1>
<p>An S5 theme consists of a directory containing several files --
stylesheets, JavaScript, and graphics:</p>
<img alt="images/s5-files.png" class="align-center" src="images/s5-files.png" />
<div class="handout container">
<p>The generated HTML contains the entire slide show text. It also
contains links to the following files:</p>
<ul>
<li><p class="first">slides.css simply contains import links to:</p>
<ul class="simple">
<li>s5-core.css: Default styles critical to the proper functioning
of the slide show; don't touch this!</li>
<li>framing.css: Sets the basic layout of slide components (header,
footer, controls, etc. This file is the often edited.</li>
<li>pretty.css: Presentation styles that give the slide show a
unique look and feel. This is the file that you're most likely
to edit for a custom theme. You can make a whole new theme
just by editing this file, and not touching the others.</li>
</ul>
</li>
<li><p class="first">outline.css: Styles for outline mode.</p>
</li>
<li><p class="first">print.css: Styles for printing; hides most layout elements, and
may display others.</p>
</li>
<li><p class="first">opera.css: Styles necessary for the proper functioning of S5 in
Opera Show.</p>
</li>
<li><p class="first">slides.js: the JavaScript that drives the dynamic side of the
slide show (actions and navigation controls). It automatically
IDs the slides when the document loads, builds the navigation
menu, handles the hiding and showing of slides, and so on. The
code also manages the fallback to Opera Show if you're using
the Opera web browser.</p>
<p>Two files are included to support PNG transparency (alpha
channels) in Internet Explorer:</p>
<ul class="simple">
<li>iepngfix.htc</li>
<li>blank.gif</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="making-a-custom-theme">
<h1><a class="toc-backref" href="#id46">Making a Custom Theme</a></h1>
<ol class="incremental arabic">
<li><p class="first">Run "<tt class="docutils literal">rst2s5.py <span class="pre">--theme</span> <span class="pre"><base-theme></span> <span class="pre"><doc>.txt</span> <span class="pre"><doc>.html</span></tt>".</p>
<p class="handout">This initializes the <tt class="docutils literal">ui</tt> directory with the base theme files.</p>
</li>
<li><p class="first">Copy <tt class="docutils literal"><span class="pre">ui/<base-theme></span></tt> to <tt class="docutils literal"><span class="pre">ui/<new-theme></span></tt>.</p>
</li>
<li><p class="first">Edit the styles.</p>
<p class="handout">Start with <tt class="docutils literal">pretty.css</tt>; edit <tt class="docutils literal">framing.css</tt> if you need to make
layout changes.</p>
</li>
<li><p class="first">Run "<tt class="docutils literal">rst2s5.py <span class="pre">--theme-url</span> <span class="pre">ui/<new-theme></span> <span class="pre"><doc>.txt</span> <span class="pre"><doc>.html</span></tt>".</p>
<p class="handout">We use the <tt class="docutils literal"><span class="pre">--theme-url</span></tt> option to refer to the new theme. Open
your <tt class="docutils literal"><span class="pre"><doc>.html</span></tt> in a browser to test the new theme.</p>
</li>
<li><p class="first">Rinse & repeat.</p>
<p class="handout">Repeat from step 3 until you're satisfied.</p>
</li>
</ol>
<!-- TODO: What to do next:
* add a ``__base__`` file
* create a personal reusable theme (plugin)
* submit the new theme to Docutils
``docutils/writers/s5_html/themes/<theme>`` -->
<div class="handout container">
<p>Resources:</p>
<ul class="simple">
<li>W3C's <a class="reference external" href="http://www.w3.org/Style/CSS/learning">Learning CSS</a></li>
<li><a class="reference external" href="http://home.cogeco.ca/~ve3ll/s5themes.htm">Creating An S5 Theme</a></li>
<li>A short tutorial on how to create themes (in German):
<a class="reference external" href="http://yatil.de/s5/dokumentation/9/">Eigenes Theme erstellen</a></li>
</ul>
</div>
</div>
<div class="section" id="classes-incremental-1">
<h1><a class="toc-backref" href="#id47">Classes: Incremental (1)</a></h1>
<p class="handout">Several "class" attribute values have built-in support in the
themes supplied with Docutils.</p>
<p class="incremental">As described earlier,</p>
<ul class="incremental">
<li><p class="first"><tt class="docutils literal">.. class:: incremental</tt></p>
</li>
<li><p class="first"><tt class="docutils literal">.. container:: incremental</tt></p>
</li>
<li><pre class="first literal-block">
.. sidebar:: title
:class: incremental
</pre>
</li>
</ul>
</div>
<div class="section" id="classes-incremental-2">
<h1><a class="toc-backref" href="#id48">Classes: Incremental (2)</a></h1>
<p>The "incremental" interpreted text role is also supported:</p>
<pre class="incremental literal-block">
:incremental:`This will appear first,` `and
this will appear second.`:incremental:
</pre>
<p class="incremental">Requires "<tt class="docutils literal">.. include:: <s5defs.txt></tt>".</p>
<div class="handout container">
As you can see, this markup is not very convenient.</div>
<div class="incremental line-block">
<div class="line">But <tt class="docutils literal">s5defs.txt</tt> includes this useful definition:</div>
<div class="line">"<tt class="docutils literal">.. <span class="pre">default-role::</span> incremental</tt>". So:</div>
</div>
<pre class="incremental literal-block">
`This` `is` `all` `we` `need`
</pre>
<p><span class="incremental">This</span> <span class="incremental">is</span> <span class="incremental">all</span> <span class="incremental">we</span> <span class="incremental">need</span> <span class="incremental">to mark up incremental text.</span></p>
</div>
<div class="section" id="classes-incremental-3">
<h1><a class="toc-backref" href="#id49">Classes: Incremental (3)</a></h1>
<pre class="small literal-block">
.. container:: animation
.. image:: images/empty.png
:class: hidden slide-display
.. class:: incremental hidden slide-display
.. image:: images/1.png
.. image:: images/2.png
.. image:: images/3.png
:class: incremental
</pre>
<div class="handout container">
<p>This is how the example works.</p>
<p>The animation effects are caused by placing successive images at
the same location, laying each image over the last. For best
results, all images should be the same size, and the positions of
image elements should be consistent. Use image transparency (alpha
channels) to get overlay effects.</p>
<p>Absolute positioning is used, which means that the images take up
no space in the flow. If you want text to follow the images, you
have to specify the total size of the container via a style.
Otherwise, the images and any following text will overlap.</p>
<p>These class values do the work:</p>
<dl class="docutils">
<dt>animation</dt>
<dd>This wraps the container with styles that position the images
absolutely, overlaying them over each other. Only useful on a
container.</dd>
<dt>hidden</dt>
<dd>Unless overridden (by "slide-display", for example), these
elements will not be displayed. Only the last image will be
displayed in handout mode, when print, or when processed to
ordinary HTML, because it does <em>not</em> carry a "hidden" class.</dd>
<dt>slide-display</dt>
<dd>In conjunction with "hidden", these elements will only appear
on the slide, preventing clutter in the handout.</dd>
<dt>incremental</dt>
<dd>The second and subsequent images will appear one at a time.
The first image will already be present when the slide is
displayed, because it does <em>not</em> carry an "incremental" class.</dd>
</dl>
</div>
</div>
<div class="section" id="classes-text-size">
<h1><a class="toc-backref" href="#id50">Classes: Text Size</a></h1>
<ul class="incremental simple">
<li><span class="tiny">tiny</span> (class & role name: "tiny", e.g. "<tt class="docutils literal"><span class="pre">:tiny:`text`</span></tt>")</li>
<li><span class="small">small</span> ("small")</li>
<li>normal (unstyled)</li>
<li><span class="big">big</span> ("big")</li>
<li><span class="huge">huge</span> ("huge")</li>
</ul>
<p class="incremental">Requires "<tt class="docutils literal">.. include:: <s5defs.txt></tt>".</p>
</div>
<div class="section" id="classes-alignment">
<h1><a class="toc-backref" href="#id51">Classes: Alignment</a></h1>
<p class="incremental left">Left (class name: "left")</p>
<p class="incremental center">Center ("center" & "centre")</p>
<p class="incremental right">Right ("right")</p>
<p class="handout">These classes apply to block-level elements only. They cannot be
used for inline text (i.e., they're not interpreted text roles).</p>
<p class="incremental">Example:</p>
<pre class="incremental literal-block">
.. class:: center
Text to be centered.
</pre>
</div>
<div class="section" id="classes-text-colours">
<h1><a class="toc-backref" href="#id52">Classes: Text Colours</a></h1>
<p><span class="black">black</span> [black], <span class="gray">gray</span>, <span class="silver">silver</span>, <span class="white">white</span>
[white], <span class="maroon">maroon</span>, <span class="red">red</span>, <span class="magenta">magenta</span>,
<span class="fuchsia">fuchsia</span>, <span class="pink">pink</span>, <span class="orange">orange</span>, <span class="yellow">yellow</span>,
<span class="lime">lime</span>, <span class="green">green</span>, <span class="olive">olive</span>, <span class="teal">teal</span>,
<span class="cyan">cyan</span>, <span class="aqua">aqua</span>, <span class="blue">blue</span>, <span class="navy">navy</span>,
<span class="purple">purple</span></p>
<p>The class names and role names are the same as the colour names. For
example, "<tt class="docutils literal"><span class="pre">:orange:`text`</span></tt>" produces "<span class="orange">text</span>".</p>
<p class="incremental">Requires "<tt class="docutils literal">.. include:: <s5defs.txt></tt>".</p>
</div>
<div class="section" id="classes-borderless-tables">
<h1><a class="toc-backref" href="#id53">Classes: Borderless Tables</a></h1>
<p class="handout">Here's an ordinary, unstyled table:</p>
<table border="1" class="incremental docutils">
<colgroup>
<col width="56%" />
<col width="44%" />
</colgroup>
<tbody valign="top">
<tr><td>Sometimes</td>
<td>borders</td>
</tr>
<tr><td>are</td>
<td>useful.</td>
</tr>
</tbody>
</table>
<p class="incremental">And after applying "<tt class="docutils literal">.. class:: borderless</tt>":</p>
<table border="1" class="incremental borderless docutils">
<colgroup>
<col width="29%" />
<col width="42%" />
<col width="29%" />
</colgroup>
<tbody valign="top">
<tr><td>But</td>
<td>sometimes,</td>
<td>borders</td>
</tr>
<tr><td>are</td>
<td><strong>not</strong></td>
<td>wanted.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="classes-print-only">
<h1><a class="toc-backref" href="#id54">Classes: Print-Only</a></h1>
<p class="handout">Elements with <tt class="docutils literal"><span class="pre">class="print"</span></tt> attributes display their contents
when printed, overriding <tt class="docutils literal"><span class="pre">class="hidden"</span></tt>.</p>
<p class="incremental">Example: the "target-notes" directive:</p>
<pre class="incremental literal-block">
.. topic:: Links
:class: hidden print
.. target-notes::
:class: hidden print
</pre>
<div class="handout container">
<p>One good example, used in this document, is the "target-notes"
directive. For each external target (hyperlink) in the text, this
directive generates a footnote containing the visible URL as
content. Footnote references are placed after each hyperlink
reference.</p>
<p>The "topic" directive is given a "class" attribute with values
"hidden" and "print", so the entire topic will only be displayed
when printed. The "target-notes" directive also assigns a "class"
attributes with values "hidden" and "print" to each of the footnote
references it inserts throughout the text; they will only show up
when printed.</p>
</div>
<p class="incremental">Other uses may require "<tt class="docutils literal">.. include:: <s5defs.txt></tt>".</p>
</div>
<div class="section" id="useful-extensions-for-firefox">
<h1><a class="toc-backref" href="#id55">Useful Extensions For Firefox</a></h1>
<ul>
<li><p class="first"><a class="reference external" href="http://www.krickelkrackel.de/autohide/autohide.htm">Autohide</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id27" id="id28">[9]</a></p>
<p class="handout">Automatically hides toolbars in full-screen mode.</p>
</li>
<li><p class="first"><a class="reference external" href="http://chrispederick.com/work/webdeveloper/">Web Developer</a><span class="hidden print"> </span><a class="hidden print footnote-reference" href="#id23" id="id29">[7]</a></p>
<p class="handout">Adds a context submenu and a toolbar with a lot of useful
functionality, including the viewing and live editing of
stylesheets, and sizing the browser window.</p>
</li>
</ul>
</div>
<div class="section" id="to-do">
<h1><a class="toc-backref" href="#id56">To Do</a></h1>
<ul class="incremental">
<li><p class="first">Multi-display support:</p>
<ul class="simple">
<li>speaker's notes on the laptop screen</li>
<li>slides on the projector</li>
<li>two views stay in sync</li>
<li>presentation controlled from either display</li>
</ul>
</li>
<li><p class="first">Add timeout to incremental style.</p>
<p class="handout">I.e., incremental-specific style should go away (revert to
normal) after a certain interval.</p>
</li>
</ul>
<p class="incremental">These will require some serious JavaScript-fu!</p>
</div>
<div class="section" id="that-s-all-folks">
<h1><a class="toc-backref" href="#id57">That's All, Folks!</a></h1>
<p class="huge">Further information:
<a class="reference external" href="http://docutils.sf.net">http://docutils.sf.net</a></p>
<p class="huge">Docutils users' mailing list:
<a class="reference external" href="mailto:docutils-users@lists.sf.net">docutils-users@lists.sf.net</a></p>
<p class="huge"><span class="incremental">Any questions?</span></p>
<div class="hidden print topic">
<p class="topic-title first">Links</p>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>, <a class="fn-backref" href="#id10">3</a>)</em> <a class="reference external" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id11" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id12">[2]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id13" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[3]</td><td><em>(<a class="fn-backref" href="#id14">1</a>, <a class="fn-backref" href="#id15">2</a>, <a class="fn-backref" href="#id22">3</a>)</em> <a class="reference external" href="http://meyerweb.com/eric/tools/s5/">http://meyerweb.com/eric/tools/s5/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id16" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id17">[4]</a></td><td><a class="reference external" href="http://www.mozilla.com/firefox/">http://www.mozilla.com/firefox/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id18" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id19">[5]</a></td><td><a class="reference external" href="http://www.opera.com/support/tutorials/operashow/">http://www.opera.com/support/tutorials/operashow/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id20" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id21">[6]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/README.html">http://docutils.sourceforge.net/README.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id23" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[7]</td><td><em>(<a class="fn-backref" href="#id24">1</a>, <a class="fn-backref" href="#id29">2</a>)</em> <a class="reference external" href="http://chrispederick.com/work/webdeveloper/">http://chrispederick.com/work/webdeveloper/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id25" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id26">[8]</a></td><td><a class="reference external" href="http://meyerweb.com/eric/tools/s5/s5blank.zip">http://meyerweb.com/eric/tools/s5/s5blank.zip</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id27" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id28">[9]</a></td><td><a class="reference external" href="http://www.krickelkrackel.de/autohide/autohide.htm">http://www.krickelkrackel.de/autohide/autohide.htm</a></td></tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="footer">
<hr class="footer" />
Location • Date
</div>
</body>
</html>