Walter Dörwald avatar Walter Dörwald committed 4357b0a

Replace <arg> with <var>.

Comments (0)

Files changed (3)

docs/XIST_Advanced.xml

 
 <section><h>Conversion targets</h>
 
-<p>The <arg>converter</arg> argument passed to the <meth>convert</meth>
+<p>The <$1var>converter</arg> argument passed to the <meth>convert</meth>
 method has an attribute <lit>target</lit> which is a module or pool and
 specifies the target namespace to which <self/> should be converted.</p>
 
 </example>
 
 <p>The default target for conversion is <mod>ll.xist.ns.html</mod>.
-Other targets can be specified via the <arg>target</arg> argument in the
+Other targets can be specified via the <$1var>target</arg> argument in the
 <class>Converter</class> constructor or the <meth>conv</meth> method:</p>
 
 <tty>

docs/XIST_Howto.xml

 <prog>
 __init__(self, *content, **attrs)
 </prog>
-<p>Positional arguments (i.e. items in <arg>content</arg>)
+<p>Positional arguments (i.e. items in <var>content</var>)
 will be the child nodes of the element node. Keyword arguments will be attributes.
 You can pass most of Python's builtin types to such a constructor.
 Strings (<class>str</class> and <class>unicode</class>) and integers
 provides several functions:</p>
 <dl>
 <dt><lit>parsestring(data, base=None, encoding=None, **builderargs)</lit></dt>
-<dd>Parse the string <arg>data</arg> into an &xist; tree.</dd>
+<dd>Parse the string <var>data</var> into an &xist; tree.</dd>
 <dt><lit>parseiter(iterable, base=None, encoding=None, **builderargs)</lit></dt>
