latex.html

来自「perl教程」· HTML 代码 · 共 444 行 · 第 1/2 页

<dd>
<p>Control the point at which <code>latex</code> section numbering is turned off.
For example, this can be used to make sure that <code>latex</code> sections
are numbered but subsections are not.</p>
</dd>
<dd>
<p>Can be used to set or retrieve the current value:</p>
</dd>
<dd>
<pre>
  <span class="variable">$lev</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">LevelNoNum</span><span class="operator">;</span>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">LevelNoNum</span><span class="operator">(</span><span class="number">2</span><span class="operator">);</span>
</pre>
</dd>
<dd>
<p>The argument must be an integer between 0 and 5 and is the same as the
number described in <a href="#item_head1level"><code>Head1Level</code></a> method description. The number has
nothing to do with the pod heading number, only the <code>latex</code> sectioning.</p>
</dd>
<dd>
<p>Default is 2. (i.e. <code>latex</code> subsections are written as <code>subsection*</code>
but sections are numbered).</p>
</dd>
</li>
<dt><strong><a name="item_makeindex"><strong>MakeIndex</strong></a></strong>

<dd>
<p>Controls whether <code>latex</code> commands for creating an index are to be inserted
into the preamble and postamble</p>
</dd>
<dd>
<pre>
  <span class="variable">$makeindex</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">MakeIndex</span><span class="operator">;</span>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">MakeIndex</span><span class="operator">(</span><span class="number">0</span><span class="operator">);</span>
</pre>
</dd>
<dd>
<p>Irrelevant if both <a href="#item_addpreamble"><code>AddPreamble</code></a> and <a href="#item_addpostamble"><code>AddPostamble</code></a> are false (or equivalently,
<a href="#item_userpreamble"><code>UserPreamble</code></a> and <a href="#item_userpostamble"><code>UserPostamble</code></a> are set).</p>
</dd>
<dd>
<p>Default is for an index to be created.</p>
</dd>
</li>
<dt><strong><a name="item_replacenamewithsection"><strong>ReplaceNAMEwithSection</strong></a></strong>

<dd>
<p>This controls whether the <a href="../../lib/Pod/perlfunc.html#item_name"><code>NAME</code></a> section in the pod is to be translated
literally or converted to a slightly modified output where the section
name is the pod name rather than &quot;NAME&quot;.</p>
</dd>
<dd>
<p>If true, the pod segment</p>
</dd>
<dd>
<pre>
  =head1 NAME</pre>
</dd>
<dd>
<pre>
  pod::name - purpose</pre>
</dd>
<dd>
<pre>
  =head1 SYNOPSIS</pre>
</dd>
<dd>
<p>is converted to the <code>latex</code></p>
</dd>
<dd>
<pre>
  <span class="operator">\</span><span class="variable">section</span><span class="operator">{</span><span class="variable">pod::name</span><span class="operator">\</span><span class="variable">label</span><span class="operator">{</span><span class="variable">pod_name</span><span class="operator">}\</span><span class="keyword">index</span><span class="operator">{</span><span class="variable">pod::name</span><span class="operator">}}</span>
</pre>
</dd>
<dd>
<pre>
  Purpose</pre>
</dd>
<dd>
<pre>
  <span class="operator">\</span><span class="variable">subsection</span><span class="variable">*</span><span class="operator">{</span><span class="variable">SYNOPSIS</span><span class="operator">\</span><span class="variable">label</span><span class="operator">{</span><span class="variable">pod_name_SYNOPSIS</span><span class="operator">}%
  </span>             <span class="operator">\</span><span class="keyword">index</span><span class="operator">{</span><span class="variable">pod::name</span><span class="operator">!</span><span class="variable">SYNOPSIS</span><span class="operator">}</span><span class="operator">}</span>
</pre>
</dd>
<dd>
<p>(dependent on the value of <a href="#item_head1level"><code>Head1Level</code></a> and <a href="#item_levelnonum"><code>LevelNoNum</code></a>). Note that
subsequent <code>head1</code> directives translate to subsections rather than
sections and that the labels and index now include the pod name (dependent
on the value of <a href="#item_uniquelabels"><code>UniqueLabels</code></a>).</p>
</dd>
<dd>
<p>The <a href="#item_label"><code>Label</code></a> is set from the pod name regardless of any current value
of <a href="#item_label"><code>Label</code></a>.</p>
</dd>
<dd>
<pre>
  <span class="variable">$mod</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">ReplaceNAMEwithSection</span><span class="operator">;</span>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">ReplaceNAMEwithSection</span><span class="operator">(</span><span class="number">0</span><span class="operator">);</span>
