/usr/share/doc/python-plastex-doc/html/module-plasTeX-Renderers.html is in python-plastex-doc 0.9.2-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | <!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 name="generator" content="plasTeX" />
<meta content="text/html; charset=utf-8" http-equiv="content-type" />
<title>plasTeX — A Python Framework for Processing LaTeX Documents: plasTeX.Renderers — The plasTeX Rendering Framework</title>
<link href="sect0041.html" title="Renderer Objects" rel="next" />
<link href="sect0040.html" title="Context Objects" rel="prev" />
<link href="sect0024.html" title="plasFrameworks and APIs" rel="up" />
<link rel="stylesheet" href="styles/styles.css" />
</head>
<body>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="sect0040.html" title="Context Objects"><img alt="Previous: Context Objects" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="sect0024.html" title="plasTeX Frameworks and APIs"><img alt="Up: plasTeX Frameworks and APIs" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sect0041.html" title="Renderer Objects"><img alt="Next: Renderer Objects" border="0" src="icons/next.gif" width="32" height="32" /></a></td>
<td class="navtitle" align="center">plasTeX — A Python Framework for Processing LaTeX Documents</td>
<td><a href="index.html" title="Table of Contents"><img border="0" alt="" src="icons/contents.gif" width="32" height="32" /></a></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
</tr>
</table>
</div>
<div class="breadcrumbs">
<span>
<span>
<a href="index.html">plasTeX — A Python Framework for Processing LaTeX Documents</a> <b>:</b>
</span>
</span><span>
<span>
<a href="sect0024.html">plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X Frameworks and APIs</a> <b>:</b>
</span>
</span><span>
<span>
<b class="current"><tt class="ttfamily">plasTeX.Renderers</tt> — The plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X Rendering Framework</b>
</span>
</span>
<hr />
</div>
<div><h1 id="module-plasTeX.Renderers">6.6 <tt class="ttfamily">plasTeX.Renderers</tt> — The plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X Rendering Framework</h1>
<p> <a name="a0000000315" id="a0000000315"></a> </p><p>The renderer is responsible for taking the information in a plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X document object and creating a another (usually visual) representation of it. This representation may be HTML, XML, RTF, etc. While this could be implemented in various ways. One rendering framework is included with plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X. </p><p>The renderer is essentially just a dictionary of functions<a href="#a0000000316" class="footnote"><sup class="footnotemark">1</sup></a>. The keys in this dictionary correspond to names of the nodes in the document object. The values are the functions that are called when a node in the document object needs to be rendered. The only argument to the function is the node itself. What this function does in the rendering process is completely up to it; however, it should refrain from changing the document object itself as other renderers may be using that same object. </p><p>There are some responsibilities that all renderers share. Renderers are responsible for checking options in the configuration object. For instance, renderers are responsible for generating filenames, creating directories, writing files in the proper encoding, generating images, splitting the document into multiple output files, etc. Of course, how it accomplishes this is really renderer dependent. An example of a renderer based on Zope Page Templates (ZPT) is included with plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X. This renderer is capable of generating XML and HTML output. </p></div>
<div class="contents section-contents"><!--<strong>Subsections</strong>-->
<ul>
<li><a href="sect0041.html">6.6.1 Renderer Objects</a>
</li><li><a href="sect0042.html">6.6.2 Renderable MixIn</a>
</li>
</ul>
</div>
<div id="footnotes">
<p><b>Footnotes</b></p>
<ol>
<li id="a0000000316"> “functions” is being used loosely here. Actually, any Python callable object (i.e. function, method, or any object with the <tt class="ttfamily">__call__</tt> method implemented) can be used</li>
</ol>
</div>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="sect0040.html" title="Context Objects"><img alt="Previous: Context Objects" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="sect0024.html" title="plasTeX Frameworks and APIs"><img alt="Up: plasTeX Frameworks and APIs" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sect0041.html" title="Renderer Objects"><img alt="Next: Renderer Objects" border="0" src="icons/next.gif" width="32" height="32" /></a></td>
<td class="navtitle" align="center">plasTeX — A Python Framework for Processing LaTeX Documents</td>
<td><a href="index.html" title="Table of Contents"><img border="0" alt="" src="icons/contents.gif" width="32" height="32" /></a></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
</tr>
</table>
</div>
<script language="javascript" src="icons/imgadjust.js" type="text/javascript"></script>
</body>
</html>
|