-<dd>Parse the input from the iterable <arg>iterable</arg> (which must produce the
+<dd>Parse the input from the iterable <var>iterable</var> (which must produce the
 input in chunks of bytes) into an &xist; tree.</dd>
 <dt><lit>parsestream(stream, base=None, encoding=None, bufsize=8192, **builderargs)</lit></dt>
-<dd>Parse &xml; from the stream <arg>stream</arg> into an &xist; tree.</dd>
+<dd>Parse &xml; from the stream <var>stream</var> into an &xist; tree.</dd>
 <dt><lit>parsefile(filename, base=None, encoding=None, bufsize=8192, **builderargs)</lit></dt>
-<dd>Parse &xml; input from the file named <arg>filename</arg>.</dd>
+<dd>Parse &xml; input from the file named <var>filename</var>.</dd>
 <dt><lit>parseurl(name, base=None, encoding=None, bufsize=8192, headers=None, data=None, **builderargs)</lit></dt>
-<dd>Parse &xml; input from the &url; <arg>name</arg> into an &xist; tree.</dd>
+<dd>Parse &xml; input from the &url; <var>name</var> into an &xist; tree.</dd>
 <dt><lit>parseetree(tree, base=None, **builderargs)</lit></dt>
-<dd>Parse &xml; input from the object <arg>tree</arg> which must support the
+<dd>Parse &xml; input from the object <var>tree</var> which must support the
 <a href="http://effbot.org/zone/element-index.htm">ElementTree</a> &api;.</dd>
 </dl>
 <p>For example, parsing a string can be done like this:</p>
 <p><pyref module="ll.xist.xsc" class="Node" method="conv"><meth>conv</meth></pyref> simply
 calls
 <pyref module="ll.xist.xsc" class="Node" method="convert"><meth>convert</meth></pyref>
-with a default <pyref module="ll.xist.converters" class="Converter"><arg>converter</arg></pyref>
+with a default <pyref module="ll.xist.converters" class="Converter"><var>converter</var></pyref>
 argument. We'll come to converters in a minute.
 <pyref module="ll.xist.xsc" class="Node" method="bytes"><meth>bytes</meth></pyref>
 is a method that converts the node to a byte string. This method will be explained
 <p>You can pass the following arguments to the
 <pyref module="ll.xist.converters" class="Converter"><class>Converter</class></pyref> constructor:</p>
 <dl>
-<dt><arg>root</arg></dt><dd><arg>root</arg> (which defaults to <lit>None</lit>) is the root &url;
+<dt><var>root</var></dt><dd><var>root</var> (which defaults to <lit>None</lit>) is the root &url;
 for the conversion process. When you want to resolve a link in some of your own <meth>convert</meth> methods,
 the &url; must be interpreted relative to this root &url; (You can use
 <pyref module="ll.xist.xsc" class="URLAttr" method="forInput"><meth>URLAttr.forInput</meth></pyref>
 for that).</dd>
-<dt><arg>mode</arg></dt><dd><arg>mode</arg> (which defaults to <lit>None</lit>) works the same way
+<dt><var>mode</var></dt><dd><var>mode</var> (which defaults to <lit>None</lit>) works the same way
 as modes in &xslt;. You can use this for implementing different conversion modes.</dd>
-<dt><arg>stage</arg></dt><dd><arg>stage</arg> (which defaults to <lit>"deliver"</lit>)
+<dt><var>stage</var></dt><dd><var>stage</var> (which defaults to <lit>"deliver"</lit>)
 allows you to implement multi stage conversion: Suppose that you want to deliver a dynamically
 constructed web page with &xist; that contains results from a database query and the current time.
 The data in the database changes infrequently, so it doesn't make sense to do the query on
 every request. The query is done every few minutes and the resulting &html; tree is
 stored in the servlet (using any of the available Python servlet technologies).
-For this conversion the <arg>stage</arg> would be <lit>"cache"</lit> and your database &xml;
-element would do the query when <lit><arg>stage</arg>=="cache"</lit>. Your time display element
-would do the conversion when <lit><arg>stage</arg>=="deliver"</lit> and simply returns itself
-when <lit><arg>stage</arg>=="cache"</lit>, so it would still be part of the cached &xml; tree
+For this conversion the <var>stage</var> would be <lit>"cache"</lit> and your database &xml;
+element would do the query when <lit><var>stage</var>=="cache"</lit>. Your time display element
+would do the conversion when <lit><var>stage</var>=="deliver"</lit> and simply returns itself
+when <lit><var>stage</var>=="cache"</lit>, so it would still be part of the cached &xml; tree
 and would be converted to &html; on every request.</dd>
-<dt><arg>target</arg></dt><dd><arg>target</arg> (which defaults to
+<dt><var>target</var></dt><dd><var>target</var> (which defaults to
 <pyref module="ll.xist.ns.html"><mod>ll.xist.ns.html</mod></pyref>) specifies what the output should be.
 Values must be <pyref module="ll.xist.xsc" class="Namespace">namespace subclasses</pyref>
 (see below for an explanation of namespaces).</dd>
-<dt><arg>lang</arg></dt><dd><p><arg>lang</arg> (which defaults to <lit>None</lit>) is the language
+<dt><var>lang</var></dt><dd><p><var>lang</var> (which defaults to <lit>None</lit>) is the language
 in which the result tree should be. This can be used in the <meth>convert</meth> method
 to implement different conversions for different languages, e.g.:</p>
 <prog>
 an instance of <pyref module="ll.xist.publishers" class="Publisher"><class>ll.xist.publisher.Publisher</class></pyref>.</p>
 
 <section><h>Specifying an encoding</h>
-<p>You can specify the encoding with the parameter <arg>encoding</arg>
+<p>You can specify the encoding with the parameter <var>encoding</var>
 (with the encoding specified in an &xml; declaration being the default, if there
 is no such declaration <lit>"utf-8"</lit> is used). Unencodable characters will
 be escaped with character references when possible (i.e. inside text nodes, for
 </section>
 
 <section><h>&html; compatibility</h>
-<p>Another useful parameter is <arg>xhtml</arg>,
+<p>Another useful parameter is <var>xhtml</var>,
 it specifies whether you want pure &html; or &xhtml; as output:</p>
 
 <dl>
 <section><h>Namespaces</h>
 
 <p>By default &xist; doesn't output any namespace declarations. The simplest
-way to change that, is to pass <lit>True</lit> for the <arg>prefixdefault</arg>
+way to change that, is to pass <lit>True</lit> for the <var>prefixdefault</var>
 argument when publishing:</p>
 
 <example><h>Publishing namespace info</h>
 </html>]]></prog>
 
 <p>When elements from more than one namespace are present in the tree,
-<arg>prefixdefault</arg> is unreliable. The first namespace encountered will
-get the prefix specified by <arg>prefixdefault</arg>, all others will get a
+<var>prefixdefault</var> is unreliable. The first namespace encountered will
+get the prefix specified by <var>prefixdefault</var>, all others will get a
 different prefix. &xist; will never use the same prefix for different namespaces.
 &xist; will also refuse to use an empty prefix for global attributes:</p>
 
 </html>]]>
 </prog>
 
-<p>In the case of multiple namespaces you can use the <arg>prefixes</arg>
+<p>In the case of multiple namespaces you can use the <var>prefixes</var>
 argument to specify an explicit prefix for each namespace. So we could change
 the publishing statement from our example above to:</p>
 
 </prog>
 
 <p>Finally it's possible to suppress output of namespace declarations
-for certain namespaces by using the <arg>hidexmlns</arg> attribute:</p>
+for certain namespaces by using the <var>hidexmlns</var> attribute:</p>
 </section>
 
 <prog>

docs/XIST_Misc.xml

 reverted for publishing. In most cases the base &url; should be a
 <lit>root</lit> &url; when you parse local files.</li>
 <li>When you parse remote web pages you can either
-omit the <arg>base</arg> argument, so it will default to the
+omit the <$1var>base</arg> argument, so it will default to the
 &url; being parsing, so that links, images, etc. on the page
 will still point back to their original location, or you
 might want to use the empty &url; <lit>URL()</lit> as the
 for a <pyref module="ll.xist.ns.code" class="pyeval"><lit>pyeval</lit></pyref> processing instruction is whatever the
 Python code in the content returns. The processing instruction content is treated as the body
 of a function, so you can put multiple return statements there.
-The converter is available as the parameter <arg>converter</arg> inside
+The converter is available as the parameter <$1var>converter</arg> inside
 the processing instruction. For example, consider the following &xml; file:</p>
 
 <prog>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.