</pre>
</dd>
<dd>
<p>Default is to translate the pod literally.</p>
</dd>
</li>
<dt><strong><a name="item_startwithnewpage"><strong>StartWithNewPage</strong></a></strong>

<dd>
<p>If true, each pod translation will begin with a <code>latex</code>
<code>\clearpage</code>.</p>
</dd>
<dd>
<pre>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">StartWithNewPage</span><span class="operator">(</span><span class="number">1</span><span class="operator">);</span>
  <span class="variable">$newpage</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">StartWithNewPage</span><span class="operator">;</span>
</pre>
</dd>
<dd>
<p>Default is false.</p>
</dd>
</li>
<dt><strong><a name="item_tableofcontents"><strong>TableOfContents</strong></a></strong>

<dd>
<p>If true, a table of contents will be created.
Irrelevant if <a href="#item_addpreamble"><code>AddPreamble</code></a> is false or <a href="#item_userpreamble"><code>UserPreamble</code></a>
is set.</p>
</dd>
<dd>
<pre>
  <span class="variable">$toc</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">TableOfContents</span><span class="operator">;</span>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">TableOfContents</span><span class="operator">(</span><span class="number">1</span><span class="operator">);</span>
</pre>
</dd>
<dd>
<p>Default is false.</p>
</dd>
</li>
<dt><strong><a name="item_uniquelabels"><strong>UniqueLabels</strong></a></strong>

<dd>
<p>If true, the translator will attempt to make sure that
each <code>latex</code> label or index entry will be uniquely identified
by prefixing the contents of <a href="#item_label"><code>Label</code></a>. This allows
multiple documents to be combined without clashing 
common labels such as <code>DESCRIPTION</code> and <code>SYNOPSIS</code></p>
</dd>
<dd>
<pre>
  <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">UniqueLabels</span><span class="operator">(</span><span class="number">1</span><span class="operator">);</span>
  <span class="variable">$unq</span> <span class="operator">=</span> <span class="variable">$parser</span><span class="operator">-&gt;</span><span class="variable">UniqueLabels</span><span class="operator">;</span>
</pre>
</dd>
<dd>
<p>Default is true.</p>
</dd>
</li>
<dt><strong><a name="item_userpreamble"><strong>UserPreamble</strong></a></strong>

<dd>
<p>User supplied <code>latex</code> preamble. Added before the pod translation
data.</p>
</dd>
<dd>
<p>If set, the contents will be prepended to the output file before the translated 
data regardless of the value of <a href="#item_addpreamble"><code>AddPreamble</code></a>.
<a href="#item_makeindex"><code>MakeIndex</code></a> and <a href="#item_tableofcontents"><code>TableOfContents</code></a> will also be ignored.</p>
</dd>
</li>
<dt><strong><a name="item_userpostamble"><strong>UserPostamble</strong></a></strong>

<dd>
<p>User supplied <code>latex</code> postamble. Added after the pod translation
data.</p>
</dd>
<dd>
<p>If set, the contents will be prepended to the output file after the translated 
data regardless of the value of <a href="#item_addpostamble"><code>AddPostamble</code></a>.
<a href="#item_makeindex"><code>MakeIndex</code></a> will also be ignored.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p>Compatible with <code>latex2e</code> only. Can not be used with <code>latex</code> v2.09
or earlier.</p>
<p>A subclass of <code>Pod::Select</code> so that specific pod sections can be
converted to <code>latex</code> by using the <a href="../../lib/Pod/perlfunc.html#item_select"><code>select</code></a> method.</p>
<p>Some HTML escapes are missing and many have not been tested.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="../../lib/Pod/Parser.html">the Pod::Parser manpage</a>, <a href="../../lib/Pod/Select.html">the Pod::Select manpage</a>, <em>pod2latex</em></p>
<p>
</p>
<hr />
<h1><a name="authors">AUTHORS</a></h1>
<p>Tim Jenness &lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;</p>
<p>Bug fixes and improvements have been received from: Simon Cozens
&lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;, Mark A. Hershberger
&lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;, Marcel Grunauer
&lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;, Hugh S Myers
&lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;, Peter J Acklam
&lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;, Sudhi Herle &lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;,
Ariel Scolnicov &lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;,
Adriano Rodrigues Ferreira &lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt; and
R. de Vries &lt;<a href="mailto:[e-mail]">[e-mail]</a>&gt;.</p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright (C) 2000-2004 Tim Jenness. All Rights Reserved.</p>
<p>This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.</p>

</body>

</html>