python-plastex-doc 0.9.2-1 / usr / share / doc / python-plastex-doc / html / sec-inimacros.html

This file is indexed.

/usr/share/doc/python-plastex-doc/html/sec-inimacros.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
<!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: INI Files</title>

<link href="sec-contextmacros.html" title="The Document Context" rel="next" />
<link href="sec-macroclasses.html" title="Python Classes" rel="prev" />
<link href="sect0009.html" title="Defining Macros in Python" 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="sec-macroclasses.html" title="Python Classes"><img alt="Previous: Python Classes" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>

<td><a href="sect0009.html" title="Defining Macros in Python"><img alt="Up: Defining Macros in Python" border="0" src="icons/up.gif" width="32" height="32" /></a></td>

<td><a href="sec-contextmacros.html" title="The Document Context"><img alt="Next: The Document Context" 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="sec-macros.html">Understanding Macros and Packages</a> <b>:</b>
</span>

</span><span>
<span>
<a href="sect0009.html">Defining Macros in Python</a> <b>:</b>
</span>

</span><span>

<span>
<b class="current">INI Files</b>
</span>
</span>
<hr />
</div>

<div><h2 id="sec:inimacros">4.2.2 INI Files</h2>
<p>Using INI files is the simplest way of creating customized Python macro classes. It does require a little bit of knowledge of writing macros in Python classes (section <a href="sec-macroclasses.html">4.2.1</a>), but not much. The only two pieces of information about Python macro classes you need to know are 1) the <tt class="ttfamily">args</tt> string format, and 2) the superclass name (in most cases, you can simply use <tt class="ttfamily">Command</tt> or <tt class="ttfamily">Environment</tt>). The INI file features correspond to Python macros in the following way. <center><table cellspacing="0" class="tabular">
<tr>

    
    <td style="text-align:left; border-right:1px solid black"><p><b class="bf">INI File</b>&amp;<b class="bf">Python Macro Use</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> section name&amp;the Python class to inherit from</p></td>

</tr><tr>

    
    <td style="text-align:left; border-right:1px solid black"><p>option name&amp;the name of the macro to create</p></td>

</tr><tr>

    
    <td style="text-align:left; border-right:1px solid black"><p>option value&amp;the args string for the macro</p></td>

</tr>
</table></center> </p><p>Here is an example of an INI file that defines several macros. </p><pre>
[Command]
; \program{ self }
program=self
; \programopt{ self }
programopt=self

[Environment]
; \begin{methoddesc}[ classname ]{ name  { args } ... \end{methoddesc}
methoddesc=[ classname ] name args
; \begin{memberdesc}[ classname ]{ name  { args } ... \end{memberdesc}
memberdesc=[ classname ] name args

[section]
; \headi( options:dict )[ toc ]{ title }
headi=( options:dict ) [ toc ] title

[subsection]
; \headii( options:dict )[ toc ]{ title }
headii=( options:dict ) [ toc ] title
</pre><p>In the INI file above, six macro are being defined. \<tt class="ttfamily">program</tt> and \<tt class="ttfamily">programopt</tt> both inherit from <tt class="ttfamily">Command</tt>, the generic L<sup style="font-variant:small-caps; margin-left:-0.3em">a</sup>T<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X macro superclass. They also both take a single mandatory argument called “self.” There are two environments defined also: <tt class="ttfamily">methoddesc</tt> and <tt class="ttfamily">memberdesc</tt>. Each of these has three arguments where the first argument is optional. The last two macros actually inherit from standard L<sup style="font-variant:small-caps; margin-left:-0.3em">a</sup>T<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X sectioning commands. They add an option, surrounded by parentheses, to the options that \<tt class="ttfamily">section</tt> and \<tt class="ttfamily">subsection</tt> already had defined. </p><p>INI versions of plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X packages are loaded much in the same way as Python plasT<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X packages. For details on how packages are loaded, see section <a href="sec-packages.html">4.3</a>. </p></div>





<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="sec-macroclasses.html" title="Python Classes"><img alt="Previous: Python Classes" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>

<td><a href="sect0009.html" title="Defining Macros in Python"><img alt="Up: Defining Macros in Python" border="0" src="icons/up.gif" width="32" height="32" /></a></td>

<td><a href="sec-contextmacros.html" title="The Document Context"><img alt="Next: The Document Context" 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>

APT Browse - Built by Thomas Orozco.