From 6a590aba95cbcce0f184381fb19d16558e56832d Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Sat, 5 Apr 2014 13:08:42 +0000 Subject: Imported from /home/lorry/working-area/delta_xmlto-tarball/xmlto-0.0.26.tar.bz2. --- doc/xmlif.xml | 107 +++++++++++++++ doc/xmlto.xml | 430 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 537 insertions(+) create mode 100644 doc/xmlif.xml create mode 100644 doc/xmlto.xml (limited to 'doc') diff --git a/doc/xmlif.xml b/doc/xmlif.xml new file mode 100644 index 0000000..67062ab --- /dev/null +++ b/doc/xmlif.xml @@ -0,0 +1,107 @@ + + + + + + xmlif + April 2009 + Linux + + Eric + S. + Raymond + +
esr@snark.thyrsus.com
+ + Author of xmlif program + + + + + xmlif + 1 + Sept 26 2002 + + + + xmlif + conditional processing instructions for XML + + + + + xmlif attrib=value + + + + DESCRIPTION + + xmlif filters XML according to + conditionalizing markup. This can be useful for formatting one + of several versions of an XML document depending on conditions + passed to the command. + + Attribute/value pairs from the command line are matched + against the attributes associated with certain processing + instructions in the document. The instructions are + <?xmlif if?> and its inverse <?xmlif if + not?>, <?xmlif elif?> and its + inverse <?xmlif elif not?>, + <?xmlif else?>, and + <?xmlif fi?>. + + Argument/value pairs given on the command line are checked + against the value of corresponding attributes in the conditional + processing instructions. An `attribute match' happens if an + attribute occurs in both the command-line arguments and the tag, + and the values match. An `attribute mismatch' happens if an + attribute occurs in both the command-line arguments and the tag, + but the values do not match. + + Spans between <?xmlif if?> or + <?xmlif elif?> and the next conditional + processing instruction at the same nesting level are passed + through unaltered if there is at least one attribute match and + no attribute mismatch; spans between <?xmlif if + not?> and <?xmlif elif not?> and + the next conditional processing instruction are passed + otherwise. Spans between <?xmlif else?> and + the next conditional-processing tag are passed through only if + no previous span at the same level has been passed + through. <?xmlif if?> and + <?xmlif fi?> (and their `not' variants) change + the current nesting level; <?xmlif else?> and + <?xmlif elif?> do not. + + All these processing instructions will be removed from the + output produced. Aside from the conditionalization, all other + input is passed through untouched; in particular, entity + references are not resolved. + + Value matching is by string equality, except that "|" in an + attribute value is interpreted as an alternation character. + Thus, saying foo='red|blue' on the command line enables + conditions red and blue. Saying color='black|white' in a tag + matches command-line conditions color='black' and + color='white'. + + Here is an example: + + +Always issue this text. +<?xmlif if condition='html'?> +Issue this text if 'condition=html' is given on the command line. +<?xmlif elif condition='pdf|ps'?> +Issue this text if 'condition=pdf' or 'condition=ps' +is given on the command line. +<?xmlif else?> +Otherwise issue this text. +<?xmlif fi?> +Always issue this text. + + + + + diff --git a/doc/xmlto.xml b/doc/xmlto.xml new file mode 100644 index 0000000..804097c --- /dev/null +++ b/doc/xmlto.xml @@ -0,0 +1,430 @@ + + +
+ + xmlto + + + Tim + Waugh + +
twaugh@redhat.com
+ + Original author, maintainer until 0.0.18 + + + Ondřej + Vašík + +
ovasik@redhat.com
+ + Maintainer since 0.0.19 + + + + + 2001-8 + Tim Waugh + + + 2008-9 + Ondřej Vašík + + + +
+ Reference + + + + xmlto + November 2011 + xmlto 0.0.25 + + + + xmlto + 1 + + + + xmlto + apply an XSL stylesheet to an XML document + + + + + xmlto + + output_dir + + custom_xsl + + xsl_fragment + + + postprocessor_opts + + + path + + + paramname=paramvalue + + + + + + format + file + + + + xmlto + + --help + --version + + + + + + Description + + The purpose of xmlto is to convert an + XML file to the desired + format using whatever means + necessary. This may involve two steps: + + + + The application of an appropriate XSL stylesheet + using an XSL-T processor. + + + + Further processing with other tools. This step may + not be necessary. + + + + To decide which stylesheet to use and what, if any, + needs to be done to post-process the output, + xmlto makes use of format + scripts, which are simple shell scripts that + xmlto calls during the conversion. + + The appropriate format script is selected based on the + type of XML file and the desired output format. + xmlto comes with some format scripts for + converting DocBook XML files to a variety of formats. You + may specify your own format script by using an absolute + filename for format on the command + line. + + Firstly, if xmlto has not been told + explicitly which stylesheet to use (with the + option), the format script will be called + with $1 set to stylesheet. + The environment variable XSLT_PROCESSOR + contains the base name of the executable that will be used to + perform the XSL-T transformation (for example + xsltproc). The format script should write + the name of the stylesheet to use to standard output and exit + successfully, or exit with a non-zero return code if there is + no appropriate stylesheet to use (for example, if the only + available stylesheet is known not to work with the XSL-T + processor that will be used). If nothing is written to + standard output but the script exits successfully, no XSL-T + transformation will be performed. + + Secondly, after an XSL-T processor has been run using + the stylesheet, the format script will be called again, this + time with $1 set to + post-process. The format script should + perform any necessary steps to translate the XSL-T processed + output into the desired output format, including copying the + output to the desired output directory. For post-processing, + the format script is run in a temporary directory containing + just the processed output (whose name is stored in + XSLT_PROCESSED and whose basename is that of + the original XML file with any filename extension replaced + with .proc). INPUT_FILE is + set to the name of the original XML file, + OUTPUT_DIR is set to the name of the directory + that the output (and only the output) must end up in, and + SEARCHPATH is set to a colon-separate list of + fallback directories in which to look for input (for images, + for example). If this step is unsuccessful the format script + should exit with a non-zero return code. + + + + Options + + + + + + Be verbose ( for very + verbose). + + + + + stylesheet + + Use stylesheet instead + of asking the format script to choose one. + + + + + fragment + + Use the provided XSL + fragment to modify the + stylesheet. + + + + + directory + + Put output in the specified + directory instead of the + current working directory. + + + + + postprocessor_opts + + Pass postprocessor_opts + to processing stages after stylesheet application + (e.g. lynx or + links when going + through HTML to text, or xmltex + when going from through TeX to DVI). If + is specified a second time, the + options specified will be passed to second-stage + postprocessing; presently this is only applicable when + going through xmltex and + dvips to PostScript. + + + + + + + Turn on stylesheet extensions for the tool chain + in use (use.extensions is turned on). + The variables turned on are the ones used + by Norman Walsh's DocBook XSL stylesheets. + + + + + path + + Add the colon-separated list of directories in + path as fallback + directories for including input. + + + + + + + Skip the validation step that is normally + performed. + + + + + paramname=paramvalue + + Pass a named parameter paramname + with value paramvalue + to stylesheet from the command line. + + + + + + + Temporary files are not deleted(their names + are shown and kept in tmp directory). It could + help with analyzing problems. + + + + + + + By default, some XSL variables are overridden + by autodetection (page.width and + page.height for paperconf + (libpaper) use, paper.type for locale-based + (LC_PAPER) selection). With this + option, xmlto doesn’t use this autodetection + and user is able to modify defaults himself (either via default + param.xsl modification or by user-defined + XSL fragment). + + + + + + + + By default, xmlto enables XSL params passivetex.extensions for + passivetex backend and fop.extensions and fop1.extensions + for fop backend. + This usually produces better results. If you for some reason don't want to use these parameters, just + disable them using this option. + + + + + + + + Use fop for formatting. + It is an experimental option, expects fop + in specific location(detected at configured time), could be changed + manually in xmlto script by modification + of FOP_PATH + + + + + + + Use dblatex for formatting. + It is an experimental option, expects dblatex + in specific location(detected at configured time), could be changed + manually in xmlto script by modification + of DBLATEX_PATH + + + + + + + + Display a short usage message. It will describe xmlto's + options, and the available output formats. + + + + + + + Display the version number of xmlto. + + + + + + Environment + + + XSLT_PROCESSOR + + Base name of the executable that will be used to + perform the XSL-T transformation (default: + xsltproc + 1 + ). + + + + + TMPDIR + + Directory, where to create temporary stylesheets + (default: /tmp). + + + + + + + Diagnostics + + + 0 + + Everything went fine. This is the expected exit code. + + + + 1 + + xmlto was called with insufficient + arguments. + + + + + 2 + + + mktemp + 1 + failed to create a file/directory. Make sure + /tmp or TMPDIR is + writable. + + + + + 3 + + xmlto failed to find some binary on + configured location. Make sure that all required packages + are installed and paths in xmlto + script are set properly. + + + + + 10+(Validation non-zero error code) + + xmlto tried to validate a xml document, but validation failed. For better diagnostic, validation output and xmllint exit code is provided. Consider either fixing your document or using . + + + + + + + Examples + + To convert a DocBook XML document to PDF, use: + + xmlto pdf mydoc.xml + + To convert a DocBook XML document to HTML and store the + resulting HTML files in a separate directory use: + + xmlto -o html-dir html mydoc.xml + + To convert a DocBook XML document to a single HTML file + use: + + xmlto html-nochunks mydoc.xml + + To modify the output using an XSL fragment use: + + xmlto -m ulink.xsl pdf mydoc.xml + + To specify which stylesheet to use (overriding the one + that the format script would choose) use: + + xmlto -x mystylesheet.xsl pdf mydoc.xml + + +
+
-- cgit v1.2.1