/usr/share/doc/python-plastex-doc/html/sect0042.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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | <!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: Renderable MixIn</title>
<link href="module-plasTeX-Imagers.html" title="plasTeX.Imagers — The plasImaging Framework" rel="next" />
<link href="sect0041.html" title="Renderer Objects" rel="prev" />
<link href="module-plasTeX-Renderers.html" title="plasTeX.Renderers — The plasRendering Framework" 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="sect0041.html" title="Renderer Objects"><img alt="Previous: Renderer Objects" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="module-plasTeX-Renderers.html" title="plasTeX.Renderers — The plasTeX Rendering Framework"><img alt="Up: plasTeX.Renderers — The plasTeX Rendering Framework" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="module-plasTeX-Imagers.html" title="plasTeX.Imagers — The plasTeX Imaging Framework"><img alt="Next: plasTeX.Imagers — The plasTeX Imaging Framework" 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>
<a href="module-plasTeX-Renderers.html"><tt class="ttfamily">plasTeX.Renderers</tt> — The plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X Rendering Framework</a> <b>:</b>
</span>
</span><span>
<span>
<b class="current">Renderable MixIn</b>
</span>
</span>
<hr />
</div>
<div><h2 id="a0000000043">6.6.2 Renderable MixIn</h2>
<p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt><b class="bf">class </b><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">Renderable</b></tt></span><span class="rmfamily"><tt class="ttfamily">(</tt></span><span style="width:0.0pt" class="parbox"><span class="rmfamily"><i class="itshape"></i></span><span class="rmfamily"><tt class="ttfamily">)</tt></span></span></dt>
<dd><p><a name="a0000000334" id="a0000000334"></a> The <tt class="ttfamily">Renderable</tt> mixin is mixed into the <tt class="ttfamily">Node</tt> namespace prior to the rendering process. The methods mixed in assist in the rendering process. </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">filename</b></tt></span></dt>
<dd><p><a name="a0000000335" id="a0000000335"></a> the filename that this object will create. Objects that don’t create new files should simply return <span class="rmfamily"><i class="itshape">None</i></span>. The configuration determines which nodes should create new files. </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">image</b></tt></span></dt>
<dd><p><a name="a0000000336" id="a0000000336"></a> generate an image of the object and return the image filename. See the <tt class="ttfamily">Imager</tt> documentation in section <a href="module-plasTeX-Imagers.html">6.7</a> for more information. </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">vectorImage</b></tt></span></dt>
<dd><p><a name="a0000000337" id="a0000000337"></a> generate a vector image of the object and return the image filename. See the <tt class="ttfamily">Imager</tt> documentation in section <a href="module-plasTeX-Imagers.html">6.7</a> for more information. </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">url</b></tt></span></dt>
<dd><p><a name="a0000000338" id="a0000000338"></a> return the relative URL of the object. </p><p>If the object actually creates a file, just the filename will be returned (e.g. ‘<span class="sffamily">foo.html</span>’). If the object is within a file, both the filename and the anchor will be returned (e.g. ‘<span class="sffamily">foo.html#bar</span>’). </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">__str__</b></tt></span><span class="rmfamily"><tt class="ttfamily">(</tt></span><span style="width:0.0pt" class="parbox"><span class="rmfamily"><i class="itshape"></i></span><span class="rmfamily"><tt class="ttfamily">)</tt></span></span></dt>
<dd><p><a name="a0000000339" id="a0000000339"></a> same as <tt class="ttfamily">__unicode__()</tt>. </p></dd>
</dl> </p><p> <dl class="description">
<dt></dt>
<dd></dd>
<dt></dt>
<dd> </dd>
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt></dt>
<dd></dd>
<dt><span class="rmfamily"><tt class="ttfamily"><b class="bfseries">__unicode__</b></tt></span><span class="rmfamily"><tt class="ttfamily">(</tt></span><span style="width:0.0pt" class="parbox"><span class="rmfamily"><i class="itshape"></i></span><span class="rmfamily"><tt class="ttfamily">)</tt></span></span></dt>
<dd><p><a name="a0000000340" id="a0000000340"></a> invoke the rendering process on all of the child nodes. The rendering process includes walking through the child nodes, looking up the appropriate rendering method from the renderer, and calling the method with the child node as its argument. </p><p>In addition to the actual rendering process, this method also prints out some status information about the rendering process. For example, if the node being rendered has a non-empty <tt class="ttfamily">filename</tt> attribute, that means that the node is generating a new file. This filename information is printed to the log. One problem with this methodology is that the filename is not actually created at this time. It is assumed that the rendering method will check for the <tt class="ttfamily">filename</tt> attribute and actually create the file. </p></dd>
</dl> </p></div>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="sect0041.html" title="Renderer Objects"><img alt="Previous: Renderer Objects" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="module-plasTeX-Renderers.html" title="plasTeX.Renderers — The plasTeX Rendering Framework"><img alt="Up: plasTeX.Renderers — The plasTeX Rendering Framework" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="module-plasTeX-Imagers.html" title="plasTeX.Imagers — The plasTeX Imaging Framework"><img alt="Next: plasTeX.Imagers — The plasTeX Imaging Framework" 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>
|