+Fri Jun 13 16:53:33 CEST 2003 Daniel Veillard <daniel@veillard.com>
+
+ * libxslt.spec.in libexslt/Makefile.am libexslt/libexslt.3
+ libxslt/Makefile.am libxslt/libxslt.3: Moved the man pages
+ to section 3
+ * libexslt/sets.c: applied patch from Peter Breitenlohner
+ * doc/*: rebuilt the docs
+ * tests/docbook/result//* tests/xmlspec/*.html: changes in
+ generattion of " as " in element content.
+
Sun Jun 08 22:57:13 CEST 2003 Igor Zlatkovic <igor@zlatkovic.com>
* libxslt/transform.c: changed xsltChoose to ignore whitespace
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Gnome XSLT Library Reference Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><meta name="description" content="This manual documents the interfaces of the libxslt
library and has some short notes to help get you up to speed
with using the library."><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
<ANCHOR id="xsltParseTemplateContent" href="libxslt/libxslt-xsltInternals.html#xsltParseTemplateContent">
<ANCHOR id="xsltAllocateExtra" href="libxslt/libxslt-xsltInternals.html#xsltAllocateExtra">
<ANCHOR id="xsltAllocateExtraCtxt" href="libxslt/libxslt-xsltInternals.html#xsltAllocateExtraCtxt">
+<ANCHOR id="xsltCreateRVT" href="libxslt/libxslt-xsltInternals.html#xsltCreateRVT">
+<ANCHOR id="xsltRegisterTmpRVT" href="libxslt/libxslt-xsltInternals.html#xsltRegisterTmpRVT">
+<ANCHOR id="xsltRegisterPersistRVT" href="libxslt/libxslt-xsltInternals.html#xsltRegisterPersistRVT">
+<ANCHOR id="xsltFreeRVTs" href="libxslt/libxslt-xsltInternals.html#xsltFreeRVTs">
<ANCHOR id="xsltNumberData" href="libxslt/libxslt-numbersInternals.html#xsltNumberData">
<ANCHOR id="xsltNumberDataPtr" href="libxslt/libxslt-numbersInternals.html#xsltNumberDataPtr">
<ANCHOR id="xsltFormatNumberInfo" href="libxslt/libxslt-numbersInternals.html#xsltFormatNumberInfo">
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>attributes</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>extensions</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>functions</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>imports</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>keys</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Libxslt Library Reference</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>namespaces</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Libxslt Programming Notes</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>numbersInternals</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
+++ /dev/null
-<HTML
-><HEAD
-><TITLE
->numbersInternals</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
-REL="HOME"
-TITLE="Gnome XSLT Library Reference Manual"
-HREF="book1.html"><LINK
-REL="UP"
-TITLE="Libxslt Library Reference"
-HREF="libxslt-lib.html"><LINK
-REL="PREVIOUS"
-TITLE="xsltInternals"
-HREF="libxslt-xsltinternals.html"></HEAD
-><BODY
-CLASS="REFENTRY"
-BGCOLOR="#FFFFFF"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-WIDTH="100%"
-BORDER="0"
-BGCOLOR="#000000"
-CELLPADDING="1"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="4"
-ALIGN="center"
-><FONT
-COLOR="#FFFFFF"
-SIZE="5"
->Gnome XSLT Library Reference Manual</FONT
-></TH
-></TR
-><TR
-><TD
-WIDTH="25%"
-BGCOLOR="#C00000"
-ALIGN="left"
-><A
-HREF="libxslt-xsltinternals.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><<< Previous Page</B
-></FONT
-></A
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#0000C0"
-ALIGN="center"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><A
-HREF="book1.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
->Home</B
-></FONT
-></A
-></B
-></FONT
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#00C000"
-ALIGN="center"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><A
-HREF="libxslt-lib.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
->Up</B
-></FONT
-></A
-></B
-></FONT
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#C00000"
-ALIGN="right"
-> </TD
-></TR
-></TABLE
-></DIV
-><H1
-><A
-NAME="LIBXSLT-NUMBERSINTERNALS"
-></A
->numbersInternals</H1
-><DIV
-CLASS="REFNAMEDIV"
-><A
-NAME="AEN6039"
-></A
-><H2
->Name</H2
->numbersInternals -- </DIV
-><DIV
-CLASS="REFSYNOPSISDIV"
-><A
-NAME="AEN6042"
-></A
-><H2
->Synopsis</H2
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="SYNOPSIS"
->
-
-struct <A
-HREF="libxslt-numbersinternals.html#XSLTNUMBERDATA"
->xsltNumberData</A
->;
-typedef <A
-HREF="libxslt-numbersinternals.html#XSLTNUMBERDATAPTR"
->xsltNumberDataPtr</A
->;
-struct <A
-HREF="libxslt-numbersinternals.html#XSLTFORMATNUMBERINFO"
->xsltFormatNumberInfo</A
->;
-typedef <A
-HREF="libxslt-numbersinternals.html#XSLTFORMATNUMBERINFOPTR"
->xsltFormatNumberInfoPtr</A
->;</PRE
-></TD
-></TR
-></TABLE
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN6049"
-></A
-><H2
->Description</H2
-><P
-></P
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN6052"
-></A
-><H2
->Details</H2
-><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN6054"
-></A
-><H3
-><A
-NAME="XSLTNUMBERDATA"
-></A
->struct xsltNumberData</H3
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
->struct xsltNumberData {
- xmlChar *level;
- xmlChar *count;
- xmlChar *from;
- xmlChar *value;
- xmlChar *format;
- int has_format;
- int digitsPerGroup;
- int groupingCharacter;
- int groupingCharacterLen;
- xmlDocPtr doc;
- xmlNodePtr node;
-};</PRE
-></TD
-></TR
-></TABLE
-><P
->This data structure is just a wrapper to pass xsl:number data in.</P
-><P
-></P
-></DIV
-><HR><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN6060"
-></A
-><H3
-><A
-NAME="XSLTNUMBERDATAPTR"
-></A
->xsltNumberDataPtr</H3
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
->typedef xsltNumberData *xsltNumberDataPtr;</PRE
-></TD
-></TR
-></TABLE
-><P
-></P
-></DIV
-><HR><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN6065"
-></A
-><H3
-><A
-NAME="XSLTFORMATNUMBERINFO"
-></A
->struct xsltFormatNumberInfo</H3
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
->struct xsltFormatNumberInfo {
- int integer_hash; /* Number of '#' in integer part */
- int integer_digits; /* Number of '0' in integer part */
- int frac_digits; /* Number of '0' in fractional part */
- int frac_hash; /* Number of '#' in fractional part */
- int group; /* Number of chars per display 'group' */
- int multiplier; /* Scaling for percent or permille */
- char add_decimal; /* Flag for whether decimal point appears in pattern */
- char is_multiplier_set; /* Flag to catch multiple occurences of percent/permille */
- char is_negative_pattern;/* Flag for processing -ve prefix/suffix */
-};</PRE
-></TD
-></TR
-></TABLE
-><P
->This data structure lists the various parameters needed to format numbers.</P
-><P
-></P
-></DIV
-><HR><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN6071"
-></A
-><H3
-><A
-NAME="XSLTFORMATNUMBERINFOPTR"
-></A
->xsltFormatNumberInfoPtr</H3
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
->typedef xsltFormatNumberInfo *xsltFormatNumberInfoPtr;</PRE
-></TD
-></TR
-></TABLE
-><P
-></P
-></DIV
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><BR
-CLEAR="all"><BR><TABLE
-WIDTH="100%"
-BORDER="0"
-BGCOLOR="#000000"
-CELLPADDING="1"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="25%"
-BGCOLOR="#C00000"
-ALIGN="left"
-><A
-HREF="libxslt-xsltinternals.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><<< Previous Page</B
-></FONT
-></A
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#0000C0"
-ALIGN="center"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><A
-HREF="book1.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
->Home</B
-></FONT
-></A
-></B
-></FONT
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#00C000"
-ALIGN="center"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
-><A
-HREF="libxslt-lib.html"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
->Up</B
-></FONT
-></A
-></B
-></FONT
-></TD
-><TD
-WIDTH="25%"
-BGCOLOR="#C00000"
-ALIGN="right"
-> </TD
-></TR
-><TR
-><TD
-COLSPAN="2"
-ALIGN="left"
-><FONT
-COLOR="#FFFFFF"
-SIZE="3"
-><B
->xsltInternals</B
-></FONT
-></TD
-><TD
-COLSPAN="2"
-ALIGN="right"
-> </TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->
\ No newline at end of file
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>pattern</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>templates</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>transform</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>variables</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xslt</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xsltInternals</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlNodePtr">xmlNodePtr</GTKDOCLINK> templ);
int <a href="libxslt-xsltInternals.html#xsltAllocateExtra">xsltAllocateExtra</a> (<a href="libxslt-xsltInternals.html#xsltStylesheetPtr">xsltStylesheetPtr</a> style);
int <a href="libxslt-xsltInternals.html#xsltAllocateExtraCtxt">xsltAllocateExtraCtxt</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt);
+<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> <a href="libxslt-xsltInternals.html#xsltCreateRVT">xsltCreateRVT</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt);
+int <a href="libxslt-xsltInternals.html#xsltRegisterTmpRVT">xsltRegisterTmpRVT</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt,
+ <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> RVT);
+int <a href="libxslt-xsltInternals.html#xsltRegisterPersistRVT">xsltRegisterPersistRVT</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt,
+ <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> RVT);
+void <a href="libxslt-xsltInternals.html#xsltFreeRVTs">xsltFreeRVTs</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt);
</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="XSLT-MAX-SORT-CAPS"></a>XSLT_MAX_SORT</h3><pre class="programlisting">#define XSLT_MAX_SORT 15
void * errctx; /* context for the error handler */
xsltSortFunc sortfunc; /* a ctxt specific sort routine */
+
+ /*
+ * handling of temporary Result Value Tree
+ */
+ xmlDocPtr tmpRVT; /* list of RVT without persistance */
+ xmlDocPtr persistRVT; /* list of persistant RVTs */
+ int ctxtflags; /* context processing flags */
};
</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XSLT transformation context
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of the slot
+</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xsltCreateRVT"></a>xsltCreateRVT ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> xsltCreateRVT (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt);</pre><p>
+Create a result value tree</p><p>
+
+</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XSLT transformation context
+</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the result value tree or NULL in case of error
+</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xsltRegisterTmpRVT"></a>xsltRegisterTmpRVT ()</h3><pre class="programlisting">int xsltRegisterTmpRVT (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt,
+ <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> RVT);</pre><p>
+Register the result value tree for destruction at the end of the context</p><p>
+
+</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XSLT transformation context
+</td></tr><tr><td><span class="term"><i><tt>RVT</tt></i> :</span></td><td> a result value tree
+</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success and -1 in case of error.
+</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xsltRegisterPersistRVT"></a>xsltRegisterPersistRVT ()</h3><pre class="programlisting">int xsltRegisterPersistRVT (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt,
+ <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xmlDocPtr">xmlDocPtr</GTKDOCLINK> RVT);</pre><p>
+Register the result value tree for destruction at the end of the processing</p><p>
+
+</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XSLT transformation context
+</td></tr><tr><td><span class="term"><i><tt>RVT</tt></i> :</span></td><td> a result value tree
+</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success and -1 in case of error.
+</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xsltFreeRVTs"></a>xsltFreeRVTs ()</h3><pre class="programlisting">void xsltFreeRVTs (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt);</pre><p>
+Free all the registered result value tree of the transformation</p><p>
+
+</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XSLT transformation context
</td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxslt-keys.html"><b><< keys</b></a></td><td align="right"><a accesskey="n" href="libxslt-numbersInternals.html"><b>numbersInternals >></b></a></td></tr></table></body></html>
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xsltutils</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
<?xml version="1.0" encoding="ISO-8859-1"?>
<api name='libxslt'>
<files>
- <file name='extra'>
- <exports symbol='XSLT_LIBXSLT_NAMESPACE'/>
- <exports symbol='XSLT_NORM_SAXON_NAMESPACE'/>
- <exports symbol='XSLT_SAXON_NAMESPACE'/>
- <exports symbol='XSLT_XALAN_NAMESPACE'/>
- <exports symbol='XSLT_XT_NAMESPACE'/>
- <exports symbol='xsltDebug'/>
- <exports symbol='xsltFunctionNodeSet'/>
- <exports symbol='xsltRegisterAllExtras'/>
- <exports symbol='xsltRegisterExtras'/>
+ <file name='documents'>
+ <exports symbol='xsltFindDocument'/>
+ <exports symbol='xsltFreeDocuments'/>
+ <exports symbol='xsltFreeStyleDocuments'/>
+ <exports symbol='xsltLoadDocument'/>
+ <exports symbol='xsltLoadStyleDocument'/>
+ <exports symbol='xsltNewDocument'/>
+ <exports symbol='xsltNewStyleDocument'/>
</file>
<file name='imports'>
<exports symbol='XSLT_GET_IMPORT_INT'/>
<exports symbol='xsltParseStylesheetImport'/>
<exports symbol='xsltParseStylesheetInclude'/>
</file>
- <file name='preproc'>
- <exports symbol='xsltDocumentComp'/>
- <exports symbol='xsltExtMarker'/>
- <exports symbol='xsltFreeStylePreComps'/>
- <exports symbol='xsltStylePreCompute'/>
+ <file name='security'>
+ <exports symbol='XSLT_SECPREF_CREATE_DIRECTORY'/>
+ <exports symbol='XSLT_SECPREF_READ_FILE'/>
+ <exports symbol='XSLT_SECPREF_READ_NETWORK'/>
+ <exports symbol='XSLT_SECPREF_WRITE_FILE'/>
+ <exports symbol='XSLT_SECPREF_WRITE_NETWORK'/>
+ <exports symbol='xsltCheckRead'/>
+ <exports symbol='xsltCheckWrite'/>
+ <exports symbol='xsltFreeSecurityPrefs'/>
+ <exports symbol='xsltGetDefaultSecurityPrefs'/>
+ <exports symbol='xsltGetSecurityPrefs'/>
+ <exports symbol='xsltNewSecurityPrefs'/>
+ <exports symbol='xsltSecurityAllow'/>
+ <exports symbol='xsltSecurityCheck'/>
+ <exports symbol='xsltSecurityForbid'/>
+ <exports symbol='xsltSecurityOption'/>
+ <exports symbol='xsltSecurityPrefs'/>
+ <exports symbol='xsltSecurityPrefsPtr'/>
+ <exports symbol='xsltSetCtxtSecurityPrefs'/>
+ <exports symbol='xsltSetDefaultSecurityPrefs'/>
+ <exports symbol='xsltSetSecurityPrefs'/>
+ </file>
+ <file name='templates'>
+ <exports symbol='xsltAttrListTemplateProcess'/>
+ <exports symbol='xsltAttrTemplateProcess'/>
+ <exports symbol='xsltAttrTemplateValueProcess'/>
+ <exports symbol='xsltAttrTemplateValueProcessNode'/>
+ <exports symbol='xsltEvalAttrValueTemplate'/>
+ <exports symbol='xsltEvalStaticAttrValueTemplate'/>
+ <exports symbol='xsltEvalTemplateString'/>
+ <exports symbol='xsltEvalXPathPredicate'/>
+ <exports symbol='xsltEvalXPathString'/>
+ <exports symbol='xsltEvalXPathStringNs'/>
+ <exports symbol='xsltTemplateProcess'/>
</file>
<file name='xsltutils'>
<exports symbol='IS_XSLT_ELEM'/>
<exports symbol='xsltUnparsedEntityURIFunction'/>
<exports symbol='xsltXPathFunctionLookup'/>
</file>
- <file name='security'>
- <exports symbol='XSLT_SECPREF_CREATE_DIRECTORY'/>
- <exports symbol='XSLT_SECPREF_READ_FILE'/>
- <exports symbol='XSLT_SECPREF_READ_NETWORK'/>
- <exports symbol='XSLT_SECPREF_WRITE_FILE'/>
- <exports symbol='XSLT_SECPREF_WRITE_NETWORK'/>
- <exports symbol='xsltCheckRead'/>
- <exports symbol='xsltCheckWrite'/>
- <exports symbol='xsltFreeSecurityPrefs'/>
- <exports symbol='xsltGetDefaultSecurityPrefs'/>
- <exports symbol='xsltGetSecurityPrefs'/>
- <exports symbol='xsltNewSecurityPrefs'/>
- <exports symbol='xsltSecurityAllow'/>
- <exports symbol='xsltSecurityCheck'/>
- <exports symbol='xsltSecurityForbid'/>
- <exports symbol='xsltSecurityOption'/>
- <exports symbol='xsltSecurityPrefs'/>
- <exports symbol='xsltSecurityPrefsPtr'/>
- <exports symbol='xsltSetCtxtSecurityPrefs'/>
- <exports symbol='xsltSetDefaultSecurityPrefs'/>
- <exports symbol='xsltSetSecurityPrefs'/>
- </file>
- <file name='templates'>
- <exports symbol='xsltAttrListTemplateProcess'/>
- <exports symbol='xsltAttrTemplateProcess'/>
- <exports symbol='xsltAttrTemplateValueProcess'/>
- <exports symbol='xsltAttrTemplateValueProcessNode'/>
- <exports symbol='xsltEvalAttrValueTemplate'/>
- <exports symbol='xsltEvalStaticAttrValueTemplate'/>
- <exports symbol='xsltEvalTemplateString'/>
- <exports symbol='xsltEvalXPathPredicate'/>
- <exports symbol='xsltEvalXPathString'/>
- <exports symbol='xsltEvalXPathStringNs'/>
- <exports symbol='xsltTemplateProcess'/>
+ <file name='namespaces'>
+ <exports symbol='xsltCopyNamespace'/>
+ <exports symbol='xsltCopyNamespaceList'/>
+ <exports symbol='xsltFreeNamespaceAliasHashes'/>
+ <exports symbol='xsltGetNamespace'/>
+ <exports symbol='xsltGetSpecialNamespace'/>
+ <exports symbol='xsltNamespaceAlias'/>
</file>
- <file name='documents'>
- <exports symbol='xsltFindDocument'/>
- <exports symbol='xsltFreeDocuments'/>
- <exports symbol='xsltFreeStyleDocuments'/>
- <exports symbol='xsltLoadDocument'/>
- <exports symbol='xsltLoadStyleDocument'/>
- <exports symbol='xsltNewDocument'/>
- <exports symbol='xsltNewStyleDocument'/>
+ <file name='extra'>
+ <exports symbol='XSLT_LIBXSLT_NAMESPACE'/>
+ <exports symbol='XSLT_NORM_SAXON_NAMESPACE'/>
+ <exports symbol='XSLT_SAXON_NAMESPACE'/>
+ <exports symbol='XSLT_XALAN_NAMESPACE'/>
+ <exports symbol='XSLT_XT_NAMESPACE'/>
+ <exports symbol='xsltDebug'/>
+ <exports symbol='xsltFunctionNodeSet'/>
+ <exports symbol='xsltRegisterAllExtras'/>
+ <exports symbol='xsltRegisterExtras'/>
</file>
<file name='xsltInternals'>
<exports symbol='CHECK_STOPPED'/>
<exports symbol='xsltLibxsltVersion'/>
<exports symbol='xsltMaxDepth'/>
</file>
- <file name='namespaces'>
- <exports symbol='xsltCopyNamespace'/>
- <exports symbol='xsltCopyNamespaceList'/>
- <exports symbol='xsltFreeNamespaceAliasHashes'/>
- <exports symbol='xsltGetNamespace'/>
- <exports symbol='xsltGetSpecialNamespace'/>
- <exports symbol='xsltNamespaceAlias'/>
+ <file name='preproc'>
+ <exports symbol='xsltDocumentComp'/>
+ <exports symbol='xsltExtMarker'/>
+ <exports symbol='xsltFreeStylePreComps'/>
+ <exports symbol='xsltStylePreCompute'/>
</file>
<file name='variables'>
<exports symbol='XSLT_REGISTER_VARIABLE_LOOKUP'/>
*'/>
<field name='tmpRVT' type='xmlDocPtr' info=' list of RVT without persistance'/>
<field name='persistRVT' type='xmlDocPtr' info=' list of persistant RVTs'/>
+ <field name='ctxtflags' type='int' info=' context processing flags'/>
</struct>
<typedef name='xsltTransformContextPtr' file='xsltInternals' type='xsltTransformContext *'/>
<typedef name='xsltTransformState' file='xsltInternals' type='enum'/>
<MACRO>
<NAME>LIBXSLT_DOTTED_VERSION</NAME>
-#define LIBXSLT_DOTTED_VERSION "1.0.29"
+#define LIBXSLT_DOTTED_VERSION "1.0.30"
</MACRO>
<MACRO>
<NAME>LIBXSLT_VERSION</NAME>
-#define LIBXSLT_VERSION 10029
+#define LIBXSLT_VERSION 10030
</MACRO>
<MACRO>
<NAME>LIBXSLT_VERSION_STRING</NAME>
-#define LIBXSLT_VERSION_STRING "10029"
+#define LIBXSLT_VERSION_STRING "10030"
</MACRO>
<MACRO>
<NAME>WITH_XSLT_DEBUG</NAME>
</FUNCTION>
<MACRO>
<NAME>LIBXSLT_DOTTED_VERSION</NAME>
-#define LIBXSLT_DOTTED_VERSION "1.0.29"
+#define LIBXSLT_DOTTED_VERSION "1.0.30"
</MACRO>
<MACRO>
<NAME>LIBXSLT_VERSION</NAME>
-#define LIBXSLT_VERSION 10029
+#define LIBXSLT_VERSION 10030
</MACRO>
<MACRO>
<NAME>LIBXSLT_VERSION_STRING</NAME>
-#define LIBXSLT_VERSION_STRING "10029"
+#define LIBXSLT_VERSION_STRING "10030"
</MACRO>
<MACRO>
<NAME>WITH_XSLT_DEBUG</NAME>
#define vdscanf trio_vdscanf
</MACRO>
<MACRO>
-<NAME>TRIO_COMPILER_GCC</NAME>
-# define TRIO_COMPILER_GCC
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUNPRO</NAME>
-# define TRIO_COMPILER_SUNPRO
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUNPRO</NAME>
-# define TRIO_COMPILER_SUNPRO
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_XLC</NAME>
-# define TRIO_COMPILER_XLC
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_XLC</NAME>
-# define TRIO_COMPILER_XLC /* Workaround for old xlc */
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_DECC</NAME>
-# define TRIO_COMPILER_DECC
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_DECC</NAME>
-# define TRIO_COMPILER_DECC /* Workaround for old DEC C compilers */
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_MSVC</NAME>
-# define TRIO_COMPILER_MSVC
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_BCB</NAME>
-# define TRIO_COMPILER_BCB
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_VMS</NAME>
-# define TRIO_PLATFORM_VMS
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_QNX</NAME>
-# define TRIO_PLATFORM_QNX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_UNIX</NAME>
-# define TRIO_PLATFORM_UNIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_WIN32</NAME>
-# define TRIO_PLATFORM_WIN32
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_MPEIX</NAME>
-# define TRIO_PLATFORM_MPEIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_AIX</NAME>
-# define TRIO_PLATFORM_AIX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_HPUX</NAME>
-# define TRIO_PLATFORM_HPUX
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_SOLARIS</NAME>
-# define TRIO_PLATFORM_SOLARIS
-</MACRO>
-<MACRO>
-<NAME>TRIO_PLATFORM_SUNOS</NAME>
-# define TRIO_PLATFORM_SUNOS
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_C89</NAME>
-# define TRIO_COMPILER_SUPPORTS_C89
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_C90</NAME>
-# define TRIO_COMPILER_SUPPORTS_C90
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_C94</NAME>
-# define TRIO_COMPILER_SUPPORTS_C94
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_C99</NAME>
-# define TRIO_COMPILER_SUPPORTS_C99
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_C94</NAME>
-# define TRIO_COMPILER_SUPPORTS_C94
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_UNIX95</NAME>
-# define TRIO_COMPILER_SUPPORTS_UNIX95
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_UNIX98</NAME>
-# define TRIO_COMPILER_SUPPORTS_UNIX98
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_UNIX01</NAME>
-# define TRIO_COMPILER_SUPPORTS_UNIX01
-</MACRO>
-<MACRO>
-<NAME>TRIO_PUBLIC</NAME>
-# define TRIO_PUBLIC
-</MACRO>
-<MACRO>
-<NAME>TRIO_PRIVATE</NAME>
-# define TRIO_PRIVATE static
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_ANCIENT</NAME>
-# define TRIO_COMPILER_ANCIENT
-</MACRO>
-<MACRO>
-<NAME>TRIO_CONST</NAME>
-# define TRIO_CONST
-</MACRO>
-<MACRO>
-<NAME>TRIO_VOLATILE</NAME>
-# define TRIO_VOLATILE
+<NAME>XSLT_MAX_SORT</NAME>
+#define XSLT_MAX_SORT 15
</MACRO>
<MACRO>
-<NAME>TRIO_SIGNED</NAME>
-# define TRIO_SIGNED
+<NAME>XSLT_PAT_NO_PRIORITY</NAME>
+#define XSLT_PAT_NO_PRIORITY -12345789
</MACRO>
+<STRUCT>
+<NAME>xsltRuntimeExtra</NAME>
+</STRUCT>
<TYPEDEF>
-<NAME>trio_long_double_t</NAME>
-typedef double trio_long_double_t;
-</TYPEDEF>
-<TYPEDEF>
-<NAME>trio_pointer_t</NAME>
-typedef char * trio_pointer_t;
+<NAME>xsltRuntimeExtraPtr</NAME>
+typedef xsltRuntimeExtra *xsltRuntimeExtraPtr;
</TYPEDEF>
+<STRUCT>
+<NAME>xsltRuntimeExtra</NAME>
+struct xsltRuntimeExtra {
+ void *info; /* pointer to the extra data */
+ xmlFreeFunc deallocate; /* pointer to the deallocation routine */
+ void *val; /* data not needing deallocation */
+};
+</STRUCT>
<MACRO>
-<NAME>TRIO_SUFFIX_LONG</NAME>
-# define TRIO_SUFFIX_LONG(x) x
-</MACRO>
-<MACRO>
-<NAME>TRIO_PROTO</NAME>
-# define TRIO_PROTO(x) ()
-</MACRO>
-<MACRO>
-<NAME>TRIO_NOARGS</NAME>
-# define TRIO_NOARGS
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS1</NAME>
-# define TRIO_ARGS1(list,a1) list a1;
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS2</NAME>
-# define TRIO_ARGS2(list,a1,a2) list a1; a2;
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS3</NAME>
-# define TRIO_ARGS3(list,a1,a2,a3) list a1; a2; a3;
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS4</NAME>
-# define TRIO_ARGS4(list,a1,a2,a3,a4) list a1; a2; a3; a4;
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS5</NAME>
-# define TRIO_ARGS5(list,a1,a2,a3,a4,a5) list a1; a2; a3; a4; a5;
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS6</NAME>
-# define TRIO_ARGS6(list,a1,a2,a3,a4,a5,a6) list a1; a2; a3; a4; a5; a6;
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS2</NAME>
-# define TRIO_VARGS2(list,a1,a2) list a1; a2
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS3</NAME>
-# define TRIO_VARGS3(list,a1,a2,a3) list a1; a2; a3
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS4</NAME>
-# define TRIO_VARGS4(list,a1,a2,a3,a4) list a1; a2; a3; a4
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS5</NAME>
-# define TRIO_VARGS5(list,a1,a2,a3,a4,a5) list a1; a2; a3; a4; a5
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_DECL</NAME>
-# define TRIO_VA_DECL va_dcl
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_START</NAME>
-# define TRIO_VA_START(x,y) va_start(x)
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_END</NAME>
-# define TRIO_VA_END(x) va_end(x)
-</MACRO>
-<MACRO>
-<NAME>TRIO_CONST</NAME>
-# define TRIO_CONST const
+<NAME>XSLT_RUNTIME_EXTRA_LST</NAME>
+#define XSLT_RUNTIME_EXTRA_LST(ctxt, nr) (ctxt)->extras[(nr)].info
</MACRO>
<MACRO>
-<NAME>TRIO_VOLATILE</NAME>
-# define TRIO_VOLATILE volatile
+<NAME>XSLT_RUNTIME_EXTRA_FREE</NAME>
+#define XSLT_RUNTIME_EXTRA_FREE(ctxt, nr) (ctxt)->extras[(nr)].deallocate
</MACRO>
<MACRO>
-<NAME>TRIO_SIGNED</NAME>
-# define TRIO_SIGNED signed
+<NAME>XSLT_RUNTIME_EXTRA</NAME>
+#define XSLT_RUNTIME_EXTRA(ctxt, nr) (ctxt)->extras[(nr)].val
</MACRO>
+<STRUCT>
+<NAME>xsltTemplate</NAME>
+</STRUCT>
<TYPEDEF>
-<NAME>trio_long_double_t</NAME>
-typedef long double trio_long_double_t;
-</TYPEDEF>
-<TYPEDEF>
-<NAME>trio_pointer_t</NAME>
-typedef void * trio_pointer_t;
-</TYPEDEF>
-<MACRO>
-<NAME>TRIO_SUFFIX_LONG</NAME>
-# define TRIO_SUFFIX_LONG(x) x ## L
-</MACRO>
-<MACRO>
-<NAME>TRIO_PROTO</NAME>
-# define TRIO_PROTO(x) x
-</MACRO>
-<MACRO>
-<NAME>TRIO_NOARGS</NAME>
-# define TRIO_NOARGS void
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS1</NAME>
-# define TRIO_ARGS1(list,a1) (a1)
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS2</NAME>
-# define TRIO_ARGS2(list,a1,a2) (a1,a2)
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS3</NAME>
-# define TRIO_ARGS3(list,a1,a2,a3) (a1,a2,a3)
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS4</NAME>
-# define TRIO_ARGS4(list,a1,a2,a3,a4) (a1,a2,a3,a4)
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS5</NAME>
-# define TRIO_ARGS5(list,a1,a2,a3,a4,a5) (a1,a2,a3,a4,a5)
-</MACRO>
-<MACRO>
-<NAME>TRIO_ARGS6</NAME>
-# define TRIO_ARGS6(list,a1,a2,a3,a4,a5,a6) (a1,a2,a3,a4,a5,a6)
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS2</NAME>
-# define TRIO_VARGS2 TRIO_ARGS2
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS3</NAME>
-# define TRIO_VARGS3 TRIO_ARGS3
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS4</NAME>
-# define TRIO_VARGS4 TRIO_ARGS4
-</MACRO>
-<MACRO>
-<NAME>TRIO_VARGS5</NAME>
-# define TRIO_VARGS5 TRIO_ARGS5
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_DECL</NAME>
-# define TRIO_VA_DECL ...
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_START</NAME>
-# define TRIO_VA_START(x,y) va_start(x,y)
-</MACRO>
-<MACRO>
-<NAME>TRIO_VA_END</NAME>
-# define TRIO_VA_END(x) va_end(x)
-</MACRO>
-<MACRO>
-<NAME>TRIO_INLINE</NAME>
-# define TRIO_INLINE inline
-</MACRO>
-<MACRO>
-<NAME>TRIO_INLINE</NAME>
-# define TRIO_INLINE __inline__
-</MACRO>
-<MACRO>
-<NAME>TRIO_INLINE</NAME>
-# define TRIO_INLINE _inline
-</MACRO>
-<MACRO>
-<NAME>TRIO_INLINE</NAME>
-# define TRIO_INLINE __inline
-</MACRO>
-<MACRO>
-<NAME>TRIO_INLINE</NAME>
-# define TRIO_INLINE
-</MACRO>
-<MACRO>
-<NAME>TRIO_COMPILER_SUPPORTS_LL</NAME>
-# define TRIO_COMPILER_SUPPORTS_LL
-</MACRO>
-<STRUCT>
-<NAME>xsltSecurityPrefs</NAME>
-</STRUCT>
-<TYPEDEF>
-<NAME>xsltSecurityPrefsPtr</NAME>
-typedef xsltSecurityPrefs *xsltSecurityPrefsPtr;
-</TYPEDEF>
-<ENUM>
-<NAME>xsltSecurityOption</NAME>
-typedef enum {
- XSLT_SECPREF_READ_FILE = 1,
- XSLT_SECPREF_WRITE_FILE,
- XSLT_SECPREF_CREATE_DIRECTORY,
- XSLT_SECPREF_READ_NETWORK,
- XSLT_SECPREF_WRITE_NETWORK
-} xsltSecurityOption;
-</ENUM>
-<USER_FUNCTION>
-<NAME>xsltSecurityCheck</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,
- xsltTransformContextPtr ctxt,
- const char *value
-</USER_FUNCTION>
-<FUNCTION>
-<NAME>xsltNewSecurityPrefs</NAME>
-<RETURNS>xsltSecurityPrefsPtr </RETURNS>
-void
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltFreeSecurityPrefs</NAME>
-<RETURNS>void </RETURNS>
-xsltSecurityPrefsPtr sec
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltSetSecurityPrefs</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltSecurityOption option,xsltSecurityCheck func
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltGetSecurityPrefs</NAME>
-<RETURNS>xsltSecurityCheck </RETURNS>
-xsltSecurityPrefsPtr sec,xsltSecurityOption option
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltSetDefaultSecurityPrefs</NAME>
-<RETURNS>void </RETURNS>
-xsltSecurityPrefsPtr sec
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltGetDefaultSecurityPrefs</NAME>
-<RETURNS>xsltSecurityPrefsPtr </RETURNS>
-void
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltSetCtxtSecurityPrefs</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltSecurityAllow</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const char *value
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltSecurityForbid</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const char *value
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltCheckWrite</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const xmlChar *URL
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltCheckRead</NAME>
-<RETURNS>int </RETURNS>
-xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const xmlChar *URL
-</FUNCTION>
-<MACRO>
-<NAME>XSLT_MAX_SORT</NAME>
-#define XSLT_MAX_SORT 15
-</MACRO>
-<MACRO>
-<NAME>XSLT_PAT_NO_PRIORITY</NAME>
-#define XSLT_PAT_NO_PRIORITY -12345789
-</MACRO>
-<STRUCT>
-<NAME>xsltRuntimeExtra</NAME>
-</STRUCT>
-<TYPEDEF>
-<NAME>xsltRuntimeExtraPtr</NAME>
-typedef xsltRuntimeExtra *xsltRuntimeExtraPtr;
-</TYPEDEF>
-<STRUCT>
-<NAME>xsltRuntimeExtra</NAME>
-struct xsltRuntimeExtra {
- void *info; /* pointer to the extra data */
- xmlFreeFunc deallocate; /* pointer to the deallocation routine */
- void *val; /* data not needing deallocation */
-};
-</STRUCT>
-<MACRO>
-<NAME>XSLT_RUNTIME_EXTRA_LST</NAME>
-#define XSLT_RUNTIME_EXTRA_LST(ctxt, nr) (ctxt)->extras[(nr)].info
-</MACRO>
-<MACRO>
-<NAME>XSLT_RUNTIME_EXTRA_FREE</NAME>
-#define XSLT_RUNTIME_EXTRA_FREE(ctxt, nr) (ctxt)->extras[(nr)].deallocate
-</MACRO>
-<MACRO>
-<NAME>XSLT_RUNTIME_EXTRA</NAME>
-#define XSLT_RUNTIME_EXTRA(ctxt, nr) (ctxt)->extras[(nr)].val
-</MACRO>
-<STRUCT>
-<NAME>xsltTemplate</NAME>
-</STRUCT>
-<TYPEDEF>
-<NAME>xsltTemplatePtr</NAME>
-typedef xsltTemplate *xsltTemplatePtr;
+<NAME>xsltTemplatePtr</NAME>
+typedef xsltTemplate *xsltTemplatePtr;
</TYPEDEF>
<STRUCT>
<NAME>xsltTemplate</NAME>
void * errctx; /* context for the error handler */
xsltSortFunc sortfunc; /* a ctxt specific sort routine */
+
+ /*
+ * handling of temporary Result Value Tree
+ */
+ xmlDocPtr tmpRVT; /* list of RVT without persistance */
+ xmlDocPtr persistRVT; /* list of persistant RVTs */
+ int ctxtflags; /* context processing flags */
};
</STRUCT>
<MACRO>
-<NAME>CHECK_STOPPED</NAME>
-#define CHECK_STOPPED if (ctxt->state == XSLT_STATE_STOPPED) return;
+<NAME>CHECK_STOPPED</NAME>
+#define CHECK_STOPPED if (ctxt->state == XSLT_STATE_STOPPED) return;
+</MACRO>
+<MACRO>
+<NAME>CHECK_STOPPEDE</NAME>
+#define CHECK_STOPPEDE if (ctxt->state == XSLT_STATE_STOPPED) goto error;
+</MACRO>
+<MACRO>
+<NAME>CHECK_STOPPED0</NAME>
+#define CHECK_STOPPED0 if (ctxt->state == XSLT_STATE_STOPPED) return(0);
+</MACRO>
+<FUNCTION>
+<NAME>xsltNewStylesheet</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseStylesheetFile</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+const xmlChar* filename
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltFreeStylesheet</NAME>
+<RETURNS>void </RETURNS>
+xsltStylesheetPtr sheet
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltIsBlank</NAME>
+<RETURNS>int </RETURNS>
+xmlChar *str
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltFreeStackElemList</NAME>
+<RETURNS>void </RETURNS>
+xsltStackElemPtr elem
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltDecimalFormatGetByName</NAME>
+<RETURNS>xsltDecimalFormatPtr </RETURNS>
+xsltStylesheetPtr sheet,xmlChar *name
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseStylesheetProcess</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+xsltStylesheetPtr ret,xmlDocPtr doc
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseStylesheetOutput</NAME>
+<RETURNS>void </RETURNS>
+xsltStylesheetPtr style,xmlNodePtr cur
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseStylesheetDoc</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+xmlDocPtr doc
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseStylesheetImportedDoc</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+xmlDocPtr doc
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltLoadStylesheetPI</NAME>
+<RETURNS>xsltStylesheetPtr </RETURNS>
+xmlDocPtr doc
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltNumberFormat</NAME>
+<RETURNS>void </RETURNS>
+xsltTransformContextPtr ctxt,xsltNumberDataPtr data,xmlNodePtr node
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltFormatNumberConversion</NAME>
+<RETURNS>xmlXPathError </RETURNS>
+xsltDecimalFormatPtr self,xmlChar *format,double number,xmlChar **result
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltParseTemplateContent</NAME>
+<RETURNS>void </RETURNS>
+xsltStylesheetPtr style,xmlNodePtr templ
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltAllocateExtra</NAME>
+<RETURNS>int </RETURNS>
+xsltStylesheetPtr style
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltAllocateExtraCtxt</NAME>
+<RETURNS>int </RETURNS>
+xsltTransformContextPtr ctxt
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltCreateRVT</NAME>
+<RETURNS>xmlDocPtr </RETURNS>
+xsltTransformContextPtr ctxt
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltRegisterTmpRVT</NAME>
+<RETURNS>int </RETURNS>
+xsltTransformContextPtr ctxt,xmlDocPtr RVT
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltRegisterPersistRVT</NAME>
+<RETURNS>int </RETURNS>
+xsltTransformContextPtr ctxt,xmlDocPtr RVT
+</FUNCTION>
+<FUNCTION>
+<NAME>xsltFreeRVTs</NAME>
+<RETURNS>void </RETURNS>
+xsltTransformContextPtr ctxt
+</FUNCTION>
+<MACRO>
+<NAME>TRIO_COMPILER_GCC</NAME>
+# define TRIO_COMPILER_GCC
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUNPRO</NAME>
+# define TRIO_COMPILER_SUNPRO
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUNPRO</NAME>
+# define TRIO_COMPILER_SUNPRO
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_XLC</NAME>
+# define TRIO_COMPILER_XLC
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_XLC</NAME>
+# define TRIO_COMPILER_XLC /* Workaround for old xlc */
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_DECC</NAME>
+# define TRIO_COMPILER_DECC
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_DECC</NAME>
+# define TRIO_COMPILER_DECC /* Workaround for old DEC C compilers */
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_MSVC</NAME>
+# define TRIO_COMPILER_MSVC
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_BCB</NAME>
+# define TRIO_COMPILER_BCB
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_VMS</NAME>
+# define TRIO_PLATFORM_VMS
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_QNX</NAME>
+# define TRIO_PLATFORM_QNX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_UNIX</NAME>
+# define TRIO_PLATFORM_UNIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_WIN32</NAME>
+# define TRIO_PLATFORM_WIN32
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_MPEIX</NAME>
+# define TRIO_PLATFORM_MPEIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_AIX</NAME>
+# define TRIO_PLATFORM_AIX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_HPUX</NAME>
+# define TRIO_PLATFORM_HPUX
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_SOLARIS</NAME>
+# define TRIO_PLATFORM_SOLARIS
+</MACRO>
+<MACRO>
+<NAME>TRIO_PLATFORM_SUNOS</NAME>
+# define TRIO_PLATFORM_SUNOS
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_C89</NAME>
+# define TRIO_COMPILER_SUPPORTS_C89
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_C90</NAME>
+# define TRIO_COMPILER_SUPPORTS_C90
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_C94</NAME>
+# define TRIO_COMPILER_SUPPORTS_C94
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_C99</NAME>
+# define TRIO_COMPILER_SUPPORTS_C99
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_C94</NAME>
+# define TRIO_COMPILER_SUPPORTS_C94
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_UNIX95</NAME>
+# define TRIO_COMPILER_SUPPORTS_UNIX95
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_UNIX98</NAME>
+# define TRIO_COMPILER_SUPPORTS_UNIX98
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_UNIX01</NAME>
+# define TRIO_COMPILER_SUPPORTS_UNIX01
+</MACRO>
+<MACRO>
+<NAME>TRIO_PUBLIC</NAME>
+# define TRIO_PUBLIC
+</MACRO>
+<MACRO>
+<NAME>TRIO_PRIVATE</NAME>
+# define TRIO_PRIVATE static
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_ANCIENT</NAME>
+# define TRIO_COMPILER_ANCIENT
+</MACRO>
+<MACRO>
+<NAME>TRIO_CONST</NAME>
+# define TRIO_CONST
+</MACRO>
+<MACRO>
+<NAME>TRIO_VOLATILE</NAME>
+# define TRIO_VOLATILE
+</MACRO>
+<MACRO>
+<NAME>TRIO_SIGNED</NAME>
+# define TRIO_SIGNED
+</MACRO>
+<TYPEDEF>
+<NAME>trio_long_double_t</NAME>
+typedef double trio_long_double_t;
+</TYPEDEF>
+<TYPEDEF>
+<NAME>trio_pointer_t</NAME>
+typedef char * trio_pointer_t;
+</TYPEDEF>
+<MACRO>
+<NAME>TRIO_SUFFIX_LONG</NAME>
+# define TRIO_SUFFIX_LONG(x) x
+</MACRO>
+<MACRO>
+<NAME>TRIO_PROTO</NAME>
+# define TRIO_PROTO(x) ()
+</MACRO>
+<MACRO>
+<NAME>TRIO_NOARGS</NAME>
+# define TRIO_NOARGS
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS1</NAME>
+# define TRIO_ARGS1(list,a1) list a1;
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS2</NAME>
+# define TRIO_ARGS2(list,a1,a2) list a1; a2;
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS3</NAME>
+# define TRIO_ARGS3(list,a1,a2,a3) list a1; a2; a3;
</MACRO>
<MACRO>
-<NAME>CHECK_STOPPEDE</NAME>
-#define CHECK_STOPPEDE if (ctxt->state == XSLT_STATE_STOPPED) goto error;
+<NAME>TRIO_ARGS4</NAME>
+# define TRIO_ARGS4(list,a1,a2,a3,a4) list a1; a2; a3; a4;
</MACRO>
<MACRO>
-<NAME>CHECK_STOPPED0</NAME>
-#define CHECK_STOPPED0 if (ctxt->state == XSLT_STATE_STOPPED) return(0);
+<NAME>TRIO_ARGS5</NAME>
+# define TRIO_ARGS5(list,a1,a2,a3,a4,a5) list a1; a2; a3; a4; a5;
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS6</NAME>
+# define TRIO_ARGS6(list,a1,a2,a3,a4,a5,a6) list a1; a2; a3; a4; a5; a6;
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS2</NAME>
+# define TRIO_VARGS2(list,a1,a2) list a1; a2
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS3</NAME>
+# define TRIO_VARGS3(list,a1,a2,a3) list a1; a2; a3
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS4</NAME>
+# define TRIO_VARGS4(list,a1,a2,a3,a4) list a1; a2; a3; a4
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS5</NAME>
+# define TRIO_VARGS5(list,a1,a2,a3,a4,a5) list a1; a2; a3; a4; a5
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_DECL</NAME>
+# define TRIO_VA_DECL va_dcl
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_START</NAME>
+# define TRIO_VA_START(x,y) va_start(x)
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_END</NAME>
+# define TRIO_VA_END(x) va_end(x)
+</MACRO>
+<MACRO>
+<NAME>TRIO_CONST</NAME>
+# define TRIO_CONST const
+</MACRO>
+<MACRO>
+<NAME>TRIO_VOLATILE</NAME>
+# define TRIO_VOLATILE volatile
+</MACRO>
+<MACRO>
+<NAME>TRIO_SIGNED</NAME>
+# define TRIO_SIGNED signed
+</MACRO>
+<TYPEDEF>
+<NAME>trio_long_double_t</NAME>
+typedef long double trio_long_double_t;
+</TYPEDEF>
+<TYPEDEF>
+<NAME>trio_pointer_t</NAME>
+typedef void * trio_pointer_t;
+</TYPEDEF>
+<MACRO>
+<NAME>TRIO_SUFFIX_LONG</NAME>
+# define TRIO_SUFFIX_LONG(x) x ## L
+</MACRO>
+<MACRO>
+<NAME>TRIO_PROTO</NAME>
+# define TRIO_PROTO(x) x
+</MACRO>
+<MACRO>
+<NAME>TRIO_NOARGS</NAME>
+# define TRIO_NOARGS void
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS1</NAME>
+# define TRIO_ARGS1(list,a1) (a1)
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS2</NAME>
+# define TRIO_ARGS2(list,a1,a2) (a1,a2)
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS3</NAME>
+# define TRIO_ARGS3(list,a1,a2,a3) (a1,a2,a3)
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS4</NAME>
+# define TRIO_ARGS4(list,a1,a2,a3,a4) (a1,a2,a3,a4)
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS5</NAME>
+# define TRIO_ARGS5(list,a1,a2,a3,a4,a5) (a1,a2,a3,a4,a5)
+</MACRO>
+<MACRO>
+<NAME>TRIO_ARGS6</NAME>
+# define TRIO_ARGS6(list,a1,a2,a3,a4,a5,a6) (a1,a2,a3,a4,a5,a6)
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS2</NAME>
+# define TRIO_VARGS2 TRIO_ARGS2
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS3</NAME>
+# define TRIO_VARGS3 TRIO_ARGS3
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS4</NAME>
+# define TRIO_VARGS4 TRIO_ARGS4
+</MACRO>
+<MACRO>
+<NAME>TRIO_VARGS5</NAME>
+# define TRIO_VARGS5 TRIO_ARGS5
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_DECL</NAME>
+# define TRIO_VA_DECL ...
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_START</NAME>
+# define TRIO_VA_START(x,y) va_start(x,y)
+</MACRO>
+<MACRO>
+<NAME>TRIO_VA_END</NAME>
+# define TRIO_VA_END(x) va_end(x)
+</MACRO>
+<MACRO>
+<NAME>TRIO_INLINE</NAME>
+# define TRIO_INLINE inline
+</MACRO>
+<MACRO>
+<NAME>TRIO_INLINE</NAME>
+# define TRIO_INLINE __inline__
+</MACRO>
+<MACRO>
+<NAME>TRIO_INLINE</NAME>
+# define TRIO_INLINE _inline
+</MACRO>
+<MACRO>
+<NAME>TRIO_INLINE</NAME>
+# define TRIO_INLINE __inline
+</MACRO>
+<MACRO>
+<NAME>TRIO_INLINE</NAME>
+# define TRIO_INLINE
+</MACRO>
+<MACRO>
+<NAME>TRIO_COMPILER_SUPPORTS_LL</NAME>
+# define TRIO_COMPILER_SUPPORTS_LL
</MACRO>
+<STRUCT>
+<NAME>xsltSecurityPrefs</NAME>
+</STRUCT>
+<TYPEDEF>
+<NAME>xsltSecurityPrefsPtr</NAME>
+typedef xsltSecurityPrefs *xsltSecurityPrefsPtr;
+</TYPEDEF>
+<ENUM>
+<NAME>xsltSecurityOption</NAME>
+typedef enum {
+ XSLT_SECPREF_READ_FILE = 1,
+ XSLT_SECPREF_WRITE_FILE,
+ XSLT_SECPREF_CREATE_DIRECTORY,
+ XSLT_SECPREF_READ_NETWORK,
+ XSLT_SECPREF_WRITE_NETWORK
+} xsltSecurityOption;
+</ENUM>
+<USER_FUNCTION>
+<NAME>xsltSecurityCheck</NAME>
+<RETURNS>int </RETURNS>
+xsltSecurityPrefsPtr sec,
+ xsltTransformContextPtr ctxt,
+ const char *value
+</USER_FUNCTION>
<FUNCTION>
-<NAME>xsltNewStylesheet</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
+<NAME>xsltNewSecurityPrefs</NAME>
+<RETURNS>xsltSecurityPrefsPtr </RETURNS>
void
</FUNCTION>
<FUNCTION>
-<NAME>xsltParseStylesheetFile</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
-const xmlChar* filename
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltFreeStylesheet</NAME>
+<NAME>xsltFreeSecurityPrefs</NAME>
<RETURNS>void </RETURNS>
-xsltStylesheetPtr sheet
+xsltSecurityPrefsPtr sec
</FUNCTION>
<FUNCTION>
-<NAME>xsltIsBlank</NAME>
+<NAME>xsltSetSecurityPrefs</NAME>
<RETURNS>int </RETURNS>
-xmlChar *str
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltFreeStackElemList</NAME>
-<RETURNS>void </RETURNS>
-xsltStackElemPtr elem
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltDecimalFormatGetByName</NAME>
-<RETURNS>xsltDecimalFormatPtr </RETURNS>
-xsltStylesheetPtr sheet,xmlChar *name
+xsltSecurityPrefsPtr sec,xsltSecurityOption option,xsltSecurityCheck func
</FUNCTION>
<FUNCTION>
-<NAME>xsltParseStylesheetProcess</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
-xsltStylesheetPtr ret,xmlDocPtr doc
+<NAME>xsltGetSecurityPrefs</NAME>
+<RETURNS>xsltSecurityCheck </RETURNS>
+xsltSecurityPrefsPtr sec,xsltSecurityOption option
</FUNCTION>
<FUNCTION>
-<NAME>xsltParseStylesheetOutput</NAME>
+<NAME>xsltSetDefaultSecurityPrefs</NAME>
<RETURNS>void </RETURNS>
-xsltStylesheetPtr style,xmlNodePtr cur
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltParseStylesheetDoc</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
-xmlDocPtr doc
-</FUNCTION>
-<FUNCTION>
-<NAME>xsltParseStylesheetImportedDoc</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
-xmlDocPtr doc
+xsltSecurityPrefsPtr sec
</FUNCTION>
<FUNCTION>
-<NAME>xsltLoadStylesheetPI</NAME>
-<RETURNS>xsltStylesheetPtr </RETURNS>
-xmlDocPtr doc
+<NAME>xsltGetDefaultSecurityPrefs</NAME>
+<RETURNS>xsltSecurityPrefsPtr </RETURNS>
+void
</FUNCTION>
<FUNCTION>
-<NAME>xsltNumberFormat</NAME>
-<RETURNS>void </RETURNS>
-xsltTransformContextPtr ctxt,xsltNumberDataPtr data,xmlNodePtr node
+<NAME>xsltSetCtxtSecurityPrefs</NAME>
+<RETURNS>int </RETURNS>
+xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt
</FUNCTION>
<FUNCTION>
-<NAME>xsltFormatNumberConversion</NAME>
-<RETURNS>xmlXPathError </RETURNS>
-xsltDecimalFormatPtr self,xmlChar *format,double number,xmlChar **result
+<NAME>xsltSecurityAllow</NAME>
+<RETURNS>int </RETURNS>
+xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const char *value
</FUNCTION>
<FUNCTION>
-<NAME>xsltParseTemplateContent</NAME>
-<RETURNS>void </RETURNS>
-xsltStylesheetPtr style,xmlNodePtr templ
+<NAME>xsltSecurityForbid</NAME>
+<RETURNS>int </RETURNS>
+xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const char *value
</FUNCTION>
<FUNCTION>
-<NAME>xsltAllocateExtra</NAME>
+<NAME>xsltCheckWrite</NAME>
<RETURNS>int </RETURNS>
-xsltStylesheetPtr style
+xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const xmlChar *URL
</FUNCTION>
<FUNCTION>
-<NAME>xsltAllocateExtraCtxt</NAME>
+<NAME>xsltCheckRead</NAME>
<RETURNS>int </RETURNS>
-xsltTransformContextPtr ctxt
+xsltSecurityPrefsPtr sec,xsltTransformContextPtr ctxt,const xmlChar *URL
</FUNCTION>
</SECTION>
<SECTION>
+<FILE>xsltInternals</FILE>
+XSLT_MAX_SORT
+XSLT_PAT_NO_PRIORITY
+xsltRuntimeExtra
+xsltRuntimeExtraPtr
+XSLT_RUNTIME_EXTRA_LST
+XSLT_RUNTIME_EXTRA_FREE
+XSLT_RUNTIME_EXTRA
+xsltTemplate
+xsltTemplatePtr
+xsltDecimalFormat
+xsltDecimalFormatPtr
+xsltDocument
+xsltDocumentPtr
+xsltTransformContext
+xsltTransformContextPtr
+xsltElemPreComp
+xsltElemPreCompPtr
+xsltTransformFunction
+xsltSortFunc
+xsltStyleType
+xsltElemPreCompDeallocator
+xsltStylePreComp
+xsltStylePreCompPtr
+xsltStackElem
+xsltStackElemPtr
+xsltStylesheet
+xsltStylesheetPtr
+xsltOutputType
+xsltTransformState
+CHECK_STOPPED
+CHECK_STOPPEDE
+CHECK_STOPPED0
+xsltNewStylesheet
+xsltParseStylesheetFile
+xsltFreeStylesheet
+xsltIsBlank
+xsltFreeStackElemList
+xsltDecimalFormatGetByName
+xsltParseStylesheetProcess
+xsltParseStylesheetOutput
+xsltParseStylesheetDoc
+xsltParseStylesheetImportedDoc
+xsltLoadStylesheetPI
+xsltNumberFormat
+xsltFormatNumberConversion
+xsltParseTemplateContent
+xsltAllocateExtra
+xsltAllocateExtraCtxt
+xsltCreateRVT
+xsltRegisterTmpRVT
+xsltRegisterPersistRVT
+xsltFreeRVTs
+</SECTION>
+
+<SECTION>
<FILE>triodef</FILE>
TRIO_COMPILER_GCC
TRIO_COMPILER_SUNPRO
xsltCheckRead
</SECTION>
-<SECTION>
-<FILE>xsltInternals</FILE>
-XSLT_MAX_SORT
-XSLT_PAT_NO_PRIORITY
-xsltRuntimeExtra
-xsltRuntimeExtraPtr
-XSLT_RUNTIME_EXTRA_LST
-XSLT_RUNTIME_EXTRA_FREE
-XSLT_RUNTIME_EXTRA
-xsltTemplate
-xsltTemplatePtr
-xsltDecimalFormat
-xsltDecimalFormatPtr
-xsltDocument
-xsltDocumentPtr
-xsltTransformContext
-xsltTransformContextPtr
-xsltElemPreComp
-xsltElemPreCompPtr
-xsltTransformFunction
-xsltSortFunc
-xsltStyleType
-xsltElemPreCompDeallocator
-xsltStylePreComp
-xsltStylePreCompPtr
-xsltStackElem
-xsltStackElemPtr
-xsltStylesheet
-xsltStylesheetPtr
-xsltOutputType
-xsltTransformState
-CHECK_STOPPED
-CHECK_STOPPEDE
-CHECK_STOPPED0
-xsltNewStylesheet
-xsltParseStylesheetFile
-xsltFreeStylesheet
-xsltIsBlank
-xsltFreeStackElemList
-xsltDecimalFormatGetByName
-xsltParseStylesheetProcess
-xsltParseStylesheetOutput
-xsltParseStylesheetDoc
-xsltParseStylesheetImportedDoc
-xsltLoadStylesheetPI
-xsltNumberFormat
-xsltFormatNumberConversion
-xsltParseTemplateContent
-xsltAllocateExtra
-xsltAllocateExtraCtxt
-</SECTION>
-
libexslt_la_LIBADD = $(INSTALLED_XSLT_LIB) $(EXTRA_LIBS)
libexslt_la_LDFLAGS = -version-info @LIBEXSLT_VERSION_INFO@
-man_MANS = libexslt.4
+man_MANS = libexslt.3
EXTRA_DIST = $(man_MANS)
-.TH libexslt 4 "15 May 2002"
+.TH libexslt 3 "15 May 2002"
.SH NAME
libexslt \- extension library for XSLT
.SH DESCRIPTION
exsltSetsDistinctFunction (xmlXPathParserContextPtr ctxt, int nargs) {
xmlXPathObjectPtr obj;
xmlNodeSetPtr ns, ret;
- int boolval;
- void *user;
+ int boolval = 0;
+ void *user = NULL;
if (nargs != 1) {
xmlXPathSetArityError(ctxt);
%doc AUTHORS ChangeLog NEWS README Copyright TODO FEATURES
%doc doc/libxslt-api.xml
%doc doc/libexslt-api.xml
-%doc %{_mandir}/man4/libxslt.4*
-%doc %{_mandir}/man4/libexslt.4*
+%doc %{_mandir}/man3/libxslt.3*
+%doc %{_mandir}/man3/libexslt.3*
%{_libdir}/lib*.so
%{_libdir}/*a
%{_libdir}/*.sh
libxslt_la_LIBADD = $(EXTRA_LIBS)
libxslt_la_LDFLAGS = -version-info @LIBXSLT_VERSION_INFO@
-man_MANS = libxslt.4
+man_MANS = libxslt.3
EXTRA_DIST = $(man_MANS)
*/
xmlDocPtr tmpRVT; /* list of RVT without persistance */
xmlDocPtr persistRVT; /* list of persistant RVTs */
+ int ctxtflags; /* context processing flags */
};
/**
</fo:block></fo:table-cell></fo:table-row><fo:table-row><fo:table-cell><fo:block><fo:inline font-weight="bold">command</fo:inline></fo:block></fo:table-cell><fo:table-cell><fo:block>
Command or text that would be typed.
</fo:block></fo:table-cell></fo:table-row><fo:table-row><fo:table-cell><fo:block><fo:inline font-weight="bold"><fo:inline font-style="italic" font-family="Courier">replaceable</fo:inline></fo:inline></fo:block></fo:table-cell><fo:table-cell><fo:block>
- "Variable" text that can be replaced.
+ "Variable" text that can be replaced.
</fo:block></fo:table-cell></fo:table-row><fo:table-row><fo:table-cell><fo:block><fo:inline font-family="Courier">Program or Doc Code</fo:inline></fo:block></fo:table-cell><fo:table-cell><fo:block>Program or document code</fo:block></fo:table-cell></fo:table-row></fo:table-body></fo:table>
</fo:block>
</fo:block>
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
The most frequently asked question of new contributors who
- join the GDP is "which document should I start
- with?". Because most people involved are volunteers, we do
+ join the GDP is "which document should I start
+ with?". Because most people involved are volunteers, we do
not <fo:inline font-style="italic">assign</fo:inline> projects and applications to
write documents for. The first step is all yours - you must
decide what about GNOME interests you most and find out if
people to make announcements and suggestions and to discuss
issues in the comments section.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2778187">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2786766">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Note</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Note that the information in the
source nature of SGML. To contribute to the GDP you should
learn to use DocBook.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2778273">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2786849">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
To get started writing for the GDP you do not need to rush
DTD's. To install the GDP custom DTD with PNG image support
by hand:
</fo:block>
- <fo:list-block id="id2778655" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2778666" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2787254" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2787263" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2778997" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2787326" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
/usr/lib/sgml/CATALOG.) Add the following line to this
file:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
</fo:block>
If you are using the 3.1 DTD, use:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
</fo:block>
</fo:block>
</fo:list-item-body>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Articles:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</fo:block>
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Books:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</fo:block>
</fo:block>
</fo:block>
mydocument.sgml</fo:inline>, after which you can print out or
view the resulting .ps file.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2899056">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2787803">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
The html files you get will not look quite the same as the
<title>My Image</title>
<screenshot>
<screeninfo>Sample GNOME Display</screeninfo>
- <graphic format="png" fileref="myfile" srccredit="me">
+ <graphic format="png" fileref="myfile" srccredit="me">
</graphic>
</screenshot>
</figure>
The following resources on the web are useful for learning
DocBook:
</fo:block>
- <fo:list-block id="id2899339" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2899347" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2909700" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2909709" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2899393" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2909755" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2899433" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2909797" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2899473" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2909836" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
The following sections of this document are designed to help
documentation authors write correct and consistent DocBook:
</fo:block>
- <fo:list-block id="id2899540" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2899548" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2909902" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2909910" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Screenshots should be kept in the main documentation
directory with your SGML file for applets, or should be
- kept in a directory called "figs" for application and other
+ kept in a directory called "figs" for application and other
documentation. After you use <fo:inline font-weight="bold">db2html</fo:inline> to
convert your SGML file to HTML (see <fo:basic-link internal-destination="make-output">the section called “Creating Something Useful with your Docs”</fo:basic-link>), you will need to copy your
screenshots (either the individual PNG files for applet
- documentation, or the whole "figs" directory for other
+ documentation, or the whole "figs" directory for other
documentation) into the newly created HTML directory. Note
that every time you use <fo:inline font-weight="bold">db2html</fo:inline> the HTML
directory is erased and rewritten, so do not store your only
CVSROOT=':pserver:anonymous@anoncvs.gnome.org:/cvs/gnome'</fo:inline>
and then login with <fo:inline font-weight="bold">cvs login</fo:inline>(there is no
password, just hit return). As an example, we will use the
- "gnome-docu/gdp" module which contains this and several
+ "gnome-docu/gdp" module which contains this and several
other documents. To check these documents out for the first
time, type <fo:inline font-weight="bold">cvs -z3 checkout
gnome-docu/gdp</fo:inline>. After you have this document
to query any part (button, widget, etc.) of an application
window. This is done by either entering a CS Help mode by
clicking on an icon or by right clicking on the application
- part and selecting "What's This" or whatever is decided on
+ part and selecting "What's This" or whatever is decided on
at the time. Context sensitive help is described in more
detail in <fo:basic-link internal-destination="writingcontextsensitivehelp">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</fo:basic-link>
below.
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Using 'content' as the elements to define the text of a document also
allows for search engines to make use of the actual elements to make a
- "smarter search". For example, if you are searching for all documents
- written by the author "Susie" your search engine could be made smart
+ "smarter search". For example, if you are searching for all documents
+ written by the author "Susie" your search engine could be made smart
enough to only search <author> elements, making for a faster and more
accurate search.
</fo:block>
advised</fo:inline> that the documentation writers conform to XML
syntax rules. Here are most important differences:
</fo:block>
- <fo:list-block id="id2901979" provisional-distance-between-starts="1in" provisional-label-separation="0.25in" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
- <fo:list-item id="id2901984" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2912217" provisional-distance-between-starts="1in" provisional-label-separation="0.25in" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2912223" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-style="italic">Minimization</fo:inline></fo:inline>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2902116" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2912357" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-style="italic">Self-closing tags</fo:inline></fo:inline>
tags. For example, it is legal for
<fo:inline font-family="Courier"><xref></fo:inline> not to have a closing tag:
<fo:inline font-family="Courier"><fo:inline font-family="Courier"><xref
- linkend="someid"></fo:inline></fo:inline>. In
+ linkend="someid"></fo:inline></fo:inline>. In
XML, it is illegal; instead, you should use
<fo:inline font-family="Courier"><fo:inline font-family="Courier"><xref
- linkend="someid"/></fo:inline></fo:inline> (note the
+ linkend="someid"/></fo:inline></fo:inline> (note the
slash!).
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2902199" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2912442" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-style="italic">Case sensitive tags</fo:inline></fo:inline>
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<figure id="shot1">
+<figure id="shot1">
<title>Screenshot</title>
<screenshot>
<screeninfo>Screenshot of a program</screeninfo>
- <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
+ <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
</graphic>
</screenshot>
</figure>
<fo:block id="shot1" space-before.minimum="1em" space-before.optimum="1.5em" space-before.maximum="2em" space-after.minimum="1em" space-after.optimum="1.5em" space-after.maximum="2em" keep-with-previous.within-column="always"><fo:block font-weight="bold" font-size="12pt" hyphenate="false" keep-with-next.within-column="always" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">Screenshot</fo:block><fo:block><fo:block><fo:external-graphic src="url(file:figures/example_screenshot)" content-width="auto" content-height="auto" width="auto" height="auto"/></fo:block></fo:block></fo:block>
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2902735">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2912982">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Notice in this example that the screenshot file name does
Note the use of tags <fo:inline font-family="Courier"><prompt></fo:inline> and
<fo:inline font-family="Courier"><userinput></fo:inline> for marking system prompt
and commands entered by user.
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2902958"><fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block><fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2913198"><fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block><fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Note that both <fo:inline font-family="Courier"><programlisting></fo:inline>
and <fo:inline font-family="Courier"><screen></fo:inline> preserve linebreaks,
but interpret SGML tags (unlike LaTeX
<fo:inline font-family="Courier"><orderedlist></fo:inline>, and
<fo:inline font-family="Courier"><variablelist></fo:inline>.
</fo:block>
- <fo:list-block id="id2903069" provisional-distance-between-starts="1in" provisional-label-separation="0.25in" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
- <fo:list-item id="id2903075" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2913311" provisional-distance-between-starts="1in" provisional-label-separation="0.25in" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913317" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-family="Courier"><itemizedlist></fo:inline></fo:inline>
<listitem>
<para>
<guilabel>Show hidden files</guilabel> &mdash; This will
- show all "dot files" or files that begin with a dot. This
+ show all "dot files" or files that begin with a dot. This
files typically include configuration files and directories.
</para>
</listitem>
</fo:block>
and output:
</fo:block>
- <fo:list-block id="id2903131" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2903137" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2913370" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2913375" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903185" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913435" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
<fo:list-item-body start-indent="body-start()">
<fo:block>
Show hidden files --
- This will show all "dot files" or files that
+ This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903217" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913467" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903389" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913638" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-family="Courier"><orderedlist></fo:inline></fo:inline>
this list uses Arabic numerals for numbering entries;
you can override this using <fo:inline font-family="Courier">numeration</fo:inline>,
for example <fo:inline font-family="Courier"><orderedlist
- numeration="lowerroman"></fo:inline>. Possible values of
+ numeration="lowerroman"></fo:inline>. Possible values of
these attribute are <fo:inline font-family="Courier">arabic</fo:inline>,
<fo:inline font-family="Courier">upperalpha</fo:inline>,
<fo:inline font-family="Courier">loweralpha</fo:inline>,
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903488" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913738" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>
<fo:inline> <fo:inline font-family="Courier"><variablelist></fo:inline></fo:inline>
</fo:block>
</fo:block>
</fo:block>
- <fo:list-block id="id2903661" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2903667" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2913920" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2913926" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903693" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2913953" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903743" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914003" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903767" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914027" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903791" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914052" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2903816" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914077" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
to (section, figure, etc.), while the second just creates a
link (in HTML output). Here is an example:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-An example of a <link linkend="extip">tip</link> was given in
-<xref linkend="notes" />.
+An example of a <link linkend="extip">tip</link> was given in
+<xref linkend="notes" />.
</fo:block>
which produces: An example of a <fo:basic-link internal-destination="extip">tip</fo:basic-link> was given in <fo:basic-link internal-destination="notes">the section called “Notes, Warnings, And Tips”</fo:basic-link>.
</fo:block>
Web page or a local file, use <fo:inline font-family="Courier"><ulink></fo:inline>
tag, for example:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
- To find more about GNOME, please visit <ulink type="http"
-url="http://www.gnome.org">GNOME Web page</ulink>
+ To find more about GNOME, please visit <ulink type="http"
+url="http://www.gnome.org">GNOME Web page</ulink>
</fo:block>
which produces: To find more about GNOME, please visit
<fo:basic-link external-destination="http://www.gnome.org">The GNOME Web
Here are some tags used to describe operating system-related
things:
</fo:block>
- <fo:list-block id="id2904206" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2904212" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2914461" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2914465" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904266" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914523" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
<fo:list-item-body start-indent="body-start()">
<fo:block> <fo:inline font-family="Courier"><filename
- class="directory"></fo:inline> -- used for
+ class="directory"></fo:inline> -- used for
directories, e.g.<fo:inline font-family="Courier"><filename
- class="directory"></fo:inline>/usr/bin
+ class="directory"></fo:inline>/usr/bin
<fo:inline font-family="Courier"></filename></fo:inline>
produces: <fo:inline font-family="Courier">/usr/bin</fo:inline>.
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904326" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914586" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904381" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914641" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904422" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914683" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904477" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2914739" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
here is partial list of most commonly used enitites:
</fo:block>
- <fo:list-block id="id2904943" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
- <fo:list-item id="id2904949" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-block id="id2915195" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em">
+ <fo:list-item id="id2915200" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904968" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2915221" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2904986" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2915240" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2905005" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2915258" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
</fo:block>
</fo:list-item-body>
</fo:list-item>
- <fo:list-item id="id2905026" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
+ <fo:list-item id="id2915283" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:list-item-label end-indent="label-end()">
<fo:block>•</fo:block>
</fo:list-item-label>
application for which the documentation is written:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<sect1 id="intro">
+<sect1 id="intro">
<title>Introduction</title>
<para>
blah-blah-blah This document describes version 1.0.53 of gfoo.
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
All GNOME applications must contain information about the
license (for software, not for documentation), either in the
- "About" box or in the manual.
+ "About" box or in the manual.
</fo:block>
</fo:block>
<fo:block id="bugtraq">
PNG format only) when appropriate. They should also describe
each feature and preference option available.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2905471">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2915726">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Documentation Availability</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Applications and applets should not rely on documentation
versions 1.x and the templates in <fo:basic-link internal-destination="template2-2x">the section called “Template 2: Applet Manual For GNOME 2.x”</fo:basic-link>
for GNOME versions 2.x.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2905564">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2915821">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Manuals For Large Applications</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Manuals for very large applications, such as GNOME Workshop
<fo:inline font-family="Courier"><sect1></fo:inline>).
</fo:block>
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2905622">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2915878">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Applet Manuals in GNOME 2.0</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Note that applet manuals in GNOME 2.0 are treated in a special
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Application manuals should be made available by having a
- "Manual" entry in the Help pull-down menu
+ "Manual" entry in the Help pull-down menu
at the top of the
application, as described in <fo:basic-link internal-destination="listingdocsinhelpmenu">the section called “Listing Documents in the Help Menu”</fo:basic-link>.
Applets should make their manuals available by
</fo:block>
</fo:block>
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2905742">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2916001">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Developer Information</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
This section is for developers. Documentation authors
from SGML into HTML with <fo:inline font-weight="bold">db2html</fo:inline>) should be
placed in this directory too.
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2905930">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2916189">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Note</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
If the help files are not present in the correct directory, the
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
GnomeUIInfo helpmenu[] = {
{GNOME_APP_UI_ITEM,
- N_("About"), N_("Info about this program"),
+ N_("About"), N_("Info about this program"),
about_cb, NULL, NULL,
GNOME_APP_PIXMAP_STOCK, GNOME_STOCK_MENU_ABOUT,
0, 0, NULL},
GNOMEUIINFO_SEPARATOR,
- GNOMEUIINFO_HELP("<fo:inline font-style="italic">appname</fo:inline>"),
+ GNOMEUIINFO_HELP("<fo:inline font-style="italic">appname</fo:inline>"),
GNOMEUIINFO_END
};
</fo:block>
</fo:block>
</fo:block>
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2906097">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2916354">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Developer Information</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
This section is for developers. Documentation authors
</fo:block>
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
gchar *tmp;
-tmp = gnome_help_file_find_file ("module", "page.html");
+tmp = gnome_help_file_find_file ("module", "page.html");
if (tmp) {
gnome_help_goto(0, tmp);
g_free(tmp);
}
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2906232">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2916491">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">NOTE</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
The example above is in the C language, please refer to other
</fo:block>
</fo:block>
</fo:block>
- <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2906480">
+ <fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" start-indent="0.25in" end-indent="0.25in" id="id2916739">
<fo:block font-size="14pt" font-weight="bold" keep-with-next="always">Developer Information</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
This section is for developers. Documentation authors
To add an applet's manual to its applet menu, use:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
/* add an item to the applet menu */
-applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
-_("Manual"), &open_manual, NULL);
+applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
+_("Manual"), &open_manual, NULL);
</fo:block>
Here the second argument is an arbitrary name for the
callback, the third argument is the label which will appear
item to the applet's menu. This is a
stock menu item and is done:
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
- GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
+applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
+ GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
NULL);
</fo:block>
</fo:block>
</fo:block>
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
- Context sensitive help, also known as "pop-up" help, will allow
+ Context sensitive help, also known as "pop-up" help, will allow
a user to obtain help information about specific buttons or
parts of an application.
</fo:block>
developer to give an id to a particular portion of the User
Interface, for example, a button. Once the interface is complete
a Perl script can then be run against the interface code to
- create a "map" file. This map file allows the developer or
+ create a "map" file. This map file allows the developer or
writer to associate particular paragraph sections from an XML
document to the interface items.
</fo:block>
user launches context sensitive help on the interface (either by
pressing a button and then clicking on the interface item they
want information on, or by right mouse clicking on the interface
- item and selecting a pop-up menu item like "What's This") a
+ item and selecting a pop-up menu item like "What's This") a
small transient window will appear with brief but detailed
information on the interface item.
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
Just as you need to juggle expert and novice readers,
you'll have to juggle a number of other extremes as you write:
- <fo:list-block id="id2907018" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em"><fo:list-item id="id2907025" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
+ <fo:list-block id="id2917292" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em" provisional-distance-between-starts="1.5em" provisional-label-separation="0.2em"><fo:list-item id="id2917298" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
you spend fewer words on the obvious, you can spend more
time clarifying the ambiguous labels and explaining
items that are more complex.
- </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2907052" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
+ </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2917325" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
maintain a standard of style which holds the reader's
interest without resorting to jokes and untranslatable
allusions or puns.
- </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2907091" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
+ </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2917363" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
It's good to provide a screenshot of any dialog windows
a user might run into, but if a dialog box has several
tabs, it's not usually necessary to have one for each.
- </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2907115" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
+ </fo:block></fo:list-item-body></fo:list-item><fo:list-item id="id2917387" space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em"><fo:list-item-label end-indent="label-end()"><fo:block>•</fo:block></fo:list-item-label><fo:list-item-body start-indent="body-start()"><fo:block>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
bug reports, writers must check for errors in their documents.
Poor grammar, bad spelling, and gross technical errors in
draft documents are fine. However, if those problems show up
- in a "real" release, they can count against the credibility of
+ in a "real" release, they can count against the credibility of
GNOME and Linux. They'll also make you look bad.
</fo:block>
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!-- if not using PNG graphic, replace reference above with
- .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
+ .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
-->
-<!ENTITY version "1.0.53">
+<!ENTITY version "1.0.53">
<!-- replace version above with actual application version number-->
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged.
Remember that this is a guide, rather than a perfect model to follow
<!-- =============Document Header ============================= -->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<artheader>
<title>MY-GNOME-APP</title>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
- Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
to: Free Software Foundation, Inc., 59 Temple Place - Suite
330, Boston, MA 02111-1307, USA.
</para>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
- <sect1 id="intro">
+ <sect1 id="intro">
<title>Introduction</title>
<para>
<!-- ================ Usage ================================ -->
<!-- This section should describe basic usage of the application. -->
- <sect1 id="usage">
+ <sect1 id="usage">
<title>Using MY-GNOME-APP</title>
<para>
<application>MY-GNOME-APP</application> can be used to produce a
</para>
<!-- ========= Basic Usage =========================== -->
- <sect2 id="mainwin">
+ <sect2 id="mainwin">
<title>Basic usage</title>
<para>
Starting <application>MY-GNOME-APP</application> opens the
<interface>Main window</interface>, shown in <xref
- linkend="mainwindow-fig">. The window is at first empty.
+ linkend="mainwindow-fig">. The window is at first empty.
<!-- ==== Figure ==== -->
- <figure id="mainwindow-fig">
+ <figure id="mainwindow-fig">
<title>MY-GNOME-APP Main Window</title>
<screenshot>
<screeninfo>MY-GNOME-APP Main Window</screeninfo>
- <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
</graphic>
</screenshot>
</figure>
</para>
- <!-- For this app, one could put "proving" or "edit" (probably even
+ <!-- For this app, one could put "proving" or "edit" (probably even
both of them) as sect2's seperate from the main window
section. Since they were both so closely involved with the main
window, I decided to have them as sect3's isntead. Judgement
call. -->
- <sect3 id="proving">
+ <sect3 id="proving">
<title>Proving a Theorem</title>
<para>
To get a proof of a theorem, select
</para>
</warning>
</sect3>
- <sect3 id="editing">
+ <sect3 id="editing">
<title>Editing Proofs</title>
<para>
Once you have proven the theorem, it will be displayed in
============================================================= -->
- <sect2 id="toolbar">
+ <sect2 id="toolbar">
<title>Toolbar</title>
<para>
- The toolbar (shown in <xref linkend="figure-usage-toolbar">)
+ The toolbar (shown in <xref linkend="figure-usage-toolbar">)
provides access to several commonly used routines.
- <figure id="figure-usage-toolbar">
+ <figure id="figure-usage-toolbar">
<title>MY-GNOME-APP Toolbar</title>
<screenshot>
<screeninfo>MY-GNOME-APP Toolbar</screeninfo>
- <graphic fileref="usage-toolbar.png" format="png"></graphic>
+ <graphic fileref="usage-toolbar.png" format="png"></graphic>
</screenshot>
</figure>
<variablelist>
</sect2>
<!-- ========= Menus =========================== -->
- <sect2 id="menubar">
+ <sect2 id="menubar">
<!-- Describing the menubar ensures comprehensive feature
coverage. Nest itemizedlists inside variablelists so that each
<para>
<guimenuitem>Preferences&hellip;</guimenuitem>
&mdash; This opens the <link
- linkend="prefs"><interface>Preferences
+ linkend="prefs"><interface>Preferences
Dialog</interface></link>, which allows you to configure
many settings.
</para>
<!-- ============= Customization ============================= -->
- <sect1 id="prefs">
+ <sect1 id="prefs">
<title>Customization</title>
<para>
To change the application settings, select
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>. This opens the
<interface>Preferences</interface> dialog, shown in <xref
- linkend="preferences-fig">.
+ linkend="preferences-fig">.
</para>
- <figure id="preferences-fig">
+ <figure id="preferences-fig">
<title>Preferences Dialog</title>
<screenshot>
<screeninfo>Preferences Dialog</screeninfo>
- <graphic fileref="SCREENSHOT" format="png"
- srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png"
+ srccredit="ME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of. -->
- <sect1 id="bugs">
+ <sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This application has no known bugs.
<!-- ============= Authors ================================ -->
- <sect1 id="authors">
+ <sect1 id="authors">
<title>Authors</title>
<para>
<application>MY-GNOME-APP</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). To find more information about
<application>MY-GNOME-APP</application>, please visit the <ulink
- url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+ url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
page</ulink>. Please send all comments, suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>.) You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also add your comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect1 id="license">
+ <sect1 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
- <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+ <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged,make sure to add/remove trademarks to the list as
appropriate for your document.
thanks ;-).
-->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<!-- ============= Document Header ============================= -->
<artheader>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
by the Free Software Foundation with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
of the <citetitle>GNU Free Documentation License</citetitle> from
- the Free Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
</para>
<!-- Template Version: 1.0.1 (do not remove this line) -->
- <sect1 id="APPLET">
+ <sect1 id="APPLET">
<title>APPLET Applet</title>
<para>
<application>APPLET</application> applet, shown in <xref
- linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
+ linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
applet to a <interface>Panel</interface>,
right-click on the <interface>Panel</interface> and choose
<menuchoice>
</menuchoice>.
</para>
- <figure id="APPLETapplet-fig">
+ <figure id="APPLETapplet-fig">
<title>APPLET Applet</title>
<screenshot>
<screeninfo>APPLET Applet</screeninfo>
- <graphic format="png" fileref="APPLET_applet"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_applet"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- ============= Usage ================================ -->
- <sect2 id="APPLET-usage">
+ <sect2 id="APPLET-usage">
<title>Usage</title>
<para>
(Place a short description of how to use the applet here.)
<listitem>
<para>
<guimenuitem>Properties&hellip;</guimenuitem> &mdash;
- opens the <link linkend="APPLET-prefs">
+ opens the <link linkend="APPLET-prefs">
<guilabel>Properties</guilabel></link> dialog.
</para>
</listitem>
<!-- ============= Customization ============================= -->
- <sect2 id="APPLET-prefs">
+ <sect2 id="APPLET-prefs">
<title>Customization</title>
<para>
You can customize <application>APPLET</application>
applet by right-clicking on it and choosing
<guimenuitem>Properties&hellip;</guimenuitem>. This will open the
<interface>Properties</interface> dialog(shown in <xref
- linkend="APPLET-settings-fig">), which allows you to
+ linkend="APPLET-settings-fig">), which allows you to
change various settings.
</para>
- <figure id="APPLET-settings-fig">
+ <figure id="APPLET-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
- <graphic format="png" fileref="APPLET_settings"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_settings"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of -->
- <sect2 id="bugs">
+ <sect2 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This applet has no known bugs.
<!-- ============= Authors ================================ -->
- <sect2 id="authors">
+ <sect2 id="authors">
<title>Authors</title>
<para>
<application>APPLET</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). Please send all comments,
suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>. You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also submit comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
Status Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect2 id="license">
+ <sect2 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<fo:block space-before.optimum="1em" space-before.minimum="0.8em" space-before.maximum="1.2em">
<fo:block wrap-option="no-wrap" text-align="start" white-space-collapse="false" linefeed-treatment="preserve" font-family="Courier" font-size="9pt" space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em">
-<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
-<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
+<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
]>
-<book id="gnome-applets">
+<book id="gnome-applets">
<bookinfo>
<title>GNOME Applets</title>
</bookinfo>
<!-- #### Introduction ###### -->
- <chapter id="applets-intro">
+ <chapter id="applets-intro">
<title>Introduction</title>
<!-- #### Intro | What Are Applets? ###### -->
- <sect1 id="applets-what-are">
+ <sect1 id="applets-what-are">
<title>What Are Applets?</title>
<para>
Applets are one of the most popular and useful objects you can add
</para>
<para>
- <figure id="example-applets-fig">
+ <figure id="example-applets-fig">
<title>Example Applets</title>
<screenshot>
<screeninfo>Example Applets</screeninfo>
- <graphic fileref="example_applets" format="png"
- srccredit="muet">
+ <graphic fileref="example_applets" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
Several example applets are shown in <xref
- linkend="example-applets-fig">. From left to right, they are: (1)
+ linkend="example-applets-fig">. From left to right, they are: (1)
<application>Mixer Applet</application>, which allows you to turn
on/off sound and control its volume by clicking on the applet. (2)
<application>Sound Monitor</application> Applet, which displays
<interface>Panels</interface> and using them. The following
chapters go through each of the standard GNOME applets describing
them in detail. There are also additional applets which can be
- downloaded off the Web. See <ulink type="http"
- url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
+ downloaded off the Web. See <ulink type="http"
+ url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
Software Map</ulink> for lists of additional GNOME applications
and applets.
</para>
</sect1>
<!-- #### Intro | Adding, Moving, and Removing Applets ###### -->
- <sect1 id="applet-add-move-replace">
+ <sect1 id="applet-add-move-replace">
<title>Adding, Moving, and Removing Applets</title>
- <sect2 id="adding-applets">
+ <sect2 id="adding-applets">
<title>Adding Applets to a Panel</title>
<para>
To add an applet to a <interface>Panel</interface>, right-click
</para>
</sect2>
- <sect2 id="moving-applets">
+ <sect2 id="moving-applets">
<title>Moving Applets In or Between Panels</title>
<para>
It is easy to move applets in a <interface>Panel</interface> or
other objects, the behavior depends on the global preferences
you have set for your <interface>Panels</interface> in the
<application>GNOME Control Center</application>: the applet you are
- moving can switch places with other objects, "push" all objects
- it meets, or "jump" over all other objects without disturbing
+ moving can switch places with other objects, "push" all objects
+ it meets, or "jump" over all other objects without disturbing
them. You can also override the default behavior by holding
- <keycap>Shift</keycap> button (for "push" mode),
- <keycap>Ctrl</keycap> (for "switched" mode), or
- <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
+ <keycap>Shift</keycap> button (for "push" mode),
+ <keycap>Ctrl</keycap> (for "switched" mode), or
+ <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
objects without disturbing them) button while dragging.
</para>
<para>
</para>
</sect2>
- <sect2 id="removing-applets">
+ <sect2 id="removing-applets">
<title>Removing Applets from a Panel</title>
<para>
To remove an applet from a <interface>Panel</interface>,
<!-- #### Intro | The Right-Click Pop-Up Menu ###### -->
- <sect1 id="right-click-pop-up-menu">
+ <sect1 id="right-click-pop-up-menu">
<title>The Right-Click Pop-Up Menu</title>
<para>
Clicking the right mouse button on any applet brings up
often has additional items which vary depending on the particular
applet.
</para>
- <sect2 id="standard-right-click-items">
+ <sect2 id="standard-right-click-items">
<title>Standard Pop-Up Items</title>
<para>
All applets should have the following items in their right-click
</para>
</sect2>
- <sect2 id="applet-properties-dialog">
+ <sect2 id="applet-properties-dialog">
<title>The Applet Properties Dialog</title>
<para>
Many applets have customizable properties. These applets will
right-click <guimenu>pop-up menu</guimenu> which brings up the
<interface>Properties</interface> dialog where you can alter the
appearance or behaviour of the applet.
- <figure id="example-props-dialog-fig">
+ <figure id="example-props-dialog-fig">
<title>An Example Applet Properties Dialog</title>
<screenshot>
<screeninfo>An Example Applets Properties Dialog</screeninfo>
- <graphic fileref="applet_props_dialog" format="png"
- srccredit="muet">
+ <graphic fileref="applet_props_dialog" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
</para>
</sect2>
- <sect2 id="common-right-click-items">
+ <sect2 id="common-right-click-items">
<title>Other Common Pop-Up Items</title>
<para>
Many applets also have one or more of the following items in their
</sect2>
</sect1>
- <sect1 id="feedback">
+ <sect1 id="feedback">
<title>Feedback</title>
- <sect2 id="reporting-bugs">
+ <sect2 id="reporting-bugs">
<title>Reporting Applet Bugs</title>
<para>
- GNOME users are encouraged to report bugs to <ulink type="http"
- url="http://bugs.gnome.org">The GNOME Bug Tracking
+ GNOME users are encouraged to report bugs to <ulink type="http"
+ url="http://bugs.gnome.org">The GNOME Bug Tracking
System</ulink>. The easiest way to submit bugs is to use the
<application>Bug Report Tool</application> program by selecting
<menuchoice>
reproduce the the scenario.
</para>
</sect2>
- <sect2 id="documentation-feedback">
+ <sect2 id="documentation-feedback">
<title>Providing Feedback</title>
<para>
GNOME users are welcome to provide suggestions for how
<application>Bug Report Tool</application> discussed above.
Suggestions for documentation changes can be emailed directly to
the documentation author (whose email should be included in the
- "Authors" section of the document) or by sending an email to
+ "Authors" section of the document) or by sending an email to
<email>docs@gnome.org</email>.
</para>
</sect2>
- <sect2 id="joining-gnome">
+ <sect2 id="joining-gnome">
<title>Joining GNOME</title>
<para>
GNOME is a community project, created by hundreds of programmers,
documentation writers, icon design artists, web masters, and
other people, most of whom work on a volunteer basis. New GNOME
contributors are always welcome. To join the GNOME team, visit
- these web sites: developers &mdash; <ulink type="http"
- url="http://developer.gnome.org">The GNOME Development
- Site</ulink>, documentation writers &mdash; <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
- Project</ulink>, icon design artists &mdash; <ulink type="http"
- url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
- general &mdash; <ulink type="http"
- url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
- or just join the gnome-list email list (see <ulink type="http"
- url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
+ these web sites: developers &mdash; <ulink type="http"
+ url="http://developer.gnome.org">The GNOME Development
+ Site</ulink>, documentation writers &mdash; <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
+ Project</ulink>, icon design artists &mdash; <ulink type="http"
+ url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
+ general &mdash; <ulink type="http"
+ url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
+ or just join the gnome-list email list (see <ulink type="http"
+ url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
Lists</ulink>) to discuss what you are interested in doing.
</para>
</sect2>
</chapter>
<!-- ############### Template Applets ##################### -->
- <chapter id="template-applets">
+ <chapter id="template-applets">
<title>Template Applets</title>
&TEMPLATE-APPLET
<!-- stated in a translation approved by the Foundation. -->
<!-- ############### GNOMEAPPLET ############### -->
- <sect1 id="GNOMEAPPLET">
+ <sect1 id="GNOMEAPPLET">
<title>GNOMEAPPLET Applet</title>
<para>
<application>GNOMEAPPLET</application> applet, shown in <xref
- linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
+ linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
add this applet to a <interface>Panel</interface>, see <xref
- linkend="adding-applets">.
+ linkend="adding-applets">.
</para>
- <figure id="GNOMEAPPLET-fig">
+ <figure id="GNOMEAPPLET-fig">
<title>GNOMEAPPLET</title>
<screenshot>
<screeninfo>GNOMEAPPLET</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
</graphic>
</screenshot>
</figure>
- <sect2 id="GNOMEAPPLET-usage">
+ <sect2 id="GNOMEAPPLET-usage">
<title>Usage</title>
<para>
This applet does nothing. To use it, just
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-right-click">
+ <sect2 id="GNOMEAPPLET-right-click">
<title>Right-Click Pop-Up Menu Items</title>
<para>
In addition to the standard menu items (see <xref
- linkend="standard-right-click-items">), the right-click pop-up menu has
+ linkend="standard-right-click-items">), the right-click pop-up menu has
the following items:
<itemizedlist>
<listitem>
<para>
<guimenuitem>Properties...</guimenuitem> &mdash; This menu
item opens the <interface>Properties</interface> dialog (see
- <xref linkend="GNOMEAPPLET-properties">) which allows you to
+ <xref linkend="GNOMEAPPLET-properties">) which allows you to
customize the appearance and behavior of this applet.
</para>
</listitem>
<para>
<guimenuitem>Run Hello World...</guimenuitem> &mdash; This
menu item starts the program <application>Hello
- World</application>, used to say "hello" to the world.
+ World</application>, used to say "hello" to the world.
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-properties">
+ <sect2 id="GNOMEAPPLET-properties">
<title>Properties</title>
<para>
You can configure <application>GNOMEAPPLET</application> applet by
right-clicking on the applet and choosing the
<guimenuitem>Properties...</guimenuitem> menu item. This will open the
<interface>Properties</interface> dialog, shown in <xref
- linkend="GNOMEAPPLET-properties-fig">.
+ linkend="GNOMEAPPLET-properties-fig">.
</para>
- <figure id="GNOMEAPPLET-properties-fig">
+ <figure id="GNOMEAPPLET-properties-fig">
<title>Properties Dialog</title>
<screenshot>
<screeninfo>Properties Dialog</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
</graphic>
</screenshot>
</figure>
dialog, including descriptions of the <guibutton>OK</guibutton>,
<guibutton>Apply</guibutton>, <guibutton>Cancel</guibutton>, and
<guibutton>Help</guibutton> buttons, see <xref
- linkend="applet-properties-dialog">.
+ linkend="applet-properties-dialog">.
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-bugs">
+ <sect2 id="GNOMEAPPLET-bugs">
<title> Known Bugs and Limitations</title>
<para>
There are no known bugs in the
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-authors">
+ <sect2 id="GNOMEAPPLET-authors">
<title>Authors</title>
<para>
This applet was writen by HACKER-NAME
which you are reading now was written by
YOUR-NAME <email>YOUR-EMAIL</email>. For information on submitting
bug reports and suggestions for improvements, see <xref
- linkend="feedback">.
+ linkend="feedback">.
</para>
</sect2>
-<html><head><meta
content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>The GNOME Handbook of Writing Software Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><h2 class="title"><a name="index"></a>The GNOME Handbook of Writing Software Documentation</h2></div><div><h3 class="author">David Mason</h3><div class="affiliation"><span class="orgname">Red Hat, Inc.<br></span><div class="address"><br>
+<html><head><meta
http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The GNOME Handbook of Writing Software Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><h2 class="title"><a name="index"></a>The GNOME Handbook of Writing Software Documentation</h2></div><div><h3 class="author">David Mason</h3><div class="affiliation"><span class="orgname">Red Hat, Inc.<br></span><div class="address"><br>
<tt><<a href="mailto:dcm@redhat.com">dcm@redhat.com</a>></tt><br>
</div></div><h3 class="author">Daniel Mueth</h3><div class="affiliation"><div class="address"><br>
<tt><<a href="mailto:d-mueth@uchicago.edu">d-mueth@uchicago.edu</a>></tt><br>
irc.gnome.org is another option for contacting GDP members.
</p></div></div><div class="sect2"><a name="notation"></a><div class="titlepage"><div><h3 class="title"><a name="notation"></a>Notation and Conventions</h3></div></div><p>
This Handbook uses the following notation:
- <div class="informaltable" id="id2797
250"><a name="id2797250"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
+ <div class="informaltable" id="id2797
678"><a name="id2797678"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
Directory
</td></tr><tr><td><tt>foo.sgml</tt></td><td>
Filename
</td></tr><tr><td><b>command</b></td><td>
Command or text that would be typed.
</td></tr><tr><td><b><i><tt>replaceable</tt></i></b></td><td>
- "Variable" text that can be replaced.
+ "Variable" text that can be replaced.
</td></tr><tr><td><tt>Program or Doc Code</tt></td><td>Program or document code</td></tr></tbody></table></div>
</p></div><div class="sect2"><a name="about"></a><div class="titlepage"><div><h3 class="title"><a name="about"></a>About This Handbook</h3></div></div><p>
This Handbook is a guide for both writing documentation for
download it anonymously from GNOME CVS under <tt>gnome-docu/gdp</tt>.
</p></div></div><div class="sect1"><a name="gettingstarted"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="gettingstarted"></a>Getting Started Writing GNOME Documentation</h2></div></div><div class="sect2"><a name="selecting"></a><div class="titlepage"><div><h3 class="title"><a name="selecting"></a>Selecting A Document</h3></div></div><div class="sect3"><a name="know"></a><div class="titlepage"><div><h4 class="title"><a name="know"></a>Document Something You Know</h4></div></div><p>
The most frequently asked question of new contributors who
- join the GDP is "which document should I start
- with?". Because most people involved are volunteers, we do
+ join the GDP is "which document should I start
+ with?". Because most people involved are volunteers, we do
not <i>assign</i> projects and applications to
write documents for. The first step is all yours - you must
decide what about GNOME interests you most and find out if
help. The <i>DocTable</i> also allows
people to make announcements and suggestions and to discuss
issues in the comments section.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
87277"></a>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
95548"></a>Note</h3><p>
Note that the information in the
<i>DocTable</i> may not always be up-to-date
or accurate. When you assign yourself to documenting an
this for documentation, not least of which is the single
source nature of SGML. To contribute to the GDP you should
learn to use DocBook.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
87363"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
95631"></a>NOTE</h3><p>
To get started writing for the GDP you do not need to rush
out and learn DocBook - if you feel it is too much to handle
for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top">
your output document appearance subtly vary between the two
DTD's. To install the GDP custom DTD with PNG image support
by hand:
- </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2787765"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2796045"></a>
Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the
GDP DocBook DTD for PNG support</a> and install it
where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that
the 3.0 DTD is missing support for the
<tt><legalnotice></tt> tag, so it is
recommended that you use version 3.1
- </p></li><li style="list-style-type: disc"><p><a name="id2788094"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2796107"></a>
Add the new DTD to your SGML CATALOG file. The location
of your SGML CATALOG file may vary depending upon your
distribution. (On Red Hat it is usually in
/usr/lib/sgml/CATALOG.) Add the following line to this
file:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
</pre>
If you are using the 3.1 DTD, use:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
</pre>
</p></li></ul></div><p>
Alternately, you can download and install the
</p><p>
Articles:
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p><p>
Books:
<pre class="programlisting">
-<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p></div><div class="sect3"><a name="editors"></a><div class="titlepage"><div><h4 class="title"><a name="editors"></a>Editors</h4></div></div><p>
There are many editors on Linux and UNIX systems available
the command <tt>$</tt><b>db2ps
mydocument.sgml</b>, after which you can print out or
view the resulting .ps file.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
907798"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
796585"></a>NOTE</h3><p>
The html files you get will not look quite the same as the
documentation distributed with GNOME unless you have the
custom stylesheets installed on your machine. DocBook
<title>My Image</title>
<screenshot>
<screeninfo>Sample GNOME Display</screeninfo>
- <graphic format="png" fileref="myfile" srccredit="me">
+ <graphic format="png" fileref="myfile" srccredit="me">
</graphic>
</screenshot>
</figure>
There are many resources available to help you learn DocBook.
The following resources on the web are useful for learning
DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2908088"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918531"></a>
<a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman
Walsh's <i>DocBook: The Definitive
Guide</i>. Online O'Reilly book on using
DocBook. Contains an excellent element reference. May be
too formal for a beginner.
- </p></li><li style="list-style-type: disc"><p><a name="id2908133"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918577"></a>
<a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a>
- The Open Source Writers Group's introduction to using
DocBook. This is an excellent HOW-TO type article on
getting started.
- </p></li><li style="list-style-type: disc"><p><a name="id2908173"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918619"></a>
<a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for
Hackers</a> - Mark Galassi's introduction to DocBook
for hackers. This has to be one of the first
introductions to DocBook ever - still as good as it ever
was.
- </p></li><li style="list-style-type: disc"><p><a name="id2908213"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918658"></a>
<a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top">
FreeBSD Documentation Project Primer for New
Contributors</a> - FreeBSD documentation project
</p><p>
The following sections of this document are designed to help
documentation authors write correct and consistent DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2908289"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918733"></a>
<a href="#docbookbasics" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
commonly used DocBook tags.
</p></li></ul></div><p>
</p></div><div class="sect3"><a name="screenshotfiles"></a><div class="titlepage"><div><h4 class="title"><a name="screenshotfiles"></a>Screenshot Files</h4></div></div><p>
Screenshots should be kept in the main documentation
directory with your SGML file for applets, or should be
- kept in a directory called "figs" for application and other
+ kept in a directory called "figs" for application and other
documentation. After you use <b>db2html</b> to
convert your SGML file to HTML (see <a href="#make-output" title="Creating Something Useful with your Docs">the section called “Creating Something Useful with your Docs”</a>), you will need to copy your
screenshots (either the individual PNG files for applet
- documentation, or the whole "figs" directory for other
+ documentation, or the whole "figs" directory for other
documentation) into the newly created HTML directory. Note
that every time you use <b>db2html</b> the HTML
directory is erased and rewritten, so do not store your only
CVSROOT=':pserver:anonymous@anoncvs.gnome.org:/cvs/gnome'</b>
and then login with <b>cvs login</b>(there is no
password, just hit return). As an example, we will use the
- "gnome-docu/gdp" module which contains this and several
+ "gnome-docu/gdp" module which contains this and several
other documents. To check these documents out for the first
time, type <b>cvs -z3 checkout
gnome-docu/gdp</b>. After you have this document
to query any part (button, widget, etc.) of an application
window. This is done by either entering a CS Help mode by
clicking on an icon or by right clicking on the application
- part and selecting "What's This" or whatever is decided on
+ part and selecting "What's This" or whatever is decided on
at the time. Context sensitive help is described in more
detail in <a href="#writingcontextsensitivehelp" title="Writing Context Sensitive Help (coming in GNOME-2.0)">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</a>
below.
</p><p>
Using 'content' as the elements to define the text of a document also
allows for search engines to make use of the actual elements to make a
- "smarter search". For example, if you are searching for all documents
- written by the author "Susie" your search engine could be made smart
+ "smarter search". For example, if you are searching for all documents
+ written by the author "Susie" your search engine could be made smart
enough to only search <author> elements, making for a faster and more
accurate search.
</p><p>
ready for this transistion, it is <i>strongly
advised</i> that the documentation writers conform to XML
syntax rules. Here are most important differences:
- </p><div class="variablelist"><dl><dt><a name="id2910725"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2910743"></a>
+ </p><div class="variablelist"><dl><dt><a name="id2921045"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2921063"></a>
It is possible with some implementations of SGML to use
minimizations to close elements in a document by using
</>, for example:
if you are using Emacs with psgml
mode, you can also use menu command
Modify->Normalize.
- </p></dd><dt><a name="id2910856"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2910876"></a>
+ </p></dd><dt><a name="id2921179"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2921197"></a>
Also, in SGML some tags are allowed not to have closing
tags. For example, it is legal for
<tt><xref></tt> not to have a closing tag:
<tt><tt><xref
- linkend="someid"></tt></tt>. In
+ linkend="someid"></tt></tt>. In
XML, it is illegal; instead, you should use
<tt><tt><xref
- linkend="someid"/></tt></tt> (note the
+ linkend="someid"/></tt></tt> (note the
slash!).
- </p></dd><dt><a name="id2910939"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2910958"></a>
+ </p></dd><dt><a name="id2921264"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2921281"></a>
In XML, unlike SGML, tags are case-senstive
<tt><title></tt> and
<tt><TITLE></tt> are different tags!
<pre class="programlisting">
-<figure id="shot1">
+<figure id="shot1">
<title>Screenshot</title>
<screenshot>
<screeninfo>Screenshot of a program</screeninfo>
- <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
+ <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
</graphic>
</screenshot>
</figure>
actual file name (without extension). The result will look like this:
<div class="figure"><p><a name="shot1"></a><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"></p></div></div>
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
11476"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
21804"></a>NOTE</h3><p>
Notice in this example that the screenshot file name does
not include the file type extension -- to find out
why, please read <a href="#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
Note the use of tags <tt><prompt></tt> and
<tt><userinput></tt> for marking system prompt
and commands entered by user.
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
11698"></a>NOTE</h3><p>
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
22020"></a>NOTE</h3><p>
Note that both <tt><programlisting></tt>
and <tt><screen></tt> preserve linebreaks,
but interpret SGML tags (unlike LaTeX
<tt><itemizedlist></tt>,
<tt><orderedlist></tt>, and
<tt><variablelist></tt>.
- </p><div class="variablelist"><dl><dt><a name="id2911815"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2911834"></a>
+ </p><div class="variablelist"><dl><dt><a name="id2922139"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2922158"></a>
This is the simplest unnumbered list, parallel to
<tt><ul></tt> in HTML. Here is an example:
<pre class="programlisting">
<listitem>
<para>
<guilabel>Show hidden files</guilabel> &mdash; This will
- show all "dot files" or files that begin with a dot. This
+ show all "dot files" or files that begin with a dot. This
files typically include configuration files and directories.
</para>
</listitem>
</pre>
and output:
- </p><div class="itemizedlist"><ul><li><p><a name="id2911878"></a>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2922197"></a>
Show backup files --
This will show any backup file that might be on
your system.
- </p></li><li><p><a name="id2911925"></a>
+ </p></li><li><p><a name="id2922257"></a>
Show hidden files --
- This will show all "dot files" or files that
+ This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
- </p></li><li><p><a name="id2911957"></a>
+ </p></li><li><p><a name="id2922289"></a>
Mix files and directories
-- This option will display files and
directories in the order you sort them instead
or -- if none of
this applies -- use
<a href="#gui" title="GUI elements"><tt><emphasis></tt></a>.
- </p></dd><dt><a name="id2912130"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2912148"></a>
+ </p></dd><dt><a name="id2922461"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2922479"></a>
This list is completely analogous to
<tt><itemizedlist></tt> and has the same
syntax, but it produces numbered list. By default,
this list uses Arabic numerals for numbering entries;
you can override this using <tt>numeration</tt>,
for example <tt><orderedlist
- numeration="lowerroman"></tt>. Possible values of
+ numeration="lowerroman"></tt>. Possible values of
these attribute are <tt>arabic</tt>,
<tt>upperalpha</tt>,
<tt>loweralpha</tt>,
<tt>upperroman</tt>,
<tt>lowerroman</tt>.
- </p></dd><dt><a name="id2912228"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2912247"></a> This list is used when each entry is
+ </p></dd><dt><a name="id2922560"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2922579"></a> This list is used when each entry is
rather long, so it should be formatted as a block of text
with some subtitle, like a small subsection. The
<tt><variablelist></tt> is more complicated
are smart enough to change the numeration (for
<tt><orderedlist></tt>) or marks of each entry
(in <tt><itemizedlist></tt>) for sub-lists
- </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2912407"></a>
+ </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2922748"></a>
<tt><guibutton></tt> -- used for
buttons, including checkbuttons and radio buttons
- </p></li><li><p><a name="id2912433"></a>
+ </p></li><li><p><a name="id2922775"></a>
<tt><guimenu></tt>,
<tt><guisubmenu></tt> --used for
top-level menus and submenus
respectively, for example <tt>
<guisubmenu>Utilities</guisubmenu> submenu of the
<guimenu>Main Menu</guimenu></tt>
- </p></li><li><p><a name="id2912484"></a>
+ </p></li><li><p><a name="id2922825"></a>
<tt><guimenuitem></tt>--an entry in a
menu
- </p></li><li><p><a name="id2912507"></a>
+ </p></li><li><p><a name="id2922849"></a>
<tt><guiicon></tt>--an icon
- </p></li><li><p><a name="id2912532"></a>
+ </p></li><li><p><a name="id2922874"></a>
<tt><guilabel></tt>--for items which have
labels, like tabs, or bounding boxes.
- </p></li><li><p><a name="id2912557"></a>
+ </p></li><li><p><a name="id2922899"></a>
<tt><interface></tt>-- for most everything
else... a window, a dialog box, the Panel, etc.
</p></li></ul></div><p>
to (section, figure, etc.), while the second just creates a
link (in HTML output). Here is an example:
<pre class="programlisting">
-An example of a <link linkend="extip">tip</link> was given in
-<xref linkend="notes" />.
+An example of a <link linkend="extip">tip</link> was given in
+<xref linkend="notes" />.
</pre>
which produces: An example of a <a href="#extip">tip</a> was given in <a href="#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a>.
</p><p>
Web page or a local file, use <tt><ulink></tt>
tag, for example:
<pre class="programlisting">
- To find more about GNOME, please visit <ulink type="http"
-url="http://www.gnome.org">GNOME Web page</ulink>
+ To find more about GNOME, please visit <ulink type="http"
+url="http://www.gnome.org">GNOME Web page</ulink>
</pre>
which produces: To find more about GNOME, please visit
<a href="http://www.gnome.org" target="_top">The GNOME Web
computer-related things</h4></div></div><p>
Here are some tags used to describe operating system-related
things:
- </p><div class="itemizedlist"><ul><li><p><a name="id2912952"></a> <tt><filename></tt> -- used
+ </p><div class="itemizedlist"><ul><li><p><a name="id2923288"></a> <tt><filename></tt> -- used
for filenames,
e.g.<tt><filename></tt>
foo.sgml
<tt></filename></tt>
produces: <tt>foo.sgml</tt>.
- </p></li><li><p><a name="id2913007"></a> <tt><filename
- class="directory"></tt> -- used for
+ </p></li><li><p><a name="id2923345"></a> <tt><filename
+ class="directory"></tt> -- used for
directories, e.g.<tt><filename
- class="directory"></tt>/usr/bin
+ class="directory"></tt>/usr/bin
<tt></filename></tt>
produces: <tt>/usr/bin</tt>.
- </p></li><li><p><a name="id2913067"></a>
+ </p></li><li><p><a name="id2923408"></a>
<tt><application></tt> -- used for
application names,
e.g. <tt><application></tt>Gnumeric
<tt></application></tt> produces:
Gnumeric.
- </p></li><li><p><a name="id2913121"></a>
+ </p></li><li><p><a name="id2923463"></a>
<tt><envar></tt> -- used for
environment variables, e.g.
<tt><envar></tt>PATH<tt></envar></tt>.
- </p></li><li><p><a name="id2913162"></a>
+ </p></li><li><p><a name="id2923505"></a>
<tt><command></tt> -- used for
commands entered on command line, e.g.
<tt><command></tt>make install
<tt></command></tt> produces:
<b>make install</b>.
- </p></li><li><p><a name="id2913218"></a>
+ </p></li><li><p><a name="id2923561"></a>
<tt><replaceable></tt> -- used for
replaceable text, e.g.
<tt><command></tt>db2html<tt><replaceable></tt>
is required.
</p><p>
here is partial list of most commonly used enitites:
- </p><div class="itemizedlist"><ul><li><p><a name="id2913689"></a>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2924022"></a>
<tt>&amp;</tt> -- ampersend (&)
- </p></li><li><p><a name="id2913708"></a>
+ </p></li><li><p><a name="id2924043"></a>
<tt>&lt;</tt> -- left angle bracket (<)
- </p></li><li><p><a name="id2913727"></a>
+ </p></li><li><p><a name="id2924062"></a>
<tt>&copy;</tt> -- copyright sign (©)
- </p></li><li><p><a name="id2913746"></a>
+ </p></li><li><p><a name="id2924080"></a>
<tt>&mdash;</tt> -- long dash (--)
- </p></li><li><p><a name="id2913767"></a>
+ </p></li><li><p><a name="id2924106"></a>
<tt>&hellip;</tt> -- ellipsis (...)
</p></li></ul></div><p>
Note that the actual look of the resulting symbols depends
application for which the documentation is written:
<pre class="programlisting">
-<sect1 id="intro">
+<sect1 id="intro">
<title>Introduction</title>
<para>
blah-blah-blah This document describes version 1.0.53 of gfoo.
</p></div><div class="sect3"><a name="license2"></a><div class="titlepage"><div><h4 class="title"><a name="license2"></a>Software license</h4></div></div><p>
All GNOME applications must contain information about the
license (for software, not for documentation), either in the
- "About" box or in the manual.
+ "About" box or in the manual.
</p></div><div class="sect3"><a name="bugtraq"></a><div class="titlepage"><div><h4 class="title"><a name="bugtraq"></a> Bug reporting</h4></div></div><p>
Application documentation should give an address for
reporting bugs and for submitting comments about the
each window or panel presented to the user using screenshots (in
PNG format only) when appropriate. They should also describe
each feature and preference option available.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14212"></a>Documentation Availability</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24548"></a>Documentation Availability</h3><p>
Applications and applets should not rely on documentation
which is only available on the internet. All manuals and
other documentation should be packaged with the application or
the templates in <a href="#template2-1x" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
versions 1.x and the templates in <a href="#template2-2x" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
for GNOME versions 2.x.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14304"></a>Manuals For Large Applications</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24643"></a>Manuals For Large Applications</h3><p>
Manuals for very large applications, such as GNOME Workshop
components should be a <tt><book></tt> (and thus
use <tt><chapter></tt> for each primary section)
, instead of <tt><article></tt> which most
applications use(with each primary section being a
<tt><sect1></tt>).
- </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14362"></a>Applet Manuals in GNOME 2.0</h3><p>
+ </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24700"></a>Applet Manuals in GNOME 2.0</h3><p>
Note that applet manuals in GNOME 2.0 are treated in a special
way. The manuals for all applets are merged into a single
virtual document by Nautilus. For this reason, the header
<tt><sect2></tt>.
</p></div><p>
Application manuals should be made available by having a
- "Manual" entry in the Help pull-down menu
+ "Manual" entry in the Help pull-down menu
at the top of the
application, as described in <a href="#listingdocsinhelpmenu" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
Applets should make their manuals available by
right-clicking on the applet.
- </p></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14482"></a>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24823"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
application's name. The application documentation (converted
from SGML into HTML with <b>db2html</b>) should be
placed in this directory too.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14671"></a>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25011"></a>Note</h3><p>
If the help files are not present in the correct directory, the
menu items will NOT appear when the program is run.
</p></div><p>
<pre class="programlisting">
GnomeUIInfo helpmenu[] = {
{GNOME_APP_UI_ITEM,
- N_("About"), N_("Info about this program"),
+ N_("About"), N_("Info about this program"),
about_cb, NULL, NULL,
GNOME_APP_PIXMAP_STOCK, GNOME_STOCK_MENU_ABOUT,
0, 0, NULL},
GNOMEUIINFO_SEPARATOR,
- GNOMEUIINFO_HELP("<i>appname</i>"),
+ GNOMEUIINFO_HELP("<i>appname</i>"),
GNOMEUIINFO_END
};
</pre>
Help menu. When the user selects any of these
topics from the Help menu, a help browser
will be started with the associated HTML documentation.
- </p></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14837"></a>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25176"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
Browser the developer should add code based on the following example:
</p><pre class="programlisting">
gchar *tmp;
-tmp = gnome_help_file_find_file ("module", "page.html");
+tmp = gnome_help_file_find_file ("module", "page.html");
if (tmp) {
gnome_help_goto(0, tmp);
g_free(tmp);
}
- </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14973"></a>NOTE</h3><p>
+ </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25314"></a>NOTE</h3><p>
The example above is in the C language, please refer to other
documentation or forums for other GNOME language bindings.
</p></div></div><div class="sect1"><a name="packagingappletdocs"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="packagingappletdocs"></a>Packaging Applet Documentation</h2></div></div><div class="sect2"><a name="appletfiles"></a><div class="titlepage"><div><h3 class="title"><a name="appletfiles"></a>Applet Documentation Files</h3></div></div><p>
of the <i>GNOME Applets</i> book, you must
remember to add <tt><legalnotice></tt> and
<tt><copyright></tt> sections.
- </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
15220"></a>Developer Information</h3><p>
+ </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25561"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
To add an applet's manual to its applet menu, use:
<pre class="programlisting">
/* add an item to the applet menu */
-applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
-_("Manual"), &open_manual, NULL);
+applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
+_("Manual"), &open_manual, NULL);
</pre>
Here the second argument is an arbitrary name for the
callback, the third argument is the label which will appear
item to the applet's menu. This is a
stock menu item and is done:
<pre class="programlisting">
-applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
- GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
+applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
+ GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
NULL);
</pre>
</p><p>
More information can be found at <a href="http://developer.gnome.org/doc/tutorials/applet/index.html" target="_top">Writing
GNOME panel applets using the GTK+/GTK-- widget set</a>.
</p></div></div><div class="sect1"><a name="writingcontextsensitivehelp"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="writingcontextsensitivehelp"></a>Writing Context Sensitive Help (coming in GNOME-2.0)</h2></div></div><p>
- Context sensitive help, also known as "pop-up" help, will allow
+ Context sensitive help, also known as "pop-up" help, will allow
a user to obtain help information about specific buttons or
parts of an application.
</p><p>
developer to give an id to a particular portion of the User
Interface, for example, a button. Once the interface is complete
a Perl script can then be run against the interface code to
- create a "map" file. This map file allows the developer or
+ create a "map" file. This map file allows the developer or
writer to associate particular paragraph sections from an XML
document to the interface items.
</p><p>
user launches context sensitive help on the interface (either by
pressing a button and then clicking on the interface item they
want information on, or by right mouse clicking on the interface
- item and selecting a pop-up menu item like "What's This") a
+ item and selecting a pop-up menu item like "What's This") a
small transient window will appear with brief but detailed
information on the interface item.
</p></div><div class="sect1"><a name="referring"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="referring"></a>Referring to Other GNOME Documentation (coming in
</p></div><div class="sect2"><a name="balance"></a><div class="titlepage"><div><h3 class="title"><a name="balance"></a>Achieving a Balanced Style</h3></div></div><p>
Just as you need to juggle expert and novice readers,
you'll have to juggle a number of other extremes as you write:
- <div class="itemizedlist"><ul><li><p><a name="id2915765"></a>
+ <div class="itemizedlist"><ul><li><p><a name="id2926120"></a>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
you spend fewer words on the obvious, you can spend more
time clarifying the ambiguous labels and explaining
items that are more complex.
- </p></li><li><p><a name="id2915792"></a>
+ </p></li><li><p><a name="id2926147"></a>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
maintain a standard of style which holds the reader's
interest without resorting to jokes and untranslatable
allusions or puns.
- </p></li><li><p><a name="id2915831"></a>
+ </p></li><li><p><a name="id2926185"></a>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
It's good to provide a screenshot of any dialog windows
a user might run into, but if a dialog box has several
tabs, it's not usually necessary to have one for each.
- </p></li><li><p><a name="id2915855"></a>
+ </p></li><li><p><a name="id2926209"></a>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
bug reports, writers must check for errors in their documents.
Poor grammar, bad spelling, and gross technical errors in
draft documents are fine. However, if those problems show up
- in a "real" release, they can count against the credibility of
+ in a "real" release, they can count against the credibility of
GNOME and Linux. They'll also make you look bad.
</p><p>
There is no substitute for a human proofreader; use a
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!-- if not using PNG graphic, replace reference above with
- .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
+ .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
-->
-<!ENTITY version "1.0.53">
+<!ENTITY version "1.0.53">
<!-- replace version above with actual application version number-->
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged.
Remember that this is a guide, rather than a perfect model to follow
<!-- =============Document Header ============================= -->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<artheader>
<title>MY-GNOME-APP</title>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
- Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
to: Free Software Foundation, Inc., 59 Temple Place - Suite
330, Boston, MA 02111-1307, USA.
</para>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
- <sect1 id="intro">
+ <sect1 id="intro">
<title>Introduction</title>
<para>
<!-- ================ Usage ================================ -->
<!-- This section should describe basic usage of the application. -->
- <sect1 id="usage">
+ <sect1 id="usage">
<title>Using MY-GNOME-APP</title>
<para>
<application>MY-GNOME-APP</application> can be used to produce a
</para>
<!-- ========= Basic Usage =========================== -->
- <sect2 id="mainwin">
+ <sect2 id="mainwin">
<title>Basic usage</title>
<para>
Starting <application>MY-GNOME-APP</application> opens the
<interface>Main window</interface>, shown in <xref
- linkend="mainwindow-fig">. The window is at first empty.
+ linkend="mainwindow-fig">. The window is at first empty.
<!-- ==== Figure ==== -->
- <figure id="mainwindow-fig">
+ <figure id="mainwindow-fig">
<title>MY-GNOME-APP Main Window</title>
<screenshot>
<screeninfo>MY-GNOME-APP Main Window</screeninfo>
- <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
</graphic>
</screenshot>
</figure>
</para>
- <!-- For this app, one could put "proving" or "edit" (probably even
+ <!-- For this app, one could put "proving" or "edit" (probably even
both of them) as sect2's seperate from the main window
section. Since they were both so closely involved with the main
window, I decided to have them as sect3's isntead. Judgement
call. -->
- <sect3 id="proving">
+ <sect3 id="proving">
<title>Proving a Theorem</title>
<para>
To get a proof of a theorem, select
</para>
</warning>
</sect3>
- <sect3 id="editing">
+ <sect3 id="editing">
<title>Editing Proofs</title>
<para>
Once you have proven the theorem, it will be displayed in
============================================================= -->
- <sect2 id="toolbar">
+ <sect2 id="toolbar">
<title>Toolbar</title>
<para>
- The toolbar (shown in <xref linkend="figure-usage-toolbar">)
+ The toolbar (shown in <xref linkend="figure-usage-toolbar">)
provides access to several commonly used routines.
- <figure id="figure-usage-toolbar">
+ <figure id="figure-usage-toolbar">
<title>MY-GNOME-APP Toolbar</title>
<screenshot>
<screeninfo>MY-GNOME-APP Toolbar</screeninfo>
- <graphic fileref="usage-toolbar.png" format="png"></graphic>
+ <graphic fileref="usage-toolbar.png" format="png"></graphic>
</screenshot>
</figure>
<variablelist>
</sect2>
<!-- ========= Menus =========================== -->
- <sect2 id="menubar">
+ <sect2 id="menubar">
<!-- Describing the menubar ensures comprehensive feature
coverage. Nest itemizedlists inside variablelists so that each
<para>
<guimenuitem>Preferences&hellip;</guimenuitem>
&mdash; This opens the <link
- linkend="prefs"><interface>Preferences
+ linkend="prefs"><interface>Preferences
Dialog</interface></link>, which allows you to configure
many settings.
</para>
<!-- ============= Customization ============================= -->
- <sect1 id="prefs">
+ <sect1 id="prefs">
<title>Customization</title>
<para>
To change the application settings, select
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>. This opens the
<interface>Preferences</interface> dialog, shown in <xref
- linkend="preferences-fig">.
+ linkend="preferences-fig">.
</para>
- <figure id="preferences-fig">
+ <figure id="preferences-fig">
<title>Preferences Dialog</title>
<screenshot>
<screeninfo>Preferences Dialog</screeninfo>
- <graphic fileref="SCREENSHOT" format="png"
- srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png"
+ srccredit="ME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of. -->
- <sect1 id="bugs">
+ <sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This application has no known bugs.
<!-- ============= Authors ================================ -->
- <sect1 id="authors">
+ <sect1 id="authors">
<title>Authors</title>
<para>
<application>MY-GNOME-APP</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). To find more information about
<application>MY-GNOME-APP</application>, please visit the <ulink
- url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+ url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
page</ulink>. Please send all comments, suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>.) You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also add your comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect1 id="license">
+ <sect1 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
- <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+ <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged,make sure to add/remove trademarks to the list as
appropriate for your document.
thanks ;-).
-->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<!-- ============= Document Header ============================= -->
<artheader>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
by the Free Software Foundation with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
of the <citetitle>GNU Free Documentation License</citetitle> from
- the Free Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
</para>
<!-- Template Version: 1.0.1 (do not remove this line) -->
- <sect1 id="APPLET">
+ <sect1 id="APPLET">
<title>APPLET Applet</title>
<para>
<application>APPLET</application> applet, shown in <xref
- linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
+ linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
applet to a <interface>Panel</interface>,
right-click on the <interface>Panel</interface> and choose
<menuchoice>
</menuchoice>.
</para>
- <figure id="APPLETapplet-fig">
+ <figure id="APPLETapplet-fig">
<title>APPLET Applet</title>
<screenshot>
<screeninfo>APPLET Applet</screeninfo>
- <graphic format="png" fileref="APPLET_applet"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_applet"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- ============= Usage ================================ -->
- <sect2 id="APPLET-usage">
+ <sect2 id="APPLET-usage">
<title>Usage</title>
<para>
(Place a short description of how to use the applet here.)
<listitem>
<para>
<guimenuitem>Properties&hellip;</guimenuitem> &mdash;
- opens the <link linkend="APPLET-prefs">
+ opens the <link linkend="APPLET-prefs">
<guilabel>Properties</guilabel></link> dialog.
</para>
</listitem>
<!-- ============= Customization ============================= -->
- <sect2 id="APPLET-prefs">
+ <sect2 id="APPLET-prefs">
<title>Customization</title>
<para>
You can customize <application>APPLET</application>
applet by right-clicking on it and choosing
<guimenuitem>Properties&hellip;</guimenuitem>. This will open the
<interface>Properties</interface> dialog(shown in <xref
- linkend="APPLET-settings-fig">), which allows you to
+ linkend="APPLET-settings-fig">), which allows you to
change various settings.
</para>
- <figure id="APPLET-settings-fig">
+ <figure id="APPLET-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
- <graphic format="png" fileref="APPLET_settings"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_settings"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of -->
- <sect2 id="bugs">
+ <sect2 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This applet has no known bugs.
<!-- ============= Authors ================================ -->
- <sect2 id="authors">
+ <sect2 id="authors">
<title>Authors</title>
<para>
<application>APPLET</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). Please send all comments,
suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>. You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also submit comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
Status Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect2 id="license">
+ <sect2 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
</p><p>
<pre class="programlisting">
-<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
-<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
+<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
]>
-<book id="gnome-applets">
+<book id="gnome-applets">
<bookinfo>
<title>GNOME Applets</title>
</bookinfo>
<!-- #### Introduction ###### -->
- <chapter id="applets-intro">
+ <chapter id="applets-intro">
<title>Introduction</title>
<!-- #### Intro | What Are Applets? ###### -->
- <sect1 id="applets-what-are">
+ <sect1 id="applets-what-are">
<title>What Are Applets?</title>
<para>
Applets are one of the most popular and useful objects you can add
</para>
<para>
- <figure id="example-applets-fig">
+ <figure id="example-applets-fig">
<title>Example Applets</title>
<screenshot>
<screeninfo>Example Applets</screeninfo>
- <graphic fileref="example_applets" format="png"
- srccredit="muet">
+ <graphic fileref="example_applets" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
Several example applets are shown in <xref
- linkend="example-applets-fig">. From left to right, they are: (1)
+ linkend="example-applets-fig">. From left to right, they are: (1)
<application>Mixer Applet</application>, which allows you to turn
on/off sound and control its volume by clicking on the applet. (2)
<application>Sound Monitor</application> Applet, which displays
<interface>Panels</interface> and using them. The following
chapters go through each of the standard GNOME applets describing
them in detail. There are also additional applets which can be
- downloaded off the Web. See <ulink type="http"
- url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
+ downloaded off the Web. See <ulink type="http"
+ url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
Software Map</ulink> for lists of additional GNOME applications
and applets.
</para>
</sect1>
<!-- #### Intro | Adding, Moving, and Removing Applets ###### -->
- <sect1 id="applet-add-move-replace">
+ <sect1 id="applet-add-move-replace">
<title>Adding, Moving, and Removing Applets</title>
- <sect2 id="adding-applets">
+ <sect2 id="adding-applets">
<title>Adding Applets to a Panel</title>
<para>
To add an applet to a <interface>Panel</interface>, right-click
</para>
</sect2>
- <sect2 id="moving-applets">
+ <sect2 id="moving-applets">
<title>Moving Applets In or Between Panels</title>
<para>
It is easy to move applets in a <interface>Panel</interface> or
other objects, the behavior depends on the global preferences
you have set for your <interface>Panels</interface> in the
<application>GNOME Control Center</application>: the applet you are
- moving can switch places with other objects, "push" all objects
- it meets, or "jump" over all other objects without disturbing
+ moving can switch places with other objects, "push" all objects
+ it meets, or "jump" over all other objects without disturbing
them. You can also override the default behavior by holding
- <keycap>Shift</keycap> button (for "push" mode),
- <keycap>Ctrl</keycap> (for "switched" mode), or
- <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
+ <keycap>Shift</keycap> button (for "push" mode),
+ <keycap>Ctrl</keycap> (for "switched" mode), or
+ <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
objects without disturbing them) button while dragging.
</para>
<para>
</para>
</sect2>
- <sect2 id="removing-applets">
+ <sect2 id="removing-applets">
<title>Removing Applets from a Panel</title>
<para>
To remove an applet from a <interface>Panel</interface>,
<!-- #### Intro | The Right-Click Pop-Up Menu ###### -->
- <sect1 id="right-click-pop-up-menu">
+ <sect1 id="right-click-pop-up-menu">
<title>The Right-Click Pop-Up Menu</title>
<para>
Clicking the right mouse button on any applet brings up
often has additional items which vary depending on the particular
applet.
</para>
- <sect2 id="standard-right-click-items">
+ <sect2 id="standard-right-click-items">
<title>Standard Pop-Up Items</title>
<para>
All applets should have the following items in their right-click
</para>
</sect2>
- <sect2 id="applet-properties-dialog">
+ <sect2 id="applet-properties-dialog">
<title>The Applet Properties Dialog</title>
<para>
Many applets have customizable properties. These applets will
right-click <guimenu>pop-up menu</guimenu> which brings up the
<interface>Properties</interface> dialog where you can alter the
appearance or behaviour of the applet.
- <figure id="example-props-dialog-fig">
+ <figure id="example-props-dialog-fig">
<title>An Example Applet Properties Dialog</title>
<screenshot>
<screeninfo>An Example Applets Properties Dialog</screeninfo>
- <graphic fileref="applet_props_dialog" format="png"
- srccredit="muet">
+ <graphic fileref="applet_props_dialog" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
</para>
</sect2>
- <sect2 id="common-right-click-items">
+ <sect2 id="common-right-click-items">
<title>Other Common Pop-Up Items</title>
<para>
Many applets also have one or more of the following items in their
</sect2>
</sect1>
- <sect1 id="feedback">
+ <sect1 id="feedback">
<title>Feedback</title>
- <sect2 id="reporting-bugs">
+ <sect2 id="reporting-bugs">
<title>Reporting Applet Bugs</title>
<para>
- GNOME users are encouraged to report bugs to <ulink type="http"
- url="http://bugs.gnome.org">The GNOME Bug Tracking
+ GNOME users are encouraged to report bugs to <ulink type="http"
+ url="http://bugs.gnome.org">The GNOME Bug Tracking
System</ulink>. The easiest way to submit bugs is to use the
<application>Bug Report Tool</application> program by selecting
<menuchoice>
reproduce the the scenario.
</para>
</sect2>
- <sect2 id="documentation-feedback">
+ <sect2 id="documentation-feedback">
<title>Providing Feedback</title>
<para>
GNOME users are welcome to provide suggestions for how
<application>Bug Report Tool</application> discussed above.
Suggestions for documentation changes can be emailed directly to
the documentation author (whose email should be included in the
- "Authors" section of the document) or by sending an email to
+ "Authors" section of the document) or by sending an email to
<email>docs@gnome.org</email>.
</para>
</sect2>
- <sect2 id="joining-gnome">
+ <sect2 id="joining-gnome">
<title>Joining GNOME</title>
<para>
GNOME is a community project, created by hundreds of programmers,
documentation writers, icon design artists, web masters, and
other people, most of whom work on a volunteer basis. New GNOME
contributors are always welcome. To join the GNOME team, visit
- these web sites: developers &mdash; <ulink type="http"
- url="http://developer.gnome.org">The GNOME Development
- Site</ulink>, documentation writers &mdash; <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
- Project</ulink>, icon design artists &mdash; <ulink type="http"
- url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
- general &mdash; <ulink type="http"
- url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
- or just join the gnome-list email list (see <ulink type="http"
- url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
+ these web sites: developers &mdash; <ulink type="http"
+ url="http://developer.gnome.org">The GNOME Development
+ Site</ulink>, documentation writers &mdash; <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
+ Project</ulink>, icon design artists &mdash; <ulink type="http"
+ url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
+ general &mdash; <ulink type="http"
+ url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
+ or just join the gnome-list email list (see <ulink type="http"
+ url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
Lists</ulink>) to discuss what you are interested in doing.
</para>
</sect2>
</chapter>
<!-- ############### Template Applets ##################### -->
- <chapter id="template-applets">
+ <chapter id="template-applets">
<title>Template Applets</title>
&TEMPLATE-APPLET
<!-- stated in a translation approved by the Foundation. -->
<!-- ############### GNOMEAPPLET ############### -->
- <sect1 id="GNOMEAPPLET">
+ <sect1 id="GNOMEAPPLET">
<title>GNOMEAPPLET Applet</title>
<para>
<application>GNOMEAPPLET</application> applet, shown in <xref
- linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
+ linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
add this applet to a <interface>Panel</interface>, see <xref
- linkend="adding-applets">.
+ linkend="adding-applets">.
</para>
- <figure id="GNOMEAPPLET-fig">
+ <figure id="GNOMEAPPLET-fig">
<title>GNOMEAPPLET</title>
<screenshot>
<screeninfo>GNOMEAPPLET</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
</graphic>
</screenshot>
</figure>
- <sect2 id="GNOMEAPPLET-usage">
+ <sect2 id="GNOMEAPPLET-usage">
<title>Usage</title>
<para>
This applet does nothing. To use it, just
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-right-click">
+ <sect2 id="GNOMEAPPLET-right-click">
<title>Right-Click Pop-Up Menu Items</title>
<para>
In addition to the standard menu items (see <xref
- linkend="standard-right-click-items">), the right-click pop-up menu has
+ linkend="standard-right-click-items">), the right-click pop-up menu has
the following items:
<itemizedlist>
<listitem>
<para>
<guimenuitem>Properties...</guimenuitem> &mdash; This menu
item opens the <interface>Properties</interface> dialog (see
- <xref linkend="GNOMEAPPLET-properties">) which allows you to
+ <xref linkend="GNOMEAPPLET-properties">) which allows you to
customize the appearance and behavior of this applet.
</para>
</listitem>
<para>
<guimenuitem>Run Hello World...</guimenuitem> &mdash; This
menu item starts the program <application>Hello
- World</application>, used to say "hello" to the world.
+ World</application>, used to say "hello" to the world.
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-properties">
+ <sect2 id="GNOMEAPPLET-properties">
<title>Properties</title>
<para>
You can configure <application>GNOMEAPPLET</application> applet by
right-clicking on the applet and choosing the
<guimenuitem>Properties...</guimenuitem> menu item. This will open the
<interface>Properties</interface> dialog, shown in <xref
- linkend="GNOMEAPPLET-properties-fig">.
+ linkend="GNOMEAPPLET-properties-fig">.
</para>
- <figure id="GNOMEAPPLET-properties-fig">
+ <figure id="GNOMEAPPLET-properties-fig">
<title>Properties Dialog</title>
<screenshot>
<screeninfo>Properties Dialog</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
</graphic>
</screenshot>
</figure>
dialog, including descriptions of the <guibutton>OK</guibutton>,
<guibutton>Apply</guibutton>, <guibutton>Cancel</guibutton>, and
<guibutton>Help</guibutton> buttons, see <xref
- linkend="applet-properties-dialog">.
+ linkend="applet-properties-dialog">.
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-bugs">
+ <sect2 id="GNOMEAPPLET-bugs">
<title> Known Bugs and Limitations</title>
<para>
There are no known bugs in the
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-authors">
+ <sect2 id="GNOMEAPPLET-authors">
<title>Authors</title>
<para>
This applet was writen by HACKER-NAME
which you are reading now was written by
YOUR-NAME <email>YOUR-EMAIL</email>. For information on submitting
bug reports and suggestions for improvements, see <xref
- linkend="feedback">.
+ linkend="feedback">.
</para>
</sect2>
irc.gnome.org is another option for contacting GDP members.
</p></div></div><div class="sect2"><a name="notation"/><div class="titlepage"><div><h3 class="title"><a name="notation"/>Notation and Conventions</h3></div></div><p>
This Handbook uses the following notation:
- <div class="informaltable" id="id2
880946"><a name="id2880946"/><table border="0"><colgroup><col/><col/></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
+ <div class="informaltable" id="id2
797668"><a name="id2797668"/><table border="0"><colgroup><col/><col/></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
Directory
</td></tr><tr><td><tt>foo.sgml</tt></td><td>
Filename
help. The <i>DocTable</i> also allows
people to make announcements and suggestions and to discuss
issues in the comments section.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
87350"/>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
95537"/>Note</h3><p>
Note that the information in the
<i>DocTable</i> may not always be up-to-date
or accurate. When you assign yourself to documenting an
this for documentation, not least of which is the single
source nature of SGML. To contribute to the GDP you should
learn to use DocBook.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
87436"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id27
95620"/>NOTE</h3><p>
To get started writing for the GDP you do not need to rush
out and learn DocBook - if you feel it is too much to handle
for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top">
your output document appearance subtly vary between the two
DTD's. To install the GDP custom DTD with PNG image support
by hand:
- </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2787838"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2796033"/>
Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the
GDP DocBook DTD for PNG support</a> and install it
where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that
the 3.0 DTD is missing support for the
<tt><legalnotice></tt> tag, so it is
recommended that you use version 3.1
- </p></li><li style="list-style-type: disc"><p><a name="id2788168"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2796096"/>
Add the new DTD to your SGML CATALOG file. The location
of your SGML CATALOG file may vary depending upon your
distribution. (On Red Hat it is usually in
the command <tt>$</tt><b>db2ps
mydocument.sgml</b>, after which you can print out or
view the resulting .ps file.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
907932"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
796573"/>NOTE</h3><p>
The html files you get will not look quite the same as the
documentation distributed with GNOME unless you have the
custom stylesheets installed on your machine. DocBook
There are many resources available to help you learn DocBook.
The following resources on the web are useful for learning
DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2908222"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918692"/>
<a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman
Walsh's <i>DocBook: The Definitive
Guide</i>. Online O'Reilly book on using
DocBook. Contains an excellent element reference. May be
too formal for a beginner.
- </p></li><li style="list-style-type: disc"><p><a name="id2908268"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918739"/>
<a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a>
- The Open Source Writers Group's introduction to using
DocBook. This is an excellent HOW-TO type article on
getting started.
- </p></li><li style="list-style-type: disc"><p><a name="id2908308"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918780"/>
<a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for
Hackers</a> - Mark Galassi's introduction to DocBook
for hackers. This has to be one of the first
introductions to DocBook ever - still as good as it ever
was.
- </p></li><li style="list-style-type: disc"><p><a name="id2908348"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2918819"/>
<a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top">
FreeBSD Documentation Project Primer for New
Contributors</a> - FreeBSD documentation project
</p><p>
The following sections of this document are designed to help
documentation authors write correct and consistent DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2908423"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918894"/>
<a href="#docbookbasics" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
commonly used DocBook tags.
</p></li></ul></div><p>
ready for this transistion, it is <i>strongly
advised</i> that the documentation writers conform to XML
syntax rules. Here are most important differences:
- </p><div class="variablelist"><dl><dt><a name="id2910860"/><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2910878"/>
+ </p><div class="variablelist"><dl><dt><a name="id2921205"/><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2921223"/>
It is possible with some implementations of SGML to use
minimizations to close elements in a document by using
</>, for example:
if you are using Emacs with psgml
mode, you can also use menu command
Modify->Normalize.
- </p></dd><dt><a name="id2910991"/><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2911010"/>
+ </p></dd><dt><a name="id2921339"/><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2921357"/>
Also, in SGML some tags are allowed not to have closing
tags. For example, it is legal for
<tt><xref></tt> not to have a closing tag:
<tt><tt><xref
linkend="someid"/></tt></tt> (note the
slash!).
- </p></dd><dt><a name="id2911074"/><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2911092"/>
+ </p></dd><dt><a name="id2921424"/><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2921441"/>
In XML, unlike SGML, tags are case-senstive
<tt><title></tt> and
<tt><TITLE></tt> are different tags!
actual file name (without extension). The result will look like this:
<div class="figure"><p><a name="shot1"/><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"/></p></div></div>
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
11611"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
21964"/>NOTE</h3><p>
Notice in this example that the screenshot file name does
not include the file type extension -- to find out
why, please read <a href="#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
Note the use of tags <tt><prompt></tt> and
<tt><userinput></tt> for marking system prompt
and commands entered by user.
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
11833"/>NOTE</h3><p>
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
22180"/>NOTE</h3><p>
Note that both <tt><programlisting></tt>
and <tt><screen></tt> preserve linebreaks,
but interpret SGML tags (unlike LaTeX
<tt><itemizedlist></tt>,
<tt><orderedlist></tt>, and
<tt><variablelist></tt>.
- </p><div class="variablelist"><dl><dt><a name="id2911950"/><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2911969"/>
+ </p><div class="variablelist"><dl><dt><a name="id2922298"/><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2922318"/>
This is the simplest unnumbered list, parallel to
<tt><ul></tt> in HTML. Here is an example:
<pre class="programlisting">
</pre>
and output:
- </p><div class="itemizedlist"><ul><li><p><a name="id2912012"/>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2922357"/>
Show backup files --
This will show any backup file that might be on
your system.
- </p></li><li><p><a name="id2912060"/>
+ </p></li><li><p><a name="id2922417"/>
Show hidden files --
This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
- </p></li><li><p><a name="id2912092"/>
+ </p></li><li><p><a name="id2922449"/>
Mix files and directories
-- This option will display files and
directories in the order you sort them instead
or -- if none of
this applies -- use
<a href="#gui" title="GUI elements"><tt><emphasis></tt></a>.
- </p></dd><dt><a name="id2912265"/><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2912283"/>
+ </p></dd><dt><a name="id2922620"/><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2922639"/>
This list is completely analogous to
<tt><itemizedlist></tt> and has the same
syntax, but it produces numbered list. By default,
<tt>loweralpha</tt>,
<tt>upperroman</tt>,
<tt>lowerroman</tt>.
- </p></dd><dt><a name="id2912363"/><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2912382"/> This list is used when each entry is
+ </p></dd><dt><a name="id2922720"/><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2922739"/> This list is used when each entry is
rather long, so it should be formatted as a block of text
with some subtitle, like a small subsection. The
<tt><variablelist></tt> is more complicated
are smart enough to change the numeration (for
<tt><orderedlist></tt>) or marks of each entry
(in <tt><itemizedlist></tt>) for sub-lists
- </p></div></div><div class="sect2"><a name="inline"/><div class="titlepage"><div><h3 class="title"><a name="inline"/>Inline Elements</h3></div></div><div class="sect3"><a name="gui"/><div class="titlepage"><div><h4 class="title"><a name="gui"/>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2912542"/>
+ </p></div></div><div class="sect2"><a name="inline"/><div class="titlepage"><div><h3 class="title"><a name="inline"/>Inline Elements</h3></div></div><div class="sect3"><a name="gui"/><div class="titlepage"><div><h4 class="title"><a name="gui"/>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2922909"/>
<tt><guibutton></tt> -- used for
buttons, including checkbuttons and radio buttons
- </p></li><li><p><a name="id2912568"/>
+ </p></li><li><p><a name="id2922935"/>
<tt><guimenu></tt>,
<tt><guisubmenu></tt> --used for
top-level menus and submenus
respectively, for example <tt>
<guisubmenu>Utilities</guisubmenu> submenu of the
<guimenu>Main Menu</guimenu></tt>
- </p></li><li><p><a name="id2912619"/>
+ </p></li><li><p><a name="id2922985"/>
<tt><guimenuitem></tt>--an entry in a
menu
- </p></li><li><p><a name="id2912642"/>
+ </p></li><li><p><a name="id2923009"/>
<tt><guiicon></tt>--an icon
- </p></li><li><p><a name="id2912666"/>
+ </p></li><li><p><a name="id2923034"/>
<tt><guilabel></tt>--for items which have
labels, like tabs, or bounding boxes.
- </p></li><li><p><a name="id2912692"/>
+ </p></li><li><p><a name="id2923060"/>
<tt><interface></tt>-- for most everything
else... a window, a dialog box, the Panel, etc.
</p></li></ul></div><p>
computer-related things</h4></div></div><p>
Here are some tags used to describe operating system-related
things:
- </p><div class="itemizedlist"><ul><li><p><a name="id2913087"/> <tt><filename></tt> -- used
+ </p><div class="itemizedlist"><ul><li><p><a name="id2923447"/> <tt><filename></tt> -- used
for filenames,
e.g.<tt><filename></tt>
foo.sgml
<tt></filename></tt>
produces: <tt>foo.sgml</tt>.
- </p></li><li><p><a name="id2913141"/> <tt><filename
+ </p></li><li><p><a name="id2923504"/> <tt><filename
class="directory"></tt> -- used for
directories, e.g.<tt><filename
class="directory"></tt>/usr/bin
<tt></filename></tt>
produces: <tt>/usr/bin</tt>.
- </p></li><li><p><a name="id2913201"/>
+ </p></li><li><p><a name="id2923567"/>
<tt><application></tt> -- used for
application names,
e.g. <tt><application></tt>Gnumeric
<tt></application></tt> produces:
Gnumeric.
- </p></li><li><p><a name="id2913256"/>
+ </p></li><li><p><a name="id2923622"/>
<tt><envar></tt> -- used for
environment variables, e.g.
<tt><envar></tt>PATH<tt></envar></tt>.
- </p></li><li><p><a name="id2913297"/>
+ </p></li><li><p><a name="id2923664"/>
<tt><command></tt> -- used for
commands entered on command line, e.g.
<tt><command></tt>make install
<tt></command></tt> produces:
<b>make install</b>.
- </p></li><li><p><a name="id2913353"/>
+ </p></li><li><p><a name="id2923721"/>
<tt><replaceable></tt> -- used for
replaceable text, e.g.
<tt><command></tt>db2html<tt><replaceable></tt>
is required.
</p><p>
here is partial list of most commonly used enitites:
- </p><div class="itemizedlist"><ul><li><p><a name="id2913824"/>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2924181"/>
<tt>&amp;</tt> -- ampersend (&)
- </p></li><li><p><a name="id2913843"/>
+ </p></li><li><p><a name="id2924202"/>
<tt>&lt;</tt> -- left angle bracket (<)
- </p></li><li><p><a name="id2913862"/>
+ </p></li><li><p><a name="id2924221"/>
<tt>&copy;</tt> -- copyright sign (©)
- </p></li><li><p><a name="id2913880"/>
+ </p></li><li><p><a name="id2924239"/>
<tt>&mdash;</tt> -- long dash (--)
- </p></li><li><p><a name="id2913902"/>
+ </p></li><li><p><a name="id2924265"/>
<tt>&hellip;</tt> -- ellipsis (...)
</p></li></ul></div><p>
Note that the actual look of the resulting symbols depends
each window or panel presented to the user using screenshots (in
PNG format only) when appropriate. They should also describe
each feature and preference option available.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14346"/>Documentation Availability</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24708"/>Documentation Availability</h3><p>
Applications and applets should not rely on documentation
which is only available on the internet. All manuals and
other documentation should be packaged with the application or
the templates in <a href="#template2-1x" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
versions 1.x and the templates in <a href="#template2-2x" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
for GNOME versions 2.x.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14439"/>Manuals For Large Applications</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24802"/>Manuals For Large Applications</h3><p>
Manuals for very large applications, such as GNOME Workshop
components should be a <tt><book></tt> (and thus
use <tt><chapter></tt> for each primary section)
, instead of <tt><article></tt> which most
applications use(with each primary section being a
<tt><sect1></tt>).
- </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14497"/>Applet Manuals in GNOME 2.0</h3><p>
+ </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24860"/>Applet Manuals in GNOME 2.0</h3><p>
Note that applet manuals in GNOME 2.0 are treated in a special
way. The manuals for all applets are merged into a single
virtual document by Nautilus. For this reason, the header
application, as described in <a href="#listingdocsinhelpmenu" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
Applets should make their manuals available by
right-clicking on the applet.
- </p></div><div class="sect1"><a name="listingdocsinhelpmenu"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"/>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14617"/>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="listingdocsinhelpmenu"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"/>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
24983"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
application's name. The application documentation (converted
from SGML into HTML with <b>db2html</b>) should be
placed in this directory too.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14806"/>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25171"/>Note</h3><p>
If the help files are not present in the correct directory, the
menu items will NOT appear when the program is run.
</p></div><p>
Help menu. When the user selects any of these
topics from the Help menu, a help browser
will be started with the associated HTML documentation.
- </p></div><div class="sect1"><a name="applicationhelpbuttons"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"/>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
14972"/>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="applicationhelpbuttons"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"/>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25335"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
gnome_help_goto(0, tmp);
g_free(tmp);
}
- </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
15108"/>NOTE</h3><p>
+ </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25473"/>NOTE</h3><p>
The example above is in the C language, please refer to other
documentation or forums for other GNOME language bindings.
</p></div></div><div class="sect1"><a name="packagingappletdocs"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="packagingappletdocs"/>Packaging Applet Documentation</h2></div></div><div class="sect2"><a name="appletfiles"/><div class="titlepage"><div><h3 class="title"><a name="appletfiles"/>Applet Documentation Files</h3></div></div><p>
of the <i>GNOME Applets</i> book, you must
remember to add <tt><legalnotice></tt> and
<tt><copyright></tt> sections.
- </p></div><div class="sect2"><a name="appletmenu"/><div class="titlepage"><div><h3 class="title"><a name="appletmenu"/>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
15355"/>Developer Information</h3><p>
+ </p></div><div class="sect2"><a name="appletmenu"/><div class="titlepage"><div><h3 class="title"><a name="appletmenu"/>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25721"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
</p></div><div class="sect2"><a name="balance"/><div class="titlepage"><div><h3 class="title"><a name="balance"/>Achieving a Balanced Style</h3></div></div><p>
Just as you need to juggle expert and novice readers,
you'll have to juggle a number of other extremes as you write:
- <div class="itemizedlist"><ul><li><p><a name="id2915900"/>
+ <div class="itemizedlist"><ul><li><p><a name="id2926279"/>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
you spend fewer words on the obvious, you can spend more
time clarifying the ambiguous labels and explaining
items that are more complex.
- </p></li><li><p><a name="id2915927"/>
+ </p></li><li><p><a name="id2926306"/>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
maintain a standard of style which holds the reader's
interest without resorting to jokes and untranslatable
allusions or puns.
- </p></li><li><p><a name="id2915966"/>
+ </p></li><li><p><a name="id2926345"/>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
It's good to provide a screenshot of any dialog windows
a user might run into, but if a dialog box has several
tabs, it's not usually necessary to have one for each.
- </p></li><li><p><a name="id2915990"/>
+ </p></li><li><p><a name="id2926368"/>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!-- if not using PNG graphic, replace reference above with
- .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
+ .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
-->
-<!ENTITY version "1.0.53">
+<!ENTITY version "1.0.53">
<!-- replace version above with actual application version number-->
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged.
Remember that this is a guide, rather than a perfect model to follow
<!-- =============Document Header ============================= -->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<artheader>
<title>MY-GNOME-APP</title>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
- Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
to: Free Software Foundation, Inc., 59 Temple Place - Suite
330, Boston, MA 02111-1307, USA.
</para>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
- <sect1 id="intro">
+ <sect1 id="intro">
<title>Introduction</title>
<para>
<!-- ================ Usage ================================ -->
<!-- This section should describe basic usage of the application. -->
- <sect1 id="usage">
+ <sect1 id="usage">
<title>Using MY-GNOME-APP</title>
<para>
<application>MY-GNOME-APP</application> can be used to produce a
</para>
<!-- ========= Basic Usage =========================== -->
- <sect2 id="mainwin">
+ <sect2 id="mainwin">
<title>Basic usage</title>
<para>
Starting <application>MY-GNOME-APP</application> opens the
<interface>Main window</interface>, shown in <xref
- linkend="mainwindow-fig">. The window is at first empty.
+ linkend="mainwindow-fig">. The window is at first empty.
<!-- ==== Figure ==== -->
- <figure id="mainwindow-fig">
+ <figure id="mainwindow-fig">
<title>MY-GNOME-APP Main Window</title>
<screenshot>
<screeninfo>MY-GNOME-APP Main Window</screeninfo>
- <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
</graphic>
</screenshot>
</figure>
</para>
- <!-- For this app, one could put "proving" or "edit" (probably even
+ <!-- For this app, one could put "proving" or "edit" (probably even
both of them) as sect2's seperate from the main window
section. Since they were both so closely involved with the main
window, I decided to have them as sect3's isntead. Judgement
call. -->
- <sect3 id="proving">
+ <sect3 id="proving">
<title>Proving a Theorem</title>
<para>
To get a proof of a theorem, select
</para>
</warning>
</sect3>
- <sect3 id="editing">
+ <sect3 id="editing">
<title>Editing Proofs</title>
<para>
Once you have proven the theorem, it will be displayed in
============================================================= -->
- <sect2 id="toolbar">
+ <sect2 id="toolbar">
<title>Toolbar</title>
<para>
- The toolbar (shown in <xref linkend="figure-usage-toolbar">)
+ The toolbar (shown in <xref linkend="figure-usage-toolbar">)
provides access to several commonly used routines.
- <figure id="figure-usage-toolbar">
+ <figure id="figure-usage-toolbar">
<title>MY-GNOME-APP Toolbar</title>
<screenshot>
<screeninfo>MY-GNOME-APP Toolbar</screeninfo>
- <graphic fileref="usage-toolbar.png" format="png"></graphic>
+ <graphic fileref="usage-toolbar.png" format="png"></graphic>
</screenshot>
</figure>
<variablelist>
</sect2>
<!-- ========= Menus =========================== -->
- <sect2 id="menubar">
+ <sect2 id="menubar">
<!-- Describing the menubar ensures comprehensive feature
coverage. Nest itemizedlists inside variablelists so that each
<para>
<guimenuitem>Preferences&hellip;</guimenuitem>
&mdash; This opens the <link
- linkend="prefs"><interface>Preferences
+ linkend="prefs"><interface>Preferences
Dialog</interface></link>, which allows you to configure
many settings.
</para>
<!-- ============= Customization ============================= -->
- <sect1 id="prefs">
+ <sect1 id="prefs">
<title>Customization</title>
<para>
To change the application settings, select
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>. This opens the
<interface>Preferences</interface> dialog, shown in <xref
- linkend="preferences-fig">.
+ linkend="preferences-fig">.
</para>
- <figure id="preferences-fig">
+ <figure id="preferences-fig">
<title>Preferences Dialog</title>
<screenshot>
<screeninfo>Preferences Dialog</screeninfo>
- <graphic fileref="SCREENSHOT" format="png"
- srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png"
+ srccredit="ME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of. -->
- <sect1 id="bugs">
+ <sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This application has no known bugs.
<!-- ============= Authors ================================ -->
- <sect1 id="authors">
+ <sect1 id="authors">
<title>Authors</title>
<para>
<application>MY-GNOME-APP</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). To find more information about
<application>MY-GNOME-APP</application>, please visit the <ulink
- url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+ url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
page</ulink>. Please send all comments, suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>.) You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also add your comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect1 id="license">
+ <sect1 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
- <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+ <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged,make sure to add/remove trademarks to the list as
appropriate for your document.
thanks ;-).
-->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<!-- ============= Document Header ============================= -->
<artheader>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
by the Free Software Foundation with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
of the <citetitle>GNU Free Documentation License</citetitle> from
- the Free Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
</para>
<!-- Template Version: 1.0.1 (do not remove this line) -->
- <sect1 id="APPLET">
+ <sect1 id="APPLET">
<title>APPLET Applet</title>
<para>
<application>APPLET</application> applet, shown in <xref
- linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
+ linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
applet to a <interface>Panel</interface>,
right-click on the <interface>Panel</interface> and choose
<menuchoice>
</menuchoice>.
</para>
- <figure id="APPLETapplet-fig">
+ <figure id="APPLETapplet-fig">
<title>APPLET Applet</title>
<screenshot>
<screeninfo>APPLET Applet</screeninfo>
- <graphic format="png" fileref="APPLET_applet"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_applet"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- ============= Usage ================================ -->
- <sect2 id="APPLET-usage">
+ <sect2 id="APPLET-usage">
<title>Usage</title>
<para>
(Place a short description of how to use the applet here.)
<listitem>
<para>
<guimenuitem>Properties&hellip;</guimenuitem> &mdash;
- opens the <link linkend="APPLET-prefs">
+ opens the <link linkend="APPLET-prefs">
<guilabel>Properties</guilabel></link> dialog.
</para>
</listitem>
<!-- ============= Customization ============================= -->
- <sect2 id="APPLET-prefs">
+ <sect2 id="APPLET-prefs">
<title>Customization</title>
<para>
You can customize <application>APPLET</application>
applet by right-clicking on it and choosing
<guimenuitem>Properties&hellip;</guimenuitem>. This will open the
<interface>Properties</interface> dialog(shown in <xref
- linkend="APPLET-settings-fig">), which allows you to
+ linkend="APPLET-settings-fig">), which allows you to
change various settings.
</para>
- <figure id="APPLET-settings-fig">
+ <figure id="APPLET-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
- <graphic format="png" fileref="APPLET_settings"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_settings"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of -->
- <sect2 id="bugs">
+ <sect2 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This applet has no known bugs.
<!-- ============= Authors ================================ -->
- <sect2 id="authors">
+ <sect2 id="authors">
<title>Authors</title>
<para>
<application>APPLET</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). Please send all comments,
suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>. You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also submit comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
Status Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect2 id="license">
+ <sect2 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
</p><p>
<pre class="programlisting">
-<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
-<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
+<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
]>
-<book id="gnome-applets">
+<book id="gnome-applets">
<bookinfo>
<title>GNOME Applets</title>
</bookinfo>
<!-- #### Introduction ###### -->
- <chapter id="applets-intro">
+ <chapter id="applets-intro">
<title>Introduction</title>
<!-- #### Intro | What Are Applets? ###### -->
- <sect1 id="applets-what-are">
+ <sect1 id="applets-what-are">
<title>What Are Applets?</title>
<para>
Applets are one of the most popular and useful objects you can add
</para>
<para>
- <figure id="example-applets-fig">
+ <figure id="example-applets-fig">
<title>Example Applets</title>
<screenshot>
<screeninfo>Example Applets</screeninfo>
- <graphic fileref="example_applets" format="png"
- srccredit="muet">
+ <graphic fileref="example_applets" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
Several example applets are shown in <xref
- linkend="example-applets-fig">. From left to right, they are: (1)
+ linkend="example-applets-fig">. From left to right, they are: (1)
<application>Mixer Applet</application>, which allows you to turn
on/off sound and control its volume by clicking on the applet. (2)
<application>Sound Monitor</application> Applet, which displays
<interface>Panels</interface> and using them. The following
chapters go through each of the standard GNOME applets describing
them in detail. There are also additional applets which can be
- downloaded off the Web. See <ulink type="http"
- url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
+ downloaded off the Web. See <ulink type="http"
+ url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
Software Map</ulink> for lists of additional GNOME applications
and applets.
</para>
</sect1>
<!-- #### Intro | Adding, Moving, and Removing Applets ###### -->
- <sect1 id="applet-add-move-replace">
+ <sect1 id="applet-add-move-replace">
<title>Adding, Moving, and Removing Applets</title>
- <sect2 id="adding-applets">
+ <sect2 id="adding-applets">
<title>Adding Applets to a Panel</title>
<para>
To add an applet to a <interface>Panel</interface>, right-click
</para>
</sect2>
- <sect2 id="moving-applets">
+ <sect2 id="moving-applets">
<title>Moving Applets In or Between Panels</title>
<para>
It is easy to move applets in a <interface>Panel</interface> or
other objects, the behavior depends on the global preferences
you have set for your <interface>Panels</interface> in the
<application>GNOME Control Center</application>: the applet you are
- moving can switch places with other objects, "push" all objects
- it meets, or "jump" over all other objects without disturbing
+ moving can switch places with other objects, "push" all objects
+ it meets, or "jump" over all other objects without disturbing
them. You can also override the default behavior by holding
- <keycap>Shift</keycap> button (for "push" mode),
- <keycap>Ctrl</keycap> (for "switched" mode), or
- <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
+ <keycap>Shift</keycap> button (for "push" mode),
+ <keycap>Ctrl</keycap> (for "switched" mode), or
+ <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
objects without disturbing them) button while dragging.
</para>
<para>
</para>
</sect2>
- <sect2 id="removing-applets">
+ <sect2 id="removing-applets">
<title>Removing Applets from a Panel</title>
<para>
To remove an applet from a <interface>Panel</interface>,
<!-- #### Intro | The Right-Click Pop-Up Menu ###### -->
- <sect1 id="right-click-pop-up-menu">
+ <sect1 id="right-click-pop-up-menu">
<title>The Right-Click Pop-Up Menu</title>
<para>
Clicking the right mouse button on any applet brings up
often has additional items which vary depending on the particular
applet.
</para>
- <sect2 id="standard-right-click-items">
+ <sect2 id="standard-right-click-items">
<title>Standard Pop-Up Items</title>
<para>
All applets should have the following items in their right-click
</para>
</sect2>
- <sect2 id="applet-properties-dialog">
+ <sect2 id="applet-properties-dialog">
<title>The Applet Properties Dialog</title>
<para>
Many applets have customizable properties. These applets will
right-click <guimenu>pop-up menu</guimenu> which brings up the
<interface>Properties</interface> dialog where you can alter the
appearance or behaviour of the applet.
- <figure id="example-props-dialog-fig">
+ <figure id="example-props-dialog-fig">
<title>An Example Applet Properties Dialog</title>
<screenshot>
<screeninfo>An Example Applets Properties Dialog</screeninfo>
- <graphic fileref="applet_props_dialog" format="png"
- srccredit="muet">
+ <graphic fileref="applet_props_dialog" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
</para>
</sect2>
- <sect2 id="common-right-click-items">
+ <sect2 id="common-right-click-items">
<title>Other Common Pop-Up Items</title>
<para>
Many applets also have one or more of the following items in their
</sect2>
</sect1>
- <sect1 id="feedback">
+ <sect1 id="feedback">
<title>Feedback</title>
- <sect2 id="reporting-bugs">
+ <sect2 id="reporting-bugs">
<title>Reporting Applet Bugs</title>
<para>
- GNOME users are encouraged to report bugs to <ulink type="http"
- url="http://bugs.gnome.org">The GNOME Bug Tracking
+ GNOME users are encouraged to report bugs to <ulink type="http"
+ url="http://bugs.gnome.org">The GNOME Bug Tracking
System</ulink>. The easiest way to submit bugs is to use the
<application>Bug Report Tool</application> program by selecting
<menuchoice>
reproduce the the scenario.
</para>
</sect2>
- <sect2 id="documentation-feedback">
+ <sect2 id="documentation-feedback">
<title>Providing Feedback</title>
<para>
GNOME users are welcome to provide suggestions for how
<application>Bug Report Tool</application> discussed above.
Suggestions for documentation changes can be emailed directly to
the documentation author (whose email should be included in the
- "Authors" section of the document) or by sending an email to
+ "Authors" section of the document) or by sending an email to
<email>docs@gnome.org</email>.
</para>
</sect2>
- <sect2 id="joining-gnome">
+ <sect2 id="joining-gnome">
<title>Joining GNOME</title>
<para>
GNOME is a community project, created by hundreds of programmers,
documentation writers, icon design artists, web masters, and
other people, most of whom work on a volunteer basis. New GNOME
contributors are always welcome. To join the GNOME team, visit
- these web sites: developers &mdash; <ulink type="http"
- url="http://developer.gnome.org">The GNOME Development
- Site</ulink>, documentation writers &mdash; <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
- Project</ulink>, icon design artists &mdash; <ulink type="http"
- url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
- general &mdash; <ulink type="http"
- url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
- or just join the gnome-list email list (see <ulink type="http"
- url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
+ these web sites: developers &mdash; <ulink type="http"
+ url="http://developer.gnome.org">The GNOME Development
+ Site</ulink>, documentation writers &mdash; <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
+ Project</ulink>, icon design artists &mdash; <ulink type="http"
+ url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
+ general &mdash; <ulink type="http"
+ url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
+ or just join the gnome-list email list (see <ulink type="http"
+ url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
Lists</ulink>) to discuss what you are interested in doing.
</para>
</sect2>
</chapter>
<!-- ############### Template Applets ##################### -->
- <chapter id="template-applets">
+ <chapter id="template-applets">
<title>Template Applets</title>
&TEMPLATE-APPLET
<!-- stated in a translation approved by the Foundation. -->
<!-- ############### GNOMEAPPLET ############### -->
- <sect1 id="GNOMEAPPLET">
+ <sect1 id="GNOMEAPPLET">
<title>GNOMEAPPLET Applet</title>
<para>
<application>GNOMEAPPLET</application> applet, shown in <xref
- linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
+ linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
add this applet to a <interface>Panel</interface>, see <xref
- linkend="adding-applets">.
+ linkend="adding-applets">.
</para>
- <figure id="GNOMEAPPLET-fig">
+ <figure id="GNOMEAPPLET-fig">
<title>GNOMEAPPLET</title>
<screenshot>
<screeninfo>GNOMEAPPLET</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
</graphic>
</screenshot>
</figure>
- <sect2 id="GNOMEAPPLET-usage">
+ <sect2 id="GNOMEAPPLET-usage">
<title>Usage</title>
<para>
This applet does nothing. To use it, just
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-right-click">
+ <sect2 id="GNOMEAPPLET-right-click">
<title>Right-Click Pop-Up Menu Items</title>
<para>
In addition to the standard menu items (see <xref
- linkend="standard-right-click-items">), the right-click pop-up menu has
+ linkend="standard-right-click-items">), the right-click pop-up menu has
the following items:
<itemizedlist>
<listitem>
<para>
<guimenuitem>Properties...</guimenuitem> &mdash; This menu
item opens the <interface>Properties</interface> dialog (see
- <xref linkend="GNOMEAPPLET-properties">) which allows you to
+ <xref linkend="GNOMEAPPLET-properties">) which allows you to
customize the appearance and behavior of this applet.
</para>
</listitem>
<para>
<guimenuitem>Run Hello World...</guimenuitem> &mdash; This
menu item starts the program <application>Hello
- World</application>, used to say "hello" to the world.
+ World</application>, used to say "hello" to the world.
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-properties">
+ <sect2 id="GNOMEAPPLET-properties">
<title>Properties</title>
<para>
You can configure <application>GNOMEAPPLET</application> applet by
right-clicking on the applet and choosing the
<guimenuitem>Properties...</guimenuitem> menu item. This will open the
<interface>Properties</interface> dialog, shown in <xref
- linkend="GNOMEAPPLET-properties-fig">.
+ linkend="GNOMEAPPLET-properties-fig">.
</para>
- <figure id="GNOMEAPPLET-properties-fig">
+ <figure id="GNOMEAPPLET-properties-fig">
<title>Properties Dialog</title>
<screenshot>
<screeninfo>Properties Dialog</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
</graphic>
</screenshot>
</figure>
dialog, including descriptions of the <guibutton>OK</guibutton>,
<guibutton>Apply</guibutton>, <guibutton>Cancel</guibutton>, and
<guibutton>Help</guibutton> buttons, see <xref
- linkend="applet-properties-dialog">.
+ linkend="applet-properties-dialog">.
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-bugs">
+ <sect2 id="GNOMEAPPLET-bugs">
<title> Known Bugs and Limitations</title>
<para>
There are no known bugs in the
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-authors">
+ <sect2 id="GNOMEAPPLET-authors">
<title>Authors</title>
<para>
This applet was writen by HACKER-NAME
which you are reading now was written by
YOUR-NAME <email>YOUR-EMAIL</email>. For information on submitting
bug reports and suggestions for improvements, see <xref
- linkend="feedback">.
+ linkend="feedback">.
</para>
</sect2>
irc.gnome.org is another option for contacting GDP members.
</p></div></div><div class="sect2"><a name="notation"></a><div class="titlepage"><div><h3 class="title"><a name="notation"></a>Notation and Conventions</h3></div></div><p>
This Handbook uses the following notation:
- <div class="informaltable" id="id28
07857"><a name="id2807857"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
+ <div class="informaltable" id="id28
14391"><a name="id2814391"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
Directory
</td></tr><tr><td><tt>foo.sgml</tt></td><td>
Filename
</td></tr><tr><td><b>command</b></td><td>
Command or text that would be typed.
</td></tr><tr><td><b><i><tt>replaceable</tt></i></b></td><td>
- "Variable" text that can be replaced.
+ "Variable" text that can be replaced.
</td></tr><tr><td><tt>Program or Doc Code</tt></td><td>Program or document code</td></tr></tbody></table></div>
</p></div><div class="sect2"><a name="about"></a><div class="titlepage"><div><h3 class="title"><a name="about"></a>About This Handbook</h3></div></div><p>
This Handbook is a guide for both writing documentation for
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Getting Started Writing GNOME Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="next" href="indexs03.html" title="The GNOME Documentation System"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Getting Started Writing GNOME Documentation</th></tr><tr><td width="20%" align="left"><a href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs03.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="gettingstarted"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="gettingstarted"></a>Getting Started Writing GNOME Documentation</h2></div></div><div class="sect2"><a name="selecting"></a><div class="titlepage"><div><h3 class="title"><a name="selecting"></a>Selecting A Document</h3></div></div><div class="sect3"><a name="know"></a><div class="titlepage"><div><h4 class="title"><a name="know"></a>Document Something You Know</h4></div></div><p>
The most frequently asked question of new contributors who
- join the GDP is "which document should I start
- with?". Because most people involved are volunteers, we do
+ join the GDP is "which document should I start
+ with?". Because most people involved are volunteers, we do
not <i>assign</i> projects and applications to
write documents for. The first step is all yours - you must
decide what about GNOME interests you most and find out if
help. The <i>DocTable</i> also allows
people to make announcements and suggestions and to discuss
issues in the comments section.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id28
01402"></a>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id28
10555"></a>Note</h3><p>
Note that the information in the
<i>DocTable</i> may not always be up-to-date
or accurate. When you assign yourself to documenting an
this for documentation, not least of which is the single
source nature of SGML. To contribute to the GDP you should
learn to use DocBook.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id28
01489"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id28
10638"></a>NOTE</h3><p>
To get started writing for the GDP you do not need to rush
out and learn DocBook - if you feel it is too much to handle
for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top">
your output document appearance subtly vary between the two
DTD's. To install the GDP custom DTD with PNG image support
by hand:
- </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2801874"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2811052"></a>
Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the
GDP DocBook DTD for PNG support</a> and install it
where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that
the 3.0 DTD is missing support for the
<tt><legalnotice></tt> tag, so it is
recommended that you use version 3.1
- </p></li><li style="list-style-type: disc"><p><a name="id2802204"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2811114"></a>
Add the new DTD to your SGML CATALOG file. The location
of your SGML CATALOG file may vary depending upon your
distribution. (On Red Hat it is usually in
/usr/lib/sgml/CATALOG.) Add the following line to this
file:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
</pre>
If you are using the 3.1 DTD, use:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
</pre>
</p></li></ul></div><p>
Alternately, you can download and install the
</p><p>
Articles:
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p><p>
Books:
<pre class="programlisting">
-<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p></div><div class="sect3"><a name="editors"></a><div class="titlepage"><div><h4 class="title"><a name="editors"></a>Editors</h4></div></div><p>
There are many editors on Linux and UNIX systems available
the command <tt>$</tt><b>db2ps
mydocument.sgml</b>, after which you can print out or
view the resulting .ps file.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
922151"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
811592"></a>NOTE</h3><p>
The html files you get will not look quite the same as the
documentation distributed with GNOME unless you have the
custom stylesheets installed on your machine. DocBook
<title>My Image</title>
<screenshot>
<screeninfo>Sample GNOME Display</screeninfo>
- <graphic format="png" fileref="myfile" srccredit="me">
+ <graphic format="png" fileref="myfile" srccredit="me">
</graphic>
</screenshot>
</figure>
There are many resources available to help you learn DocBook.
The following resources on the web are useful for learning
DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2922441"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2933577"></a>
<a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman
Walsh's <i>DocBook: The Definitive
Guide</i>. Online O'Reilly book on using
DocBook. Contains an excellent element reference. May be
too formal for a beginner.
- </p></li><li style="list-style-type: disc"><p><a name="id2922486"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2933624"></a>
<a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a>
- The Open Source Writers Group's introduction to using
DocBook. This is an excellent HOW-TO type article on
getting started.
- </p></li><li style="list-style-type: disc"><p><a name="id2922526"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2933666"></a>
<a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for
Hackers</a> - Mark Galassi's introduction to DocBook
for hackers. This has to be one of the first
introductions to DocBook ever - still as good as it ever
was.
- </p></li><li style="list-style-type: disc"><p><a name="id2922566"></a>
+ </p></li><li style="list-style-type: disc"><p><a name="id2933704"></a>
<a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top">
FreeBSD Documentation Project Primer for New
Contributors</a> - FreeBSD documentation project
</p><p>
The following sections of this document are designed to help
documentation authors write correct and consistent DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2922642"></a>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2933779"></a>
<a href="indexs04.html" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
commonly used DocBook tags.
</p></li></ul></div><p>
</p></div><div class="sect3"><a name="screenshotfiles"></a><div class="titlepage"><div><h4 class="title"><a name="screenshotfiles"></a>Screenshot Files</h4></div></div><p>
Screenshots should be kept in the main documentation
directory with your SGML file for applets, or should be
- kept in a directory called "figs" for application and other
+ kept in a directory called "figs" for application and other
documentation. After you use <b>db2html</b> to
convert your SGML file to HTML (see <a href="indexs02.html#make-output" title="Creating Something Useful with your Docs">the section called “Creating Something Useful with your Docs”</a>), you will need to copy your
screenshots (either the individual PNG files for applet
- documentation, or the whole "figs" directory for other
+ documentation, or the whole "figs" directory for other
documentation) into the newly created HTML directory. Note
that every time you use <b>db2html</b> the HTML
directory is erased and rewritten, so do not store your only
CVSROOT=':pserver:anonymous@anoncvs.gnome.org:/cvs/gnome'</b>
and then login with <b>cvs login</b>(there is no
password, just hit return). As an example, we will use the
- "gnome-docu/gdp" module which contains this and several
+ "gnome-docu/gdp" module which contains this and several
other documents. To check these documents out for the first
time, type <b>cvs -z3 checkout
gnome-docu/gdp</b>. After you have this document
to query any part (button, widget, etc.) of an application
window. This is done by either entering a CS Help mode by
clicking on an icon or by right clicking on the application
- part and selecting "What's This" or whatever is decided on
+ part and selecting "What's This" or whatever is decided on
at the time. Context sensitive help is described in more
detail in <a href="indexs10.html" title="Writing Context Sensitive Help (coming in GNOME-2.0)">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</a>
below.
</p><p>
Using 'content' as the elements to define the text of a document also
allows for search engines to make use of the actual elements to make a
- "smarter search". For example, if you are searching for all documents
- written by the author "Susie" your search engine could be made smart
+ "smarter search". For example, if you are searching for all documents
+ written by the author "Susie" your search engine could be made smart
enough to only search <author> elements, making for a faster and more
accurate search.
</p><p>
ready for this transistion, it is <i>strongly
advised</i> that the documentation writers conform to XML
syntax rules. Here are most important differences:
- </p><div class="variablelist"><dl><dt><a name="id2925078"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2925097"></a>
+ </p><div class="variablelist"><dl><dt><a name="id2936091"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2936110"></a>
It is possible with some implementations of SGML to use
minimizations to close elements in a document by using
</>, for example:
if you are using Emacs with psgml
mode, you can also use menu command
Modify->Normalize.
- </p></dd><dt><a name="id2925210"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2925229"></a>
+ </p></dd><dt><a name="id2936225"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2936244"></a>
Also, in SGML some tags are allowed not to have closing
tags. For example, it is legal for
<tt><xref></tt> not to have a closing tag:
<tt><tt><xref
- linkend="someid"></tt></tt>. In
+ linkend="someid"></tt></tt>. In
XML, it is illegal; instead, you should use
<tt><tt><xref
- linkend="someid"/></tt></tt> (note the
+ linkend="someid"/></tt></tt> (note the
slash!).
- </p></dd><dt><a name="id2925293"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2925311"></a>
+ </p></dd><dt><a name="id2936311"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2936327"></a>
In XML, unlike SGML, tags are case-senstive
<tt><title></tt> and
<tt><TITLE></tt> are different tags!
<pre class="programlisting">
-<figure id="shot1">
+<figure id="shot1">
<title>Screenshot</title>
<screenshot>
<screeninfo>Screenshot of a program</screeninfo>
- <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
+ <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
</graphic>
</screenshot>
</figure>
actual file name (without extension). The result will look like this:
<div class="figure"><p><a name="shot1"></a><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"></p></div></div>
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
25829"></a>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
36851"></a>NOTE</h3><p>
Notice in this example that the screenshot file name does
not include the file type extension -- to find out
why, please read <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
Note the use of tags <tt><prompt></tt> and
<tt><userinput></tt> for marking system prompt
and commands entered by user.
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
26052"></a>NOTE</h3><p>
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
37067"></a>NOTE</h3><p>
Note that both <tt><programlisting></tt>
and <tt><screen></tt> preserve linebreaks,
but interpret SGML tags (unlike LaTeX
<tt><itemizedlist></tt>,
<tt><orderedlist></tt>, and
<tt><variablelist></tt>.
- </p><div class="variablelist"><dl><dt><a name="id2926168"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2926188"></a>
+ </p><div class="variablelist"><dl><dt><a name="id2937185"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2937205"></a>
This is the simplest unnumbered list, parallel to
<tt><ul></tt> in HTML. Here is an example:
<pre class="programlisting">
<listitem>
<para>
<guilabel>Show hidden files</guilabel> &mdash; This will
- show all "dot files" or files that begin with a dot. This
+ show all "dot files" or files that begin with a dot. This
files typically include configuration files and directories.
</para>
</listitem>
</pre>
and output:
- </p><div class="itemizedlist"><ul><li><p><a name="id2926231"></a>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2937244"></a>
Show backup files --
This will show any backup file that might be on
your system.
- </p></li><li><p><a name="id2926278"></a>
+ </p></li><li><p><a name="id2937304"></a>
Show hidden files --
- This will show all "dot files" or files that
+ This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
- </p></li><li><p><a name="id2926310"></a>
+ </p></li><li><p><a name="id2937335"></a>
Mix files and directories
-- This option will display files and
directories in the order you sort them instead
or -- if none of
this applies -- use
<a href="indexs04.html#gui" title="GUI elements"><tt><emphasis></tt></a>.
- </p></dd><dt><a name="id2926483"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2926502"></a>
+ </p></dd><dt><a name="id2937507"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2937525"></a>
This list is completely analogous to
<tt><itemizedlist></tt> and has the same
syntax, but it produces numbered list. By default,
this list uses Arabic numerals for numbering entries;
you can override this using <tt>numeration</tt>,
for example <tt><orderedlist
- numeration="lowerroman"></tt>. Possible values of
+ numeration="lowerroman"></tt>. Possible values of
these attribute are <tt>arabic</tt>,
<tt>upperalpha</tt>,
<tt>loweralpha</tt>,
<tt>upperroman</tt>,
<tt>lowerroman</tt>.
- </p></dd><dt><a name="id2926582"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2926600"></a> This list is used when each entry is
+ </p></dd><dt><a name="id2937607"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2937625"></a> This list is used when each entry is
rather long, so it should be formatted as a block of text
with some subtitle, like a small subsection. The
<tt><variablelist></tt> is more complicated
are smart enough to change the numeration (for
<tt><orderedlist></tt>) or marks of each entry
(in <tt><itemizedlist></tt>) for sub-lists
- </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2926761"></a>
+ </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2937796"></a>
<tt><guibutton></tt> -- used for
buttons, including checkbuttons and radio buttons
- </p></li><li><p><a name="id2926786"></a>
+ </p></li><li><p><a name="id2937822"></a>
<tt><guimenu></tt>,
<tt><guisubmenu></tt> --used for
top-level menus and submenus
respectively, for example <tt>
<guisubmenu>Utilities</guisubmenu> submenu of the
<guimenu>Main Menu</guimenu></tt>
- </p></li><li><p><a name="id2926837"></a>
+ </p></li><li><p><a name="id2937872"></a>
<tt><guimenuitem></tt>--an entry in a
menu
- </p></li><li><p><a name="id2926860"></a>
+ </p></li><li><p><a name="id2937896"></a>
<tt><guiicon></tt>--an icon
- </p></li><li><p><a name="id2926885"></a>
+ </p></li><li><p><a name="id2937921"></a>
<tt><guilabel></tt>--for items which have
labels, like tabs, or bounding boxes.
- </p></li><li><p><a name="id2926910"></a>
+ </p></li><li><p><a name="id2937946"></a>
<tt><interface></tt>-- for most everything
else... a window, a dialog box, the Panel, etc.
</p></li></ul></div><p>
to (section, figure, etc.), while the second just creates a
link (in HTML output). Here is an example:
<pre class="programlisting">
-An example of a <link linkend="extip">tip</link> was given in
-<xref linkend="notes" />.
+An example of a <link linkend="extip">tip</link> was given in
+<xref linkend="notes" />.
</pre>
which produces: An example of a <a href="indexs04.html#extip">tip</a> was given in <a href="indexs04.html#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a>.
</p><p>
Web page or a local file, use <tt><ulink></tt>
tag, for example:
<pre class="programlisting">
- To find more about GNOME, please visit <ulink type="http"
-url="http://www.gnome.org">GNOME Web page</ulink>
+ To find more about GNOME, please visit <ulink type="http"
+url="http://www.gnome.org">GNOME Web page</ulink>
</pre>
which produces: To find more about GNOME, please visit
<a href="http://www.gnome.org" target="_top">The GNOME Web
computer-related things</h4></div></div><p>
Here are some tags used to describe operating system-related
things:
- </p><div class="itemizedlist"><ul><li><p><a name="id2927306"></a> <tt><filename></tt> -- used
+ </p><div class="itemizedlist"><ul><li><p><a name="id2938334"></a> <tt><filename></tt> -- used
for filenames,
e.g.<tt><filename></tt>
foo.sgml
<tt></filename></tt>
produces: <tt>foo.sgml</tt>.
- </p></li><li><p><a name="id2927360"></a> <tt><filename
- class="directory"></tt> -- used for
+ </p></li><li><p><a name="id2938391"></a> <tt><filename
+ class="directory"></tt> -- used for
directories, e.g.<tt><filename
- class="directory"></tt>/usr/bin
+ class="directory"></tt>/usr/bin
<tt></filename></tt>
produces: <tt>/usr/bin</tt>.
- </p></li><li><p><a name="id2927420"></a>
+ </p></li><li><p><a name="id2938454"></a>
<tt><application></tt> -- used for
application names,
e.g. <tt><application></tt>Gnumeric
<tt></application></tt> produces:
Gnumeric.
- </p></li><li><p><a name="id2927475"></a>
+ </p></li><li><p><a name="id2938509"></a>
<tt><envar></tt> -- used for
environment variables, e.g.
<tt><envar></tt>PATH<tt></envar></tt>.
- </p></li><li><p><a name="id2927515"></a>
+ </p></li><li><p><a name="id2938551"></a>
<tt><command></tt> -- used for
commands entered on command line, e.g.
<tt><command></tt>make install
<tt></command></tt> produces:
<b>make install</b>.
- </p></li><li><p><a name="id2927571"></a>
+ </p></li><li><p><a name="id2938607"></a>
<tt><replaceable></tt> -- used for
replaceable text, e.g.
<tt><command></tt>db2html<tt><replaceable></tt>
is required.
</p><p>
here is partial list of most commonly used enitites:
- </p><div class="itemizedlist"><ul><li><p><a name="id2928042"></a>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2939068"></a>
<tt>&amp;</tt> -- ampersend (&)
- </p></li><li><p><a name="id2928061"></a>
+ </p></li><li><p><a name="id2939089"></a>
<tt>&lt;</tt> -- left angle bracket (<)
- </p></li><li><p><a name="id2928080"></a>
+ </p></li><li><p><a name="id2939108"></a>
<tt>&copy;</tt> -- copyright sign (©)
- </p></li><li><p><a name="id2928099"></a>
+ </p></li><li><p><a name="id2939126"></a>
<tt>&mdash;</tt> -- long dash (--)
- </p></li><li><p><a name="id2928120"></a>
+ </p></li><li><p><a name="id2939152"></a>
<tt>&hellip;</tt> -- ellipsis (...)
</p></li></ul></div><p>
Note that the actual look of the resulting symbols depends
application for which the documentation is written:
<pre class="programlisting">
-<sect1 id="intro">
+<sect1 id="intro">
<title>Introduction</title>
<para>
blah-blah-blah This document describes version 1.0.53 of gfoo.
</p></div><div class="sect3"><a name="license2"></a><div class="titlepage"><div><h4 class="title"><a name="license2"></a>Software license</h4></div></div><p>
All GNOME applications must contain information about the
license (for software, not for documentation), either in the
- "About" box or in the manual.
+ "About" box or in the manual.
</p></div><div class="sect3"><a name="bugtraq"></a><div class="titlepage"><div><h4 class="title"><a name="bugtraq"></a> Bug reporting</h4></div></div><p>
Application documentation should give an address for
reporting bugs and for submitting comments about the
each window or panel presented to the user using screenshots (in
PNG format only) when appropriate. They should also describe
each feature and preference option available.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
28565"></a>Documentation Availability</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
39595"></a>Documentation Availability</h3><p>
Applications and applets should not rely on documentation
which is only available on the internet. All manuals and
other documentation should be packaged with the application or
the templates in <a href="apas02.html" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
versions 1.x and the templates in <a href="apas03.html" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
for GNOME versions 2.x.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
28657"></a>Manuals For Large Applications</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
39689"></a>Manuals For Large Applications</h3><p>
Manuals for very large applications, such as GNOME Workshop
components should be a <tt><book></tt> (and thus
use <tt><chapter></tt> for each primary section)
, instead of <tt><article></tt> which most
applications use(with each primary section being a
<tt><sect1></tt>).
- </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
28715"></a>Applet Manuals in GNOME 2.0</h3><p>
+ </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
39746"></a>Applet Manuals in GNOME 2.0</h3><p>
Note that applet manuals in GNOME 2.0 are treated in a special
way. The manuals for all applets are merged into a single
virtual document by Nautilus. For this reason, the header
<tt><sect2></tt>.
</p></div><p>
Application manuals should be made available by having a
- "Manual" entry in the Help pull-down menu
+ "Manual" entry in the Help pull-down menu
at the top of the
application, as described in <a href="indexs07.html" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
Applets should make their manuals available by
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Listing Documents in the Help Menu</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs06.html" title="Writing Application and Applet Manuals"><link rel="next" href="indexs08.html" title="Application Help Buttons"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Listing Documents in the Help Menu</th></tr><tr><td width="20%" align="left"><a href="indexs06.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs08.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
28836"></a>Developer Information</h3><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Listing Documents in the Help Menu</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs06.html" title="Writing Application and Applet Manuals"><link rel="next" href="indexs08.html" title="Application Help Buttons"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Listing Documents in the Help Menu</th></tr><tr><td width="20%" align="left"><a href="indexs06.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs08.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
39869"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
application's name. The application documentation (converted
from SGML into HTML with <b>db2html</b>) should be
placed in this directory too.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
29024"></a>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
40058"></a>Note</h3><p>
If the help files are not present in the correct directory, the
menu items will NOT appear when the program is run.
</p></div><p>
<pre class="programlisting">
GnomeUIInfo helpmenu[] = {
{GNOME_APP_UI_ITEM,
- N_("About"), N_("Info about this program"),
+ N_("About"), N_("Info about this program"),
about_cb, NULL, NULL,
GNOME_APP_PIXMAP_STOCK, GNOME_STOCK_MENU_ABOUT,
0, 0, NULL},
GNOMEUIINFO_SEPARATOR,
- GNOMEUIINFO_HELP("<i>appname</i>"),
+ GNOMEUIINFO_HELP("<i>appname</i>"),
GNOMEUIINFO_END
};
</pre>
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Application Help Buttons</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs07.html" title="Listing Documents in the Help Menu"><link rel="next" href="indexs09.html" title="Packaging Applet Documentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Application Help Buttons</th></tr><tr><td width="20%" align="left"><a href="indexs07.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs09.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
29190"></a>Developer Information</h3><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Application Help Buttons</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs07.html" title="Listing Documents in the Help Menu"><link rel="next" href="indexs09.html" title="Packaging Applet Documentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Application Help Buttons</th></tr><tr><td width="20%" align="left"><a href="indexs07.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs09.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
40222"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
Browser the developer should add code based on the following example:
</p><pre class="programlisting">
gchar *tmp;
-tmp = gnome_help_file_find_file ("module", "page.html");
+tmp = gnome_help_file_find_file ("module", "page.html");
if (tmp) {
gnome_help_goto(0, tmp);
g_free(tmp);
}
- </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
29326"></a>NOTE</h3><p>
+ </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
40360"></a>NOTE</h3><p>
The example above is in the C language, please refer to other
documentation or forums for other GNOME language bindings.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a href="indexs07.html">Prev</a> </td><td width="20%" align="center"><a href="index.html">Home</a></td><td width="40%" align="right"> <a href="indexs09.html">Next</a></td></tr><tr><td width="40%" align="left">Listing Documents in the Help Menu </td><td width="20%" align="center"><a href="index.html">Up</a></td><td width="40%" align="right"> Packaging Applet Documentation</td></tr></table></div></body></html>
of the <i>GNOME Applets</i> book, you must
remember to add <tt><legalnotice></tt> and
<tt><copyright></tt> sections.
- </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
29573"></a>Developer Information</h3><p>
+ </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id29
40608"></a>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
To add an applet's manual to its applet menu, use:
<pre class="programlisting">
/* add an item to the applet menu */
-applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
-_("Manual"), &open_manual, NULL);
+applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
+_("Manual"), &open_manual, NULL);
</pre>
Here the second argument is an arbitrary name for the
callback, the third argument is the label which will appear
item to the applet's menu. This is a
stock menu item and is done:
<pre class="programlisting">
-applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
- GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
+applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
+ GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
NULL);
</pre>
</p><p>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Writing Context Sensitive Help (coming in GNOME-2.0)</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs09.html" title="Packaging Applet Documentation"><link rel="next" href="indexs11.html" title="Referring to Other GNOME Documentation (coming in
GNOME-2.0)"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Writing Context Sensitive Help (coming in GNOME-2.0)</th></tr><tr><td width="20%" align="left"><a href="indexs09.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs11.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="writingcontextsensitivehelp"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="writingcontextsensitivehelp"></a>Writing Context Sensitive Help (coming in GNOME-2.0)</h2></div></div><p>
- Context sensitive help, also known as "pop-up" help, will allow
+ Context sensitive help, also known as "pop-up" help, will allow
a user to obtain help information about specific buttons or
parts of an application.
</p><p>
developer to give an id to a particular portion of the User
Interface, for example, a button. Once the interface is complete
a Perl script can then be run against the interface code to
- create a "map" file. This map file allows the developer or
+ create a "map" file. This map file allows the developer or
writer to associate particular paragraph sections from an XML
document to the interface items.
</p><p>
user launches context sensitive help on the interface (either by
pressing a button and then clicking on the interface item they
want information on, or by right mouse clicking on the interface
- item and selecting a pop-up menu item like "What's This") a
+ item and selecting a pop-up menu item like "What's This") a
small transient window will appear with brief but detailed
information on the interface item.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a href="indexs09.html">Prev</a> </td><td width="20%" align="center"><a href="index.html">Home</a></td><td width="40%" align="right"> <a href="indexs11.html">Next</a></td></tr><tr><td width="40%" align="left">Packaging Applet Documentation </td><td width="20%" align="center"><a href="index.html">Up</a></td><td width="40%" align="right"> Referring to Other GNOME Documentation (coming in
</p></div><div class="sect2"><a name="balance"></a><div class="titlepage"><div><h3 class="title"><a name="balance"></a>Achieving a Balanced Style</h3></div></div><p>
Just as you need to juggle expert and novice readers,
you'll have to juggle a number of other extremes as you write:
- <div class="itemizedlist"><ul><li><p><a name="id2930118"></a>
+ <div class="itemizedlist"><ul><li><p><a name="id2941166"></a>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
you spend fewer words on the obvious, you can spend more
time clarifying the ambiguous labels and explaining
items that are more complex.
- </p></li><li><p><a name="id2930146"></a>
+ </p></li><li><p><a name="id2941193"></a>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
maintain a standard of style which holds the reader's
interest without resorting to jokes and untranslatable
allusions or puns.
- </p></li><li><p><a name="id2930185"></a>
+ </p></li><li><p><a name="id2941232"></a>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
It's good to provide a screenshot of any dialog windows
a user might run into, but if a dialog box has several
tabs, it's not usually necessary to have one for each.
- </p></li><li><p><a name="id2930208"></a>
+ </p></li><li><p><a name="id2941255"></a>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
bug reports, writers must check for errors in their documents.
Poor grammar, bad spelling, and gross technical errors in
draft documents are fine. However, if those problems show up
- in a "real" release, they can count against the credibility of
+ in a "real" release, they can count against the credibility of
GNOME and Linux. They'll also make you look bad.
</p><p>
There is no substitute for a human proofreader; use a
<h2><a name="contents">Table of Contents</a></h2><p class="toc">1 <a href="#sec-intro">Introduction</a><br> 1.1 <a href="#sec-origin-goals">Origin and Goals</a><br> 1.2 <a href="#sec-terminology">Terminology</a><br>2 <a href="#sec-documents">Documents</a><br> 2.1 <a href="#sec-well-formed">Well-Formed XML Documents</a><br> 2.2 <a href="#charsets">Characters</a><br> 2.3 <a href="#sec-common-syn">Common Syntactic Constructs</a><br> 2.4 <a href="#syntax">Character Data and Markup</a><br> 2.5 <a href="#sec-comments">Comments</a><br> 2.6 <a href="#sec-pi">Processing Instructions</a><br> 2.7 <a href="#sec-cdata-sect">CDATA Sections</a><br> 2.8 <a href="#sec-prolog-dtd">Prolog and Document Type Declaration</a><br> 2.9 <a href="#sec-rmd">Standalone Document Declaration</a><br> 2.10 <a href="#sec-white-space">White Space Handling</a><br> 2.11 <a href="#sec-line-ends">End-of-Line Handling</a><br> 2.12 <a href="#sec-lang-tag">Language Identification</a><br>3 <a href="#sec-logical-struct">Logical Structures</a><br> 3.1 <a href="#sec-starttags">Start-Tags, End-Tags, and Empty-Element Tags</a><br> 3.2 <a href="#elemdecls">Element Type Declarations</a><br> 3.2.1 <a href="#sec-element-content">Element Content</a><br> 3.2.2 <a href="#sec-mixed-content">Mixed Content</a><br> 3.3 <a href="#attdecls">Attribute-List Declarations</a><br> 3.3.1 <a href="#sec-attribute-types">Attribute Types</a><br> 3.3.2 <a href="#sec-attr-defaults">Attribute Defaults</a><br> 3.3.3 <a href="#AVNormalize">Attribute-Value
Normalization</a><br> 3.4 <a href="#sec-condition-sect">Conditional Sections</a><br>4 <a href="#sec-physical-struct">Physical Structures</a><br> 4.1 <a href="#sec-references">Character and Entity References</a><br> 4.2 <a href="#sec-entity-decl">Entity Declarations</a><br> 4.2.1 <a href="#sec-internal-ent">Internal Entities</a><br> 4.2.2 <a href="#sec-external-ent">External Entities</a><br> 4.3 <a href="#TextEntities">Parsed Entities</a><br> 4.3.1 <a href="#sec-TextDecl">The Text Declaration</a><br> 4.3.2 <a href="#wf-entities">Well-Formed Parsed Entities</a><br> 4.3.3 <a href="#charencoding">Character Encoding in Entities</a><br> 4.4 <a href="#entproc">XML Processor Treatment of Entities and References</a><br> 4.4.1 <a href="#not-recognized">Not Recognized</a><br> 4.4.2 <a href="#included">Included</a><br> 4.4.3 <a href="#include-if-valid">Included If Validating</a><br> 4.4.4 <a href="#forbidden">Forbidden</a><br> 4.4.5 <a href="#inliteral">Included in Literal</a><br> 4.4.6 <a href="#notify">Notify</a><br> 4.4.7 <a href="#bypass">Bypassed</a><br> 4.4.8 <a href="#as-PE">Included as PE</a><br> 4.5 <a href="#intern-replacement">Construction of Internal Entity Replacement Text</a><br> 4.6 <a href="#sec-predefined-ent">Predefined Entities</a><br> 4.7 <a href="#Notations">Notation Declarations</a><br> 4.8 <a href="#sec-doc-entity">Document Entity</a><br>5 <a href="#sec-conformance">Conformance</a><br> 5.1 <a href="#proc-types">Validating and Non-Validating Processors</a><br> 5.2 <a href="#safe-behavior">Using XML Processors</a><br>6 <a href="#sec-notation">Notation</a><br></p>
<h3>Appendices</h3><p class="toc">A <a href="#sec-bibliography">References</a><br> A.1 <a href="#sec-existing-stds">Normative References</a><br> A.2 <a href="#null">Other References</a><br>B <a href="#CharClasses">Character Classes</a><br>C <a href="#sec-xml-and-sgml">XML and SGML</a> (Non-Normative)<br>D <a href="#sec-entexpand">Expansion of Entity and Character References</a> (Non-Normative)<br>E <a href="#determinism">Deterministic Content Models</a> (Non-Normative)<br>F <a href="#sec-guessing">Autodetection
-of Character Encodings</a> (Non-Normative)<br> F.1 <a href="#sec-guessing-no-ext-info">Detection Without External Encoding Information</a><br> F.2 <a href="#sec-guessing-with-ext-info">Priorities in the Presence of External Encoding Information</a><br>G <a href="#sec-xml-wg">W3C XML Working Group</a> (Non-Normative)<br>H <a href="#sec-core-wg">W3C XML Core Group</a> (Non-Normative)<br>I <a href="#id26
76581">Production Notes</a> (Non-Normative)<br></p></div><hr><div class="body">
+of Character Encodings</a> (Non-Normative)<br> F.1 <a href="#sec-guessing-no-ext-info">Detection Without External Encoding Information</a><br> F.2 <a href="#sec-guessing-with-ext-info">Priorities in the Presence of External Encoding Information</a><br>G <a href="#sec-xml-wg">W3C XML Working Group</a> (Non-Normative)<br>H <a href="#sec-core-wg">W3C XML Core Group</a> (Non-Normative)<br>I <a href="#id26
81697">Production Notes</a> (Non-Normative)<br></p></div><hr><div class="body">
<div class="div1">
<h2><a name="sec-intro"></a>1 Introduction</h2>
<p>Each XML document has both a logical and a physical structure. Physically,
the document is composed of units called <a title="Entity" href="#dt-entity">entities</a>.
An entity may <a title="Entity Reference" href="#dt-entref">refer</a> to other entities to
-cause their inclusion in the document. A document begins in a "root"
+cause their inclusion in the document. A document begins in a "root"
or <a title="Document Entity" href="#dt-docent">document entity</a>. Logically, the document
is composed of declarations, elements, comments, character references, and
processing instructions, all of which are indicated in the document by explicit
current at the time this document was prepared. New characters may be added
to these standards by amendments or new editions. Consequently, XML processors
must accept any character in the range specified for <a href="#NT-Char">Char</a>.</span>
-The use of "compatibility characters", as defined in section
+The use of "compatibility characters", as defined in section
6.8 of <a href="#Unicode">[Unicode]</a> <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E67">[E67]</a>(see
also D21 in section 3.6 of <a href="#Unicode3">[Unicode3]</a>)</span>, is discouraged.]</p>
<p>[<a name="dt-name" title="Name">Definition</a>: A <b>Name</b> is a token beginning
with a letter or one of a few punctuation characters, and continuing with
letters, digits, hyphens, underscores, colons, or full stops, together known
-as name characters.] Names beginning with the string "<code>xml</code>",
+as name characters.] Names beginning with the string "<code>xml</code>",
or any string which would match <code>(('X'|'x') ('M'|'m') ('L'|'l'))</code>,
are reserved for standardization in this or future versions of this specification.</p>
<div class="note"><p class="prefix"><b>Note:</b></p>
(<a href="#NT-SystemLiteral">SystemLiteral</a>). Note that a <a href="#NT-SystemLiteral">SystemLiteral</a>
can be parsed without scanning for markup.</p>
-<h5>Literals</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EntityValue"></a>[9] </td><td><code>EntityValue</code></td><td> ::= </td><td><code>'
"' ([^%&"] | <a href="#NT-PEReference">PEReference</a>
-| <a href="#NT-Reference">Reference</a>)* '
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^%&'] | <a href="#NT-PEReference">PEReference</a> | <a href="#NT-Reference">Reference</a>)* "'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-AttValue"></a>[10] </td><td><code>AttValue</code></td><td> ::= </td><td><code>'"' ([^<&"] | <a href="#NT-Reference">Reference</a>)*
-'
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^<&'] | <a href="#NT-Reference">Reference</a>)*
-"'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-SystemLiteral"></a>[11] </td><td><code>SystemLiteral</code></td><td> ::= </td><td><code>('"' [^"]* '"') | ("'" [^']* "'") </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidLiteral"></a>[12] </td><td><code>PubidLiteral</code></td><td> ::= </td><td><code>'"' <a href="#NT-PubidChar">PubidChar</a>* '"'
-|
"'" (<a href="#NT-PubidChar">PubidChar</a> - "'")* "'"</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidChar"></a>[13] </td><td><code>PubidChar</code></td><td> ::= </td><td><code>#x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</code></td><xsltdebug></xsltdebug></tr></tbody></table>
+<h5>Literals</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EntityValue"></a>[9] </td><td><code>EntityValue</code></td><td> ::= </td><td><code>'
"' ([^%&"] | <a href="#NT-PEReference">PEReference</a>
+| <a href="#NT-Reference">Reference</a>)* '
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^%&'] | <a href="#NT-PEReference">PEReference</a> | <a href="#NT-Reference">Reference</a>)* "'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-AttValue"></a>[10] </td><td><code>AttValue</code></td><td> ::= </td><td><code>'"' ([^<&"] | <a href="#NT-Reference">Reference</a>)*
+'
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^<&'] | <a href="#NT-Reference">Reference</a>)*
+"'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-SystemLiteral"></a>[11] </td><td><code>SystemLiteral</code></td><td> ::= </td><td><code>('"' [^"]* '"') | ("'" [^']* "'") </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidLiteral"></a>[12] </td><td><code>PubidLiteral</code></td><td> ::= </td><td><code>'"' <a href="#NT-PubidChar">PubidChar</a>* '"'
+|
"'" (<a href="#NT-PubidChar">PubidChar</a> - "'")* "'"</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidChar"></a>[13] </td><td><code>PubidChar</code></td><td> ::= </td><td><code>#x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</code></td><xsltdebug></xsltdebug></tr></tbody></table>
<div class="diff-add"><div class="note"><p class="prefix"><b>Note:</b></p>
<p><a href="http://www.w3.org/XML/xml-19980210-errata#E72">[E72]</a>Although
the <a href="#NT-EntityValue">EntityValue</a> production allows the definition
of an entity consisting of a single explicit <code><</code> in the literal
-(e.g., <code><!ENTITY mylt "<"></code>), it is strongly advised to avoid
+(e.g., <code><!ENTITY mylt "<"></code>), it is strongly advised to avoid
this practice since any reference to that entity will cause a well-formedness
error.</p>
</div></div>
of an internal entity declaration; see <a href="#wf-entities"><b>4.3.2 Well-Formed Parsed Entities</b></a>.</span>
If they are needed elsewhere, they must be <a title="escape" href="#dt-escape">escaped</a>
using either <a title="Character Reference" href="#dt-charref">numeric character references</a>
-or the strings "<code>&amp;</code>" and "<code>&lt;</code>"
-respectively. The right angle bracket (>) may be represented using the string "<code>&gt;</code>",
+or the strings "<code>&amp;</code>" and "<code>&lt;</code>"
+respectively. The right angle bracket (>) may be represented using the string "<code>&gt;</code>",
and must, <a title="For Compatibility" href="#dt-compat">for compatibility</a>, be escaped
-using "<code>&gt;</code>" or a character reference when it
-appears in the string "<code>]]></code>" in content, when
+using "<code>&gt;</code>" or a character reference when it
+appears in the string "<code>]]></code>" in content, when
that string is not marking the end of a <a title="CDATA Section" href="#dt-cdsection">CDATA
section</a>.</p>
<p>In the content of elements, character data is any string of characters
which does not contain the start-delimiter of any markup. In a CDATA section,
character data is any string of characters not including the CDATA-section-close
-delimiter, "<code>]]></code>".</p>
+delimiter, "<code>]]></code>".</p>
<p>To allow attribute values to contain both single and double quotes, the
-apostrophe or single-quote character (') may be represented as "<code>&apos;</code>",
-and the double-quote character (") as "<code>&quot;</code>".</p>
+apostrophe or single-quote character (') may be represented as "<code>&apos;</code>",
+and the double-quote character (") as "<code>&quot;</code>".</p>
<h5>Character Data</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-CharData"></a>[14] </td><td><code>CharData</code></td><td> ::= </td><td><code>[^<&]* - ([^<&]* ']]>' [^<&]*)</code></td><xsltdebug></xsltdebug></tr></tbody></table>
</div>
allowed by the grammar. They are not part of the document's <a title="Character Data" href="#dt-chardata">character
data</a>; an XML processor may, but need not, make it possible for an
application to retrieve the text of comments. <a title="For Compatibility" href="#dt-compat">For
-compatibility</a>, the string "<code>--</code>" (double-hyphen)
+compatibility</a>, the string "<code>--</code>" (double-hyphen)
must not occur within comments.] <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E63">[E63]</a>Parameter
entity references are not recognized within comments.</span></p>
<p>PIs are not part of the document's <a title="Character Data" href="#dt-chardata">character
data</a>, but must be passed through to the application. The PI begins
with a target (<a href="#NT-PITarget">PITarget</a>) used to identify the application
-to which the instruction is directed. The target names "<code>XML</code>", "<code>xml</code>",
+to which the instruction is directed. The target names "<code>XML</code>", "<code>xml</code>",
and so on are reserved for standardization in this or future versions of this
specification. The XML <a title="Notation" href="#dt-notation">Notation</a> mechanism
may be used for formal declaration of PI targets. <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E63">[E63]</a>Parameter
<p>[<a name="dt-cdsection" title="CDATA Section">Definition</a>: <b>CDATA sections</b>
may occur anywhere character data may occur; they are used to escape blocks
of text containing characters which would otherwise be recognized as markup.
-CDATA sections begin with the string "<code><![CDATA[</code>"
-and end with the string "<code>]]></code>":]</p>
+CDATA sections begin with the string "<code><![CDATA[</code>"
+and end with the string "<code>]]></code>":]</p>
<h5>CDATA Sections</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-CDSect"></a>[18] </td><td><code>CDSect</code></td><td> ::= </td><td><code><a href="#NT-CDStart">CDStart</a> <a href="#NT-CData">CData</a> <a href="#NT-CDEnd">CDEnd</a></code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CDStart"></a>[19] </td><td><code>CDStart</code></td><td> ::= </td><td><code>'<![CDATA['</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CData"></a>[20] </td><td><code>CData</code></td><td> ::= </td><td><code>(<a href="#NT-Char">Char</a>* - (<a href="#NT-Char">Char</a>*
']]>' <a href="#NT-Char">Char</a>*)) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CDEnd"></a>[21] </td><td><code>CDEnd</code></td><td> ::= </td><td><code>']]>'</code></td><xsltdebug></xsltdebug></tr></tbody></table>
<p>Within a CDATA section, only the <a href="#NT-CDEnd">CDEnd</a> string is
recognized as markup, so that left angle brackets and ampersands may occur
-in their literal form; they need not (and cannot) be escaped using "<code>&lt;</code>"
-and "<code>&amp;</code>". CDATA sections cannot nest.</p>
-<p>An example of a CDATA section, in which "<code><greeting></code>"
-and
"<code></greeting></code>" are recognized as <a title="Character Data" href="#dt-chardata">character data</a>, not <a title="Markup" href="#dt-markup">markup</a>:</p>
+in their literal form; they need not (and cannot) be escaped using "<code>&lt;</code>"
+and "<code>&amp;</code>". CDATA sections cannot nest.</p>
+<p>An example of a CDATA section, in which "<code><greeting></code>"
+and
"<code></greeting></code>" are recognized as <a title="Character Data" href="#dt-chardata">character data</a>, not <a title="Markup" href="#dt-markup">markup</a>:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><![CDATA[<greeting>Hello, world!</greeting>]]> </pre></td></tr></table>
</div>
<div class="div2">
<p>[<a name="dt-xmldecl" title="XML Declaration">Definition</a>: XML documents <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E107">[E107]</a>should</span>
begin with an <b>XML declaration</b> which specifies the version of
XML being used.] For example, the following is a complete XML document, <a title="Well-Formed" href="#dt-wellformed">well-formed</a> but not <a title="Validity" href="#dt-valid">valid</a>:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <greeting>Hello, world!</greeting> </pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <greeting>Hello, world!</greeting> </pre></td></tr></table>
<p>and so is this:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><greeting>Hello, world!</greeting></pre></td></tr></table>
-<p>The version number "<code>1.0</code>" should be used to indicate
+<p>The version number "<code>1.0</code>" should be used to indicate
conformance to this version of this specification; it is an error for a document
-to use the value "<code>1.0</code>" if it does not conform to
+to use the value "<code>1.0</code>" if it does not conform to
this version of this specification. It is the intent of the XML working group
-to give later versions of this specification numbers other than "<code>1.0</code>",
+to give later versions of this specification numbers other than "<code>1.0</code>",
but this intent does not indicate a commitment to produce any future versions
of XML, nor if any are produced, to use any particular numbering scheme. Since
future versions are not ruled out, this construct is provided as a means to
(<a href="#NT-doctypedecl">doctypedecl</a> <a href="#NT-Misc">Misc</a>*)?</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-XMLDecl"></a>[23] </td><td><code>XMLDecl</code></td><td> ::= </td><td><code>'<?xml' <a href="#NT-VersionInfo">VersionInfo</a> <a href="#NT-EncodingDecl">EncodingDecl</a>? <a href="#NT-SDDecl">SDDecl</a>? <a href="#NT-S">S</a>? '?>'</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td class="diff-chg"><a name="NT-VersionInfo"></a>[24] </td><td class="diff-chg"><code>VersionInfo</code></td><td class="diff-chg"> ::= </td><td class="diff-chg"><code><a href="#NT-S">S</a> 'version' <a href="#NT-Eq">Eq</a>
-(
"'" <a href="#NT-VersionNum">VersionNum</a> "'" | '"' <a href="#NT-VersionNum">VersionNum</a>
-'
"')<i>/* <a href="http://www.w3.org/XML/xml-19980210-errata#E15">[E15]</a> */</i></code></td><xsltdebug></xsltdebug></tr>
+(
"'" <a href="#NT-VersionNum">VersionNum</a> "'" | '"' <a href="#NT-VersionNum">VersionNum</a>
+'
"')<i>/* <a href="http://www.w3.org/XML/xml-19980210-errata#E15">[E15]</a> */</i></code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-Eq"></a>[25] </td><td><code>Eq</code></td><td> ::= </td><td><code><a href="#NT-S">S</a>? '=' <a href="#NT-S">S</a>?</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-VersionNum"></a>[26] </td><td><code>VersionNum</code></td><td> ::= </td><td><code>([a-zA-Z0-9_.:] | '-')+</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-Misc"></a>[27] </td><td><code>Misc</code></td><td> ::= </td><td><code><a href="#NT-Comment">Comment</a> | <a href="#NT-PI">PI</a>
references</a> are permitted <em>within</em> markup declarations,
not only <em>between</em> markup declarations.</p>
<p>An example of an XML document with a document type declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> <greeting>Hello, world!</greeting> </pre></td></tr></table>
-<p>The <a title="System Identifier" href="#dt-sysid">system identifier</a> "<code>hello.dtd</code>"
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> <greeting>Hello, world!</greeting> </pre></td></tr></table>
+<p>The <a title="System Identifier" href="#dt-sysid">system identifier</a> "<code>hello.dtd</code>"
gives the <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E78">[E78]</a>address
(a URI reference)</span> of a DTD for the document.</p>
<p>The declarations can also be given locally, as in this example:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" encoding="UTF-8" ?>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE greeting [
<!ELEMENT greeting (#PCDATA)>
]>
<h5>Standalone Document Declaration</h5><table class="scrap" summary="Scrap"><tbody>
<tr valign="baseline"><td><a name="NT-SDDecl"></a>[32] </td><td><code>SDDecl</code></td><td> ::= </td><td><code> <a href="#NT-S">S</a> 'standalone' <a href="#NT-Eq">Eq</a>
-((
"'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"')) </code></td><xsltdebug></xsltdebug><td><a href="#vc-check-rmd">[VC: Standalone Document Declaration]</a></td></tr>
+((
"'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"')) </code></td><xsltdebug></xsltdebug><td><a href="#vc-check-rmd">[VC: Standalone Document Declaration]</a></td></tr>
</tbody></table>
-<p>In a standalone document declaration, the value "yes" indicates
+<p>In a standalone document declaration, the value "yes" indicates
that there are no <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E64">[E64]</a><a title="External Markup Declaration" href="#dt-extmkpdecl">external markup declarations</a></span> which
affect the information passed from the XML processor to the application. The
-value "no" indicates that there are or may be such external
+value "no" indicates that there are or may be such external
markup declarations. Note that the standalone document declaration only denotes
the presence of external <em>declarations</em>; the presence, in a document,
of references to external <em>entities</em>, when those entities are internally
declared, does not change its standalone status.</p>
<p>If there are no external markup declarations, the standalone document declaration
has no meaning. If there are external markup declarations but there is no
-standalone document declaration, the value "no" is assumed.</p>
-<p>Any XML document for which <code>standalone="no"</code> holds can be converted
+standalone document declaration, the value "no" is assumed.</p>
+<p>Any XML document for which <code>standalone="no"</code> holds can be converted
algorithmically to a standalone document, which may be desirable for some
network delivery applications.</p>
<div class="constraint"><p class="prefix"><a name="vc-check-rmd"></a><b>Validity constraint: Standalone Document Declaration</b></p><p>The
-standalone document declaration must have the value "no" if
+standalone document declaration must have the value "no" if
any external markup declarations contain declarations of:</p>
<ul>
<li><p>attributes with <a title="Attribute Default" href="#dt-default">default</a> values,
</ul>
</div>
<p>An example XML declaration with a standalone document declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" standalone='yes'?></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" standalone='yes'?></pre></td></tr></table>
</div>
<div class="div2">
<h3><a name="sec-white-space"></a>2.10 White Space Handling</h3>
-<p>In editing XML documents, it is often convenient to use "white space"
+<p>In editing XML documents, it is often convenient to use "white space"
(spaces, tabs, and blank lines<span class="diff-del"><a href="http://www.w3.org/XML/xml-19980210-errata#E39">[E39]</a>,
denoted by the nonterminal <a href="#NT-S">S</a> in this specification</span>)
to set apart the markup for greater readability. Such white space is typically
not intended for inclusion in the delivered version of the document. On the
-other hand, "significant" white space that should be preserved
+other hand, "significant" white space that should be preserved
in the delivered version is common, for example in poetry and source code.</p>
<p>An <a title="XML Processor" href="#dt-xml-proc">XML processor</a> must always pass
all characters in a document that are not markup through to the application.
attribute, like any other, must be <a title="Attribute-List Declaration" href="#dt-attdecl">declared</a>
if it is used. When declared, it must be given as an <a title="Enumerated Attribute Values" href="#dt-enumerated">enumerated
type</a> whose <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E81">[E81]</a>values
-are one or both of</span> "default" and "preserve".
+are one or both of</span> "default" and "preserve".
For example:</p>
<div class="diff-chg"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td class="diff-chg"><pre><!ATTLIST poem xml:space (default|preserve) 'preserve'>
<!-- <a href="http://www.w3.org/XML/xml-19980210-errata#E81">[E81]</a>-->
<!ATTLIST pre xml:space (preserve) #FIXED 'preserve'></pre></td></tr></table></div>
-<p>The value "default" signals that applications' default white-space
-processing modes are acceptable for this element; the value "preserve"
+<p>The value "default" signals that applications' default white-space
+processing modes are acceptable for this element; the value "preserve"
indicates the intent that applications preserve all the white space. This
declared intent is considered to apply to all elements within the content
of the element where it is specified, unless overriden with another instance
carriage-return (#xD) and line-feed (#xA).</p>
<div class="diff-del"><p>To simplify the tasks of <a title="Application" href="#dt-app">applications</a>,
wherever an external parsed entity or the literal entity value of an internal
-parsed entity contains either the literal two-character sequence "#xD#xA"
+parsed entity contains either the literal two-character sequence "#xD#xA"
or a standalone literal #xD, an <a title="XML Processor" href="#dt-xml-proc">XML processor</a>
must pass to the application the single character #xA. (This behavior can
conveniently be produced by normalizing all line breaks to #xA on input, before
for the representation of names of languages</cite></p></li>
<li><p>a language identifier registered with the Internet Assigned Numbers
Authority <span class="diff-chg"><a href="#IANA-LANGCODES">[IANA-LANGCODES]</a></span>; these begin with the
-prefix "<code>i-</code>" (or "<code>I-</code>")</p>
+prefix "<code>i-</code>" (or "<code>I-</code>")</p>
</li>
<li><p>a language identifier assigned by the user, or agreed on between
-parties in private use; these must begin with the prefix "<code>x-</code>"
-or "<code>X-</code>" in order to ensure that they do not conflict
+parties in private use; these must begin with the prefix "<code>x-</code>"
+or "<code>X-</code>" in order to ensure that they do not conflict
with names later standardized or registered with IANA</p></li>
</ul></div>
<div class="diff-del"><p>There may be any number of <a href="#NT-Subcode">Subcode</a>
segments; if the first subcode segment exists and the Subcode consists of
two letters, then it must be a country code from <a href="#ISO3166">[ISO 3166]</a>,
-"Codes for the representation of names of countries." If the first subcode
+"Codes for the representation of names of countries." If the first subcode
consists of more than two letters, it must be a subcode for the language in
question registered with IANA, unless the <a href="#NT-Langcode">Langcode</a>
-begins with the prefix "<code>x-</code>" or "<code>X-</code>". </p></div>
+begins with the prefix "<code>x-</code>" or "<code>X-</code>". </p></div>
<div class="diff-del"><p>It is customary to give the language code in lower case, and
the country code (if any) in upper case. Note that these values, unlike other
names in XML documents, are case insensitive.</p></div>
<p>For example:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p xml:lang="en">The quick brown fox jumps over the lazy dog.</p>
-<p xml:lang="en-GB">What colour is it?</p>
-<p xml:lang="en-US">What color is it?</p>
-<sp who="Faust" desc='leise' xml:lang="de">
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p xml:lang="en">The quick brown fox jumps over the lazy dog.</p>
+<p xml:lang="en-GB">What colour is it?</p>
+<p xml:lang="en-US">What color is it?</p>
+<sp who="Faust" desc='leise' xml:lang="de">
<l>Habe nun, ach! Philosophie,</l>
<l>Juristerei, und Medizin</l>
<l>und leider auch Theologie</l>
of which are either delimited by <a title="Start-Tag" href="#dt-stag">start-tags</a>
and <a title="End Tag" href="#dt-etag">end-tags</a>, or, for <a title="Empty" href="#dt-empty">empty</a>
elements, by an <a title="empty-element tag" href="#dt-eetag">empty-element tag</a>. Each
-element has a type, identified by name, sometimes called its "generic
-identifier" (GI), and may have a set of attribute specifications.]
+element has a type, identified by name, sometimes called its "generic
+identifier" (GI), and may have a set of attribute specifications.]
Each attribute specification has a <a title="Attribute Name" href="#dt-attrname">name</a>
and a <a title="Attribute Value" href="#dt-attrval">value</a>.</p>
<p>The <a href="#NT-Name">Name</a> in the start- and end-tags gives the element's <b>type</b>. [<a name="dt-attr" title="Attribute">Definition</a>: The <a href="#NT-Name">Name</a>-<a href="#NT-AttValue">AttValue</a>
pairs are referred to as the <b>attribute specifications</b> of the
element], [<a name="dt-attrname" title="Attribute Name">Definition</a>: with the <a href="#NT-Name">Name</a> in each pair referred to as the <b>attribute name</b>]
-and [<a name="dt-attrval" title="Attribute Value">Definition</a>: the content of the <a href="#NT-AttValue">AttValue</a> (the text between the <code>'</code> or <code>"</code>
+and [<a name="dt-attrval" title="Attribute Value">Definition</a>: the content of the <a href="#NT-AttValue">AttValue</a> (the text between the <code>'</code> or <code>"</code>
delimiters) as the <b>attribute value</b>.]<span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E46">[E46]</a>Note
that the order of attribute specifications in a start-tag or empty-element
tag is not significant.</span></p>
<div class="constraint"><p class="prefix"><a name="CleanAttrVals"></a><b>Well-formedness constraint: No <code><</code> in Attribute Values</b></p>
<p>The <a title="Replacement Text" href="#dt-repltext">replacement text</a> of any entity
referred to directly or indirectly in an attribute value <span class="diff-del"><a href="http://www.w3.org/XML/xml-19980210-errata#E83">[E83]</a>(other
-than "<code>&lt;</code>") </span>must not contain a <code><</code>.</p>
+than "<code>&lt;</code>") </span>must not contain a <code><</code>.</p>
</div>
<p>An example of a start-tag:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><termdef id="dt-dog" term="dog"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><termdef id="dt-dog" term="dog"></pre></td></tr></table>
<p>[<a name="dt-etag" title="End Tag">Definition</a>: The end of every element that begins
with a start-tag must be marked by an <b>end-tag</b> containing a name
that echoes the element's type as given in the start-tag:]</p>
be used, and should only be used,</span> for elements which are declared
EMPTY.</p>
<p>Examples of empty elements:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><IMG align="left"
- src="http://www.w3.org/Icons/WWW/w3c_home" />
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><IMG align="left"
+ src="http://www.w3.org/Icons/WWW/w3c_home" />
<br></br>
<br/></pre></td></tr></table>
</div>
</tbody></table>
<p>where the <a href="#NT-Name">Name</a>s give the types of elements that
may appear as children. <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E10">[E10]</a>The
-keyword <b>#PCDATA</b> derives historically from the term "parsed
-character data."</span></p>
+keyword <b>#PCDATA</b> derives historically from the term "parsed
+character data."</span></p>
<div class="constraint"><p class="prefix"><a name="vc-MixedChildrenUnique"></a><b>Validity constraint: No Duplicate Types</b></p><p>The
same name must not appear more than once in a single mixed-content declaration.</p>
</div>
id ID #REQUIRED
name CDATA #IMPLIED>
<!ATTLIST list
- type (bullets|ordered|glossary) "ordered">
+ type (bullets|ordered|glossary) "ordered">
<!ATTLIST form
- method CDATA #FIXED "POST"></pre></td></tr></table>
+ method CDATA #FIXED "POST"></pre></td></tr></table>
</div>
<div class="diff-chg"><div class="div3">
as if declared <b>CDATA</b>.</p>
<p>Following are examples of attribute normalization. Given the following
declarations:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY d "&#xD;">
-<!ENTITY a "&#xA;">
-<!ENTITY da "&#xD;&#xA;"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY d "&#xD;">
+<!ENTITY a "&#xA;">
+<!ENTITY da "&#xD;&#xA;"></pre></td></tr></table>
<p>the attribute specifications in the left column below would be normalized
to the character sequences of the middle column if the attribute <code>a</code>
is declared <b>NMTOKENS</b> and to those of the right columns if <code>a</code>
is declared <b>CDATA</b>.</p>
<table border="1" frame="border"><thead><tr><th colspan="1" rowspan="1">Attribute specification</th>
-<th colspan="1" rowspan="1">a is NMTOKENS</th><th colspan="1" rowspan="1">a is CDATA</th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="
+<th colspan="1" rowspan="1">a is NMTOKENS</th><th colspan="1" rowspan="1">a is CDATA</th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="
-xyz"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>x y z</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 x y z</code></td>
-</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="&d;&d;A&a;&a;B&da;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>A
+xyz"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>x y z</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 x y z</code></td>
+</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="&d;&d;A&a;&a;B&da;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>A
#x20 B</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 A #x20 #x20 B #x20 #x20</code></td>
</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a=
-"&#xd;&#xd;A&#xa;&#xa;B&#xd;&#xa;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>#xD
+"&#xd;&#xd;A&#xa;&#xa;B&#xd;&#xa;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>#xD
#xD A #xA #xA B #xD #xA</code></td><td colspan="1" rowspan="1"><code>#xD #xD A #xA #xA B #xD #xD</code></td>
</tr></tbody></table>
<p>Note that the last example is invalid (but well-formed) if <code>a</code>
('<![' | ']]>') <a href="#NT-Char">Char</a>*) </code></td><xsltdebug></xsltdebug></tr>
</tbody></table>
<div class="diff-add"><div class="constraint"><p class="prefix"><a name="condsec-nesting"></a><b>Validity constraint: <a href="http://www.w3.org/XML/xml-19980210-errata#E90">[E90]</a>Proper
-Conditional Section/PE Nesting</b></p><p>If any of the "<code><![</code>",
-"<code>[</code>", or "<code>]]></code>" of a conditional section is contained
+Conditional Section/PE Nesting</b></p><p>If any of the "<code><![</code>",
+"<code>[</code>", or "<code>]]></code>" of a conditional section is contained
in the replacement text for a parameter-entity reference, all of them must
be contained in the same replacement text.</p>
</div></div>
a larger conditional section with a keyword of <b>IGNORE</b>, both the outer
and the inner conditional sections are ignored.<span class="diff-add"> <a href="http://www.w3.org/XML/xml-19980210-errata#E90">[E90]</a>The contents
of an ignored conditional section are parsed by ignoring all characters after
-the "<code>[</code>" following the keyword, except conditional section starts
-"<code><![</code>" and ends "<code>]]></code>", until the matching conditional
+the "<code>[</code>" following the keyword, except conditional section starts
+"<code><![</code>" and ends "<code>]]></code>", until the matching conditional
section end is found. Parameter entity references are not recognized in this
process.</span></p>
<p>If the keyword of the conditional section is a parameter-entity reference,
<div class="constraint"><p class="prefix"><a name="wf-Legalchar"></a><b>Well-formedness constraint: Legal Character</b></p><p>Characters referred
to using character references must match the production for <a title="" href="#NT-Char">Char</a>.</p>
</div>
-<p>If the character reference begins with "<code>&#x</code>",
+<p>If the character reference begins with "<code>&#x</code>",
the digits and letters up to the terminating <code>;</code> provide a hexadecimal
representation of the character's code point in ISO/IEC 10646. If it begins
-just with "<code>&#</code>", the digits up to the terminating <code>;</code>
+just with "<code>&#</code>", the digits up to the terminating <code>;</code>
provide a decimal representation of the character's code point.</p>
<p>[<a name="dt-entref" title="Entity Reference">Definition</a>: An <b>entity reference</b>
refers to the content of a named entity.] [<a name="dt-GERef" title="General Entity Reference">Definition</a>: References to parsed general entities use
<h5>Entity Reference</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-Reference"></a>[67] </td><td><code>Reference</code></td><td> ::= </td><td><code><a href="#NT-EntityRef">EntityRef</a> | <a href="#NT-CharRef">CharRef</a></code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EntityRef"></a>[68] </td><td><code>EntityRef</code></td><td> ::= </td><td><code>'&' <a href="#NT-Name">Name</a> ';'</code></td><xsltdebug></xsltdebug><td><a href="#wf-entdeclared">[WFC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#vc-entdeclared">[VC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#textent">[WFC: Parsed Entity]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#norecursion">[WFC: No Recursion]</a></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PEReference"></a>[69] </td><td><code>PEReference</code></td><td> ::= </td><td><code>'%' <a href="#NT-Name">Name</a> ';'</code></td><xsltdebug></xsltdebug><td><a href="#vc-entdeclared">[VC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#norecursion">[WFC: No Recursion]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#indtd">[WFC: In DTD]</a></td></tr></tbody></table>
<div class="constraint"><p class="prefix"><a name="wf-entdeclared"></a><b>Well-formedness constraint: Entity Declared</b></p><p>In a document
without any DTD, a document with only an internal DTD subset which contains
-no parameter entity references, or a document with
"<code>standalone='yes'</code>", <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E34">[E34]</a>for
+no parameter entity references, or a document with
"<code>standalone='yes'</code>", <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E34">[E34]</a>for
an entity reference that does not occur within the external subset or a parameter
entity, the <a href="#NT-Name">Name</a> given in the entity reference must <a title="match" href="#dt-match">match</a> that in an <a href="#sec-entity-decl"><cite>entity
declaration</cite></a> that does not occur within the external subset or a
if <a href="#sec-rmd"><cite>standalone='yes'</cite></a>.</p>
</div>
<div class="constraint"><p class="prefix"><a name="vc-entdeclared"></a><b>Validity constraint: Entity Declared</b></p><p>In a document with
-an external subset or external parameter entities with "<code>standalone='no'</code>",
+an external subset or external parameter entities with "<code>standalone='no'</code>",
the <a href="#NT-Name">Name</a> given in the entity reference must <a title="match" href="#dt-match">match</a> that in an <a href="#sec-entity-decl"><cite>entity
declaration</cite></a>. For interoperability, valid documents should declare
the entities <code>amp</code>,
This document was prepared on &docdate; and
is classified &security-level;.</pre></td></tr></table>
<p>Example of a parameter-entity reference:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!-- declare the parameter entity "ISOLat2"... -->
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!-- declare the parameter entity "ISOLat2"... -->
<!ENTITY % ISOLat2
- SYSTEM "http://www.xml.com/iso/isolat2-xml.entities" >
+ SYSTEM "http://www.xml.com/iso/isolat2-xml.entities" >
<!-- ... now reference it. -->
%ISOLat2;</pre></td></tr></table>
</div>
the correct <a title="Replacement Text" href="#dt-repltext">replacement text</a>: see <a href="#intern-replacement"><b>4.5 Construction of Internal Entity Replacement Text</b></a>.</p>
<p>An internal entity is a <a title="Text Entity" href="#dt-parsedent">parsed entity</a>.</p>
<p>Example of an internal entity declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY Pub-Status "This is a pre-release of the
- specification."></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY Pub-Status "This is a pre-release of the
+ specification."></pre></td></tr></table>
</div>
<div class="div3">
be removed.</p>
<p>Examples of external entity declarations:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY open-hatch
- SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
+ SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
<!ENTITY open-hatch
- PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN"
- "http://www.textuality.com/boilerplate/OpenHatch.xml">
+ PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN"
+ "http://www.textuality.com/boilerplate/OpenHatch.xml">
<!ENTITY hatch-pic
- SYSTEM "../grafix/OpenHatch.gif"
+ SYSTEM "../grafix/OpenHatch.gif"
NDATA gif ></pre></td></tr></table>
</div>
</div>
<h4><a name="charencoding"></a>4.3.3 Character Encoding in Entities</h4>
<p>Each external parsed entity in an XML document may use a different encoding
for its characters. All XML processors must be able to read entities in <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E56">[E56]</a>both
-the UTF-8 and UTF-16 encodings.</span> <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E77">[E77]</a>The terms "UTF-8"
-and "UTF-16" in this specification do not apply to character
+the UTF-8 and UTF-16 encodings.</span> <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E77">[E77]</a>The terms "UTF-8"
+and "UTF-16" in this specification do not apply to character
encodings with any other labels, even if the encodings or labels are very
similar to UTF-8 or UTF-16.</span></p>
<p>Entities encoded in UTF-16 must begin with the Byte Order Mark described
an encoding declaration:</p>
<h5>Encoding Declaration</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EncodingDecl"></a>[80] </td><td><code>EncodingDecl</code></td><td> ::= </td><td><code><a href="#NT-S">S</a> 'encoding' <a href="#NT-Eq">Eq</a>
-('
"' <a href="#NT-EncName">EncName</a> '"' | "'" <a href="#NT-EncName">EncName</a>
-
"'" ) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EncName"></a>[81] </td><td><code>EncName</code></td><td> ::= </td><td><code>[A-Za-z] ([A-Za-z0-9._] | '-')*</code></td><xsltdebug></xsltdebug><td><i>/* Encoding
+('
"' <a href="#NT-EncName">EncName</a> '"' | "'" <a href="#NT-EncName">EncName</a>
+
"'" ) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EncName"></a>[81] </td><td><code>EncName</code></td><td> ::= </td><td><code>[A-Za-z] ([A-Za-z0-9._] | '-')*</code></td><xsltdebug></xsltdebug><td><i>/* Encoding
name contains only Latin characters */</i></td></tr></tbody></table>
<p>In the <a title="Document Entity" href="#dt-docent">document entity</a>, the encoding
declaration is part of the <a title="XML Declaration" href="#dt-xmldecl">XML declaration</a>.
The <a href="#NT-EncName">EncName</a> is the name of the encoding used.</p>
-<p>In an encoding declaration, the values "<code>UTF-8</code>", "<code>UTF-16</code>", "<code>ISO-10646-UCS-2</code>", and "<code>ISO-10646-UCS-4</code>" should be used
+<p>In an encoding declaration, the values "<code>UTF-8</code>", "<code>UTF-16</code>", "<code>ISO-10646-UCS-2</code>", and "<code>ISO-10646-UCS-4</code>" should be used
for the various encodings and transformations of Unicode / ISO/IEC 10646,
-the values "<code>ISO-8859-1</code>", "<code>ISO-8859-2</code>",
-... <a href="http://www.w3.org/XML/xml-19980210-errata#E106">[E106]</a><span class="diff-chg">"<code>ISO-8859-</code><var>n</var>" (where <var>n</var>
+the values "<code>ISO-8859-1</code>", "<code>ISO-8859-2</code>",
+... <a href="http://www.w3.org/XML/xml-19980210-errata#E106">[E106]</a><span class="diff-chg">"<code>ISO-8859-</code><var>n</var>" (where <var>n</var>
is the part number)</span> should be used for the parts of ISO 8859, and
-the values "<code>ISO-2022-JP</code>", "<code>Shift_JIS</code>",
-and "<code>EUC-JP</code>" should be used for the various encoded
+the values "<code>ISO-2022-JP</code>", "<code>Shift_JIS</code>",
+and "<code>EUC-JP</code>" should be used for the various encoded
forms of JIS X-0208-1997. <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E57">[E57]</a>It
is recommended that character encodings registered (as <em>charset</em>s)
with the Internet Assigned Numbers Authority <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E58">[E58]</a><a href="#IANA">[IANA-CHARSETS]</a></span>,
other than those just listed, be referred to using their registered names;
-other encodings should use names starting with an "x-" prefix.
+other encodings should use names starting with an "x-" prefix.
XML processors should match character encoding names in a case-insensitive
way and should either interpret an IANA-registered name as the encoding registered
at IANA for that name or treat it as unknown (processors are, of course, not
<code>gt</code>,
<code>apos</code>,
<code>quot</code>)
-is always treated as data</span>. (The string "<code>AT&amp;T;</code>"
-expands to "<code>AT&T;</code>" and the remaining ampersand
+is always treated as data</span>. (The string "<code>AT&amp;T;</code>"
+expands to "<code>AT&T;</code>" and the remaining ampersand
is not recognized as an entity-reference delimiter.) A character reference
is <b>included</b> when the indicated character is processed in place
of the reference itself. </p>
quote character in the replacement text is always treated as a normal data
character and will not terminate the literal. For example, this is well-formed:</p>
<div class="diff-chg"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td class="diff-chg"><pre><!-- <a href="http://www.w3.org/XML/xml-19980210-errata#E4">[E4]</a> -->
-<!ENTITY % YN '"Yes"' >
-<!ENTITY WhatHeSaid "He said %YN;" ></pre></td></tr></table></div>
+<!ENTITY % YN '"Yes"' >
+<!ENTITY WhatHeSaid "He said %YN;" ></pre></td></tr></table></div>
<p>while this is not:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY EndAttr "27'" >
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY EndAttr "27'" >
<element attribute='a-&EndAttr;></pre></td></tr></table>
</div>
<div class="div3">
referred to, in place of any character references in the literal entity value;
however, general-entity references must be left as-is, unexpanded. For example,
given the following declarations:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY % pub "&#xc9;ditions Gallimard" >
-<!ENTITY rights "All rights reserved" >
-<!ENTITY book "La Peste: Albert Camus,
-&#xA9; 1947 %pub;. &rights;" ></pre></td></tr></table>
-<p>then the replacement text for the entity "<code>book</code>"
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY % pub "&#xc9;ditions Gallimard" >
+<!ENTITY rights "All rights reserved" >
+<!ENTITY book "La Peste: Albert Camus,
+&#xA9; 1947 %pub;. &rights;" ></pre></td></tr></table>
+<p>then the replacement text for the entity "<code>book</code>"
is:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>La Peste: Albert Camus,
© 1947 Éditions Gallimard. &rights;</pre></td></tr></table>
-<p>The general-entity reference "<code>&rights;</code>" would
-be expanded should the reference "<code>&book;</code>" appear
+<p>The general-entity reference "<code>&rights;</code>" would
+be expanded should the reference "<code>&book;</code>" appear
in the document's content or an attribute value.</p>
<p>These simple rules may have complex interactions; for a detailed discussion
of a difficult example, see <a href="#sec-entexpand"><b>D Expansion of Entity and Character References</b></a>.</p>
<code>quot</code>) is specified for
this purpose. Numeric character references may also be used; they are expanded
immediately when recognized and must be treated as character data, so the
-numeric character references "<code>&#60;</code>" and "<code>&#38;</code>"
+numeric character references "<code>&#60;</code>" and "<code>&#38;</code>"
may be used to escape <code><</code> and <code>&</code> when they occur
in character data.]</p>
<p>All XML processors must recognize these entities whether they are declared
whose replacement text is the single character being escaped (or a character
reference to that character; the double escaping here is unnecessary but harmless).
For example:</span></p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY lt "&#38;#60;">
-<!ENTITY gt "&#62;">
-<!ENTITY amp "&#38;#38;">
-<!ENTITY apos "&#39;">
-<!ENTITY quot "&#34;"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY lt "&#38;#60;">
+<!ENTITY gt "&#62;">
+<!ENTITY amp "&#38;#38;">
+<!ENTITY apos "&#39;">
+<!ENTITY quot "&#34;"></pre></td></tr></table>
<div class="diff-del"><p>Note that the <code><</code> and <code>&</code> characters
-in the declarations of "<code>lt</code>" and "<code>amp</code>"
+in the declarations of "<code>lt</code>" and "<code>amp</code>"
are doubly escaped to meet the requirement that entity replacement be well-formed.</p></div>
</div>
<div class="div2">
in those declarations to <a href="#AVNormalize"><cite>normalize</cite></a>
attribute values, <a href="#included"><cite>include</cite></a> the replacement
text of internal entities, and supply <a href="#sec-attr-defaults"><cite>default
-attribute values</cite></a>.] <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E33">[E33]</a>Except when <code>standalone="yes"</code>, </span>they
+attribute values</cite></a>.] <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E33">[E33]</a>Except when <code>standalone="yes"</code>, </span>they
must not <a title="Process Declarations" href="#dt-use-mdecl">process</a> <a title="entity declaration" href="#dt-entdecl">entity
declarations</a> or <a title="Attribute-List Declaration" href="#dt-attdecl">attribute-list declarations</a>
encountered after a reference to a parameter entity that is not read, since
<p>matches any <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E93">[E93]</a><a href="#NT-Char">Char</a></span> with a value not among the characters given. <span class="diff-add"><a href="http://www.w3.org/XML/xml-19980210-errata#E3">[E3]</a>Enumerations
and ranges of forbidden values can be mixed in one set of brackets.</span></p>
</dd>
-<dt class="label"><code>"string"</code></dt>
+<dt class="label"><code>"string"</code></dt>
<dd>
<p>matches a literal string <a title="match" href="#dt-match">matching</a> that
given inside the double quotes.</p>
<li><p>Characters in the compatibility area (i.e. with character code greater
than #xF900 and less than #xFFFE) are not allowed in XML names.</p></li>
<li><p>Characters which have a font or compatibility decomposition (i.e.
-those with a "compatibility formatting tag" in field 5 of the
-database -- marked by field 5 beginning with a "<") are not
+those with a "compatibility formatting tag" in field 5 of the
+database -- marked by field 5 beginning with a "<") are not
allowed.</p></li>
<li><p>The following characters are treated as name-start characters rather
than name characters, because the property file classifies them as Alphabetic:
<p>This appendix contains some examples illustrating the sequence of entity-
and character-reference recognition and expansion, as specified in <a href="#entproc"><b>4.4 XML Processor Treatment of Entities and References</b></a>.</p>
<p>If the DTD contains the declaration</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY example "<p>An ampersand (&#38;#38;) may be escaped
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY example "<p>An ampersand (&#38;#38;) may be escaped
numerically (&#38;#38;#38;) or with a general entity
-(&amp;amp;).</p>" ></pre></td></tr></table>
+(&amp;amp;).</p>" ></pre></td></tr></table>
<p>then the XML processor will recognize the character references when it
parses the entity declaration, and resolve them before storing the following
-string as the value of the entity "<code>example</code>":</p>
+string as the value of the entity "<code>example</code>":</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p>An ampersand (&#38;) may be escaped
numerically (&#38;#38;) or with a general entity
(&amp;amp;).</p></pre></td></tr></table>
-<p>A reference in the document to "<code>&example;</code>"
+<p>A reference in the document to "<code>&example;</code>"
will cause the text to be reparsed, at which time the start- and end-tags
of the <code>p</code> element will be recognized and the three references will
be recognized and expanded, resulting in a <code>p</code> element with the following
2 <!DOCTYPE test [
3 <!ELEMENT test (#PCDATA) >
4 <!ENTITY % xx '&#37;zz;'>
-5 <!ENTITY % zz '&#60;!ENTITY tricky "error-prone" >' >
+5 <!ENTITY % zz '&#60;!ENTITY tricky "error-prone" >' >
6 %xx;
7 ]>
8 <test>This sample shows a &tricky; method.</test></pre></td></tr></table>
<p>This produces the following:</p>
<ul>
<li><p>in line 4, the reference to character 37 is expanded immediately,
-and the parameter entity "<code>xx</code>" is stored in the symbol
-table with the value "<code>%zz;</code>". Since the replacement
-text is not rescanned, the reference to parameter entity "<code>zz</code>"
-is not recognized. (And it would be an error if it were, since "<code>zz</code>"
+and the parameter entity "<code>xx</code>" is stored in the symbol
+table with the value "<code>%zz;</code>". Since the replacement
+text is not rescanned, the reference to parameter entity "<code>zz</code>"
+is not recognized. (And it would be an error if it were, since "<code>zz</code>"
is not yet declared.)</p></li>
-<li><p>in line 5, the character reference "<code>&#60;</code>"
-is expanded immediately and the parameter entity "<code>zz</code>"
-is stored with the replacement text "<code><!ENTITY tricky "error-prone"
-></code>", which is a well-formed entity declaration.</p></li>
-<li><p>in line 6, the reference to "<code>xx</code>" is recognized,
-and the replacement text of "<code>xx</code>" (namely "<code>%zz;</code>")
-is parsed. The reference to "<code>zz</code>" is recognized in
-its turn, and its replacement text ("<code><!ENTITY tricky "error-prone"
-></code>") is parsed. The general entity "<code>tricky</code>"
-has now been declared, with the replacement text "<code>error-prone</code>".</p>
+<li><p>in line 5, the character reference "<code>&#60;</code>"
+is expanded immediately and the parameter entity "<code>zz</code>"
+is stored with the replacement text "<code><!ENTITY tricky "error-prone"
+></code>", which is a well-formed entity declaration.</p></li>
+<li><p>in line 6, the reference to "<code>xx</code>" is recognized,
+and the replacement text of "<code>xx</code>" (namely "<code>%zz;</code>")
+is parsed. The reference to "<code>zz</code>" is recognized in
+its turn, and its replacement text ("<code><!ENTITY tricky "error-prone"
+></code>") is parsed. The general entity "<code>tricky</code>"
+has now been declared, with the replacement text "<code>error-prone</code>".</p>
</li>
-<li><p>in line 8, the reference to the general entity "<code>tricky</code>"
+<li><p>in line 8, the reference to the general entity "<code>tricky</code>"
is recognized, and it is expanded, so the full content of the <code>test</code>
element is the self-describing (and ungrammatical) string <em>This sample
shows a error-prone method.</em></p></li>
<p><span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E102">[E102]</a>As
noted in <a href="#sec-element-content"><b>3.2.1 Element Content</b></a>, it is required that content
models in element type declarations be deterministic. This requirement is <a title="For Compatibility" href="#dt-compat">for compatibility</a> with SGML (which calls deterministic
-content models "unambiguous");</span> XML processors built
+content models "unambiguous");</span> XML processors built
using SGML systems may flag non-deterministic content models as errors.</p>
<p>For example, the content model <code>((b, c) | (b, d))</code> is non-deterministic,
because given an initial <code>b</code> the <span class="diff-chg"><a href="http://www.w3.org/XML/xml-19980210-errata#E95">[E95]</a>XML processor</span>
begin with an XML encoding declaration, in which the first characters must
be '<code><?xml</code>', any conforming processor can detect, after two
to four octets of input, which of the following cases apply. In reading this
-list, it may help to know that in UCS-4, '<' is "<code>#x0000003C</code>"
-and '?' is "<code>#x0000003F</code>", and the Byte Order Mark
-required of UTF-16 data streams is "<code>#xFEFF</code>". <span class="diff-add">The notation <var>##</var> is used to denote any byte value except <span class="diff-chg">that two consecutive <var>##</var>s cannot be both 00</span>.</span></p>
+list, it may help to know that in UCS-4, '<' is "<code>#x0000003C</code>"
+and '?' is "<code>#x0000003F</code>", and the Byte Order Mark
+required of UTF-16 data streams is "<code>#xFEFF</code>". <span class="diff-add">The notation <var>##</var> is used to denote any byte value except <span class="diff-chg">that two consecutive <var>##</var>s cannot be both 00</span>.</span></p>
<div class="diff-add"><p>With a Byte Order Mark:</p></div>
<div class="diff-add"><table border="1" frame="border"><tbody><tr><td colspan="1" rowspan="1"><code>00 00 FE
FF</code></td><td colspan="1" rowspan="1">UCS-4, big-endian machine (1234 order)</td></tr><tr><td colspan="1" rowspan="1"><code>FF
</div></div>
<div class="diff-add"><div class="div1">
-<h2><a name="id2676581"></a>I Production Notes (Non-Normative)</h2>
+<h2><a name="id2681697"></a>I Production Notes (Non-Normative)</h2>
<p>This Second Edition was encoded in the <a href="http://www.w3.org/XML/1998/06/xmlspec-v21.dtd">XMLspec
DTD</a> (which has <a href="http://www.w3.org/XML/1998/06/xmlspec-report-v21.htm">documentation</a>
available). The HTML versions were produced with a combination of the <a href="http://www.w3.org/XML/1998/06/xmlspec.xsl">xmlspec.xsl</a>, <a href="http://www.w3.org/XML/1998/06/diffspec.xsl">diffspec.xsl</a>,
<h2><a name="contents">Table of Contents</a></h2><p class="toc">1 <a href="#sec-intro">Introduction</a><br> 1.1 <a href="#sec-origin-goals">Origin and Goals</a><br> 1.2 <a href="#sec-terminology">Terminology</a><br>2 <a href="#sec-documents">Documents</a><br> 2.1 <a href="#sec-well-formed">Well-Formed XML Documents</a><br> 2.2 <a href="#charsets">Characters</a><br> 2.3 <a href="#sec-common-syn">Common Syntactic Constructs</a><br> 2.4 <a href="#syntax">Character Data and Markup</a><br> 2.5 <a href="#sec-comments">Comments</a><br> 2.6 <a href="#sec-pi">Processing Instructions</a><br> 2.7 <a href="#sec-cdata-sect">CDATA Sections</a><br> 2.8 <a href="#sec-prolog-dtd">Prolog and Document Type Declaration</a><br> 2.9 <a href="#sec-rmd">Standalone Document Declaration</a><br> 2.10 <a href="#sec-white-space">White Space Handling</a><br> 2.11 <a href="#sec-line-ends">End-of-Line Handling</a><br> 2.12 <a href="#sec-lang-tag">Language Identification</a><br>3 <a href="#sec-logical-struct">Logical Structures</a><br> 3.1 <a href="#sec-starttags">Start-Tags, End-Tags, and Empty-Element Tags</a><br> 3.2 <a href="#elemdecls">Element Type Declarations</a><br> 3.2.1 <a href="#sec-element-content">Element Content</a><br> 3.2.2 <a href="#sec-mixed-content">Mixed Content</a><br> 3.3 <a href="#attdecls">Attribute-List Declarations</a><br> 3.3.1 <a href="#sec-attribute-types">Attribute Types</a><br> 3.3.2 <a href="#sec-attr-defaults">Attribute Defaults</a><br> 3.3.3 <a href="#AVNormalize">Attribute-Value
Normalization</a><br> 3.4 <a href="#sec-condition-sect">Conditional Sections</a><br>4 <a href="#sec-physical-struct">Physical Structures</a><br> 4.1 <a href="#sec-references">Character and Entity References</a><br> 4.2 <a href="#sec-entity-decl">Entity Declarations</a><br> 4.2.1 <a href="#sec-internal-ent">Internal Entities</a><br> 4.2.2 <a href="#sec-external-ent">External Entities</a><br> 4.3 <a href="#TextEntities">Parsed Entities</a><br> 4.3.1 <a href="#sec-TextDecl">The Text Declaration</a><br> 4.3.2 <a href="#wf-entities">Well-Formed Parsed Entities</a><br> 4.3.3 <a href="#charencoding">Character Encoding in Entities</a><br> 4.4 <a href="#entproc">XML Processor Treatment of Entities and References</a><br> 4.4.1 <a href="#not-recognized">Not Recognized</a><br> 4.4.2 <a href="#included">Included</a><br> 4.4.3 <a href="#include-if-valid">Included If Validating</a><br> 4.4.4 <a href="#forbidden">Forbidden</a><br> 4.4.5 <a href="#inliteral">Included in Literal</a><br> 4.4.6 <a href="#notify">Notify</a><br> 4.4.7 <a href="#bypass">Bypassed</a><br> 4.4.8 <a href="#as-PE">Included as PE</a><br> 4.5 <a href="#intern-replacement">Construction of Internal Entity Replacement Text</a><br> 4.6 <a href="#sec-predefined-ent">Predefined Entities</a><br> 4.7 <a href="#Notations">Notation Declarations</a><br> 4.8 <a href="#sec-doc-entity">Document Entity</a><br>5 <a href="#sec-conformance">Conformance</a><br> 5.1 <a href="#proc-types">Validating and Non-Validating Processors</a><br> 5.2 <a href="#safe-behavior">Using XML Processors</a><br>6 <a href="#sec-notation">Notation</a><br></p>
<h3>Appendices</h3><p class="toc">A <a href="#sec-bibliography">References</a><br> A.1 <a href="#sec-existing-stds">Normative References</a><br> A.2 <a href="#null">Other References</a><br>B <a href="#CharClasses">Character Classes</a><br>C <a href="#sec-xml-and-sgml">XML and SGML</a> (Non-Normative)<br>D <a href="#sec-entexpand">Expansion of Entity and Character References</a> (Non-Normative)<br>E <a href="#determinism">Deterministic Content Models</a> (Non-Normative)<br>F <a href="#sec-guessing">Autodetection
-of Character Encodings</a> (Non-Normative)<br> F.1 <a href="#sec-guessing-no-ext-info">Detection Without External Encoding Information</a><br> F.2 <a href="#sec-guessing-with-ext-info">Priorities in the Presence of External Encoding Information</a><br>G <a href="#sec-xml-wg">W3C XML Working Group</a> (Non-Normative)<br>H <a href="#sec-core-wg">W3C XML Core Group</a> (Non-Normative)<br>I <a href="#id26
76581">Production Notes</a> (Non-Normative)<br></p></div><hr><div class="body">
+of Character Encodings</a> (Non-Normative)<br> F.1 <a href="#sec-guessing-no-ext-info">Detection Without External Encoding Information</a><br> F.2 <a href="#sec-guessing-with-ext-info">Priorities in the Presence of External Encoding Information</a><br>G <a href="#sec-xml-wg">W3C XML Working Group</a> (Non-Normative)<br>H <a href="#sec-core-wg">W3C XML Core Group</a> (Non-Normative)<br>I <a href="#id26
81697">Production Notes</a> (Non-Normative)<br></p></div><hr><div class="body">
<div class="div1">
<h2><a name="sec-intro"></a>1 Introduction</h2>
<p>Each XML document has both a logical and a physical structure. Physically,
the document is composed of units called <a title="Entity" href="#dt-entity">entities</a>.
An entity may <a title="Entity Reference" href="#dt-entref">refer</a> to other entities to
-cause their inclusion in the document. A document begins in a "root"
+cause their inclusion in the document. A document begins in a "root"
or <a title="Document Entity" href="#dt-docent">document entity</a>. Logically, the document
is composed of declarations, elements, comments, character references, and
processing instructions, all of which are indicated in the document by explicit
current at the time this document was prepared. New characters may be added
to these standards by amendments or new editions. Consequently, XML processors
must accept any character in the range specified for <a href="#NT-Char">Char</a>.
-The use of "compatibility characters", as defined in section
+The use of "compatibility characters", as defined in section
6.8 of <a href="#Unicode">[Unicode]</a> (see
also D21 in section 3.6 of <a href="#Unicode3">[Unicode3]</a>), is discouraged.]</p>
<p>[<a name="dt-name" title="Name">Definition</a>: A <b>Name</b> is a token beginning
with a letter or one of a few punctuation characters, and continuing with
letters, digits, hyphens, underscores, colons, or full stops, together known
-as name characters.] Names beginning with the string "<code>xml</code>",
+as name characters.] Names beginning with the string "<code>xml</code>",
or any string which would match <code>(('X'|'x') ('M'|'m') ('L'|'l'))</code>,
are reserved for standardization in this or future versions of this specification.</p>
<div class="note"><p class="prefix"><b>Note:</b></p>
(<a href="#NT-SystemLiteral">SystemLiteral</a>). Note that a <a href="#NT-SystemLiteral">SystemLiteral</a>
can be parsed without scanning for markup.</p>
-<h5>Literals</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EntityValue"></a>[9] </td><td><code>EntityValue</code></td><td> ::= </td><td><code>'
"' ([^%&"] | <a href="#NT-PEReference">PEReference</a>
-| <a href="#NT-Reference">Reference</a>)* '
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^%&'] | <a href="#NT-PEReference">PEReference</a> | <a href="#NT-Reference">Reference</a>)* "'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-AttValue"></a>[10] </td><td><code>AttValue</code></td><td> ::= </td><td><code>'"' ([^<&"] | <a href="#NT-Reference">Reference</a>)*
-'
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^<&'] | <a href="#NT-Reference">Reference</a>)*
-"'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-SystemLiteral"></a>[11] </td><td><code>SystemLiteral</code></td><td> ::= </td><td><code>('"' [^"]* '"') | ("'" [^']* "'") </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidLiteral"></a>[12] </td><td><code>PubidLiteral</code></td><td> ::= </td><td><code>'"' <a href="#NT-PubidChar">PubidChar</a>* '"'
-|
"'" (<a href="#NT-PubidChar">PubidChar</a> - "'")* "'"</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidChar"></a>[13] </td><td><code>PubidChar</code></td><td> ::= </td><td><code>#x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</code></td><xsltdebug></xsltdebug></tr></tbody></table>
+<h5>Literals</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EntityValue"></a>[9] </td><td><code>EntityValue</code></td><td> ::= </td><td><code>'
"' ([^%&"] | <a href="#NT-PEReference">PEReference</a>
+| <a href="#NT-Reference">Reference</a>)* '
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^%&'] | <a href="#NT-PEReference">PEReference</a> | <a href="#NT-Reference">Reference</a>)* "'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-AttValue"></a>[10] </td><td><code>AttValue</code></td><td> ::= </td><td><code>'"' ([^<&"] | <a href="#NT-Reference">Reference</a>)*
+'
"' </code></td><xsltdebug></xsltdebug></tr><tr valign="baseline"><td></td><td></td><td></td><td><code>| "'" ([^<&'] | <a href="#NT-Reference">Reference</a>)*
+"'"</code></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-SystemLiteral"></a>[11] </td><td><code>SystemLiteral</code></td><td> ::= </td><td><code>('"' [^"]* '"') | ("'" [^']* "'") </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidLiteral"></a>[12] </td><td><code>PubidLiteral</code></td><td> ::= </td><td><code>'"' <a href="#NT-PubidChar">PubidChar</a>* '"'
+|
"'" (<a href="#NT-PubidChar">PubidChar</a> - "'")* "'"</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PubidChar"></a>[13] </td><td><code>PubidChar</code></td><td> ::= </td><td><code>#x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</code></td><xsltdebug></xsltdebug></tr></tbody></table>
<div class="note"><p class="prefix"><b>Note:</b></p>
<p>Although
the <a href="#NT-EntityValue">EntityValue</a> production allows the definition
of an entity consisting of a single explicit <code><</code> in the literal
-(e.g., <code><!ENTITY mylt "<"></code>), it is strongly advised to avoid
+(e.g., <code><!ENTITY mylt "<"></code>), it is strongly advised to avoid
this practice since any reference to that entity will cause a well-formedness
error.</p>
</div>
instruction</a>, or a <a title="CDATA Section" href="#dt-cdsection">CDATA section</a>.
If they are needed elsewhere, they must be <a title="escape" href="#dt-escape">escaped</a>
using either <a title="Character Reference" href="#dt-charref">numeric character references</a>
-or the strings "<code>&amp;</code>" and "<code>&lt;</code>"
-respectively. The right angle bracket (>) may be represented using the string "<code>&gt;</code>",
+or the strings "<code>&amp;</code>" and "<code>&lt;</code>"
+respectively. The right angle bracket (>) may be represented using the string "<code>&gt;</code>",
and must, <a title="For Compatibility" href="#dt-compat">for compatibility</a>, be escaped
-using "<code>&gt;</code>" or a character reference when it
-appears in the string "<code>]]></code>" in content, when
+using "<code>&gt;</code>" or a character reference when it
+appears in the string "<code>]]></code>" in content, when
that string is not marking the end of a <a title="CDATA Section" href="#dt-cdsection">CDATA
section</a>.</p>
<p>In the content of elements, character data is any string of characters
which does not contain the start-delimiter of any markup. In a CDATA section,
character data is any string of characters not including the CDATA-section-close
-delimiter, "<code>]]></code>".</p>
+delimiter, "<code>]]></code>".</p>
<p>To allow attribute values to contain both single and double quotes, the
-apostrophe or single-quote character (') may be represented as "<code>&apos;</code>",
-and the double-quote character (") as "<code>&quot;</code>".</p>
+apostrophe or single-quote character (') may be represented as "<code>&apos;</code>",
+and the double-quote character (") as "<code>&quot;</code>".</p>
<h5>Character Data</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-CharData"></a>[14] </td><td><code>CharData</code></td><td> ::= </td><td><code>[^<&]* - ([^<&]* ']]>' [^<&]*)</code></td><xsltdebug></xsltdebug></tr></tbody></table>
</div>
allowed by the grammar. They are not part of the document's <a title="Character Data" href="#dt-chardata">character
data</a>; an XML processor may, but need not, make it possible for an
application to retrieve the text of comments. <a title="For Compatibility" href="#dt-compat">For
-compatibility</a>, the string "<code>--</code>" (double-hyphen)
+compatibility</a>, the string "<code>--</code>" (double-hyphen)
must not occur within comments.] Parameter
entity references are not recognized within comments.</p>
<p>PIs are not part of the document's <a title="Character Data" href="#dt-chardata">character
data</a>, but must be passed through to the application. The PI begins
with a target (<a href="#NT-PITarget">PITarget</a>) used to identify the application
-to which the instruction is directed. The target names "<code>XML</code>", "<code>xml</code>",
+to which the instruction is directed. The target names "<code>XML</code>", "<code>xml</code>",
and so on are reserved for standardization in this or future versions of this
specification. The XML <a title="Notation" href="#dt-notation">Notation</a> mechanism
may be used for formal declaration of PI targets. Parameter
<p>[<a name="dt-cdsection" title="CDATA Section">Definition</a>: <b>CDATA sections</b>
may occur anywhere character data may occur; they are used to escape blocks
of text containing characters which would otherwise be recognized as markup.
-CDATA sections begin with the string "<code><![CDATA[</code>"
-and end with the string "<code>]]></code>":]</p>
+CDATA sections begin with the string "<code><![CDATA[</code>"
+and end with the string "<code>]]></code>":]</p>
<h5>CDATA Sections</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-CDSect"></a>[18] </td><td><code>CDSect</code></td><td> ::= </td><td><code><a href="#NT-CDStart">CDStart</a> <a href="#NT-CData">CData</a> <a href="#NT-CDEnd">CDEnd</a></code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CDStart"></a>[19] </td><td><code>CDStart</code></td><td> ::= </td><td><code>'<![CDATA['</code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CData"></a>[20] </td><td><code>CData</code></td><td> ::= </td><td><code>(<a href="#NT-Char">Char</a>* - (<a href="#NT-Char">Char</a>*
']]>' <a href="#NT-Char">Char</a>*)) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-CDEnd"></a>[21] </td><td><code>CDEnd</code></td><td> ::= </td><td><code>']]>'</code></td><xsltdebug></xsltdebug></tr></tbody></table>
<p>Within a CDATA section, only the <a href="#NT-CDEnd">CDEnd</a> string is
recognized as markup, so that left angle brackets and ampersands may occur
-in their literal form; they need not (and cannot) be escaped using "<code>&lt;</code>"
-and "<code>&amp;</code>". CDATA sections cannot nest.</p>
-<p>An example of a CDATA section, in which "<code><greeting></code>"
-and
"<code></greeting></code>" are recognized as <a title="Character Data" href="#dt-chardata">character data</a>, not <a title="Markup" href="#dt-markup">markup</a>:</p>
+in their literal form; they need not (and cannot) be escaped using "<code>&lt;</code>"
+and "<code>&amp;</code>". CDATA sections cannot nest.</p>
+<p>An example of a CDATA section, in which "<code><greeting></code>"
+and
"<code></greeting></code>" are recognized as <a title="Character Data" href="#dt-chardata">character data</a>, not <a title="Markup" href="#dt-markup">markup</a>:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><![CDATA[<greeting>Hello, world!</greeting>]]> </pre></td></tr></table>
</div>
<div class="div2">
<p>[<a name="dt-xmldecl" title="XML Declaration">Definition</a>: XML documents should
begin with an <b>XML declaration</b> which specifies the version of
XML being used.] For example, the following is a complete XML document, <a title="Well-Formed" href="#dt-wellformed">well-formed</a> but not <a title="Validity" href="#dt-valid">valid</a>:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <greeting>Hello, world!</greeting> </pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <greeting>Hello, world!</greeting> </pre></td></tr></table>
<p>and so is this:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><greeting>Hello, world!</greeting></pre></td></tr></table>
-<p>The version number "<code>1.0</code>" should be used to indicate
+<p>The version number "<code>1.0</code>" should be used to indicate
conformance to this version of this specification; it is an error for a document
-to use the value "<code>1.0</code>" if it does not conform to
+to use the value "<code>1.0</code>" if it does not conform to
this version of this specification. It is the intent of the XML working group
-to give later versions of this specification numbers other than "<code>1.0</code>",
+to give later versions of this specification numbers other than "<code>1.0</code>",
but this intent does not indicate a commitment to produce any future versions
of XML, nor if any are produced, to use any particular numbering scheme. Since
future versions are not ruled out, this construct is provided as a means to
(<a href="#NT-doctypedecl">doctypedecl</a> <a href="#NT-Misc">Misc</a>*)?</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-XMLDecl"></a>[23] </td><td><code>XMLDecl</code></td><td> ::= </td><td><code>'<?xml' <a href="#NT-VersionInfo">VersionInfo</a> <a href="#NT-EncodingDecl">EncodingDecl</a>? <a href="#NT-SDDecl">SDDecl</a>? <a href="#NT-S">S</a>? '?>'</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-VersionInfo"></a>[24] </td><td><code>VersionInfo</code></td><td> ::= </td><td><code><a href="#NT-S">S</a> 'version' <a href="#NT-Eq">Eq</a>
-(
"'" <a href="#NT-VersionNum">VersionNum</a> "'" | '"' <a href="#NT-VersionNum">VersionNum</a>
-'"')<i>/* */</i></code></td><xsltdebug></xsltdebug></tr>
+(
"'" <a href="#NT-VersionNum">VersionNum</a> "'" | '"' <a href="#NT-VersionNum">VersionNum</a>
+'"')<i>/* */</i></code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-Eq"></a>[25] </td><td><code>Eq</code></td><td> ::= </td><td><code><a href="#NT-S">S</a>? '=' <a href="#NT-S">S</a>?</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-VersionNum"></a>[26] </td><td><code>VersionNum</code></td><td> ::= </td><td><code>([a-zA-Z0-9_.:] | '-')+</code></td><xsltdebug></xsltdebug></tr>
<tr valign="baseline"><td><a name="NT-Misc"></a>[27] </td><td><code>Misc</code></td><td> ::= </td><td><code><a href="#NT-Comment">Comment</a> | <a href="#NT-PI">PI</a>
references</a> are permitted <em>within</em> markup declarations,
not only <em>between</em> markup declarations.</p>
<p>An example of an XML document with a document type declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> <greeting>Hello, world!</greeting> </pre></td></tr></table>
-<p>The <a title="System Identifier" href="#dt-sysid">system identifier</a> "<code>hello.dtd</code>"
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> <greeting>Hello, world!</greeting> </pre></td></tr></table>
+<p>The <a title="System Identifier" href="#dt-sysid">system identifier</a> "<code>hello.dtd</code>"
gives the address
(a URI reference) of a DTD for the document.</p>
<p>The declarations can also be given locally, as in this example:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" encoding="UTF-8" ?>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE greeting [
<!ELEMENT greeting (#PCDATA)>
]>
<h5>Standalone Document Declaration</h5><table class="scrap" summary="Scrap"><tbody>
<tr valign="baseline"><td><a name="NT-SDDecl"></a>[32] </td><td><code>SDDecl</code></td><td> ::= </td><td><code> <a href="#NT-S">S</a> 'standalone' <a href="#NT-Eq">Eq</a>
-((
"'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"')) </code></td><xsltdebug></xsltdebug><td><a href="#vc-check-rmd">[VC: Standalone Document Declaration]</a></td></tr>
+((
"'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"')) </code></td><xsltdebug></xsltdebug><td><a href="#vc-check-rmd">[VC: Standalone Document Declaration]</a></td></tr>
</tbody></table>
-<p>In a standalone document declaration, the value "yes" indicates
+<p>In a standalone document declaration, the value "yes" indicates
that there are no <a title="External Markup Declaration" href="#dt-extmkpdecl">external markup declarations</a> which
affect the information passed from the XML processor to the application. The
-value "no" indicates that there are or may be such external
+value "no" indicates that there are or may be such external
markup declarations. Note that the standalone document declaration only denotes
the presence of external <em>declarations</em>; the presence, in a document,
of references to external <em>entities</em>, when those entities are internally
declared, does not change its standalone status.</p>
<p>If there are no external markup declarations, the standalone document declaration
has no meaning. If there are external markup declarations but there is no
-standalone document declaration, the value "no" is assumed.</p>
-<p>Any XML document for which <code>standalone="no"</code> holds can be converted
+standalone document declaration, the value "no" is assumed.</p>
+<p>Any XML document for which <code>standalone="no"</code> holds can be converted
algorithmically to a standalone document, which may be desirable for some
network delivery applications.</p>
<div class="constraint"><p class="prefix"><a name="vc-check-rmd"></a><b>Validity constraint: Standalone Document Declaration</b></p><p>The
-standalone document declaration must have the value "no" if
+standalone document declaration must have the value "no" if
any external markup declarations contain declarations of:</p>
<ul>
<li><p>attributes with <a title="Attribute Default" href="#dt-default">default</a> values,
</ul>
</div>
<p>An example XML declaration with a standalone document declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" standalone='yes'?></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><?xml version="1.0" standalone='yes'?></pre></td></tr></table>
</div>
<div class="div2">
<h3><a name="sec-white-space"></a>2.10 White Space Handling</h3>
-<p>In editing XML documents, it is often convenient to use "white space"
+<p>In editing XML documents, it is often convenient to use "white space"
(spaces, tabs, and blank lines)
to set apart the markup for greater readability. Such white space is typically
not intended for inclusion in the delivered version of the document. On the
-other hand, "significant" white space that should be preserved
+other hand, "significant" white space that should be preserved
in the delivered version is common, for example in poetry and source code.</p>
<p>An <a title="XML Processor" href="#dt-xml-proc">XML processor</a> must always pass
all characters in a document that are not markup through to the application.
attribute, like any other, must be <a title="Attribute-List Declaration" href="#dt-attdecl">declared</a>
if it is used. When declared, it must be given as an <a title="Enumerated Attribute Values" href="#dt-enumerated">enumerated
type</a> whose values
-are one or both of "default" and "preserve".
+are one or both of "default" and "preserve".
For example:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ATTLIST poem xml:space (default|preserve) 'preserve'>
<!-- -->
<!ATTLIST pre xml:space (preserve) #FIXED 'preserve'></pre></td></tr></table>
-<p>The value "default" signals that applications' default white-space
-processing modes are acceptable for this element; the value "preserve"
+<p>The value "default" signals that applications' default white-space
+processing modes are acceptable for this element; the value "preserve"
indicates the intent that applications preserve all the white space. This
declared intent is considered to apply to all elements within the content
of the element where it is specified, unless overriden with another instance
<p>For example:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p xml:lang="en">The quick brown fox jumps over the lazy dog.</p>
-<p xml:lang="en-GB">What colour is it?</p>
-<p xml:lang="en-US">What color is it?</p>
-<sp who="Faust" desc='leise' xml:lang="de">
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p xml:lang="en">The quick brown fox jumps over the lazy dog.</p>
+<p xml:lang="en-GB">What colour is it?</p>
+<p xml:lang="en-US">What color is it?</p>
+<sp who="Faust" desc='leise' xml:lang="de">
<l>Habe nun, ach! Philosophie,</l>
<l>Juristerei, und Medizin</l>
<l>und leider auch Theologie</l>
of which are either delimited by <a title="Start-Tag" href="#dt-stag">start-tags</a>
and <a title="End Tag" href="#dt-etag">end-tags</a>, or, for <a title="Empty" href="#dt-empty">empty</a>
elements, by an <a title="empty-element tag" href="#dt-eetag">empty-element tag</a>. Each
-element has a type, identified by name, sometimes called its "generic
-identifier" (GI), and may have a set of attribute specifications.]
+element has a type, identified by name, sometimes called its "generic
+identifier" (GI), and may have a set of attribute specifications.]
Each attribute specification has a <a title="Attribute Name" href="#dt-attrname">name</a>
and a <a title="Attribute Value" href="#dt-attrval">value</a>.</p>
<p>The <a href="#NT-Name">Name</a> in the start- and end-tags gives the element's <b>type</b>. [<a name="dt-attr" title="Attribute">Definition</a>: The <a href="#NT-Name">Name</a>-<a href="#NT-AttValue">AttValue</a>
pairs are referred to as the <b>attribute specifications</b> of the
element], [<a name="dt-attrname" title="Attribute Name">Definition</a>: with the <a href="#NT-Name">Name</a> in each pair referred to as the <b>attribute name</b>]
-and [<a name="dt-attrval" title="Attribute Value">Definition</a>: the content of the <a href="#NT-AttValue">AttValue</a> (the text between the <code>'</code> or <code>"</code>
+and [<a name="dt-attrval" title="Attribute Value">Definition</a>: the content of the <a href="#NT-AttValue">AttValue</a> (the text between the <code>'</code> or <code>"</code>
delimiters) as the <b>attribute value</b>.]Note
that the order of attribute specifications in a start-tag or empty-element
tag is not significant.</p>
referred to directly or indirectly in an attribute value must not contain a <code><</code>.</p>
</div>
<p>An example of a start-tag:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><termdef id="dt-dog" term="dog"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><termdef id="dt-dog" term="dog"></pre></td></tr></table>
<p>[<a name="dt-etag" title="End Tag">Definition</a>: The end of every element that begins
with a start-tag must be marked by an <b>end-tag</b> containing a name
that echoes the element's type as given in the start-tag:]</p>
be used, and should only be used, for elements which are declared
EMPTY.</p>
<p>Examples of empty elements:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><IMG align="left"
- src="http://www.w3.org/Icons/WWW/w3c_home" />
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><IMG align="left"
+ src="http://www.w3.org/Icons/WWW/w3c_home" />
<br></br>
<br/></pre></td></tr></table>
</div>
</tbody></table>
<p>where the <a href="#NT-Name">Name</a>s give the types of elements that
may appear as children. The
-keyword <b>#PCDATA</b> derives historically from the term "parsed
-character data."</p>
+keyword <b>#PCDATA</b> derives historically from the term "parsed
+character data."</p>
<div class="constraint"><p class="prefix"><a name="vc-MixedChildrenUnique"></a><b>Validity constraint: No Duplicate Types</b></p><p>The
same name must not appear more than once in a single mixed-content declaration.</p>
</div>
id ID #REQUIRED
name CDATA #IMPLIED>
<!ATTLIST list
- type (bullets|ordered|glossary) "ordered">
+ type (bullets|ordered|glossary) "ordered">
<!ATTLIST form
- method CDATA #FIXED "POST"></pre></td></tr></table>
+ method CDATA #FIXED "POST"></pre></td></tr></table>
</div>
<div class="div3">
as if declared <b>CDATA</b>.</p>
<p>Following are examples of attribute normalization. Given the following
declarations:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY d "&#xD;">
-<!ENTITY a "&#xA;">
-<!ENTITY da "&#xD;&#xA;"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY d "&#xD;">
+<!ENTITY a "&#xA;">
+<!ENTITY da "&#xD;&#xA;"></pre></td></tr></table>
<p>the attribute specifications in the left column below would be normalized
to the character sequences of the middle column if the attribute <code>a</code>
is declared <b>NMTOKENS</b> and to those of the right columns if <code>a</code>
is declared <b>CDATA</b>.</p>
<table border="1" frame="border"><thead><tr><th colspan="1" rowspan="1">Attribute specification</th>
-<th colspan="1" rowspan="1">a is NMTOKENS</th><th colspan="1" rowspan="1">a is CDATA</th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="
+<th colspan="1" rowspan="1">a is NMTOKENS</th><th colspan="1" rowspan="1">a is CDATA</th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="
-xyz"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>x y z</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 x y z</code></td>
-</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="&d;&d;A&a;&a;B&da;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>A
+xyz"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>x y z</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 x y z</code></td>
+</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a="&d;&d;A&a;&a;B&da;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>A
#x20 B</code></td><td colspan="1" rowspan="1"><code>#x20 #x20 A #x20 #x20 B #x20 #x20</code></td>
</tr><tr><td colspan="1" rowspan="1"><table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>a=
-"&#xd;&#xd;A&#xa;&#xa;B&#xd;&#xa;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>#xD
+"&#xd;&#xd;A&#xa;&#xa;B&#xd;&#xa;"</pre></td></tr></table></td><td colspan="1" rowspan="1"><code>#xD
#xD A #xA #xA B #xD #xA</code></td><td colspan="1" rowspan="1"><code>#xD #xD A #xA #xA B #xD #xD</code></td>
</tr></tbody></table>
<p>Note that the last example is invalid (but well-formed) if <code>a</code>
('<![' | ']]>') <a href="#NT-Char">Char</a>*) </code></td><xsltdebug></xsltdebug></tr>
</tbody></table>
<div class="constraint"><p class="prefix"><a name="condsec-nesting"></a><b>Validity constraint: Proper
-Conditional Section/PE Nesting</b></p><p>If any of the "<code><![</code>",
-"<code>[</code>", or "<code>]]></code>" of a conditional section is contained
+Conditional Section/PE Nesting</b></p><p>If any of the "<code><![</code>",
+"<code>[</code>", or "<code>]]></code>" of a conditional section is contained
in the replacement text for a parameter-entity reference, all of them must
be contained in the same replacement text.</p>
</div>
a larger conditional section with a keyword of <b>IGNORE</b>, both the outer
and the inner conditional sections are ignored. The contents
of an ignored conditional section are parsed by ignoring all characters after
-the "<code>[</code>" following the keyword, except conditional section starts
-"<code><![</code>" and ends "<code>]]></code>", until the matching conditional
+the "<code>[</code>" following the keyword, except conditional section starts
+"<code><![</code>" and ends "<code>]]></code>", until the matching conditional
section end is found. Parameter entity references are not recognized in this
process.</p>
<p>If the keyword of the conditional section is a parameter-entity reference,
<div class="constraint"><p class="prefix"><a name="wf-Legalchar"></a><b>Well-formedness constraint: Legal Character</b></p><p>Characters referred
to using character references must match the production for <a title="" href="#NT-Char">Char</a>.</p>
</div>
-<p>If the character reference begins with "<code>&#x</code>",
+<p>If the character reference begins with "<code>&#x</code>",
the digits and letters up to the terminating <code>;</code> provide a hexadecimal
representation of the character's code point in ISO/IEC 10646. If it begins
-just with "<code>&#</code>", the digits up to the terminating <code>;</code>
+just with "<code>&#</code>", the digits up to the terminating <code>;</code>
provide a decimal representation of the character's code point.</p>
<p>[<a name="dt-entref" title="Entity Reference">Definition</a>: An <b>entity reference</b>
refers to the content of a named entity.] [<a name="dt-GERef" title="General Entity Reference">Definition</a>: References to parsed general entities use
<h5>Entity Reference</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-Reference"></a>[67] </td><td><code>Reference</code></td><td> ::= </td><td><code><a href="#NT-EntityRef">EntityRef</a> | <a href="#NT-CharRef">CharRef</a></code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EntityRef"></a>[68] </td><td><code>EntityRef</code></td><td> ::= </td><td><code>'&' <a href="#NT-Name">Name</a> ';'</code></td><xsltdebug></xsltdebug><td><a href="#wf-entdeclared">[WFC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#vc-entdeclared">[VC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#textent">[WFC: Parsed Entity]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#norecursion">[WFC: No Recursion]</a></td></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-PEReference"></a>[69] </td><td><code>PEReference</code></td><td> ::= </td><td><code>'%' <a href="#NT-Name">Name</a> ';'</code></td><xsltdebug></xsltdebug><td><a href="#vc-entdeclared">[VC: Entity Declared]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#norecursion">[WFC: No Recursion]</a></td></tr><tr valign="baseline"><td></td><td></td><td></td><td></td><td><a href="#indtd">[WFC: In DTD]</a></td></tr></tbody></table>
<div class="constraint"><p class="prefix"><a name="wf-entdeclared"></a><b>Well-formedness constraint: Entity Declared</b></p><p>In a document
without any DTD, a document with only an internal DTD subset which contains
-no parameter entity references, or a document with "<code>standalone='yes'</code>", for
+no parameter entity references, or a document with "<code>standalone='yes'</code>", for
an entity reference that does not occur within the external subset or a parameter
entity, the <a href="#NT-Name">Name</a> given in the entity reference must <a title="match" href="#dt-match">match</a> that in an <a href="#sec-entity-decl"><cite>entity
declaration</cite></a> that does not occur within the external subset or a
if <a href="#sec-rmd"><cite>standalone='yes'</cite></a>.</p>
</div>
<div class="constraint"><p class="prefix"><a name="vc-entdeclared"></a><b>Validity constraint: Entity Declared</b></p><p>In a document with
-an external subset or external parameter entities with "<code>standalone='no'</code>",
+an external subset or external parameter entities with "<code>standalone='no'</code>",
the <a href="#NT-Name">Name</a> given in the entity reference must <a title="match" href="#dt-match">match</a> that in an <a href="#sec-entity-decl"><cite>entity
declaration</cite></a>. For interoperability, valid documents should declare
the entities <code>amp</code>,
This document was prepared on &docdate; and
is classified &security-level;.</pre></td></tr></table>
<p>Example of a parameter-entity reference:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!-- declare the parameter entity "ISOLat2"... -->
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!-- declare the parameter entity "ISOLat2"... -->
<!ENTITY % ISOLat2
- SYSTEM "http://www.xml.com/iso/isolat2-xml.entities" >
+ SYSTEM "http://www.xml.com/iso/isolat2-xml.entities" >
<!-- ... now reference it. -->
%ISOLat2;</pre></td></tr></table>
</div>
the correct <a title="Replacement Text" href="#dt-repltext">replacement text</a>: see <a href="#intern-replacement"><b>4.5 Construction of Internal Entity Replacement Text</b></a>.</p>
<p>An internal entity is a <a title="Text Entity" href="#dt-parsedent">parsed entity</a>.</p>
<p>Example of an internal entity declaration:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY Pub-Status "This is a pre-release of the
- specification."></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY Pub-Status "This is a pre-release of the
+ specification."></pre></td></tr></table>
</div>
<div class="div3">
be removed.</p>
<p>Examples of external entity declarations:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY open-hatch
- SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
+ SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
<!ENTITY open-hatch
- PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN"
- "http://www.textuality.com/boilerplate/OpenHatch.xml">
+ PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN"
+ "http://www.textuality.com/boilerplate/OpenHatch.xml">
<!ENTITY hatch-pic
- SYSTEM "../grafix/OpenHatch.gif"
+ SYSTEM "../grafix/OpenHatch.gif"
NDATA gif ></pre></td></tr></table>
</div>
</div>
<h4><a name="charencoding"></a>4.3.3 Character Encoding in Entities</h4>
<p>Each external parsed entity in an XML document may use a different encoding
for its characters. All XML processors must be able to read entities in both
-the UTF-8 and UTF-16 encodings. The terms "UTF-8"
-and "UTF-16" in this specification do not apply to character
+the UTF-8 and UTF-16 encodings. The terms "UTF-8"
+and "UTF-16" in this specification do not apply to character
encodings with any other labels, even if the encodings or labels are very
similar to UTF-8 or UTF-16.</p>
<p>Entities encoded in UTF-16 must begin with the Byte Order Mark described
an encoding declaration:</p>
<h5>Encoding Declaration</h5><table class="scrap" summary="Scrap"><tbody><tr valign="baseline"><td><a name="NT-EncodingDecl"></a>[80] </td><td><code>EncodingDecl</code></td><td> ::= </td><td><code><a href="#NT-S">S</a> 'encoding' <a href="#NT-Eq">Eq</a>
-('
"' <a href="#NT-EncName">EncName</a> '"' | "'" <a href="#NT-EncName">EncName</a>
-
"'" ) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EncName"></a>[81] </td><td><code>EncName</code></td><td> ::= </td><td><code>[A-Za-z] ([A-Za-z0-9._] | '-')*</code></td><xsltdebug></xsltdebug><td><i>/* Encoding
+('
"' <a href="#NT-EncName">EncName</a> '"' | "'" <a href="#NT-EncName">EncName</a>
+
"'" ) </code></td><xsltdebug></xsltdebug></tr></tbody><tbody><tr valign="baseline"><td><a name="NT-EncName"></a>[81] </td><td><code>EncName</code></td><td> ::= </td><td><code>[A-Za-z] ([A-Za-z0-9._] | '-')*</code></td><xsltdebug></xsltdebug><td><i>/* Encoding
name contains only Latin characters */</i></td></tr></tbody></table>
<p>In the <a title="Document Entity" href="#dt-docent">document entity</a>, the encoding
declaration is part of the <a title="XML Declaration" href="#dt-xmldecl">XML declaration</a>.
The <a href="#NT-EncName">EncName</a> is the name of the encoding used.</p>
-<p>In an encoding declaration, the values "<code>UTF-8</code>", "<code>UTF-16</code>", "<code>ISO-10646-UCS-2</code>", and "<code>ISO-10646-UCS-4</code>" should be used
+<p>In an encoding declaration, the values "<code>UTF-8</code>", "<code>UTF-16</code>", "<code>ISO-10646-UCS-2</code>", and "<code>ISO-10646-UCS-4</code>" should be used
for the various encodings and transformations of Unicode / ISO/IEC 10646,
-the values "<code>ISO-8859-1</code>", "<code>ISO-8859-2</code>",
-... "<code>ISO-8859-</code><var>n</var>" (where <var>n</var>
+the values "<code>ISO-8859-1</code>", "<code>ISO-8859-2</code>",
+... "<code>ISO-8859-</code><var>n</var>" (where <var>n</var>
is the part number) should be used for the parts of ISO 8859, and
-the values "<code>ISO-2022-JP</code>", "<code>Shift_JIS</code>",
-and "<code>EUC-JP</code>" should be used for the various encoded
+the values "<code>ISO-2022-JP</code>", "<code>Shift_JIS</code>",
+and "<code>EUC-JP</code>" should be used for the various encoded
forms of JIS X-0208-1997. It
is recommended that character encodings registered (as <em>charset</em>s)
with the Internet Assigned Numbers Authority <a href="#IANA">[IANA-CHARSETS]</a>,
other than those just listed, be referred to using their registered names;
-other encodings should use names starting with an "x-" prefix.
+other encodings should use names starting with an "x-" prefix.
XML processors should match character encoding names in a case-insensitive
way and should either interpret an IANA-registered name as the encoding registered
at IANA for that name or treat it as unknown (processors are, of course, not
the document at the location the reference was recognized.] The replacement
text may contain both <a title="Character Data" href="#dt-chardata">character data</a>
and (except for parameter entities) <a title="Markup" href="#dt-markup">markup</a>,
-which must be recognized in the usual way. (The string "<code>AT&amp;T;</code>"
-expands to "<code>AT&T;</code>" and the remaining ampersand
+which must be recognized in the usual way. (The string "<code>AT&amp;T;</code>"
+expands to "<code>AT&T;</code>" and the remaining ampersand
is not recognized as an entity-reference delimiter.) A character reference
is <b>included</b> when the indicated character is processed in place
of the reference itself. </p>
quote character in the replacement text is always treated as a normal data
character and will not terminate the literal. For example, this is well-formed:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!-- -->
-<!ENTITY % YN '"Yes"' >
-<!ENTITY WhatHeSaid "He said %YN;" ></pre></td></tr></table>
+<!ENTITY % YN '"Yes"' >
+<!ENTITY WhatHeSaid "He said %YN;" ></pre></td></tr></table>
<p>while this is not:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY EndAttr "27'" >
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY EndAttr "27'" >
<element attribute='a-&EndAttr;></pre></td></tr></table>
</div>
<div class="div3">
referred to, in place of any character references in the literal entity value;
however, general-entity references must be left as-is, unexpanded. For example,
given the following declarations:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY % pub "&#xc9;ditions Gallimard" >
-<!ENTITY rights "All rights reserved" >
-<!ENTITY book "La Peste: Albert Camus,
-&#xA9; 1947 %pub;. &rights;" ></pre></td></tr></table>
-<p>then the replacement text for the entity "<code>book</code>"
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY % pub "&#xc9;ditions Gallimard" >
+<!ENTITY rights "All rights reserved" >
+<!ENTITY book "La Peste: Albert Camus,
+&#xA9; 1947 %pub;. &rights;" ></pre></td></tr></table>
+<p>then the replacement text for the entity "<code>book</code>"
is:</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre>La Peste: Albert Camus,
© 1947 Éditions Gallimard. &rights;</pre></td></tr></table>
-<p>The general-entity reference "<code>&rights;</code>" would
-be expanded should the reference "<code>&book;</code>" appear
+<p>The general-entity reference "<code>&rights;</code>" would
+be expanded should the reference "<code>&book;</code>" appear
in the document's content or an attribute value.</p>
<p>These simple rules may have complex interactions; for a detailed discussion
of a difficult example, see <a href="#sec-entexpand"><b>D Expansion of Entity and Character References</b></a>.</p>
<code>quot</code>) is specified for
this purpose. Numeric character references may also be used; they are expanded
immediately when recognized and must be treated as character data, so the
-numeric character references "<code>&#60;</code>" and "<code>&#38;</code>"
+numeric character references "<code>&#60;</code>" and "<code>&#38;</code>"
may be used to escape <code><</code> and <code>&</code> when they occur
in character data.]</p>
<p>All XML processors must recognize these entities whether they are declared
whose replacement text is the single character being escaped (or a character
reference to that character; the double escaping here is unnecessary but harmless).
For example:</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY lt "&#38;#60;">
-<!ENTITY gt "&#62;">
-<!ENTITY amp "&#38;#38;">
-<!ENTITY apos "&#39;">
-<!ENTITY quot "&#34;"></pre></td></tr></table>
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY lt "&#38;#60;">
+<!ENTITY gt "&#62;">
+<!ENTITY amp "&#38;#38;">
+<!ENTITY apos "&#39;">
+<!ENTITY quot "&#34;"></pre></td></tr></table>
</div>
<div class="div2">
in those declarations to <a href="#AVNormalize"><cite>normalize</cite></a>
attribute values, <a href="#included"><cite>include</cite></a> the replacement
text of internal entities, and supply <a href="#sec-attr-defaults"><cite>default
-attribute values</cite></a>.] Except when <code>standalone="yes"</code>, they
+attribute values</cite></a>.] Except when <code>standalone="yes"</code>, they
must not <a title="Process Declarations" href="#dt-use-mdecl">process</a> <a title="entity declaration" href="#dt-entdecl">entity
declarations</a> or <a title="Attribute-List Declaration" href="#dt-attdecl">attribute-list declarations</a>
encountered after a reference to a parameter entity that is not read, since
<p>matches any <a href="#NT-Char">Char</a> with a value not among the characters given. Enumerations
and ranges of forbidden values can be mixed in one set of brackets.</p>
</dd>
-<dt class="label"><code>"string"</code></dt>
+<dt class="label"><code>"string"</code></dt>
<dd>
<p>matches a literal string <a title="match" href="#dt-match">matching</a> that
given inside the double quotes.</p>
<li><p>Characters in the compatibility area (i.e. with character code greater
than #xF900 and less than #xFFFE) are not allowed in XML names.</p></li>
<li><p>Characters which have a font or compatibility decomposition (i.e.
-those with a "compatibility formatting tag" in field 5 of the
-database -- marked by field 5 beginning with a "<") are not
+those with a "compatibility formatting tag" in field 5 of the
+database -- marked by field 5 beginning with a "<") are not
allowed.</p></li>
<li><p>The following characters are treated as name-start characters rather
than name characters, because the property file classifies them as Alphabetic:
<p>This appendix contains some examples illustrating the sequence of entity-
and character-reference recognition and expansion, as specified in <a href="#entproc"><b>4.4 XML Processor Treatment of Entities and References</b></a>.</p>
<p>If the DTD contains the declaration</p>
-<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY example "<p>An ampersand (&#38;#38;) may be escaped
+<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><!ENTITY example "<p>An ampersand (&#38;#38;) may be escaped
numerically (&#38;#38;#38;) or with a general entity
-(&amp;amp;).</p>" ></pre></td></tr></table>
+(&amp;amp;).</p>" ></pre></td></tr></table>
<p>then the XML processor will recognize the character references when it
parses the entity declaration, and resolve them before storing the following
-string as the value of the entity "<code>example</code>":</p>
+string as the value of the entity "<code>example</code>":</p>
<table class="eg" cellpadding="5" border="1" bgcolor="#99ffff" width="100%" summary="Example"><tr><td><pre><p>An ampersand (&#38;) may be escaped
numerically (&#38;#38;) or with a general entity
(&amp;amp;).</p></pre></td></tr></table>
-<p>A reference in the document to "<code>&example;</code>"
+<p>A reference in the document to "<code>&example;</code>"
will cause the text to be reparsed, at which time the start- and end-tags
of the <code>p</code> element will be recognized and the three references will
be recognized and expanded, resulting in a <code>p</code> element with the following
2 <!DOCTYPE test [
3 <!ELEMENT test (#PCDATA) >
4 <!ENTITY % xx '&#37;zz;'>
-5 <!ENTITY % zz '&#60;!ENTITY tricky "error-prone" >' >
+5 <!ENTITY % zz '&#60;!ENTITY tricky "error-prone" >' >
6 %xx;
7 ]>
8 <test>This sample shows a &tricky; method.</test></pre></td></tr></table>
<p>This produces the following:</p>
<ul>
<li><p>in line 4, the reference to character 37 is expanded immediately,
-and the parameter entity "<code>xx</code>" is stored in the symbol
-table with the value "<code>%zz;</code>". Since the replacement
-text is not rescanned, the reference to parameter entity "<code>zz</code>"
-is not recognized. (And it would be an error if it were, since "<code>zz</code>"
+and the parameter entity "<code>xx</code>" is stored in the symbol
+table with the value "<code>%zz;</code>". Since the replacement
+text is not rescanned, the reference to parameter entity "<code>zz</code>"
+is not recognized. (And it would be an error if it were, since "<code>zz</code>"
is not yet declared.)</p></li>
-<li><p>in line 5, the character reference "<code>&#60;</code>"
-is expanded immediately and the parameter entity "<code>zz</code>"
-is stored with the replacement text "<code><!ENTITY tricky "error-prone"
-></code>", which is a well-formed entity declaration.</p></li>
-<li><p>in line 6, the reference to "<code>xx</code>" is recognized,
-and the replacement text of "<code>xx</code>" (namely "<code>%zz;</code>")
-is parsed. The reference to "<code>zz</code>" is recognized in
-its turn, and its replacement text ("<code><!ENTITY tricky "error-prone"
-></code>") is parsed. The general entity "<code>tricky</code>"
-has now been declared, with the replacement text "<code>error-prone</code>".</p>
+<li><p>in line 5, the character reference "<code>&#60;</code>"
+is expanded immediately and the parameter entity "<code>zz</code>"
+is stored with the replacement text "<code><!ENTITY tricky "error-prone"
+></code>", which is a well-formed entity declaration.</p></li>
+<li><p>in line 6, the reference to "<code>xx</code>" is recognized,
+and the replacement text of "<code>xx</code>" (namely "<code>%zz;</code>")
+is parsed. The reference to "<code>zz</code>" is recognized in
+its turn, and its replacement text ("<code><!ENTITY tricky "error-prone"
+></code>") is parsed. The general entity "<code>tricky</code>"
+has now been declared, with the replacement text "<code>error-prone</code>".</p>
</li>
-<li><p>in line 8, the reference to the general entity "<code>tricky</code>"
+<li><p>in line 8, the reference to the general entity "<code>tricky</code>"
is recognized, and it is expanded, so the full content of the <code>test</code>
element is the self-describing (and ungrammatical) string <em>This sample
shows a error-prone method.</em></p></li>
<p>As
noted in <a href="#sec-element-content"><b>3.2.1 Element Content</b></a>, it is required that content
models in element type declarations be deterministic. This requirement is <a title="For Compatibility" href="#dt-compat">for compatibility</a> with SGML (which calls deterministic
-content models "unambiguous"); XML processors built
+content models "unambiguous"); XML processors built
using SGML systems may flag non-deterministic content models as errors.</p>
<p>For example, the content model <code>((b, c) | (b, d))</code> is non-deterministic,
because given an initial <code>b</code> the XML processor
begin with an XML encoding declaration, in which the first characters must
be '<code><?xml</code>', any conforming processor can detect, after two
to four octets of input, which of the following cases apply. In reading this
-list, it may help to know that in UCS-4, '<' is "<code>#x0000003C</code>"
-and '?' is "<code>#x0000003F</code>", and the Byte Order Mark
-required of UTF-16 data streams is "<code>#xFEFF</code>". The notation <var>##</var> is used to denote any byte value except that two consecutive <var>##</var>s cannot be both 00.</p>
+list, it may help to know that in UCS-4, '<' is "<code>#x0000003C</code>"
+and '?' is "<code>#x0000003F</code>", and the Byte Order Mark
+required of UTF-16 data streams is "<code>#xFEFF</code>". The notation <var>##</var> is used to denote any byte value except that two consecutive <var>##</var>s cannot be both 00.</p>
<p>With a Byte Order Mark:</p>
<table border="1" frame="border"><tbody><tr><td colspan="1" rowspan="1"><code>00 00 FE
FF</code></td><td colspan="1" rowspan="1">UCS-4, big-endian machine (1234 order)</td></tr><tr><td colspan="1" rowspan="1"><code>FF
</div>
<div class="div1">
-<h2><a name="id2676581"></a>I Production Notes (Non-Normative)</h2>
+<h2><a name="id2681697"></a>I Production Notes (Non-Normative)</h2>
<p>This Second Edition was encoded in the <a href="http://www.w3.org/XML/1998/06/xmlspec-v21.dtd">XMLspec
DTD</a> (which has <a href="http://www.w3.org/XML/1998/06/xmlspec-report-v21.htm">documentation</a>
available). The HTML versions were produced with a combination of the <a href="http://www.w3.org/XML/1998/06/xmlspec.xsl">xmlspec.xsl</a>, <a href="http://www.w3.org/XML/1998/06/diffspec.xsl">diffspec.xsl</a>,
static int nbstrparams = 0;
static xmlChar *paths[MAX_PATHS + 1];
static int nbpaths = 0;
-static const char *output = NULL;
+static char *output = NULL;
static int errorno = 0;
static const char *writesubtree = NULL;
output = xmlCanonicPath(argv[i]);
if (output == NULL)
#endif
- output = xmlStrdup(argv[i]);
+ output = (char *) xmlStrdup((xmlChar *) argv[i]);
} else if ((!strcmp(argv[i], "-V")) ||
(!strcmp(argv[i], "-version")) ||
(!strcmp(argv[i], "--version"))) {
projects / platform / upstream / libxslt.git / commitdiff