From 8f8a9f01909ba29e2b781310baeeaaddc3f15f0d Mon Sep 17 00:00:00 2001 From: "Gerald W. Carter" Date: Tue, 22 Apr 2008 10:09:40 -0500 Subject: Moving docs tree to docs-xml to make room for generated docs in the release tarball. (This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14) --- .../xslt/db2latex-xsl/xsl/param-switch.mod.xsl | 698 +++++++++++++++++++++ 1 file changed, 698 insertions(+) create mode 100644 docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl (limited to 'docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl') diff --git a/docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl b/docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl new file mode 100644 index 0000000000..e0956967e3 --- /dev/null +++ b/docs-xml/xslt/db2latex-xsl/xsl/param-switch.mod.xsl @@ -0,0 +1,698 @@ + + %xsldoc.ent; ]> + + + + + + + + $Id: param-switch.mod.xsl,v 1.17 2004/01/31 11:52:31 j-devenish Exp $ + + + &ramon; + &james; + + + 20002001200220032004 + Ramon Casellas + + + &rev_2003_05; + + + Parameters: &DB2LaTeX; Switches <filename>param-switch.mod.xsl</filename> + + + + The values of parameters in this file are used to influence + the behaviour of &DB2LaTeX; templates through the selection + of pre-defined options. + All parameter names begin with latex.. + + + + + + In some stylesheets, tests of parameter values use + !=0 logic. However, &DB2LaTeX; uses + =1 logic. This means that empty parameters are + off in &DB2LaTeX; but on in those + other stylesheets. The XPath values + true() and false() work as + expected. + + + + + + + + Control the display of captions in lists of figures. + + + By default, lists of figures (see ) + will include both figure titles and mediaobject captions. + This is useful for readers, as they have a full description of each figure. + However, it is impractical for large documents because the list + of figures will occupy too many pages. + + + This variable, when set to '1', authorises DB2LaTeX to include + mediaobject captions in lists of figures. It is enabled by default. + When set to '0', lists of figures will contain only the + titles of figures. + + + + 1 + + + + Control the output of the \bibliography{.bib}. + + + The value of this parameter is output. + An example is citations.bib, + if your BibTeX file has that name. + + + + + + Controls the output of LaTeX packages and commands to support + documents with math commands and environments.. + + If this parameter is set to 1, the stylesheets generate code to + DEFAULT: 1 Only more code is generated. + + + + 1 + + + Controls if the revision history table is generated as the first document + table. + + + If this parameter is set to 1, the stylesheets generate code to + DEFAULT: 1 Only more code is generated. + + + + 1 + + + Options for fancybox + + + + Undocumented. + + + + + + + + Controls the output of LaTeX commands to support the generation + of PDF files. + + If this parameter is set to 1, the stylesheets generate code to + detect if it is either latex or pdflatex + the shell command that is being used to compile the LaTeX text file. Some + packages (graphicx, hyperref) are used + with the right parameters. Finally, the graphic extensions declared, to use in + \includegraphics commands depends also on which command is + being used. If this parameter is set to zero, such code is not generated (which + does not mean that the file cannot compile with pdflatex, but some strange issues + may appear). DEFAULT: 1 Only more code is generated. + + + + 1 + + + Enable the generation of indexterms + Support index generation. + + 1 + + + DB2LaTeX hyphenation linebreak tricks + + + Usually, LaTeX does not perform hyphenation in teletype (monospace) + text. This can lead to formatting problems. But certain monospace texts, such as + URLs and filenames, have natural breakpoints such as full stops + and slashes. DB2LaTeX's tttricks exploit a hyphenation trick in + order to provide line wrapping in the middle of monospace text. Set this to '1' + to enable these tricks (they are not enabled by default). See also the FAQ. + + + + 0 + + + Decimal point for &LaTeX; tables + + + + This is a non-localisable character that may be used + for decimal alignment of &LaTeX; tables. + + + + + + + + Toggle the trimming of leading and trailing whitespace in verbatim environments + + In verbatim environments such as programlisting and screen, + it can be useful to trim leading and trailing whitespace. However, this is not compliant + with The Definitive Guide. + + + 0 + + + Toggle the use of the ltxtable LaTeX package + + + This is not implemented as true ltxtable support, yet. + It uses longtable until we can integrate proper ltxtable support. + One the feature is supported, it should probably be enabled by + default! + + If this package is used then tables will be have the capability + to run over multiple pages when necessary. + + Cells spanning multiple columns may require extra passes with LaTeX + in order for column widths to 'converge'. + + + + 0 + + + Toggle the use of the longtable LaTeX package + + + Enabling this option allows simplelists to run over multiple + pages. In the future, it will be superseded by . + + + + 0 + + + Toggle the use of the overpic LaTeX package + Facilitates overlays (for callouts). + + 1 + + + Toggle the use of the umoline LaTeX package + Provide underlining. + + 0 + + + Toggle the use of the url LaTeX package + Provide partial support for hyperlinks. + + 1 + + + Toggle the use of the the draft preamble + &DB2LaTeX; provides a number of draft-mode features to aid + the refinement of documents. Normally, this mode is enabled or disabled according + to the status attribute of the top-level + book or article element. However, this variable + will take precedence when it is not empty. It is empty by default. + + + + &test_index_draft; + &test_draft; + + + + + + + Toggle the use of the varioref LaTeX package + varioref seemed like a good idea at first, + but we not realise it does understand &DocBook; gentext localisations. By default, it is enabled + when is enabled. + + + 1 + + + + Toggle the use of the fancyhdr LaTeX package + Provides page headers and footers. Disabling support for + this package will make headers and footer go away. + + 1 + + + Control the inclusion of chapter titles in lots + + + When this variable is set, lists of tables and lists of figures + will be grouped and labeled by chapter. + + + + 1 + + + Configure the application of truncation partitions + + + + For , the + partition can be modulated in a left-right fashion or an + inside-outside fashion. Use lr for left-right, + all other values are inside-outside (io is + suggested). The default is io, because this + matches . + + + + + io + + + Configure the width of header portions on each page + + + + It is possible that the titles of chapter or sections will + occupy more than the width of a single line. When this variable + is empty, headers will be allowed to occupy multiple lines. + However, it is possible that the left-hand portion of a header + will collide with the right-hand portion of header. To prevent + this, headers can be truncated if they exceed an allowable + width. When this variables is set to a number from zero to 100, + the left-hand (or inside) side of each header will have that + width reserved. The right-hand (or outside) side will have the + remainder. A common option is to set this variable to zero and + set to + io. + + + + + 50 + + + Section/chapter style for fancy headers + + + + &DB2LaTeX; comes with some pre-configured styles for page + headers. These include , the default, which is + determined by the fancyhdr package. + Another option is natural, in which both the + chapter and section are shown on each page with their numbers. + An alternative is to provide your own template with a + value such as \pagestyle{headings} (the + headings page style, which is not a + fancyhdr style, shows page numbers + in the headers whereas the others show page numbers in the + footers). + + + + + + + + Toggle the use of the parskip &latex; package + + Use block paragraph style instead of indentation. + + + parskip introduces vertical whitespace between + paragraphs and list items. However, &db2latex;'s toc and + lot templates attempt to suppress this whitespace. + When this option is off, you may wish to investigate . + + + + + + + + 0 + + + Toggle the use of noindent commands + + + + When this parameter is 1, &DB2LaTeX; will deliberately insert + noindents at particular locations within your document. + + + + + + + When traditional &LaTeX; paragraph indentation and spacing is used, + it is often necessary to use noindent after certain block-formatted + elements (e.g. itemizedlist). Let us know if we + need to insert more noindent---so far, there are few + places where we make use of it. + + + + + By default, this option will be turned on when is off and + will be turned off when + is on. + + + + + + + + + + + + + + + + + + + + + + Toggle the use of the subfigure LaTeX package + Used to provide nice layout of multiple mediaobjects in figures. + + 1 + + + Toggle the use of the rotating LaTeX package + Undocumented. + + 1 + + + Toggle the use of the tabularx LaTeX package + Used to provide certain table features. Has some incompatabilities + with packages, but also solves some conflicts that the regular tabular + environment has. + + 1 + + + Toggle the use of the dcolumn LaTeX package + + + Currently, dcolumn support does not function + correctly. + + + dcolumn provides support for the char + alignment of table cells. + + + + + + + + + 0 + + + Toggle the use of the hyperref LaTeX package + This is used extensively for hyperlinking within documents. + + 1 + + + Toggle the use of the fancybox LaTeX package + This is essential for admonitions. + + 1 + + + Toggle the use of the fancyvrb LaTeX package + Provides support for tabbed whitespace in verbatim environments. + See also . + + 1 + + + Toggle the use of the isolatin1 LaTeX package + + + This option is deprecated. See . + + + + 0 + + + Choose whether to use the unicode LaTeX package + See the unicode documentation for details. + + 0 + + + Control which references are cited in the bibliography + + + The DB2LaTeX generated bibliography (bibitems) may either + include all biblioentries found in the document, or only thee ones explicitly + cited with citation. + + Two values are possible: all or cited. + + + all + + + Control bibliographic citation style + + By default, this value is empty. Alternatively, a special value + is recognised: ieee (or IEEE). + + + + + + Improved typesetting of captions + + + DB2LaTeX supports $formal.title.placement + as a mechanism for choosing whether captions will appear above or below the objects they describe. + + However, LaTeX will often produce an ugly result when captions occur + above their corresponding content. This usually arises because of + unsuitable \abovecaptionskip and \belowcaptionskip. + + + This variable, when set to '1', authorises DB2LaTeX to swap the caption + 'skip' lengths when a caption is placed above its + corresponding content. This is enabled by default. + + + + 1 + + + Control imagedata selection. + + This controls how DB2LaTeX behaves when a mediaobject contains + multiple imagedata. When non-empty, DB2LaTeX will exclude + imagedata that have a format no listed within this variable. + + + + + + Control Unicode character handling. + + + Normally, XSLT processors will convert SGML character entities into + Unicode characters and DB2LaTeX doesn't have much chance to do anything + toward converting them to LaTeX equivalents. We do not yet know how we + can solve this problem best. + + + Proposed values: 'catcode', 'unicode', 'extension'. + Currently only 'catcode' is supported. All other values will + cause no special handling except for certain mappings in MathML. + In future, perhaps the 'unicode' LaTeX package could be of assistance. + 'Extension' could be an XSLT extension that handles the characters + using a mapping table. + + + + + + + Control the use of otherterm attributes + + + When a glosssee or glossseealso element contains + both an otherterm attribute and content templates, + this variable elects which will be the source of the displayed text. By default, + this variable is enabled and a cross-reference to the otherwterm will be + generated (i.e. content templates will be ignored). + + + + 1 + + + Control the use of alt text + + + By default, DB2LaTeX assumes that alt + text should be typeset in preference to any + mediaobjects. + + + + + + + + + 1 + + + Whether to apply templates for component titles. + + + Controls whether component titles will be generated by + applying templates or by conversion to string values. + When enabled, templates will be applied. This enables template + expression in titles but may have problematic side-effects such + as nested links. + + + + This variable does not influence all title + elements. Some may have their own configuration variables or be non-configurable. + + + + + 1 + + + Whether to apply templates for admonition titles. + + + Controls whether admonition titles will be generated by + applying templates or by conversion to string values. + When enabled, templates will be applied. + + + + 1 + + + Whether to delimit URLs with quotation characters + + + When this option is enabled, gentext quotation characters + (urlstartquote and urlendquote) are used to delimit the + URLs when they are displayed as part of ulink + formatting. The delimiters do not form part of the URL or + hyperlink per se. + + + + 1 + + + Control string comparison for ulinks + + + + The formatting of a ulink element varies according + to whether its url attribute + differs from its content. When this option is enabled, the + comparison between these two values ignores the + protocol portion of the URL (that which occurs + before ':' or '://', as a concession to HTTP URLs). For example, + when this option is enabled, a.b.c/d would be + considered equivalent to http://a.b.c/d and + file:a.b.c/d. + + + + + + + + Warning: $ulink.protocols.relaxed was a misnomer: use $latex.ulink.protocols.relaxed instead + + + + + + + + + + + Control the suppression of headers/footers on blank pages in double-side documents + + + + When this option is enabled, &DB2LaTeX; will attempt to + suppress headers and footers on pages that contain no + other content (i.e. left-handed pages in a double-sided + document). When this option is disabled, &DB2LaTeX; does + not interfere with the default appearance of headers and + footers. + + + + + 1 + + -- cgit