twisted.lore.slides.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.lore.slides</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.lore.html">Package lore</a> ::
Module slides
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.lore.slides.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.lore.slides</h2>
<p>Rudimentary slide support for Lore.</p>
TODO:
<ul>
<li>
Complete mgp output target
<ul>
<li>
syntax highlighting
</li>
<li>
saner font handling
</li>
<li>
probably lots more
</li>
</ul>
</li>
<li>
Add HTML output targets
<ul>
<li>
one slides per page (with navigation links)
</li>
<li>
all in one page
</li>
</ul>
</li>
</ul>
Example input file:
<pre class="literalblock">
<html>
<head><title>Title of talk</title></head>
<body>
<h1>Title of talk</h1>
<h2>First Slide</h2>
<ul>
<li>Bullet point</li>
<li>Look ma, I'm <strong>bold</strong>!</li>
<li>... etc ...</li>
</ul>
<h2>Second Slide</h2>
<pre class="python">
# Sample code sample.
print "Hello, World!"
</pre>
</body>
</html>
</pre>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.HTMLSlide.html"><code>HTMLSlide</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.MagicpointOutput.html"><code>MagicpointOutput</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.PagebreakLatex.html"><code>PagebreakLatex</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.ProsperSlides.html"><code>ProsperSlides</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.SlidesProcessingFunctionFactory.html"><code>SlidesProcessingFunctionFactory</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.lore.slides.TwoPagebreakLatex.html"><code>TwoPagebreakLatex</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="convertFile"></a><span class="summary-sig"><span class="summary-sig-name">convertFile</span>(<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>outputter</span>,
<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>ext</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="doFile"></a><span class="summary-sig"><span class="summary-sig-name">doFile</span>(<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>linkrel</span>,
<span class=summary-sig-arg>ext</span>,
<span class=summary-sig-arg>url</span>,
<span class=summary-sig-arg>templ</span>,
<span class=summary-sig-arg>options</span>,
<span class=summary-sig-arg>outfileGenerator</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getOutputFileName"></a><span class="summary-sig"><span class="summary-sig-name">getOutputFileName</span>(<span class=summary-sig-arg>originalFileName</span>,
<span class=summary-sig-arg>outputExtension</span>,
<span class=summary-sig-arg>index</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="insertPrevNextLinks"></a><span class="summary-sig"><span class="summary-sig-name">insertPrevNextLinks</span>(<span class=summary-sig-arg>slides</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>ext</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="munge"></a><span class="summary-sig"><span class="summary-sig-name">munge</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>linkrel</span>,
<span class=summary-sig-arg>d</span>,
<span class=summary-sig-arg>fullpath</span>,
<span class=summary-sig-arg>ext</span>,
<span class=summary-sig-arg>url</span>,
<span class=summary-sig-arg>config</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="splitIntoSlides"></a><span class="summary-sig"><span class="summary-sig-name">splitIntoSlides</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.lore.slides.html#entities"><code>entities</code></a></b> = <span title="{'amp': '&', 'lt': '<', 'gt': '>', 'copy': '(c)', 'quot': '"'}"><code>{'amp': '&', 'lt': '<', 'gt': '>', 'copy': '(<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a
href="twisted.lore.slides.SlidesProcessingFunctionFactory.html"
class="link"><code>SlidesProcessingFunctionFactory</code></a></font></td>
<td><b><a href="twisted.lore.slides.html#factory"><code>factory</code></a></b> = <span title="<twisted.lore.slides.SlidesProcessingFunctionFactory instance at 0x8af6174>"><code><twisted.lore.slides.SlidesProcessingFunctionF<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.lore.slides.html#hacked_entities"><code>hacked_entities</code></a></b> = <span title="{'amp': ' &', 'lt': ' <', 'gt': ' >', 'copy': ' (c)', 'quot': ' "'}"><code>{'amp': ' &', 'lt': ' <', 'gt': ' >', <span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="entities"></a>
<h3>entities</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'amp': '&', 'lt': '<', 'gt': '>', 'copy': '(c)', 'quot': '"'}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'amp': '&', 'lt': '<', 'gt': '>', 'copy': '(c)', 'quot': '"'} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="factory"></a>
<h3>factory</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a
href="twisted.lore.slides.SlidesProcessingFunctionFactory.html"
class="link"><code>SlidesProcessingFunctionFactory</code></a>
</dd>
<span title="<twisted.lore.slides.SlidesProcessingFunctionFactory instance at 0x8af6174>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<twisted.lore.slides.SlidesProcessingFunctionFactory instance at 0x8af<span class="variable-linewrap">\</span>
6174> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="hacked_entities"></a>
<h3>hacked_entities</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'amp': ' &', 'lt': ' <', 'gt': ' >', 'copy': ' (c)', 'quot': ' "'}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'amp': ' &', 'lt': ' <', 'gt': ' >', 'copy': ' (c)', 'quot': ' "'} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:16 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>