diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/.gitignore | 2 | ||||
| -rw-r--r-- | doc/Makefile.am | 55 | ||||
| -rw-r--r-- | doc/reference.html | 16 | ||||
| -rw-r--r-- | doc/xmlwf.xml | 18 |
4 files changed, 80 insertions, 11 deletions
diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..65c1472 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +/XMLWF.1 +/xmlwf.1 diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..7c79aa4 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,55 @@ +# +# __ __ _ +# ___\ \/ /_ __ __ _| |_ +# / _ \\ /| '_ \ / _` | __| +# | __// \| |_) | (_| | |_ +# \___/_/\_\ .__/ \__,_|\__| +# |_| XML parser +# +# Copyright (c) 2017 Expat development team +# Licensed under the MIT license: +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to permit +# persons to whom the Software is furnished to do so, subject to the +# following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +# USE OR OTHER DEALINGS IN THE SOFTWARE. + +dist_man_MANS = xmlwf.1 + +xmlwf.1: xmlwf.xml +if WITH_DOCBOOK + $(DOCBOOK_TO_MAN) $< + mv XMLWF.1 $@ +else + @echo 'ERROR: Configure with --with-docbook for "make dist".' 1>&2 + @false +endif + +# https://www.gnu.org/software/automake/manual/automake.html#What-Gets-Cleaned +.PHONY: clean-local +clean-local: clean-local-check + +.PHONY: clean-local-check +clean-local-check: + $(RM) xmlwf.1 + +EXTRA_DIST = \ + expat.png \ + reference.html \ + style.css \ + valid-xhtml10.png \ + xmlwf.xml diff --git a/doc/reference.html b/doc/reference.html index a4ab405..efc19f4 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -31,7 +31,7 @@ the underlying XML parser for the open source Mozilla project, Perl's other open-source XML parsers.</p> <p>This library is the creation of James Clark, who's also given us -groff (an nroff look-alike), Jade (an implemention of ISO's DSSSL +groff (an nroff look-alike), Jade (an implementation of ISO's DSSSL stylesheet language for SGML), XP (a Java XML parser package), XT (a Java XSL engine). James was also the technical lead on the XML Working Group at W3C that produced the XML specification.</p> @@ -277,7 +277,7 @@ directions or Unix directions below.</p> <p>If you're using the GNU compiler under cygwin, follow the Unix directions in the next section. Otherwise if you have Microsoft's Developer Studio installed, then from Windows Explorer double-click on -"expat.dsp" in the lib directory and build and install in the usual +"expat.vcxproj" in the lib directory and build and install in the usual manner.</p> <p>Alternatively, you may download the Win32 binary package that @@ -360,7 +360,7 @@ off by default.</dd> <dd>The number of input bytes of markup context which the parser will ensure are available for reporting via <code><a href= "#XML_GetInputContext" >XML_GetInputContext</a></code>. This is -normally set to 1024, and must be set to a positive interger. If this +normally set to 1024, and must be set to a positive integer. If this is not defined, the input context will not be available and <code><a href= "#XML_GetInputContext" >XML_GetInputContext</a></code> will always report NULL. Without this, Expat has a smaller memory @@ -373,7 +373,7 @@ the right MSVC magic annotations correct. This is ignored on other platforms.</dd> <dt>XML_ATTR_INFO</dt> -<dd>If defined, makes the the additional function <code><a href= +<dd>If defined, makes the additional function <code><a href= "#XML_GetAttributeInfo" >XML_GetAttributeInfo</a></code> available for reporting attribute byte offsets.</dd> </dl> @@ -739,7 +739,7 @@ arguments:</p> <dt><code>XML_PARAM_ENTITY_PARSING_NEVER</code></dt> <dd>Don't parse parameter entities or the external subset</dd> <dt><code>XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE</code></dt> -<dd>Parse parameter entites and the external subset unless +<dd>Parse parameter entities and the external subset unless <code>standalone</code> was set to "yes" in the XML declaration.</dd> <dt><code>XML_PARAM_ENTITY_PARSING_ALWAYS</code></dt> <dd>Always parse parameter entities and the external subset</dd> @@ -767,7 +767,7 @@ include</p> <li>Stopping parsing completely (simply free or reset the parser instead of resuming in the outer parsing loop). This can be useful - if a application-domain error is found in the XML being parsed or if + if an application-domain error is found in the XML being parsed or if the result of the parse is determined not to be useful after all.</li> </ul> @@ -1564,7 +1564,7 @@ at most once per parsed (external) entity. The optional application data pointer <code>encodingHandlerData</code> will be passed back to the handler.</p> -<p>The map array contains information for every possible possible leading +<p>The map array contains information for every possible leading byte in a byte sequence. If the corresponding value is >= 0, then it's a single byte sequence and the byte encodes that Unicode value. If the value is -1, then that byte is invalid as the initial byte in a sequence. @@ -1999,7 +1999,7 @@ return NULL.</p> <h3><a name="miscellaneous">Miscellaneous functions</a></h3> <p>The functions in this section either obtain state information from -the parser or can be used to dynamicly set parser options.</p> +the parser or can be used to dynamically set parser options.</p> <pre class="fcndec" id="XML_SetUserData"> void XMLCALL diff --git a/doc/xmlwf.xml b/doc/xmlwf.xml index 92ea8b5..5e2a4ae 100644 --- a/doc/xmlwf.xml +++ b/doc/xmlwf.xml @@ -58,6 +58,7 @@ <arg><option>-r</option></arg> <arg><option>-t</option></arg> + <arg><option>-N</option></arg> <arg><option>-v</option></arg> @@ -146,7 +147,7 @@ supports both. doesn't encounter any errors, the input file is simply copied to the output directory unchanged. This implies no namespaces (turns off <option>-n</option>) and - requires <option>-d</option> to specify an output file. + requires <option>-d</option> to specify an output directory. </para> </listitem> </varlistentry> @@ -159,8 +160,8 @@ supports both. representations of the input files. By default, <option>-d</option> outputs a canonical representation (described below). - You can select different output formats using <option>-c</option> - and <option>-m</option>. + You can select different output formats using <option>-c</option>, + <option>-m</option> and <option>-N</option>. </para> <para> The output filenames will @@ -220,6 +221,17 @@ supports both. </varlistentry> <varlistentry> + <term><option>-N</option></term> + <listitem> + <para> + Adds a doctype and notation declarations to canonical XML output. + This matches the example output used by the formal XML test cases. + Requires <option>-d</option> to specify an output file. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>-p</option></term> <listitem> <para> |