/usr/share/doc/python-plastex-doc/html/sec-config-links.html is in python-plastex-doc 0.9.2-1.
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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | <!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: Document Links</title>
<link href="sec-config-files.html" title="Input and Output Files" rel="next" />
<link href="sect0005.html" title="Counters" rel="prev" />
<link href="sect0003.html" title="Command-Line and Configuration Options" 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="sect0005.html" title="Counters"><img alt="Previous: Counters" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="sect0003.html" title="Command-Line and Configuration Options"><img alt="Up: Command-Line and Configuration Options" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sec-config-files.html" title="Input and Output Files"><img alt="Next: Input and Output Files" 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="sect0002.html"><b class="bf">plastex</b> — The Command-Line Interface</a> <b>:</b>
</span>
</span><span>
<span>
<a href="sect0003.html">Command-Line and Configuration Options</a> <b>:</b>
</span>
</span><span>
<span>
<b class="current">Document Links</b>
</span>
</span>
<hr />
</div>
<div><h2 id="sec:config-links">2.1.4 Document Links</h2>
<p>The links section of the configuration is a little different than the others. The options in the links section are not preconfigured, they are all user-specified. The links section includes information to be included in the navigation object available on all sections in a document. By default, the section’s navigation object includes things like the previous and next objects in the document, the child nodes, the sibling nodes, etc. The table below lists all of the navigation objects that are already defined. The names for these items came from the link types defined at <a href="http://fantasai.tripod.com/qref/Appendix/LinkTypes/ltdef.html">http://fantasai.tripod.com/qref/Appendix/LinkTypes/ltdef.html</a>. Of course, it is up to the renderer to actually make use of them. </p><p><center><table cellspacing="0" class="tabular">
<tr>
<td style="text-align:left; border-right:1px solid black"><p><b class="bf">Name</b>&<b class="bf">Description</b> </p></td>
</tr><tr>
<td style="border-top-style:solid; text-align:left; border-top-color:black; border-top-width:1px; border-right:1px solid black"><p> <span class="rmfamily"><i class="itshape">home</i></span>&the first section in the document</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">start</i></span>&same as <span class="rmfamily"><i class="itshape">home</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">begin</i></span>&same as <span class="rmfamily"><i class="itshape">home</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">first</i></span>&same as <span class="rmfamily"><i class="itshape">home</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">end</i></span>&the last section in the document</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">last</i></span>&same as <span class="rmfamily"><i class="itshape">end</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">next</i></span>&the next section in the document</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">prev</i></span>&the previous section in the document</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">previous</i></span>&same as <span class="rmfamily"><i class="itshape">prev</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">up</i></span>&the parent section</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">top</i></span>&the top section in the document</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">origin</i></span>&same as <span class="rmfamily"><i class="itshape">top</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">parent</i></span>&the parent section</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">child</i></span>&a list of the subsections</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">siblings</i></span>&a list of the sibling sections</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">document</i></span>&the document object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">part</i></span>&the current part object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">chapter</i></span>&the current chapter object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">section</i></span>&the current section object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">subsection</i></span>&the current subsection object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">navigator</i></span>&the top node in the document object</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">toc</i></span>&the node containing the table of contents</p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">contents</i></span>&same as <span class="rmfamily"><i class="itshape">toc</i></span></p></td>
</tr><tr>
<td style="text-align:left; border-right:1px solid black"><p><span class="rmfamily"><i class="itshape">breadcrumbs</i></span>&a list of the parent objects of the current node</p></td>
</tr>
</table></center> </p><p>Since each of these items references an object that is expected to have a URL and a title, any user-defined fields should contain these as well (although the URL is optional in some items). To create a user-defined field in this object, you need to use two options: one for the title and one for the URL, if one exists. They are specified in the config file as follows: </p><pre>
[links]
next-url=http://myhost.com/glossary
next-title=The Next Document
mylink-title=Another Title
</pre><p>These option names are split on the dash (-) to create a key, before the dash, and a member, after the dash. A dictionary is inserted into the navigation object with the name of the key, and the members are added to that dictionary. The configuration above would create the following Python dictionary. </p><pre>
{
'next':
{
'url':'http://myhost.com/glossary',
'title':'The Next Document'
},
'mylink':
{
'title':'Another Title'
}
}
</pre><p>While you can not override a field that is populated by the document, there are times when a field isn’t populated. This occurs, for example, in the <span class="rmfamily"><i class="itshape">prev</i></span> field at the beginning of the document, or the <span class="rmfamily"><i class="itshape">next</i></span> field at the end of the document. If you specify a <span class="rmfamily"><i class="itshape">prev</i></span> or <span class="rmfamily"><i class="itshape">next</i></span> field in your configuration, those fields will be used when no <span class="rmfamily"><i class="itshape">prev</i></span> or <span class="rmfamily"><i class="itshape">next</i></span> is available. This allows you to link to external documents at those points. </p><p><dl class="description">
<dt><b class="bfseries">Set document links</b></dt>
<dd><p><br /><b class="bfseries">Command-Line Options:</b> <tt class="ttfamily"><b class="bf">--links=<span class="rmfamily"><i class="itshape">[ key optional-url title ]</i></span></b></tt><br />specifies links to be included in the navigation object. Since at least two values are needed in the links (key and title, with an optional URL), the values are grouped in square brackets on the command-line ([ ]). </p></dd>
</dl> </p></div>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="sect0005.html" title="Counters"><img alt="Previous: Counters" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="sect0003.html" title="Command-Line and Configuration Options"><img alt="Up: Command-Line and Configuration Options" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sec-config-files.html" title="Input and Output Files"><img alt="Next: Input and Output Files" 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>
|