diff options
author | Shaun McCance <shaunm@gnome.org> | 2016-04-02 08:24:05 -0400 |
---|---|---|
committer | Shaun McCance <shaunm@gnome.org> | 2016-04-02 08:24:05 -0400 |
commit | 34e39805fc7a603b9286fa31544bca0a534897d5 (patch) | |
tree | c771fec00ac4f9464940e5e4fb19d6e089b1c20e /doc/yelp-xsl | |
parent | cdfb5255416e3f62df099748cd893a6bf9fd8396 (diff) | |
download | yelp-xsl-34e39805fc7a603b9286fa31544bca0a534897d5.tar.gz |
Adding generated docs to git
Not my favorite thing to do, but this lets me merge them into the
yelp.io site and publish them automatically.
Diffstat (limited to 'doc/yelp-xsl')
314 files changed, 4448 insertions, 0 deletions
diff --git a/doc/yelp-xsl/C/color.background.page b/doc/yelp-xsl/C/color.background.page new file mode 100644 index 00000000..a364eeb2 --- /dev/null +++ b/doc/yelp-xsl/C/color.background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The background color.</desc></info><title>color.background</title><p>The background color.</p> + + + <p>This parameter specifies the default background color. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.blue_background.page b/doc/yelp-xsl/C/color.blue_background.page new file mode 100644 index 00000000..ada124e6 --- /dev/null +++ b/doc/yelp-xsl/C/color.blue_background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.blue_background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The blue background color.</desc></info><title>color.blue_background</title><p>The blue background color.</p> + + + <p>This parameter specifies the blue background color. The blue background color may be used by certain types of block elements. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.blue_border.page b/doc/yelp-xsl/C/color.blue_border.page new file mode 100644 index 00000000..aecf1d4e --- /dev/null +++ b/doc/yelp-xsl/C/color.blue_border.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.blue_border" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The blue border color.</desc></info><title>color.blue_border</title><p>The blue border color.</p> + + + <p>This parameter specifies the blue border color. The blue border color may be used by certain types of block elements.</p> +</page> diff --git a/doc/yelp-xsl/C/color.dark_background.page b/doc/yelp-xsl/C/color.dark_background.page new file mode 100644 index 00000000..e0c44c39 --- /dev/null +++ b/doc/yelp-xsl/C/color.dark_background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.dark_background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The dark gray background color.</desc></info><title>color.dark_background</title><p>The dark gray background color.</p> + + + <p>This parameter specifies the dark gray background color. The dark gray background color may be used by certain types of block elements. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.gray_background.page b/doc/yelp-xsl/C/color.gray_background.page new file mode 100644 index 00000000..a0fa9bf1 --- /dev/null +++ b/doc/yelp-xsl/C/color.gray_background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.gray_background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The gray background color.</desc></info><title>color.gray_background</title><p>The gray background color.</p> + + + <p>This parameter specifies the gray background color. The gray background color may be used by certain types of block elements. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.gray_border.page b/doc/yelp-xsl/C/color.gray_border.page new file mode 100644 index 00000000..97c2ecef --- /dev/null +++ b/doc/yelp-xsl/C/color.gray_border.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.gray_border" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The gray border color.</desc></info><title>color.gray_border</title><p>The gray border color.</p> + + + <p>This parameter specifies the gray border color. The gray border color may be used by certain types of block elements.</p> +</page> diff --git a/doc/yelp-xsl/C/color.link.page b/doc/yelp-xsl/C/color.link.page new file mode 100644 index 00000000..21e0f359 --- /dev/null +++ b/doc/yelp-xsl/C/color.link.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.link" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The color of links.</desc></info><title>color.link</title><p>The color of links.</p> + + + <p>This parameter specifies the color for unvisited links. It should be legible on all background colors.</p> +</page> diff --git a/doc/yelp-xsl/C/color.link_visited.page b/doc/yelp-xsl/C/color.link_visited.page new file mode 100644 index 00000000..47af12b5 --- /dev/null +++ b/doc/yelp-xsl/C/color.link_visited.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.link_visited" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The color of visited links.</desc></info><title>color.link_visited</title><p>The color of visited links.</p> + + + <p>This parameter specifies the color for visited links. It should be legible on all background colors.</p> +</page> diff --git a/doc/yelp-xsl/C/color.page b/doc/yelp-xsl/C/color.page new file mode 100644 index 00000000..531500b2 --- /dev/null +++ b/doc/yelp-xsl/C/color.page @@ -0,0 +1,36 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="color" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><link type="xslt-defines-param" xref="color.background"/><link type="xslt-defines-param" xref="color.link"/><link type="xslt-defines-param" xref="color.link_visited"/><link type="xslt-defines-param" xref="color.text"/><link type="xslt-defines-param" xref="color.text_light"/><link type="xslt-defines-param" xref="color.text_error"/><link type="xslt-defines-param" xref="color.blue_background"/><link type="xslt-defines-param" xref="color.blue_border"/><link type="xslt-defines-param" xref="color.gray_background"/><link type="xslt-defines-param" xref="color.dark_background"/><link type="xslt-defines-param" xref="color.gray_border"/><link type="xslt-defines-param" xref="color.red_background"/><link type="xslt-defines-param" xref="color.red_border"/><link type="xslt-defines-param" xref="color.yellow_background"/><link type="xslt-defines-param" xref="color.yellow_border"/></info><title>Colors</title><p>Specify common named colors to style output.</p> + + + <p>This stylesheet provides a common interface to specify custom colors for transformations to presentation-oreinted formats. This allows similar output for different types of input documents.</p> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links></page> diff --git a/doc/yelp-xsl/C/color.red_background.page b/doc/yelp-xsl/C/color.red_background.page new file mode 100644 index 00000000..ca17b630 --- /dev/null +++ b/doc/yelp-xsl/C/color.red_background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.red_background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The red background color.</desc></info><title>color.red_background</title><p>The red background color.</p> + + + <p>This parameter specifies the red background color. The red background color may be used by certain types of block elements. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.red_border.page b/doc/yelp-xsl/C/color.red_border.page new file mode 100644 index 00000000..4f5108cc --- /dev/null +++ b/doc/yelp-xsl/C/color.red_border.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.red_border" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The red border color.</desc></info><title>color.red_border</title><p>The red border color.</p> + + + <p>This parameter specifies the red border color. The red border color may be used by certain types of block elements.</p> +</page> diff --git a/doc/yelp-xsl/C/color.text.page b/doc/yelp-xsl/C/color.text.page new file mode 100644 index 00000000..f1305f43 --- /dev/null +++ b/doc/yelp-xsl/C/color.text.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.text" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The normal text color.</desc></info><title>color.text</title><p>The normal text color.</p> + + + <p>This parameter specifies the default color for normal text. It should be legible on all background colors.</p> +</page> diff --git a/doc/yelp-xsl/C/color.text_error.page b/doc/yelp-xsl/C/color.text_error.page new file mode 100644 index 00000000..6d3fdd06 --- /dev/null +++ b/doc/yelp-xsl/C/color.text_error.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.text_error" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The error text color.</desc></info><title>color.text_error</title><p>The error text color.</p> + + + <p>This parameter specifies the color for error text. The error text color is used to style error messages from command line sessions. It should be legible on all background colors.</p> +</page> diff --git a/doc/yelp-xsl/C/color.text_light.page b/doc/yelp-xsl/C/color.text_light.page new file mode 100644 index 00000000..df0f215c --- /dev/null +++ b/doc/yelp-xsl/C/color.text_light.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.text_light" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The light text color.</desc></info><title>color.text_light</title><p>The light text color.</p> + + + <p>This parameter specifies the color for light text. The light text color is used to make bold headings and certain parenthetical text less intense. It should be legible on all background colors.</p> +</page> diff --git a/doc/yelp-xsl/C/color.yellow_background.page b/doc/yelp-xsl/C/color.yellow_background.page new file mode 100644 index 00000000..ba572c86 --- /dev/null +++ b/doc/yelp-xsl/C/color.yellow_background.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.yellow_background" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The yellow background color.</desc></info><title>color.yellow_background</title><p>The yellow background color.</p> + + + <p>This parameter specifies the yellow background color. The yellow background color may be used by certain types of block elements. Foreground colors should be legible on this color.</p> +</page> diff --git a/doc/yelp-xsl/C/color.yellow_border.page b/doc/yelp-xsl/C/color.yellow_border.page new file mode 100644 index 00000000..92bc5bb1 --- /dev/null +++ b/doc/yelp-xsl/C/color.yellow_border.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="color.yellow_border" type="topic" style="xslt-param"><info><link type="guide" xref="color" group="parameters"/><link type="guide" xref="parameters" group="color"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The yellow border color.</desc></info><title>color.yellow_border</title><p>The yellow border color.</p> + + + <p>This parameter specifies the yellow border color. The yellow border color may be used by certain types of block elements.</p> +</page> diff --git a/doc/yelp-xsl/C/db-chunk.page b/doc/yelp-xsl/C/db-chunk.page new file mode 100644 index 00000000..9188b525 --- /dev/null +++ b/doc/yelp-xsl/C/db-chunk.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db-chunk" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="db.chunk.depth-in-chunk"/><link type="xslt-defines-template" xref="db.chunk.depth-of-chunk"/><link type="xslt-defines-template" xref="db.chunk.chunk-id"/><link type="xslt-defines-template" xref="db.chunk.chunk-id.axis"/><link type="xslt-defines-param" xref="db.chunk.max_depth"/><link type="xslt-defines-param" xref="db.chunk.basename"/><link type="xslt-defines-param" xref="db.chunk.extension"/></info><title>DocBook Chunking</title> + + + <comment><p>Describe this module</p></comment> + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.basename"/></p></item><item><p><link xref="db.chunk.max_depth"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db-common.page b/doc/yelp-xsl/C/db-common.page new file mode 100644 index 00000000..708f8eb7 --- /dev/null +++ b/doc/yelp-xsl/C/db-common.page @@ -0,0 +1,26 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db-common" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="l10n"/><link type="xslt-defines-template" xref="db.copyright"/><link type="xslt-defines-template" xref="db.linenumbering.start"/><link type="xslt-defines-template" xref="db.orderedlist.start"/><link type="xslt-defines-template" xref="db.personname"/><link type="xslt-defines-template" xref="db.personname.list"/><link type="xslt-implements-mode" xref="l10n.format.mode"/></info><title>DocBook Common</title> + + + <p>This stylesheet module provides utility templates for DocBook that are independant of the target format.</p> + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db.profile.test"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:copyright.years</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:copyright.name</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db-profile.page b/doc/yelp-xsl/C/db-profile.page new file mode 100644 index 00000000..7074c50c --- /dev/null +++ b/doc/yelp-xsl/C/db-profile.page @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db-profile" type="guide" style="xslt-stylesheet"><?xslt-private _db.profile.test.compare?><info><link type="guide" xref="stylesheets" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><link type="xslt-defines-template" xref="db.profile.test"/><link type="xslt-defines-param" xref="db.profile.arch"/><link type="xslt-defines-param" xref="db.profile.audience"/><link type="xslt-defines-param" xref="db.profile.condition"/><link type="xslt-defines-param" xref="db.profile.conformance"/><link type="xslt-defines-param" xref="db.profile.os"/><link type="xslt-defines-param" xref="db.profile.os"/><link type="xslt-defines-param" xref="db.profile.revision"/><link type="xslt-defines-param" xref="db.profile.security"/><link type="xslt-defines-param" xref="db.profile.userlevel"/><link type="xslt-defines-param" xref="db.profile.vendor"/><link type="xslt-defines-param" xref="db.profile.wordsize"/></info><title>DocBook Profiling</title><p>Support for DocBook effectivity attributes</p> + + + <p>This stylesheet contains utilities for handling conditional processing in DocBook documents.</p> + + + + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.profile.arch"/></p></item><item><p><link xref="db.profile.audience"/></p></item><item><p><link xref="db.profile.condition"/></p></item><item><p><link xref="db.profile.conformance"/></p></item><item><p><link xref="db.profile.os"/></p></item><item><p><link xref="db.profile.outputformat"/></p></item><item><p><link xref="db.profile.revision"/></p></item><item><p><link xref="db.profile.security"/></p></item><item><p><link xref="db.profile.userlevel"/></p></item><item><p><link xref="db.profile.vendor"/></p></item><item><p><link xref="db.profile.wordsize"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db-title.page b/doc/yelp-xsl/C/db-title.page new file mode 100644 index 00000000..59df5268 --- /dev/null +++ b/doc/yelp-xsl/C/db-title.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db-title" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db"/><revision version="3.4" date="2011-11-10" status="final"/><link type="xslt-defines-template" xref="db.title"/><link type="xslt-defines-template" xref="db.titleabbrev"/><link type="xslt-defines-template" xref="db.subtitle"/></info><title>DocBook Titles</title><p>Support for DocBook title, titleabbrev, and subtitle elements.</p> + + + <p>This stylesheet contains templates for outputting titles based on title, titleabbrev, or subtitle elements. It supports automatic titles for certain elements with optional titles.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.chunk-id"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db-xref.page b/doc/yelp-xsl/C/db-xref.page new file mode 100644 index 00000000..e2c3c58e --- /dev/null +++ b/doc/yelp-xsl/C/db-xref.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db-xref" type="guide" style="xslt-stylesheet"><?xslt-private l10n.format.mode?><info><link type="guide" xref="stylesheets" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-chunk"/><link type="xslt-requires" xref="db-title"/><link type="xslt-requires" xref="l10n"/><link type="xslt-defines-template" xref="db.ulink.tooltip"/><link type="xslt-defines-template" xref="db.xref.content"/><link type="xslt-defines-template" xref="db.xref.target"/><link type="xslt-defines-template" xref="db.xref.tooltip"/><link type="xslt-implements-mode" xref="db.xref.tooltip.mode"/></info><title>DocBook Links</title> + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-chunk"/></p></item><item><p><link xref="db-title"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="utils.email_address"/></p></item><item><p><link xref="db.title"/></p></item><item><p><link xref="db.chunk.chunk-id"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.basename"/></p></item><item><p><link xref="db.chunk.extension"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="db.xref.tooltip.mode">db.xref.tooltip.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="db.xref.tooltip.mode">db.xref.tooltip.mode</link></p></td><td><p><code>biblioentry | bibliomixed | db:biblioentry | db:bibliomixed </code></p></td></tr><tr><td><p><link xref="db.xref.tooltip.mode">db.xref.tooltip.mode</link></p></td><td><p><code>glossentry | db:glossentry</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db.biblio.abbrev.key.page b/doc/yelp-xsl/C/db.biblio.abbrev.key.page new file mode 100644 index 00000000..7e829e10 --- /dev/null +++ b/doc/yelp-xsl/C/db.biblio.abbrev.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.biblio.abbrev.key" type="topic" style="xslt-key"><info><link type="guide" xref="db-common" group="keys"/><link type="guide" xref="keys" group="db"/><revision version="3.18" date="2015-07-23" status="final"/><desc>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>abbrev</code>.</desc></info><title>db.biblio.abbrev.key</title><p>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>abbrev</code>.</p> + + + <p>This key returns <code>biblioentry</code> and <code>bibliomixed</code> elements based on their child <code>abbrev</code> elements. The <code>abbrev</code> element must be the first child element of the <code>biblioentry</code> or <code>bibliomixed</code> element. This key only returns elements that have an <code>id</code> attribute for DocBook 4 or an <code>xml:id</code> attribute for DocBook 5.</p> +</page> diff --git a/doc/yelp-xsl/C/db.biblio.id.key.page b/doc/yelp-xsl/C/db.biblio.id.key.page new file mode 100644 index 00000000..440803b1 --- /dev/null +++ b/doc/yelp-xsl/C/db.biblio.id.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.biblio.id.key" type="topic" style="xslt-key"><info><link type="guide" xref="db-common" group="keys"/><link type="guide" xref="keys" group="db"/><revision version="3.18" date="2015-07-23" status="final"/><desc>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>id</code>.</desc></info><title>db.biblio.id.key</title><p>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>id</code>.</p> + + + <p>This key returns <code>biblioentry</code> and <code>bibliomixed</code> elements based on their <code>id</code> or <code>xml:id</code> attributes. The {#id} attribute is used for DocBook 4, and the <code>xml:id</code> attribute is used for DocBook 5.</p> +</page> diff --git a/doc/yelp-xsl/C/db.biblio.label.key.page b/doc/yelp-xsl/C/db.biblio.label.key.page new file mode 100644 index 00000000..8f0d2798 --- /dev/null +++ b/doc/yelp-xsl/C/db.biblio.label.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.biblio.label.key" type="topic" style="xslt-key"><info><link type="guide" xref="db-common" group="keys"/><link type="guide" xref="keys" group="db"/><revision version="3.18" date="2015-07-23" status="final"/><desc>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>xreflabel</code>.</desc></info><title>db.biblio.label.key</title><p>Get a <code>biblioentry</code> or <code>bibliomixed</code> element from its <code>xreflabel</code>.</p> + + + <p>This key returns <code>biblioentry</code> and <code>bibliomixed</code> elements based on their <code>xreflabel</code> attributes. It only returns elements that have an <code>id</code> attribute for DocBook 4 or an <code>xml:id</code> attribute for DocBook 5.</p> +</page> diff --git a/doc/yelp-xsl/C/db.chunk.basename.page b/doc/yelp-xsl/C/db.chunk.basename.page new file mode 100644 index 00000000..1e71fc35 --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.basename.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.basename" type="topic" style="xslt-param"><info><link type="guide" xref="db-chunk" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>The base filename of the output file, without an extension.</desc></info><title>db.chunk.basename</title><p>The base filename of the output file, without an extension.</p> + + + <comment><p>Describe what this does</p></comment> +</page> diff --git a/doc/yelp-xsl/C/db.chunk.chunk-id.axis.page b/doc/yelp-xsl/C/db.chunk.chunk-id.axis.page new file mode 100644 index 00000000..bfeb49a7 --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.chunk-id.axis.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.chunk-id.axis" type="topic" style="xslt-template"><info><link type="guide" xref="db-chunk" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determines the id of the first chunk along a specified axis.</desc></info><title>db.chunk.chunk-id.axis</title><p>Determines the id of the first chunk along a specified axis.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The base element</p> + </item> + <item> + <title><code>node</code></title> + <p>The axis along which to find the first chunk</p> + </item> + <item> + <title><code>depth_in_chunk</code></title> + <p>The depth of <code style="xslt-param">node</code> in the containing chunk</p> + </item> + <item> + <title><code>depth_of_chunk</code></title> + <p>The depth of the containing chunk in the document</p> + </item> + </terms></synopsis> + <comment><p>Explain how this works, and what the axes are</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-in-chunk"/></p></item><item><p><link xref="db.chunk.chunk-id.axis"/></p></item><item><p><link xref="db.chunk.chunk-id"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.max_depth"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.chunk.chunk-id.page b/doc/yelp-xsl/C/db.chunk.chunk-id.page new file mode 100644 index 00000000..f04dbf1c --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.chunk-id.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.chunk-id" type="topic" style="xslt-template"><info><link type="guide" xref="db-chunk" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determines the id of the chunk that contains an element.</desc></info><title>db.chunk.chunk-id</title><p>Determines the id of the chunk that contains an element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>id</code></title> + <p>The id of the element to determine the chunk id of</p> + </item> + <item> + <title><code>node</code></title> + <p>The element to determine the chunk id of</p> + </item> + <item> + <title><code>depth_in_chunk</code></title> + <p>The depth of <code style="xslt-param">node</code> in the containing chunk</p> + </item> + </terms></synopsis> + <comment><p>Explain how this works</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-in-chunk"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.basename"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.chunk.depth-in-chunk.page b/doc/yelp-xsl/C/db.chunk.depth-in-chunk.page new file mode 100644 index 00000000..5498573e --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.depth-in-chunk.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.depth-in-chunk" type="topic" style="xslt-template"><info><link type="guide" xref="db-chunk" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determines the depth of an element in the containing chunk.</desc></info><title>db.chunk.depth-in-chunk</title><p>Determines the depth of an element in the containing chunk.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to determine the depth of</p> + </item> + </terms></synopsis> + <comment><p>Explain how this works</p></comment> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.max_depth"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.chunk.depth-of-chunk.page b/doc/yelp-xsl/C/db.chunk.depth-of-chunk.page new file mode 100644 index 00000000..b2eb7db2 --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.depth-of-chunk.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.depth-of-chunk" type="topic" style="xslt-template"><info><link type="guide" xref="db-chunk" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determines the depth of the containing chunk in the document.</desc></info><title>db.chunk.depth-of-chunk</title><p>Determines the depth of the containing chunk in the document.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to determine the depth of</p> + </item> + </terms></synopsis> + <comment><p>Explain how this works</p></comment> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.max_depth"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.chunk.extension.page b/doc/yelp-xsl/C/db.chunk.extension.page new file mode 100644 index 00000000..8778ae34 --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.extension.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.extension" type="topic" style="xslt-param"><info><link type="guide" xref="db-chunk" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>The default file extension for new output documents.</desc></info><title>db.chunk.extension</title><p>The default file extension for new output documents.</p> + + + <comment><p>Describe what this does</p></comment> +</page> diff --git a/doc/yelp-xsl/C/db.chunk.max_depth.page b/doc/yelp-xsl/C/db.chunk.max_depth.page new file mode 100644 index 00000000..76967d5f --- /dev/null +++ b/doc/yelp-xsl/C/db.chunk.max_depth.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.chunk.max_depth" type="topic" style="xslt-param"><info><link type="guide" xref="db-chunk" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>The maximum depth for chunking sections.</desc></info><title>db.chunk.max_depth</title><p>The maximum depth for chunking sections.</p> + + + <comment><p>Describe what this does</p></comment> +</page> diff --git a/doc/yelp-xsl/C/db.copyright.page b/doc/yelp-xsl/C/db.copyright.page new file mode 100644 index 00000000..ae0b0117 --- /dev/null +++ b/doc/yelp-xsl/C/db.copyright.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.copyright" type="topic" style="xslt-template"><info><link type="guide" xref="db-common" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Outputs copyright information</desc></info><title>db.copyright</title><p>Outputs copyright information</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>copyright</code> element to format</p> + </item> + </terms></synopsis> + <p>This template outputs copyright information from a <code>copyright</code> elements. It assembles the <code>year</code> and <code>holder</code> elements into a simple copyright notice, beginning with the copyright symbol "©".</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.glossentry.key.page b/doc/yelp-xsl/C/db.glossentry.key.page new file mode 100644 index 00000000..694211f5 --- /dev/null +++ b/doc/yelp-xsl/C/db.glossentry.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.glossentry.key" type="topic" style="xslt-key"><info><link type="guide" xref="db-common" group="keys"/><link type="guide" xref="keys" group="db"/><revision version="3.18" date="2015-07-22" status="final"/><desc>Get a <code>glossentry</code> element from its <code>glossterm</code>.</desc></info><title>db.glossentry.key</title><p>Get a <code>glossentry</code> element from its <code>glossterm</code>.</p> + + + <p>This key returns <code>glossentry</code> elements based on the text in their <code>glossterm</code> child elements. It only returns <code>glossentry</code> elements that have an <code>id</code> attribute in DocBook 4 or an <code>xml:id</code> attribute in DocBook 5.</p> +</page> diff --git a/doc/yelp-xsl/C/db.id.key.page b/doc/yelp-xsl/C/db.id.key.page new file mode 100644 index 00000000..41d719d1 --- /dev/null +++ b/doc/yelp-xsl/C/db.id.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.id.key" type="topic" style="xslt-key"><info><link type="guide" xref="db-common" group="keys"/><link type="guide" xref="keys" group="db"/><revision version="3.4" date="2012-01-26" status="final"/><desc>Get an element from the <code>id</code> attribute.</desc></info><title>db.id.key</title><p>Get an element from the <code>id</code> attribute.</p> + + + <p>This key returns any element based on the <code>id</code> attribute, or the <code>xml:id</code> attribute in DocBook 5.</p> +</page> diff --git a/doc/yelp-xsl/C/db.linenumbering.start.page b/doc/yelp-xsl/C/db.linenumbering.start.page new file mode 100644 index 00000000..f93a9ea2 --- /dev/null +++ b/doc/yelp-xsl/C/db.linenumbering.start.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.linenumbering.start" type="topic" style="xslt-template"><info><link type="guide" xref="db-common" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determines the starting line number for a verbatim element</desc></info><title>db.linenumbering.start</title><p>Determines the starting line number for a verbatim element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The verbatim element to determine the starting line number for</p> + </item> + </terms></synopsis> + <p>This template determines the starting line number for a verbatim element using the <code>continuation</code> attribute. The template finds the first preceding element of the same name, counts its lines, and handles any <code>startinglinenumber</code> or <code>continuation</code> element it finds on that element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.linenumbering.start"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.orderedlist.start.page b/doc/yelp-xsl/C/db.orderedlist.start.page new file mode 100644 index 00000000..79ddc700 --- /dev/null +++ b/doc/yelp-xsl/C/db.orderedlist.start.page @@ -0,0 +1,18 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.orderedlist.start" type="topic" style="xslt-template"><info><link type="guide" xref="db-common" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>Determine the number to use for the first <code>listitem</code> in an <code>orderedlist</code>.</desc></info><title>db.orderedlist.start</title><p>Determine the number to use for the first <code>listitem</code> in an <code>orderedlist</code>.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>orderedlist</code> element to use.</p> + </item> + <item> + <title><code>continuation</code></title> + <p>The value of the <code>continuation</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template determines the starting number for an <code>orderedlist</code> element using the <code>continuation</code> attribute. The template finds the first preceding <code>orderedlist</code> element and counts its list items. If that element also uses the <code>continuation</code> attribute, this template calls itself recursively to add that element's starting line number to its list item count.</p> + <p>This template uses conditional processing when looking at preceding ordered lists and their child list items.</p> + <p>The <code style="xslt-param">continuation</code> parameter is automatically set based on the <code>continuation</code> attribute of <code style="xslt-param">node</code>. It exists as a parameter to allow this template to force continuation when it calls itself recursively for conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="db.orderedlist.start"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.personname.list.page b/doc/yelp-xsl/C/db.personname.list.page new file mode 100644 index 00000000..5d15ecec --- /dev/null +++ b/doc/yelp-xsl/C/db.personname.list.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.personname.list" type="topic" style="xslt-template"><info><link type="guide" xref="db-common" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Outputs a list of people's names</desc></info><title>db.personname.list</title><p>Outputs a list of people's names</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>nodes</code></title> + <p>The elements containing tags such as <code>firstname</code> and <code>surname</code></p> + </item> + </terms></synopsis> + <p>This template outputs a list of names of people as modelled by the <code>personname</code> element. The <code>personname</code> element allows authors to mark up components of a person's name, such as the person's first name and surname.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db.personname"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.personname.page b/doc/yelp-xsl/C/db.personname.page new file mode 100644 index 00000000..58b2be3c --- /dev/null +++ b/doc/yelp-xsl/C/db.personname.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.personname" type="topic" style="xslt-template"><info><link type="guide" xref="db-common" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Outputs the name of a person</desc></info><title>db.personname</title><p>Outputs the name of a person</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element containing tags such as <code>firstname</code> and <code>surname</code></p> + </item> + </terms></synopsis> + <p>This template outputs the name of a person as modelled by the <code>personname</code> element. The <code>personname</code> element allows authors to mark up components of a person's name, such as the person's first name and surname. This template assembles those into a string.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.personname"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.profile.arch.page b/doc/yelp-xsl/C/db.profile.arch.page new file mode 100644 index 00000000..4c29aa2c --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.arch.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.arch" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of architectures for conditional processing.</desc></info><title>db.profile.arch</title><p>The list of architectures for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>arch</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.audience.page b/doc/yelp-xsl/C/db.profile.audience.page new file mode 100644 index 00000000..a81be5a3 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.audience.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.audience" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of audiences for conditional processing.</desc></info><title>db.profile.audience</title><p>The list of audiences for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>audience</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.condition.page b/doc/yelp-xsl/C/db.profile.condition.page new file mode 100644 index 00000000..0d6c4d19 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.condition.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.condition" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of application-specific conditions for conditional processing.</desc></info><title>db.profile.condition</title><p>The list of application-specific conditions for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>condition</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.conformance.page b/doc/yelp-xsl/C/db.profile.conformance.page new file mode 100644 index 00000000..347258d0 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.conformance.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.conformance" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of conformance characteristics for conditional processing.</desc></info><title>db.profile.conformance</title><p>The list of conformance characteristics for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>conformance</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.os.page b/doc/yelp-xsl/C/db.profile.os.page new file mode 100644 index 00000000..fdc669c3 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.os.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.os" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of operating systems for conditional processing.</desc></info><title>db.profile.os</title><p>The list of operating systems for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>os</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.outputformat.page b/doc/yelp-xsl/C/db.profile.outputformat.page new file mode 100644 index 00000000..b47c75c7 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.outputformat.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.outputformat" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of output formats for conditional processing.</desc></info><title>db.profile.outputformat</title><p>The list of output formats for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>outputformat</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.revision.page b/doc/yelp-xsl/C/db.profile.revision.page new file mode 100644 index 00000000..a05862ae --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.revision.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.revision" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of editorial revisions for conditional processing.</desc></info><title>db.profile.revision</title><p>The list of editorial revisions for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>revision</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.security.page b/doc/yelp-xsl/C/db.profile.security.page new file mode 100644 index 00000000..ce99c129 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.security.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.security" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of security levels for conditional processing.</desc></info><title>db.profile.security</title><p>The list of security levels for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>security</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.test.page b/doc/yelp-xsl/C/db.profile.test.page new file mode 100644 index 00000000..910fb2fd --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.test.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.test" type="topic" style="xslt-template"><info><link type="guide" xref="db-profile" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>Test if an element should be shown based on profiling attributes.</desc></info><title>db.profile.test</title><p>Test if an element should be shown based on profiling attributes.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to check the condition for.</p> + </item> + </terms></synopsis> + <p>This template looks at all the profiling attributes of the element <code style="xslt-param">node</code>: <code>arch</code>, <code>audience</code>, <code>condition</code>, <code>conformance</code>, <code>os</code>, <code>outputformat</code>, <code>revision</code>, <code>security</code>, <code>userlevel</code>, <code>vendor</code>, and <code>wordsize</code>. It returns the string <code>"true"</code> if all attributes present match the corresponding parameter in this stylesheet. Attributes and parameters can both be lists, separated by semicolons. An attribute matches a parameter if there is at least one value in common between the two.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="db.profile.arch"/></p></item><item><p><link xref="db.profile.audience"/></p></item><item><p><link xref="db.profile.condition"/></p></item><item><p><link xref="db.profile.conformance"/></p></item><item><p><link xref="db.profile.os"/></p></item><item><p><link xref="db.profile.outputformat"/></p></item><item><p><link xref="db.profile.revision"/></p></item><item><p><link xref="db.profile.security"/></p></item><item><p><link xref="db.profile.userlevel"/></p></item><item><p><link xref="db.profile.vendor"/></p></item><item><p><link xref="db.profile.wordsize"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.profile.userlevel.page b/doc/yelp-xsl/C/db.profile.userlevel.page new file mode 100644 index 00000000..c7abbecb --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.userlevel.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.userlevel" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of user experience levels for conditional processing.</desc></info><title>db.profile.userlevel</title><p>The list of user experience levels for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>userlevel</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.vendor.page b/doc/yelp-xsl/C/db.profile.vendor.page new file mode 100644 index 00000000..287813c1 --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.vendor.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.vendor" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of vendors for conditional processing.</desc></info><title>db.profile.vendor</title><p>The list of vendors for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>vendor</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.profile.wordsize.page b/doc/yelp-xsl/C/db.profile.wordsize.page new file mode 100644 index 00000000..4797839b --- /dev/null +++ b/doc/yelp-xsl/C/db.profile.wordsize.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.profile.wordsize" type="topic" style="xslt-param"><info><link type="guide" xref="db-profile" group="parameters"/><link type="guide" xref="parameters" group="db"/><revision version="3.10" date="2013-08-12" status="final"/><desc>The list of word sizes for conditional processing.</desc></info><title>db.profile.wordsize</title><p>The list of word sizes for conditional processing.</p> + + + <p>This parameter takes a semicolon-separated list of values to match against the <code>wordsize</code> attribute for conditional processing.</p> +</page> diff --git a/doc/yelp-xsl/C/db.subtitle.page b/doc/yelp-xsl/C/db.subtitle.page new file mode 100644 index 00000000..17607ef4 --- /dev/null +++ b/doc/yelp-xsl/C/db.subtitle.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.subtitle" type="topic" style="xslt-template"><info><link type="guide" xref="db-title" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output a subtitle for an element.</desc></info><title>db.subtitle</title><p>Output a subtitle for an element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to output the subtitle of.</p> + </item> + <item> + <title><code>info</code></title> + <p>The info child element of <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs the subtitle of the element <code style="xslt-param">node</code>, which is sometimes used for link text. If no explicit <code>titleabbrev</code> element is found, this template just calls <code style="xslt-template" xref="db.title">db.title</code>. This template is not suitable for determining whehter a subtitle should be placed in a heading, as it will always return the title if a subtitle is not found.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.title"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.title.page b/doc/yelp-xsl/C/db.title.page new file mode 100644 index 00000000..00a53bf2 --- /dev/null +++ b/doc/yelp-xsl/C/db.title.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.title" type="topic" style="xslt-template"><info><link type="guide" xref="db-title" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output a title for an element.</desc></info><title>db.title</title><p>Output a title for an element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to output the title of.</p> + </item> + <item> + <title><code>info</code></title> + <p>The info child element of <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs the title of the element <code style="xslt-param">node</code> as it might be used for a heading or for link text. For certain types of elements, this templates will use a localized automatic title if no explicit title is provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.chunk-id"/></p></item><item><p><link xref="db.title"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.titleabbrev.page b/doc/yelp-xsl/C/db.titleabbrev.page new file mode 100644 index 00000000..64bd8121 --- /dev/null +++ b/doc/yelp-xsl/C/db.titleabbrev.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.titleabbrev" type="topic" style="xslt-template"><info><link type="guide" xref="db-title" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output an abbreviated title for an element.</desc></info><title>db.titleabbrev</title><p>Output an abbreviated title for an element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to output the abbreviated title of.</p> + </item> + <item> + <title><code>info</code></title> + <p>The info child element of <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs the abbreviated title of the element <code style="xslt-param">node</code>, which is sometimes used for link text. If no explicit <code>titleabbrev</code> element is found, this template just calls <code style="xslt-template" xref="db.title">db.title</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.title"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.ulink.tooltip.page b/doc/yelp-xsl/C/db.ulink.tooltip.page new file mode 100644 index 00000000..ec677a89 --- /dev/null +++ b/doc/yelp-xsl/C/db.ulink.tooltip.page @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.ulink.tooltip" type="topic" style="xslt-template"><info><link type="guide" xref="db-xref" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates the tooltip for an external link</desc></info><title>db.ulink.tooltip</title><p>Generates the tooltip for an external link</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to generate a tooltip for</p> + </item> + <item> + <title><code>url</code></title> + <p>The URL of the link, usually from the <code>url</code> attribute</p> + </item> + </terms></synopsis> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="utils.email_address"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.xref.content.page b/doc/yelp-xsl/C/db.xref.content.page new file mode 100644 index 00000000..21528c29 --- /dev/null +++ b/doc/yelp-xsl/C/db.xref.content.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.xref.content" type="topic" style="xslt-template"><info><link type="guide" xref="db-xref" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates the content of a cross reference</desc></info><title>db.xref.content</title><p>Generates the content of a cross reference</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>linkend</code></title> + <p>The id of the linked-to element, usually from the <code>linkend</code> attribute</p> + </item> + <item> + <title><code>target</code></title> + <p>The linked-to element</p> + </item> + <item> + <title><code>xrefstyle</code></title> + <p>The cross reference style, usually from the <code>xrefstyle</code> attribute</p> + </item> + </terms></synopsis> + <comment><p>The xrefstyle/role stuff needs to be documented</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.title"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.xref.target.page b/doc/yelp-xsl/C/db.xref.target.page new file mode 100644 index 00000000..127ee835 --- /dev/null +++ b/doc/yelp-xsl/C/db.xref.target.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.xref.target" type="topic" style="xslt-template"><info><link type="guide" xref="db-xref" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates the target identifier of a cross reference</desc></info><title>db.xref.target</title><p>Generates the target identifier of a cross reference</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>linkend</code></title> + <p>The id of the linked-to element, usually from the <code>linkend</code> attribute</p> + </item> + <item> + <title><code>target</code></title> + <p>The linked-to element</p> + </item> + <item> + <title><code>is_chunk</code></title> + <p>Whether <code style="xslt-param">target</code> is known to be a chunked element</p> + </item> + </terms></synopsis> + <comment><p>Talk about how this works with chunking</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.chunk-id"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.basename"/></p></item><item><p><link xref="db.chunk.extension"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db.xref.tooltip.mode.page b/doc/yelp-xsl/C/db.xref.tooltip.mode.page new file mode 100644 index 00000000..06cb668c --- /dev/null +++ b/doc/yelp-xsl/C/db.xref.tooltip.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.xref.tooltip.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db-xref" group="modes"/><link type="guide" xref="modes" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>FIXME</desc></info><title>db.xref.tooltip.mode</title><p>FIXME</p> + + + <comment><p>Document this</p></comment> +</page> diff --git a/doc/yelp-xsl/C/db.xref.tooltip.page b/doc/yelp-xsl/C/db.xref.tooltip.page new file mode 100644 index 00000000..bec901d6 --- /dev/null +++ b/doc/yelp-xsl/C/db.xref.tooltip.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db.xref.tooltip" type="topic" style="xslt-template"><info><link type="guide" xref="db-xref" group="templates"/><link type="guide" xref="templates" group="db"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates the tooltip for a cross reference</desc></info><title>db.xref.tooltip</title><p>Generates the tooltip for a cross reference</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>linkend</code></title> + <p>The id of the linked-to element, usually from the <code>linkend</code> attribute</p> + </item> + <item> + <title><code>target</code></title> + <p>The linked-to element</p> + </item> + </terms></synopsis> + <comment><p>Document this</p></comment> +<list style="compact"><title>Calls Modes</title><item><p><link xref="db.xref.tooltip.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html-bibliography.page b/doc/yelp-xsl/C/db2html-bibliography.page new file mode 100644 index 00000000..1bd787eb --- /dev/null +++ b/doc/yelp-xsl/C/db2html-bibliography.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-bibliography" type="guide" style="xslt-stylesheet"><?xslt-private l10n.format.mode?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.4" date="2011-11-14" status="final"/><link type="xslt-defines-template" xref="db2html.biblioentry.data"/><link type="xslt-defines-template" xref="db2html.biblioentry.label"/><link type="xslt-implements-mode" xref="db2html.biblioentry.mode"/></info><title>DocBook to HTML - Bibliographies</title> + + + <p>This module provides templates to process DocBook bibliograpies.</p> + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="db.personname.list"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="db2html.division.div"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>bibliography | db:bibliography</code></p></td></tr><tr><td><p/></td><td><p><code>bibliodiv | db:bibliodiv</code></p></td></tr><tr><td><p/></td><td><p><code>biblioentry | db:biblioentry</code></p></td></tr><tr><td><p/></td><td><p><code>bibliomixed | db:bibliomixed</code></p></td></tr><tr><td><p/></td><td><p><code>bibliolist | db:bibliolist</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>abstract | db:abstract</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>affiliation | db:affiliation</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>author | db:author</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>authorblurb</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>authorgroup | db:authorgroup</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>biblioset | db:biblioset</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>citerefentry | db:citerefentry</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>collab | db:collab</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>copyright | db:copyright</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>db:cover</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>editor | db:editor</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>footnote | footnoteref | db:footnote | db:footnoteref</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>glossterm | db:glossterm</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>indexterm | db:indexterm</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>legalnotice | db:legalnotice</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>mediaobject | db:mediaobject</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>db:org</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>othercredit | db:othercredit</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>db:person</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>personname | db:personname</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>personblurb | db:personblurb</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>publisher | db:publisher</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>printhistory | db:printhistory</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>subscript | db:subscript</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>superscript | db:superscript</code></p></td></tr><tr><td><p><link xref="db2html.biblioentry.mode">db2html.biblioentry.mode</link></p></td><td><p><code>revhistory | db:revhistory</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-block.page b/doc/yelp-xsl/C/db2html-block.page new file mode 100644 index 00000000..21e9f34f --- /dev/null +++ b/doc/yelp-xsl/C/db2html-block.page @@ -0,0 +1,18 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-block" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.4" date="2011-11-12" status="final"/><link type="xslt-defines-template" xref="db2html.block"/><link type="xslt-defines-template" xref="db2html.block.formal"/><link type="xslt-defines-template" xref="db2html.block.title"/><link type="xslt-defines-template" xref="db2html.blockquote"/><link type="xslt-defines-template" xref="db2html.para"/><link type="xslt-defines-template" xref="db2html.pre"/></info><title>DocBook to HTML - Block Elements</title> + + + <p>This stylesheet handles most simple block-level elements, turning them into the appropriate HTML tags. It does not handle tables, lists, and various other complex block-level elements.</p> + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="utils.linenumbering"/></p></item><item><p><link xref="html.syntax.class"/></p></item><item><p><link xref="db.chunk.depth-in-chunk"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.syntax.highlight"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>abstract | db:abstract</code></p></td></tr><tr><td><p/></td><td><p><code>ackno</code></p></td></tr><tr><td><p/></td><td><p><code>db:acknowledgements</code></p></td></tr><tr><td><p/></td><td><p><code>address | db:address</code></p></td></tr><tr><td><p/></td><td><p><code>attribution | db:attribution</code></p></td></tr><tr><td><p/></td><td><p><code>blockquote | db:blockquote</code></p></td></tr><tr><td><p/></td><td><p><code>bridgehead | db:bridgehead</code></p></td></tr><tr><td><p/></td><td><p><code>caption | db:caption</code></p></td></tr><tr><td><p/></td><td><p><code>caution | db:caution</code></p></td></tr><tr><td><p/></td><td><p><code>epigraph | db:epigraph</code></p></td></tr><tr><td><p/></td><td><p><code>equation | db:equation</code></p></td></tr><tr><td><p/></td><td><p><code>example | db:example</code></p></td></tr><tr><td><p/></td><td><p><code>figure | informalfigure | db:figure | db:informalfigure</code></p></td></tr><tr><td><p/></td><td><p><code>formalpara | db:formalpara</code></p></td></tr><tr><td><p/></td><td><p><code>highlights</code></p></td></tr><tr><td><p/></td><td><p><code>important | db:important</code></p></td></tr><tr><td><p/></td><td><p><code>informalequation | db:informalequation</code></p></td></tr><tr><td><p/></td><td><p><code>informalexample | db:informalexample</code></p></td></tr><tr><td><p/></td><td><p><code>literallayout | db:literallayout</code></p></td></tr><tr><td><p/></td><td><p><code>note | db:note</code></p></td></tr><tr><td><p/></td><td><p><code>para | db:para</code></p></td></tr><tr><td><p/></td><td><p><code>programlisting | db:programlisting</code></p></td></tr><tr><td><p/></td><td><p><code>screen | db:screen</code></p></td></tr><tr><td><p/></td><td><p><code>screenshot | db:screenshot</code></p></td></tr><tr><td><p/></td><td><p><code>sidebar | db:sidebar</code></p></td></tr><tr><td><p/></td><td><p><code>simpara | db:simpara</code></p></td></tr><tr><td><p/></td><td><p><code>synopsis | db:synopsis</code></p></td></tr><tr><td><p/></td><td><p><code>task | db:task</code></p></td></tr><tr><td><p/></td><td><p><code>taskprerequisites | db:taskprerequisites</code></p></td></tr><tr><td><p/></td><td><p><code>taskrelated | db:taskrelated</code></p></td></tr><tr><td><p/></td><td><p><code>tasksummary | db:tasksummary</code></p></td></tr><tr><td><p/></td><td><p><code>tip | db:tip</code></p></td></tr><tr><td><p/></td><td><p><code>title | db:title</code></p></td></tr><tr><td><p/></td><td><p><code>warning | db:warning</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-callout.page b/doc/yelp-xsl/C/db2html-callout.page new file mode 100644 index 00000000..1e08a14b --- /dev/null +++ b/doc/yelp-xsl/C/db2html-callout.page @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-callout" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><link type="xslt-requires" xref="db2html-block"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="html"/><link type="xslt-defines-template" xref="db2html.callout.label"/></info><title>DocBook to HTML - Callouts</title> + + + <p>This modules handles simple DocBook callouts using the <code>co</code> and <code>callout</code> elements. Currently, only callouts to <code>co</code> elements are supported. The <code>area</code> element is not supported.</p> + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-block"/></p></item><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="html"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>co | db:co</code></p></td></tr><tr><td><p/></td><td><p><code>calloutlist | db:calloutlist</code></p></td></tr><tr><td><p/></td><td><p><code>callout | db:callout</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-classsynopsis.page b/doc/yelp-xsl/C/db2html-classsynopsis.page new file mode 100644 index 00000000..3d53ca8d --- /dev/null +++ b/doc/yelp-xsl/C/db2html-classsynopsis.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-classsynopsis" type="guide" style="xslt-stylesheet"><?xslt-private db2html.class.cpp.modifier?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="html"/><link type="xslt-implements-mode" xref="db2html.class.cpp.mode"/><link type="xslt-implements-mode" xref="db2html.class.python.mode"/><link type="xslt-defines-param" xref="db2html.classsynopsis.language"/></info><title>DocBook to HTML - Class Synopses</title> + + + <p>This module handles the DocBook <code>classsynopsis</code> and related elements. The contents of the class-modeling elements are processed in a mode depending on the programming language to format the synopsis correctly.</p> + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="html"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db2html.classsynopsis.language"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code> classsynopsis | constructorsynopsis | fieldsynopsis | methodsynopsis | destructorsynopsis | db:classsynopsis | db:constructorsynopsis | db:fieldsynopsis | db:methodsynopsis | db:destructorsynopsis |</code></p></td></tr><tr><td><p/></td><td><p><code>classsynopsisinfo | db:classsynopsisinfo</code></p></td></tr><tr><td><p/></td><td><p><code>methodparam | db:methodparam</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>classsynopsis | db:classsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>constructorsynopsis | db:constructorsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>destructorsynopsis | db:destructorsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>fieldsynopsis | db:fieldsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>methodparam | db:methodparam</code></p></td></tr><tr><td><p><link xref="db2html.class.cpp.mode">db2html.class.cpp.mode</link></p></td><td><p><code>methodsynopsis | db:methodsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>classsynopsis | db:classsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>constructorsynopsis | db:constructorsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>destructorsynopsis | db:destructorsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>fieldsynopsis | db:fieldsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>methodparam | db:methodparam</code></p></td></tr><tr><td><p><link xref="db2html.class.python.mode">db2html.class.python.mode</link></p></td><td><p><code>methodsynopsis | db:methodsynopsis</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-cmdsynopsis.page b/doc/yelp-xsl/C/db2html-cmdsynopsis.page new file mode 100644 index 00000000..a2bcb519 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-cmdsynopsis.page @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-cmdsynopsis" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="html"/><link type="xslt-implements-mode" xref="db2html.cmdsynopsis.sbr.padding.mode"/></info><title>DocBook to HTML - Command Synopses</title> + + + <p>This module contains templates to process DocBook command synopsis elements.</p> + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="html"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.profile.test"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>arg | db:arg</code></p></td></tr><tr><td><p/></td><td><p><code>cmdsynopsis | db:cmdsynopsis</code></p></td></tr><tr><td><p/></td><td><p><code>group | db:group</code></p></td></tr><tr><td><p/></td><td><p><code>synopfragment | db:synopfragment</code></p></td></tr><tr><td><p/></td><td><p><code>synopfragmentref | db:synopfragmentref</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>node()</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>cmdsynopsis | db:cmdsynopsis</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>arg | db:arg</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>group | db:group</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>synopfragment | db:synopfragment</code></p></td></tr><tr><td><p><link xref="db2html.cmdsynopsis.sbr.padding.mode">db2html.cmdsynopsis.sbr.padding.mode</link></p></td><td><p><code>synopfragmentref | db:synopfragmentref</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-css.page b/doc/yelp-xsl/C/db2html-css.page new file mode 100644 index 00000000..8c9c1d14 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-css.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-css" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="color"/><link type="xslt-requires" xref="html"/><link type="xslt-requires" xref="l10n"/><link type="xslt-implements-mode" xref="html.css.mode"/></info><title>DocBook to HTML - CSS</title> + + + <comment><p>Describe this module</p></comment> +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="color"/></p></item><item><p><link xref="html"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.blue_background"/></p></item><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.text_light"/></p></item><item><p><link xref="color.yellow_background"/></p></item><item><p><link xref="color.yellow_border"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="html.css.mode">html.css.mode</link></p></td><td><p><code>*</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-division.page b/doc/yelp-xsl/C/db2html-division.page new file mode 100644 index 00000000..3b2393d8 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-division.page @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-division" type="guide" style="xslt-stylesheet"><?xslt-private _db2html.division.div.inner?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-template" xref="db2html.division.div"/><link type="xslt-defines-template" xref="db2html.hgroup"/><link type="xslt-defines-template" xref="db2html.division.about"/><link type="xslt-implements-mode" xref="html.title.mode"/><link type="xslt-implements-mode" xref="html.header.mode"/><link type="xslt-implements-mode" xref="html.footer.mode"/><link type="xslt-implements-mode" xref="html.body.mode"/><link type="xslt-implements-mode" xref="html.output.after.mode"/><link type="xslt-implements-mode" xref="db2html.division.div.content.mode"/></info><title>DocBook to HTML - Divisions</title><p>Handle division-level DocBook elements.</p> + + + <p>This stylesheet contains templates to process top-level and sectioning elements in DocBook. It handles chunking and implements the interfaces provided by the common <file xref="html">html</file> stylesheet.</p> + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="db.title"/></p></item><item><p><link xref="db2html.links.linktrail"/></p></item><item><p><link xref="html.output"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.links.section"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.max_depth"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>appendix | db:appendix</code></p></td></tr><tr><td><p/></td><td><p><code>article | db:article</code></p></td></tr><tr><td><p/></td><td><p><code>book | db:book</code></p></td></tr><tr><td><p/></td><td><p><code>chapter | db:chapter</code></p></td></tr><tr><td><p/></td><td><p><code>colophon | db:colophon</code></p></td></tr><tr><td><p/></td><td><p><code>dedication | db:dedication</code></p></td></tr><tr><td><p/></td><td><p><code>glossary | db:glossary</code></p></td></tr><tr><td><p/></td><td><p><code>glossdiv | db:glossdiv</code></p></td></tr><tr><td><p/></td><td><p><code>part | db:part</code></p></td></tr><tr><td><p/></td><td><p><code>preface | db:preface</code></p></td></tr><tr><td><p/></td><td><p><code>qandadiv | db:qandadiv</code></p></td></tr><tr><td><p/></td><td><p><code>qandaset | db:qandaset</code></p></td></tr><tr><td><p/></td><td><p><code>reference | db:reference</code></p></td></tr><tr><td><p/></td><td><p><code>sect1 | db:sect1</code></p></td></tr><tr><td><p/></td><td><p><code>sect2 | db:sect2</code></p></td></tr><tr><td><p/></td><td><p><code>sect3 | db:sect3</code></p></td></tr><tr><td><p/></td><td><p><code>sect4 | db:sect4</code></p></td></tr><tr><td><p/></td><td><p><code>sect5 | db:sect5</code></p></td></tr><tr><td><p/></td><td><p><code>section | db:section</code></p></td></tr><tr><td><p/></td><td><p><code>simplesect | db:simplesect</code></p></td></tr><tr><td><p><link xref="db2html.division.div.content.mode">db2html.division.div.content.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.body.mode">html.body.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.footer.mode">html.footer.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.header.mode">html.header.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.output.after.mode">html.output.after.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.title.mode">html.title.mode</link></p></td><td><p><code>*</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-ebnf.page b/doc/yelp-xsl/C/db2html-ebnf.page new file mode 100644 index 00000000..a644738b --- /dev/null +++ b/doc/yelp-xsl/C/db2html-ebnf.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-ebnf" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db2html-xref"/></info><title>DocBook to HTML - EBNF Elements</title> + + + <comment><p>Describe this module</p></comment> +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-xref"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.anchor"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>productionset | db:productionset</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-footnote.page b/doc/yelp-xsl/C/db2html-footnote.page new file mode 100644 index 00000000..eae2c1f6 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-footnote.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-footnote" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="db2html.footnote.link"/><link type="xslt-defines-template" xref="db2html.footnote.note"/><link type="xslt-defines-template" xref="db2html.footnote.footer"/></info><title>DocBook to HTML - Footnotes</title> + + + <p>FIXME: Describe this module</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.chunk.depth-of-chunk"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>footnote | db:footnote</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-funcsynopsis.page b/doc/yelp-xsl/C/db2html-funcsynopsis.page new file mode 100644 index 00000000..c199faca --- /dev/null +++ b/doc/yelp-xsl/C/db2html-funcsynopsis.page @@ -0,0 +1,9 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-funcsynopsis" type="guide" style="xslt-stylesheet"><?xslt-private _db2html.funcsynopsis.pad?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db2html-block"/><link type="xslt-requires" xref="db2html-inline"/><link type="xslt-defines-param" xref="db2html.funcsynopsis.style"/></info><title>DocBook to HTML - Function Synopses</title> + + + <comment><p>Describe this module</p></comment> + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-block"/></p></item><item><p><link xref="db2html-inline"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.inline"/></p></item><item><p><link xref="db2html.pre"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db2html.funcsynopsis.style"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>funcdef | db:funcdef</code></p></td></tr><tr><td><p/></td><td><p><code>funcparams | db:funcparams</code></p></td></tr><tr><td><p/></td><td><p><code>funcprototype | db:funcprototype</code></p></td></tr><tr><td><p/></td><td><p><code>funcsynopsis | db:funcsynopsis</code></p></td></tr><tr><td><p/></td><td><p><code>funcsynopsisinfo | db:funcsynopsisinfo</code></p></td></tr><tr><td><p/></td><td><p><code>initializer | db:initializer</code></p></td></tr><tr><td><p/></td><td><p><code>modifier | db:modifier</code></p></td></tr><tr><td><p/></td><td><p><code>paramdef | db:paramdef</code></p></td></tr><tr><td><p/></td><td><p><code>varargs | db:varargs</code></p></td></tr><tr><td><p/></td><td><p><code>void | db:void</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-index.page b/doc/yelp-xsl/C/db2html-index.page new file mode 100644 index 00000000..9cfe4e9c --- /dev/null +++ b/doc/yelp-xsl/C/db2html-index.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-index" type="guide" style="xslt-stylesheet"><?xslt-private l10n.format.mode?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-chunk"/><link type="xslt-requires" xref="db2html-division"/><link type="xslt-requires" xref="l10n"/></info><title>DocBook to HTML - Indexes</title> + + + <p>This module provides templates to process DocBook indexes.</p> + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-chunk"/></p></item><item><p><link xref="db2html-division"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.division.div"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>primaryie | db:primaryie</code></p></td></tr><tr><td><p/></td><td><p><code>secondaryie | db:secondaryie</code></p></td></tr><tr><td><p/></td><td><p><code>tertiaryie | db:tertiaryie</code></p></td></tr><tr><td><p/></td><td><p><code>indexentry | db:indexentry</code></p></td></tr><tr><td><p/></td><td><p><code>index | db:index</code></p></td></tr><tr><td><p/></td><td><p><code>indexdiv | db:indexdiv</code></p></td></tr><tr><td><p/></td><td><p><code>setindex | db:setindex</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-inline.page b/doc/yelp-xsl/C/db2html-inline.page new file mode 100644 index 00000000..c65b17e6 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-inline.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-inline" type="guide" style="xslt-stylesheet"><?xslt-private l10n.format.mode?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-common"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="l10n"/><link type="xslt-defines-template" xref="db2html.inline.children"/><link type="xslt-defines-template" xref="db2html.inline"/><link type="xslt-implements-mode" xref="db2html.inline.content.mode"/></info><title>DocBook to HTML - Inline Elements</title> + + + <comment><p>Describe this module</p></comment> + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-common"/></p></item><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.xlink"/></p></item><item><p><link xref="db.personname"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.xref"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.biblio.abbrev.key"/></p></item><item><p><link xref="db.biblio.id.key"/></p></item><item><p><link xref="db.biblio.label.key"/></p></item><item><p><link xref="db.glossentry.key"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>abbrev | db:abbrev</code></p></td></tr><tr><td><p/></td><td><p><code>accel | db:accel</code></p></td></tr><tr><td><p/></td><td><p><code>acronym | db:acronym</code></p></td></tr><tr><td><p/></td><td><p><code>action</code></p></td></tr><tr><td><p/></td><td><p><code>artpagenums | db:artpagenums</code></p></td></tr><tr><td><p/></td><td><p><code>application | db:application</code></p></td></tr><tr><td><p/></td><td><p><code>author | db:author</code></p></td></tr><tr><td><p/></td><td><p><code>authorinitials | db:authorinitials</code></p></td></tr><tr><td><p/></td><td><p><code>db:biblioid</code></p></td></tr><tr><td><p/></td><td><p><code>citation | db:citation</code></p></td></tr><tr><td><p/></td><td><p><code>citetitle | db:citetitle</code></p></td></tr><tr><td><p/></td><td><p><code>city | db:city</code></p></td></tr><tr><td><p/></td><td><p><code>classname | db:classname</code></p></td></tr><tr><td><p/></td><td><p><code>code | db:code</code></p></td></tr><tr><td><p/></td><td><p><code>collab | db:collab</code></p></td></tr><tr><td><p/></td><td><p><code>collabname</code></p></td></tr><tr><td><p/></td><td><p><code>command | db:command</code></p></td></tr><tr><td><p/></td><td><p><code>computeroutput | db:computeroutput</code></p></td></tr><tr><td><p/></td><td><p><code>constant | db:constant</code></p></td></tr><tr><td><p/></td><td><p><code>corpauthor</code></p></td></tr><tr><td><p/></td><td><p><code>corpcredit</code></p></td></tr><tr><td><p/></td><td><p><code>country | db:country</code></p></td></tr><tr><td><p/></td><td><p><code>database | db:database</code></p></td></tr><tr><td><p/></td><td><p><code>date | db:date</code></p></td></tr><tr><td><p/></td><td><p><code>edition | db:edition</code></p></td></tr><tr><td><p/></td><td><p><code>editor | db:editor</code></p></td></tr><tr><td><p/></td><td><p><code>email | db:email</code></p></td></tr><tr><td><p/></td><td><p><code>emphasis | db:emphasis</code></p></td></tr><tr><td><p/></td><td><p><code>envar | db:envar</code></p></td></tr><tr><td><p/></td><td><p><code>errorcode | db:errorcode</code></p></td></tr><tr><td><p/></td><td><p><code>errorname | db:errorname</code></p></td></tr><tr><td><p/></td><td><p><code>errortext | db:errortext</code></p></td></tr><tr><td><p/></td><td><p><code>errortype | db:errortype</code></p></td></tr><tr><td><p/></td><td><p><code>exceptionname | db:exceptionname</code></p></td></tr><tr><td><p/></td><td><p><code>fax | db:fax</code></p></td></tr><tr><td><p/></td><td><p><code>filename | db:filename</code></p></td></tr><tr><td><p/></td><td><p><code>firstname | db:firstname</code></p></td></tr><tr><td><p/></td><td><p><code>firstterm | db:firstterm</code></p></td></tr><tr><td><p/></td><td><p><code>foreignphrase | db:foreignphrase</code></p></td></tr><tr><td><p/></td><td><p><code>function | db:function</code></p></td></tr><tr><td><p/></td><td><p><code>glossterm | db:glossterm</code></p></td></tr><tr><td><p/></td><td><p><code>guibutton | db:guibutton</code></p></td></tr><tr><td><p/></td><td><p><code>guiicon | db:guiicon</code></p></td></tr><tr><td><p/></td><td><p><code>guilabel | db:guilabel</code></p></td></tr><tr><td><p/></td><td><p><code>guimenu | db:guimenu</code></p></td></tr><tr><td><p/></td><td><p><code>guimenuitem | db:guimenuitem</code></p></td></tr><tr><td><p/></td><td><p><code>guisubmenu | db:guisubmenu</code></p></td></tr><tr><td><p/></td><td><p><code>hardware | db:hardware</code></p></td></tr><tr><td><p/></td><td><p><code>holder | db:holder</code></p></td></tr><tr><td><p/></td><td><p><code>honorific | db:honorific</code></p></td></tr><tr><td><p/></td><td><p><code>inlineequation | db:inlineequation</code></p></td></tr><tr><td><p/></td><td><p><code>interface | db:interface</code></p></td></tr><tr><td><p/></td><td><p><code>interfacename | db:interfacename</code></p></td></tr><tr><td><p/></td><td><p><code>isbn | db:biblioid[@class = 'isbn']</code></p></td></tr><tr><td><p/></td><td><p><code>issn | db:biblioid[@class = 'issn']</code></p></td></tr><tr><td><p/></td><td><p><code>issuenum | db:issuenum</code></p></td></tr><tr><td><p/></td><td><p><code>jobtitle | db:jobtitle</code></p></td></tr><tr><td><p/></td><td><p><code>keycap | db:keycap</code></p></td></tr><tr><td><p/></td><td><p><code>keycode | db:keycode</code></p></td></tr><tr><td><p/></td><td><p><code>keycombo | db:keycombo</code></p></td></tr><tr><td><p/></td><td><p><code>keysym | db:keysym</code></p></td></tr><tr><td><p/></td><td><p><code>lineage | db:lineage</code></p></td></tr><tr><td><p/></td><td><p><code>lineannotation | db:lineannotation</code></p></td></tr><tr><td><p/></td><td><p><code>literal | db:literal</code></p></td></tr><tr><td><p/></td><td><p><code>markup | db:markup</code></p></td></tr><tr><td><p/></td><td><p><code>mathphrase | db:mathphrase</code></p></td></tr><tr><td><p/></td><td><p><code>medialabel</code></p></td></tr><tr><td><p/></td><td><p><code>menuchoice | db:menuchoice</code></p></td></tr><tr><td><p/></td><td><p><code>methodname | db:methodname</code></p></td></tr><tr><td><p/></td><td><p><code>mousebutton | db:mousebutton</code></p></td></tr><tr><td><p/></td><td><p><code>option | db:option</code></p></td></tr><tr><td><p/></td><td><p><code>optional | db:optional</code></p></td></tr><tr><td><p/></td><td><p><code>db:org</code></p></td></tr><tr><td><p/></td><td><p><code>orgdiv | db:orgdiv</code></p></td></tr><tr><td><p/></td><td><p><code>orgname | db:orgname</code></p></td></tr><tr><td><p/></td><td><p><code>othercredit | db:othercredit</code></p></td></tr><tr><td><p/></td><td><p><code>othername | db:othername</code></p></td></tr><tr><td><p/></td><td><p><code>package | db:package</code></p></td></tr><tr><td><p/></td><td><p><code>pagenums | db:pagenums</code></p></td></tr><tr><td><p/></td><td><p><code>parameter | db:parameter</code></p></td></tr><tr><td><p/></td><td><p><code>db:person</code></p></td></tr><tr><td><p/></td><td><p><code>personname | db:personname</code></p></td></tr><tr><td><p/></td><td><p><code>phone | db:phone</code></p></td></tr><tr><td><p/></td><td><p><code>phrase | db:phrase</code></p></td></tr><tr><td><p/></td><td><p><code>pob | db:pob</code></p></td></tr><tr><td><p/></td><td><p><code>postcode | db:postcode</code></p></td></tr><tr><td><p/></td><td><p><code>productname | db:productname</code></p></td></tr><tr><td><p/></td><td><p><code>productnumber | db:productnumber</code></p></td></tr><tr><td><p/></td><td><p><code>prompt | db:prompt</code></p></td></tr><tr><td><p/></td><td><p><code>property | db:property</code></p></td></tr><tr><td><p/></td><td><p><code>pubdate | db:pubdate</code></p></td></tr><tr><td><p/></td><td><p><code>publisher | db:publisher</code></p></td></tr><tr><td><p/></td><td><p><code>publishername | db:publishername</code></p></td></tr><tr><td><p/></td><td><p><code>ooclass | db:ooclass</code></p></td></tr><tr><td><p/></td><td><p><code>ooexception | db:ooexception</code></p></td></tr><tr><td><p/></td><td><p><code>oointerface | db:oointerface</code></p></td></tr><tr><td><p/></td><td><p><code>quote | db:quote</code></p></td></tr><tr><td><p/></td><td><p><code>replaceable | db:replaceable</code></p></td></tr><tr><td><p/></td><td><p><code>returnvalue | db:returnvalue</code></p></td></tr><tr><td><p/></td><td><p><code>sgmltag | db:tag</code></p></td></tr><tr><td><p/></td><td><p><code>shortcut | db:shortcut</code></p></td></tr><tr><td><p/></td><td><p><code>state | db:state</code></p></td></tr><tr><td><p/></td><td><p><code>street | db:street</code></p></td></tr><tr><td><p/></td><td><p><code>structfield</code></p></td></tr><tr><td><p/></td><td><p><code>structname</code></p></td></tr><tr><td><p/></td><td><p><code>subscript | db:subscript</code></p></td></tr><tr><td><p/></td><td><p><code>superscript | db:superscript</code></p></td></tr><tr><td><p/></td><td><p><code>surname | db:surname</code></p></td></tr><tr><td><p/></td><td><p><code>symbol | db:symbol</code></p></td></tr><tr><td><p/></td><td><p><code>systemitem | db:systemitem</code></p></td></tr><tr><td><p/></td><td><p><code>token | db:token</code></p></td></tr><tr><td><p/></td><td><p><code>trademark | db:trademark</code></p></td></tr><tr><td><p/></td><td><p><code>type | db:type</code></p></td></tr><tr><td><p/></td><td><p><code>uri | db:uri</code></p></td></tr><tr><td><p/></td><td><p><code>userinput | db:userinput</code></p></td></tr><tr><td><p/></td><td><p><code>varname | db:varname</code></p></td></tr><tr><td><p/></td><td><p><code>volumenum | db:volumenum</code></p></td></tr><tr><td><p/></td><td><p><code>wordasword | db:wordasword</code></p></td></tr><tr><td><p/></td><td><p><code>year | db:year</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>author | db:author</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>citation | db:citation</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>editor | db:editor</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>email | db:email</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>firstterm | db:firstterm</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>glossterm | db:glossterm</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>keycap | db:keycap</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>keycombo | db:keycombo</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>menuchoice | db:menuchoice</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>optional | db:optional</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>othercredit | db:othercredit</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>db:person</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>personname | db:personname</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>productname | db:productname</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>ooclass | db:ooclass</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>ooexception | db:ooexception</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>oointerface | db:oointerface</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>quote | db:quote</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>sgmltag | db:tag</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>shortcut | db:shortcut</code></p></td></tr><tr><td><p><link xref="db2html.inline.content.mode">db2html.inline.content.mode</link></p></td><td><p><code>trademark | db:trademark</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-links.page b/doc/yelp-xsl/C/db2html-links.page new file mode 100644 index 00000000..2c62d93e --- /dev/null +++ b/doc/yelp-xsl/C/db2html-links.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-links" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.4" date="2011-11-08" status="final"/><link type="xslt-defines-template" xref="db2html.links.linktrail"/><link type="xslt-defines-template" xref="db2html.links.next"/><link type="xslt-defines-template" xref="db2html.links.section"/></info><title>DocBook to HTML - Links</title> + + + <p>This stylesheet contains templates to handle implicit automatic links.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="html.linktrails.prefix"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.tooltip"/></p></item><item><p><link xref="db.titleabbrev"/></p></item><item><p><link xref="html.linktrails.empty"/></p></item><item><p><link xref="db.chunk.depth-of-chunk"/></p></item><item><p><link xref="db.chunk.chunk-id.axis"/></p></item><item><p><link xref="db2html.xref"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html-list.page b/doc/yelp-xsl/C/db2html-list.page new file mode 100644 index 00000000..8c8e151c --- /dev/null +++ b/doc/yelp-xsl/C/db2html-list.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-list" type="guide" style="xslt-stylesheet"><?xslt-private l10n.format.mode?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-common"/><link type="xslt-requires" xref="db2html-inline"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="l10n"/><link type="xslt-requires" xref="html"/></info><title>DocBook to HTML - Lists</title> + + + <comment><p>Describe this module</p></comment> + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-common"/></p></item><item><p><link xref="db2html-inline"/></p></item><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="html"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.content"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>glosslist | db:glosslist</code></p></td></tr><tr><td><p/></td><td><p><code>glossdef | db:glossdef</code></p></td></tr><tr><td><p/></td><td><p><code>glossentry | db:glossentry</code></p></td></tr><tr><td><p/></td><td><p><code>glosssee | glossseealso | db:glosssee | db:glossseealso</code></p></td></tr><tr><td><p/></td><td><p><code>itemizedlist | db:itemizedlist</code></p></td></tr><tr><td><p/></td><td><p><code>itemizedlist/listitem | db:itemizedlist/db:listitem</code></p></td></tr><tr><td><p/></td><td><p><code>member | db:member</code></p></td></tr><tr><td><p/></td><td><p><code>orderedlist | db:orderedlist</code></p></td></tr><tr><td><p/></td><td><p><code>orderedlist/listitem | db:orderedlist/db:listitem</code></p></td></tr><tr><td><p/></td><td><p><code>procedure | db:procedure</code></p></td></tr><tr><td><p/></td><td><p><code>answer | db:answer</code></p></td></tr><tr><td><p/></td><td><p><code>qandaentry | db:qandaentry</code></p></td></tr><tr><td><p/></td><td><p><code>question | db:question</code></p></td></tr><tr><td><p/></td><td><p><code>seg | db:seg</code></p></td></tr><tr><td><p/></td><td><p><code>seglistitem | db:seglistitem</code></p></td></tr><tr><td><p/></td><td><p><code>segmentedlist | db:segmentedlist</code></p></td></tr><tr><td><p/></td><td><p><code>segtitle | db:segtitle</code></p></td></tr><tr><td><p/></td><td><p><code>simplelist | db:simplelist</code></p></td></tr><tr><td><p/></td><td><p><code>step | db:step</code></p></td></tr><tr><td><p/></td><td><p><code>substeps | db:substeps</code></p></td></tr><tr><td><p/></td><td><p><code>term | db:term</code></p></td></tr><tr><td><p/></td><td><p><code>variablelist | db:variablelist</code></p></td></tr><tr><td><p/></td><td><p><code>varlistentry | db:varlistentry</code></p></td></tr><tr><td><p/></td><td><p><code>varlistentry/listitem | db:varlistentry/db:listitem</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-math.page b/doc/yelp-xsl/C/db2html-math.page new file mode 100644 index 00000000..4914153f --- /dev/null +++ b/doc/yelp-xsl/C/db2html-math.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-math" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.8" date="2012-11-13" status="final"/><link type="xslt-defines-template" xref="db2html.math.div"/><link type="xslt-defines-template" xref="db2html.math.span"/><link type="xslt-implements-mode" xref="db2html.math.mode"/></info><title>DocBook to HTML - MathML</title><p>Handle MathML in DocBook documents.</p> + + + <p>This stylesheet matches embedded MathML and processes it in <code style="xslt-mode" xref="db2html.math.mode">db2html.math.mode</code>. The matched templates for the <code>mml:math</code> element automatically set the <code>display</code> attribute based on whether the element is in block or inline context.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>equation/mml:math | informalequation/mml:math | db:equation/mml:math | db:informalequation/mml:math</code></p></td></tr><tr><td><p/></td><td><p><code>inlineequation/mml:math | db:inlineequation/mml:math</code></p></td></tr><tr><td><p/></td><td><p><code>db:imagedata[@format='mathml']/mml:math</code></p></td></tr><tr><td><p><link xref="db2html.math.mode">db2html.math.mode</link></p></td><td><p><code>mml:*</code></p></td></tr><tr><td><p><link xref="db2html.math.mode">db2html.math.mode</link></p></td><td><p><code>text()</code></p></td></tr><tr><td><p><link xref="db2html.math.mode">db2html.math.mode</link></p></td><td><p><code>*</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-media.page b/doc/yelp-xsl/C/db2html-media.page new file mode 100644 index 00000000..b0429b84 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-media.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-media" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.8" date="2012-11-13" status="final"/><link type="xslt-defines-template" xref="db2html.audiodata"/><link type="xslt-defines-template" xref="db2html.imagedata"/><link type="xslt-defines-template" xref="db2html.videodata"/><link type="xslt-defines-template" xref="db2html.mediaobject"/><link type="xslt-defines-template" xref="db2html.mediaobject.fallback"/></info><title>DocBook to HTML - Images and Media</title><p>Handle DocBook media elements.</p> + + + <p>This stylesheet contains templates for handling DocBook <code>mediaobject</code> and <code>inlinemediaobject</code> elements, as well as the various <code>object</code> and <code>data</code> elements found in these elements. This stylesheet also handles the deprecated DocBook 4 <code>graphic</code> and <code>inlinegraphic</code> elements.</p> + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>mediaobject/audioobject/audiodata | db:mediaobject/db:audioobject/db:audiodata</code></p></td></tr><tr><td><p/></td><td><p><code>inlinemediaobject/audioobject/audiodata | db:inlinemediaobject/db:audioobject/db:audiodata</code></p></td></tr><tr><td><p/></td><td><p><code>audioobject | db:audioobject</code></p></td></tr><tr><td><p/></td><td><p><code>graphic</code></p></td></tr><tr><td><p/></td><td><p><code>imagedata | db:imagedata</code></p></td></tr><tr><td><p/></td><td><p><code>imageobject | db:imageobject</code></p></td></tr><tr><td><p/></td><td><p><code>inlinegraphic</code></p></td></tr><tr><td><p/></td><td><p><code>inlinemediaobject | db:inlinemediaobject</code></p></td></tr><tr><td><p/></td><td><p><code>mediaobject | db:mediaobject</code></p></td></tr><tr><td><p/></td><td><p><code>mediaobject/videoobject/videodata | db:mediaobject/db:videoobject/db:videodata</code></p></td></tr><tr><td><p/></td><td><p><code>inlinemediaobject/videoobject/videodata | db:inlinemediaobject/db:videoobject/db:videodata</code></p></td></tr><tr><td><p/></td><td><p><code>videoobject | db:videoobject</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-refentry.page b/doc/yelp-xsl/C/db2html-refentry.page new file mode 100644 index 00000000..450ed392 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-refentry.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-refentry" type="guide" style="xslt-stylesheet"><?xslt-private db2html.division.div.content.mode?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-chunk"/><link type="xslt-requires" xref="db-title"/><link type="xslt-requires" xref="db2html-inline"/><link type="xslt-requires" xref="db2html-division"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="l10n"/></info><title>DocBook to HTML - Reference Pages</title> + + + <comment><p>Describe this module. Talk about refenty and friends</p></comment> + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-chunk"/></p></item><item><p><link xref="db-title"/></p></item><item><p><link xref="db2html-division"/></p></item><item><p><link xref="db2html-inline"/></p></item><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.inline"/></p></item><item><p><link xref="db2html.division.div"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>citerefentry | db:citerefentry</code></p></td></tr><tr><td><p/></td><td><p><code>citerefentry/refentrytitle | db:citerefentry/db:refentrytitle</code></p></td></tr><tr><td><p/></td><td><p><code>manvolnum | db:manvolnum</code></p></td></tr><tr><td><p/></td><td><p><code>refentry | db:refentry</code></p></td></tr><tr><td><p/></td><td><p><code>refdescriptor | db:refdescriptor</code></p></td></tr><tr><td><p/></td><td><p><code>refname | db:refname</code></p></td></tr><tr><td><p/></td><td><p><code>refnamediv | db:refnamediv</code></p></td></tr><tr><td><p/></td><td><p><code>refpurpose | db:refpurpose</code></p></td></tr><tr><td><p/></td><td><p><code>refsect1 | db:refsect1</code></p></td></tr><tr><td><p/></td><td><p><code>refsect2 | db:refsect2</code></p></td></tr><tr><td><p/></td><td><p><code>refsect3 | db:refsect3</code></p></td></tr><tr><td><p/></td><td><p><code>refsection | db:refsection</code></p></td></tr><tr><td><p/></td><td><p><code>refsynopsisdiv | db:refsynopsisdiv</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-table.page b/doc/yelp-xsl/C/db2html-table.page new file mode 100644 index 00000000..1a600484 --- /dev/null +++ b/doc/yelp-xsl/C/db2html-table.page @@ -0,0 +1,23 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-table" type="guide" style="xslt-stylesheet"><?xslt-private db2html.spanstr.decrement?><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db2html-block"/><link type="xslt-requires" xref="db2html-inline"/><link type="xslt-requires" xref="db2html-xref"/><link type="xslt-requires" xref="l10n"/><link type="xslt-defines-template" xref="db2html.row"/><link type="xslt-defines-template" xref="db2html.entry"/><link type="xslt-defines-template" xref="db2html.entry.implicit"/><link type="xslt-defines-template" xref="db2html.entry.colnum"/><link type="xslt-defines-template" xref="db2html.colspec.colnum"/><link type="xslt-defines-template" xref="db2html.entry.colspan"/><link type="xslt-defines-template" xref="db2html.spanstr"/><link type="xslt-defines-template" xref="db2html.spanstr.pop"/><link type="xslt-defines-template" xref="db2html.table.table"/></info><title>DocBook to HTML - Tables</title> + + + <comment><p>This needs lots of talk about CALS</p></comment> + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db2html-block"/></p></item><item><p><link xref="db2html-inline"/></p></item><item><p><link xref="db2html-xref"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="utils.repeat_string"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>entrytbl | db:entrytbl</code></p></td></tr><tr><td><p/></td><td><p><code>table | informaltable | db:table | db:informaltable</code></p></td></tr><tr><td><p/></td><td><p><code>tgroup | db:tgroup</code></p></td></tr><tr><td><p/></td><td><p><code>tbody | tfoot | thead | db:tbody | db:tfoot | db:thead</code></p></td></tr><tr><td><p/></td><td><p><code>tr | db:tr</code></p></td></tr><tr><td><p/></td><td><p><code>td | th | db:td | db:th</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html-xref.page b/doc/yelp-xsl/C/db2html-xref.page new file mode 100644 index 00000000..256a9b8e --- /dev/null +++ b/doc/yelp-xsl/C/db2html-xref.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html-xref" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-requires" xref="db-xref"/><link type="xslt-defines-template" xref="db2html.anchor"/><link type="xslt-defines-template" xref="db2html.link"/><link type="xslt-defines-template" xref="db2html.ulink"/><link type="xslt-defines-template" xref="db2html.xlink"/><link type="xslt-defines-template" xref="db2html.xref"/></info><title>DocBook to HTML - Links and Cross References</title> + + + <comment><p>Describe this module</p></comment> + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="db-xref"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.tooltip"/></p></item><item><p><link xref="db.ulink.tooltip"/></p></item><item><p><link xref="db.xref.content"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>anchor | db:anchor</code></p></td></tr><tr><td><p/></td><td><p><code>link</code></p></td></tr><tr><td><p/></td><td><p><code>ulink</code></p></td></tr><tr><td><p/></td><td><p><code>db:link</code></p></td></tr><tr><td><p/></td><td><p><code>xref | db:xref</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/db2html.anchor.page b/doc/yelp-xsl/C/db2html.anchor.page new file mode 100644 index 00000000..3d136b65 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.anchor.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.anchor" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-xref" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates an anchor point for an element</desc></info><title>db2html.anchor</title><p>Generates an anchor point for an element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to generate an anchor for</p> + </item> + <item> + <title><code>name</code></title> + <p>The text to use for the <code>name</code> attribute</p> + </item> + </terms></synopsis> + <comment><p>Describe this template</p></comment> +</page> diff --git a/doc/yelp-xsl/C/db2html.audiodata.page b/doc/yelp-xsl/C/db2html.audiodata.page new file mode 100644 index 00000000..e0d31ad2 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.audiodata.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.audiodata" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-media" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.8" date="2012-11-12" status="final"/><desc>Output an HTML <code>audio</code> element for a <code>audiodata</code> element.</desc></info><title>db2html.audiodata</title><p>Output an HTML <code>audio</code> element for a <code>audiodata</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>audiodata</code> element.</p> + </item> + </terms></synopsis> + <p>This template creates an <code>audio</code> element in the HTML output. This template calls <code style="xslt-template" xref="db2html.mediaobject.fallback">db2html.mediaobject.fallback</code> for the contents of the <code>audio</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.mediaobject.fallback"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.biblioentry.data.page b/doc/yelp-xsl/C/db2html.biblioentry.data.page new file mode 100644 index 00000000..a14098e9 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.biblioentry.data.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.biblioentry.data" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-bibliography" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-14" status="final"/><desc>Output structured data for a bibliography entry.</desc></info><title>db2html.biblioentry.data</title><p>Output structured data for a bibliography entry.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>biblioentry</code> or <code>biblioset</code> element to output data for.</p> + </item> + </terms></synopsis> + <p>This template outputs a bibliography entry, or part of a bibliography entry, based on structured data found in a <code>biblioentry</code> or <code>biblioset</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.personname.list"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.biblioentry.data"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="db2html.biblioentry.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.biblioentry.label.page b/doc/yelp-xsl/C/db2html.biblioentry.label.page new file mode 100644 index 00000000..f2fefcde --- /dev/null +++ b/doc/yelp-xsl/C/db2html.biblioentry.label.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.biblioentry.label" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-bibliography" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-14" status="final"/><desc>Output the label for a bibliography entry.</desc></info><title>db2html.biblioentry.label</title><p>Output the label for a bibliography entry.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>biblioentry</code> or <code>bibliomixed</code> element to generate a label for.</p> + </item> + </terms></synopsis> + <p>This template outputs a label to be placed inline at the beginning of a bibliography entry. Labels are created for both <code>biblioentry</code> and <code>bibliomixed</code> elements. The label is typically an abbreviation of the authors' names and the year of publication. In DocBook, it is usually provided with a leading <code>abbrev</code> element. Without a leading <code>abbrev</code> element, this template will instead use the <code>xreflabel</code> or <code>id</code> attribute.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.biblioentry.mode.page b/doc/yelp-xsl/C/db2html.biblioentry.mode.page new file mode 100644 index 00000000..fc12cfb4 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.biblioentry.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.biblioentry.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-bibliography" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="3.4" date="2011-11-14" status="final"/><desc>Format elements inside a <code>biblioentry</code> or <code>bibliomixed</code> element.</desc></info><title>db2html.biblioentry.mode</title><p>Format elements inside a <code>biblioentry</code> or <code>bibliomixed</code> element.</p> + + + <p>This mode is used when processing the child elements of a <code>biblioentry</code> or a <code>bibliomixed</code> element. Some elements are treated differently when they appear inside a bibliography entry.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.block.formal.page b/doc/yelp-xsl/C/db2html.block.formal.page new file mode 100644 index 00000000..3cd91692 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.block.formal.page @@ -0,0 +1,29 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.block.formal" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-09" status="final"/><desc>Output HTML for a block-level element with an optional title and caption.</desc></info><title>db2html.block.formal</title><p>Output HTML for a block-level element with an optional title and caption.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The block-level element to render.</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the HTML <code>class</code> attribute.</p> + </item> + <item> + <title><code>title</code></title> + <p>An element to use for the title.</p> + </item> + <item> + <title><code>caption</code></title> + <p>An element to use for the caption.</p> + </item> + <item> + <title><code>titleattr</code></title> + <p>An optional value for the HTML <code>title</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template outputs HTML for a formal DocBook element, one that can have a title or caption. It passes the <code style="xslt-param">class</code> parameter to <code style="xslt-template" xref="html.class.attr">html.class.attr</code>. If the <code style="xslt-param">class</code> parameter is not provided, it uses the local name of <code style="xslt-param">node</code>. Even if <code style="xslt-param">title</code> and <code style="xslt-param">caption</code> are both empty, this template still outputs the extra wrapper elements for formal elements. If <code style="xslt-param">titleattr</code> is provided, it is used for the value of the HTML <code>title</code> attribute on the outermost <code>div</code> element.</p> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.block.title"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.block.page b/doc/yelp-xsl/C/db2html.block.page new file mode 100644 index 00000000..f52dc4fd --- /dev/null +++ b/doc/yelp-xsl/C/db2html.block.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.block" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-09" status="final"/><desc>Output an HTML <code>div</code> element for a block-level element.</desc></info><title>db2html.block</title><p>Output an HTML <code>div</code> element for a block-level element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The block-level element to render.</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the HTML <code>class</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>div</code> element for the given DocBook element. It passes the <code style="xslt-param">class</code> parameter to <code style="xslt-template" xref="html.class.attr">html.class.attr</code>. If the <code style="xslt-param">class</code> parameter is not provided, it uses the local name of <code style="xslt-param">node</code>.</p> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.block.title.page b/doc/yelp-xsl/C/db2html.block.title.page new file mode 100644 index 00000000..2592e831 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.block.title.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.block.title" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-12" status="final"/><desc>Output a formal title for a block-level element.</desc></info><title>db2html.block.title</title><p>Output a formal title for a block-level element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The block-level element being processed.</p> + </item> + <item> + <title><code>title</code></title> + <p>The element containing the title.</p> + </item> + </terms></synopsis> + <p>This template formats the contents of <code style="xslt-param">title</code> as a title for a block-level element. It is called by <code style="xslt-template" xref="db2html.block.formal">db2html.block.formal</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-in-chunk"/></p></item><item><p><link xref="html.class.attr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.blockquote.page b/doc/yelp-xsl/C/db2html.blockquote.page new file mode 100644 index 00000000..33633514 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.blockquote.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.blockquote" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-09" status="final"/><desc>Output an HTML <code>blockquote</code> element.</desc></info><title>db2html.blockquote</title><p>Output an HTML <code>blockquote</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The DocBook element ot render as a quote.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>blockquote</code> element for the given DocBook element. It's used for the DocBook <code>blockquote</code> and <code>epigraph</code> elements.</p> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.callout.label.page b/doc/yelp-xsl/C/db2html.callout.label.page new file mode 100644 index 00000000..07d7fad1 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.callout.label.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.callout.label" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-callout" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><desc>Create a callout label for a <code>co</code> element.</desc></info><title>db2html.callout.label</title><p>Create a callout label for a <code>co</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>co</code> element to create a callout label for.</p> + </item> + </terms></synopsis> + <p>This template creates a label for a callout, taking a <code>co</code> element as the <code style="xslt-param">node</code> parameter. The label is numbered according to the position of the <code>co</code> element in the document. To create the corresponding label for a <code>callout</code> element, locate the corresponding <code>co</code> element and call this template on it.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.class.cpp.mode.page b/doc/yelp-xsl/C/db2html.class.cpp.mode.page new file mode 100644 index 00000000..2c0f23af --- /dev/null +++ b/doc/yelp-xsl/C/db2html.class.cpp.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.class.cpp.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-classsynopsis" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><desc>Process a C++ synopsis.</desc></info><title>db2html.class.cpp.mode</title><p>Process a C++ synopsis.</p> + + + <p>This mode is applied to child elements for synopsis elements for the C++ programming language. In C++ synopses, the first <code>modifier</code> element for methods is expected to mark the visibility, such as <code>public</code> or <code>private</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.class.python.mode.page b/doc/yelp-xsl/C/db2html.class.python.mode.page new file mode 100644 index 00000000..c88c6b52 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.class.python.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.class.python.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-classsynopsis" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><desc>Process a Python synopsis.</desc></info><title>db2html.class.python.mode</title><p>Process a Python synopsis.</p> + + + <p>This mode is applied to child elements for synopsis elements for the Python programming language.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.classsynopsis.language.page b/doc/yelp-xsl/C/db2html.classsynopsis.language.page new file mode 100644 index 00000000..c20c2597 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.classsynopsis.language.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.classsynopsis.language" type="topic" style="xslt-param"><info><link type="guide" xref="db2html-classsynopsis" group="parameters"/><link type="guide" xref="parameters" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><desc>The default programming language used to format <code>classsynopsis</code> elements.</desc></info><title>db2html.classsynopsis.language</title><p>The default programming language used to format <code>classsynopsis</code> elements.</p> + + + <p>This parameter sets the default value for the <code>language</code> attribute of elements like <code>classsynopsis</code>. Templates in this module will always use the <code>language</code> attribute if present. Otherwise, they fall back to this value. This parameter can be set with the <code>db2html.classsynopsis.language</code> processing instruction at the root of a DocBook document.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.cmdsynopsis.sbr.padding.mode.page b/doc/yelp-xsl/C/db2html.cmdsynopsis.sbr.padding.mode.page new file mode 100644 index 00000000..0f3ad5ed --- /dev/null +++ b/doc/yelp-xsl/C/db2html.cmdsynopsis.sbr.padding.mode.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.cmdsynopsis.sbr.padding.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-cmdsynopsis" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="1.0" date="2011-05-16" status="final"/><desc>Output padding for elements leading up to an <code>sbr</code> element.</desc></info><title>db2html.cmdsynopsis.sbr.padding.mode</title><p>Output padding for elements leading up to an <code>sbr</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>sbr</code></title> + <p>The <code>sbr</code> element to pad up to</p> + </item> + <item> + <title><code>sepchar</code></title> + <p>The value of the <code>sepchar</code> attribute on the enclosing <code>cmdsynopsis</code></p> + </item> + </terms></synopsis> + <p>When processed in this mode, elements output whitespace to the length of the textual output they would normally produce. This allows options to be aligned when explicit line breaks are inserted with <code>sbr</code> elements.</p> + <p>To create the padding for a given <code>sbr</code> element, this mode is called on the enclosing <code>cmdsynopsis</code> element, passing the <code>sbr</code> element. When processed in this mode, elements should only output padding for content the leads up to the <code>sbr</code> element passed in the <code style="xslt-param">sbr</code> parameter. When processing children that don't contain the given <code>sbr</code> element, the <code style="xslt-param">sbr</code> parameter should be set to <code>false()</code> for those children. This avoids additional descendant selectors, which are generally expensive to perform.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.colspec.colnum.page b/doc/yelp-xsl/C/db2html.colspec.colnum.page new file mode 100644 index 00000000..2b2cd1e9 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.colspec.colnum.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.colspec.colnum" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Calculates the column number for a <code>colspec</code> element</desc></info><title>db2html.colspec.colnum</title><p>Calculates the column number for a <code>colspec</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>colspec</code></title> + <p>The <code>colspec</code> element to process</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + </terms></synopsis> + <p>FIXME</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.colspec.colnum"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.division.about.page b/doc/yelp-xsl/C/db2html.division.about.page new file mode 100644 index 00000000..b62a9b85 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.division.about.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.division.about" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-division" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output the copyrights, credits, and license information at the bottom of a page.</desc></info><title>db2html.division.about</title><p>Output the copyrights, credits, and license information at the bottom of a page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A division-level element a page is being created for.</p> + </item> + <item> + <title><code>info</code></title> + <p>The info child element of <code style="xslt-param">node</code></p> + </item> + </terms></synopsis> + <p>This template outputs copyright information, credits, and license information for the division. By default it is called by the <code style="xslt-mode" xref="html.footer.mode">html.footer.mode</code> implementation.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db.copyright"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.division.div.content.mode.page b/doc/yelp-xsl/C/db2html.division.div.content.mode.page new file mode 100644 index 00000000..28fb6e6f --- /dev/null +++ b/doc/yelp-xsl/C/db2html.division.div.content.mode.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.division.div.content.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-division" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Renders the block-level content of a division element</desc></info><title>db2html.division.div.content.mode</title><p>Renders the block-level content of a division element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>depth_in_chunk</code></title> + <p>The depth of the context element in the containing chunk</p> + </item> + <item> + <title><code>depth_of_chunk</code></title> + <p>The depth of the containing chunk in the document</p> + </item> + </terms></synopsis> + <comment><p>Talk about how this works with <code>callback</code></p></comment> +</page> diff --git a/doc/yelp-xsl/C/db2html.division.div.page b/doc/yelp-xsl/C/db2html.division.div.page new file mode 100644 index 00000000..68a36443 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.division.div.page @@ -0,0 +1,36 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.division.div" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-division" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Renders the content of a division element, chunking children if necessary</desc></info><title>db2html.division.div</title><p>Renders the content of a division element, chunking children if necessary</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to render the content of</p> + </item> + <item> + <title><code>info</code></title> + <p>The info child element of <code style="xslt-param">node</code></p> + </item> + <item> + <title><code>entries</code></title> + <p>The entry-style child elements</p> + </item> + <item> + <title><code>divisions</code></title> + <p>The division-level child elements</p> + </item> + <item> + <title><code>depth_in_chunk</code></title> + <p>The depth of <code style="xslt-param">node</code> in the containing chunk</p> + </item> + <item> + <title><code>depth_of_chunk</code></title> + <p>The depth of the containing chunk in the document</p> + </item> + <item> + <title><code>chunk_divisions</code></title> + <p>Whether to create new documents for <code style="xslt-param">divisions</code></p> + </item> + </terms></synopsis> + <comment><p>Talk about some of the parameters</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-in-chunk"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="db.chunk.max_depth"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.entry.colnum.page b/doc/yelp-xsl/C/db2html.entry.colnum.page new file mode 100644 index 00000000..3b961bb1 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.entry.colnum.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.entry.colnum" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Calculates the actual column number for an <code>entry</code> element</desc></info><title>db2html.entry.colnum</title><p>Calculates the actual column number for an <code>entry</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>entry</code></title> + <p>The <code>entry</code> element to process</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>colpos</code></title> + <p>The column position, as passed by the preceding <code>entry</code></p> + </item> + </terms></synopsis> + <p>FIXME</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.colspec.colnum"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.entry.colspan.page b/doc/yelp-xsl/C/db2html.entry.colspan.page new file mode 100644 index 00000000..a44cf71d --- /dev/null +++ b/doc/yelp-xsl/C/db2html.entry.colspan.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.entry.colspan" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Calculates the <code>colspan</code> for an <code>entry</code> element</desc></info><title>db2html.entry.colspan</title><p>Calculates the <code>colspan</code> for an <code>entry</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>entry</code></title> + <p>The <code>entry</code> element to process</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + </terms></synopsis> + <p>This template calculates how many columns an <code>entry</code> element should span. In CALS tables, column spanning is done by specifying starting and ending <code>colspec</code> elements, or by specifying a <code>spanspec</code> element which specifies starting and ending <code>colspec</code> elements.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.colspec.colnum"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.entry.implicit.page b/doc/yelp-xsl/C/db2html.entry.implicit.page new file mode 100644 index 00000000..871c2aeb --- /dev/null +++ b/doc/yelp-xsl/C/db2html.entry.implicit.page @@ -0,0 +1,46 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.entry.implicit" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Creates an implicit <code>td</code> element to fill up unoccupied columns</desc></info><title>db2html.entry.implicit</title><p>Creates an implicit <code>td</code> element to fill up unoccupied columns</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>entry</code></title> + <p>The <code>entry</code> element currently being processed</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>colsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>rowsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>colpos</code></title> + <p>The output column position currently being considered</p> + </item> + <item> + <title><code>colnum</code></title> + <p>The actual column number of <code style="xslt-param">entry</code></p> + </item> + <item> + <title><code>colspan</code></title> + <p>How many columns the implicit <code>td</code> currently spans</p> + </item> + <item> + <title><code>spanstr</code></title> + <p>The string representation of the row spans</p> + </item> + </terms></synopsis> + <p>CALS tables in DocBook don't need to have <code>entry</code> elements for each column in each row, even when the column is not covered by a row-spanning entry from a previous row. An <code>entry</code> can explicitly specify which column it's in, and any previous unfilled columns are considered blank. Since HTML tables don't have this mechanism, we have to insert blank <code>td</code> elements to fill the gaps.</p> + <p>When <code style="xslt-template" xref="db2html.entry">db2html.entry</code> detects a blank entry, it will call this template with the approprite parameters. This template then calls itself recursively, each time adjusting the <code style="xslt-param">colpos</code>, <code style="xslt-param">colspan</code>, and <code style="xslt-param">spanstr</code> parameters, until it comes across the last column that needs to be filled. It then outputs a <code>td</code> element with an appropriate <code>colspan</code> attribute.</p> + <p>Finally, this template calls <code style="xslt-template" xref="db2html.entry">db2html.entry</code> again on <code style="xslt-param">entry</code>. With the values of <code style="xslt-param">colpos</code> and <code style="xslt-param">spanstr</code> suitably adjusted, that template is then able to output the <code>td</code> for the <code>entry</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.entry.colnum"/></p></item><item><p><link xref="db2html.entry"/></p></item><item><p><link xref="db2html.entry.implicit"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.entry.page b/doc/yelp-xsl/C/db2html.entry.page new file mode 100644 index 00000000..87c4aa50 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.entry.page @@ -0,0 +1,45 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.entry" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Creates a <code>td</code> element for an <code>entry</code> element</desc></info><title>db2html.entry</title><p>Creates a <code>td</code> element for an <code>entry</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>entry</code></title> + <p>The <code>entry</code> element to process</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>colsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>rowsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>colpos</code></title> + <p>The output column position currently being considered</p> + </item> + <item> + <title><code>colnum</code></title> + <p>The actual column number of <code style="xslt-param">entry</code></p> + </item> + <item> + <title><code>spanstr</code></title> + <p>The string representation of the row spans</p> + </item> + </terms></synopsis> + <p>This template processes a single <code>entry</code> element and generates <code>td</code> elements as needed. It then calls itself on the following <code>entry</code> element, adjusting parameters as necessary. Under certain conditions, this template may not be able to output a <code>td</code> element immediately. In these cases, it makes whatever adjustments are needed and calls itself or <code style="xslt-template" xref="db2html.entry.implicit">db2html.entry.implicit</code> (which, in turn, calls this template again when it's finished).</p> + <p>Three parameters are used to determine whether a <code>td</code> element can be output. The <code style="xslt-param">spanstr</code> parameter provides infomation about row spans in effect from entries in previous rows; the <code style="xslt-param">colpos</code> parameter specifies which column we would output to if we created a <code>td</code>; and the <code style="xslt-param">colnum</code> parameter specifies which column this <code>entry</code> should be in, according to any relevant <code>colspec</code> or <code>spanspec</code> elemets.</p> + <p>There are two conditions that cause this template not to output a <code>td</code> element immediately: if the <code style="xslt-param">spanstr</code> parameter does not start with <code>0:</code>, and if the <code style="xslt-param">colpos</code> parameter is less than the <code style="xslt-param">colnum</code> parameter.</p> + <p>The <code style="xslt-param">spanstr</code> parameter specifies the row spans in effect from entries in previous rows. As this template iterates over the <code>entry</code> elements, it strips off parts of <code style="xslt-param">spanstr</code> so that only the parts relevant to the <code>entry</code> are present. If <code style="xslt-param">spanstr</code> does not start with <code>0:</code>, then an entry in a previous row occupies this column position. In this case, that value is removed from <code style="xslt-param">spanstr</code>, the <code style="xslt-param">colpos</code> parameter is incremented, and <code style="xslt-template" xref="db2html.entry">db2html.entry</code> is called again. Additionally, since <code style="xslt-template" xref="db2html.entry.colnum">db2html.entry.colnum</code> doesn't consider row spans, the <code style="xslt-param">colnum</code> parameter may be incremented as well.</p> + <p>If the <code style="xslt-param">colpos</code> parameter is less than the <code style="xslt-param">colnum</code> parameter, then the document has skipped entries by explicitly referencing a column. This is allowed in CALS tables, but not in HTML. To fill the blank spaces, we call <code style="xslt-template" xref="db2html.entry.implicit">db2html.entry.implicit</code>, which outputs an empty <code>td</code> element spanning as many columns as necessary to fill in the blanks. The <code style="xslt-template" xref="db2html.entry.implicit">db2html.entry.implicit</code> template then calls this template again with appropriate parameter values.</p> + <p>When this template is finally able to output a <code>td</code> element, it calculates appropriate values for the <code>style</code> and <code>class</code> attribute based on DocBook attributes on the <code>entry</code>, the relevant <code>colspec</code> or <code>spanspec</code>, and any relevant ancestor elements. It then calls itself on the following <code>entry</code> element to output the next <code>td</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.entry.colnum"/></p></item><item><p><link xref="db2html.entry.colspan"/></p></item><item><p><link xref="db2html.entry"/></p></item><item><p><link xref="db2html.entry.implicit"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.spanstr.pop"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.footnote.footer.page b/doc/yelp-xsl/C/db2html.footnote.footer.page new file mode 100644 index 00000000..7b7057ef --- /dev/null +++ b/doc/yelp-xsl/C/db2html.footnote.footer.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.footnote.footer" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-footnote" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output all footnotes for a page.</desc></info><title>db2html.footnote.footer</title><p>Output all footnotes for a page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The division-level element containing footnotes</p> + </item> + <item> + <title><code>depth_of_chunk</code></title> + <p>The depth of the containing chunk in the document.</p> + </item> + </terms></synopsis> + <p>This template collects all <code>footnote</code> elements under <code style="xslt-param">node</code> and outputs them with <code style="xslt-template" xref="db2html.footnote.note">db2html.footnote.note</code>. It checks if each footnote would be displayed on a separate page by a child division-level element, and if so, it doesn't output that footnote.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-of-chunk"/></p></item><item><p><link xref="db2html.footnote.note"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.footnote.link.page b/doc/yelp-xsl/C/db2html.footnote.link.page new file mode 100644 index 00000000..b8585da0 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.footnote.link.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.footnote.link" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-footnote" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output a link to a footnote.</desc></info><title>db2html.footnote.link</title><p>Output a link to a footnote.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>footnote</code> element to process.</p> + </item> + </terms></synopsis> + <p>This templates outputs an inline link to the footnote displayed at the bottom of the page.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.footnote.note.page b/doc/yelp-xsl/C/db2html.footnote.note.page new file mode 100644 index 00000000..5958ecf1 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.footnote.note.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.footnote.note" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-footnote" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-10" status="final"/><desc>Output a footnote.</desc></info><title>db2html.footnote.note</title><p>Output a footnote.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>footnote</code> element to process.</p> + </item> + </terms></synopsis> + <p>This templates outputs the actual text of a footnote as a block-level element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.funcsynopsis.style.page b/doc/yelp-xsl/C/db2html.funcsynopsis.style.page new file mode 100644 index 00000000..c4d82027 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.funcsynopsis.style.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.funcsynopsis.style" type="topic" style="xslt-param"><info><link type="guide" xref="db2html-funcsynopsis" group="parameters"/><link type="guide" xref="parameters" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>How to render <code>funcsynopsis</code> elements</desc></info><title>db2html.funcsynopsis.style</title><p>How to render <code>funcsynopsis</code> elements</p> + + + <p>This parameter controls the indentation style used to render <code>funcsynopsis</code> elements. Supported values are <code>'KR'</code> and <code>'ANSI'</code>. This value can also be set with the <code>db2html.funcsynopsis.style</code> processing instruction at the top of the XML document. The same processing instruction or inside a <code>funcsynopsis</code> element will override this setting for that synopsis.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.hgroup.page b/doc/yelp-xsl/C/db2html.hgroup.page new file mode 100644 index 00000000..6b946679 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.hgroup.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.hgroup" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-division" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Output the title and subtitle for an element.</desc></info><title>db2html.hgroup</title><p>Output the title and subtitle for an element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element containing the title.</p> + </item> + <item> + <title><code>info</code></title> + <p>FIXME.</p> + </item> + <item> + <title><code>depth_in_chunk</code></title> + <p>The depth of <code style="xslt-param">node</code> in the containing chunk.</p> + </item> + </terms></synopsis> + <comment><p>Talk about the different kinds of title blocks</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-in-chunk"/></p></item><item><p><link xref="db2html.anchor"/></p></item><item><p><link xref="db.title"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.imagedata.page b/doc/yelp-xsl/C/db2html.imagedata.page new file mode 100644 index 00000000..cce69bf6 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.imagedata.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.imagedata" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-media" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-11" status="final"/><desc>Output an HTML <code>img</code> element for a <code>imagedata</code> element.</desc></info><title>db2html.imagedata</title><p>Output an HTML <code>img</code> element for a <code>imagedata</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>imagedata</code> or other graphic element.</p> + </item> + </terms></synopsis> + <p>This template creates an <code>img</code> element in the HTML output. This template is called not only for <code>imagedata</code> elements, but also for <code>graphic</code> and <code>inlinegraphic</code> elements. Note that <code>graphic</code> and <code>inlinegraphic</code> are deprecated and should not be used in any newly-written DocBook files. Use <code>mediaobject</code> instead.</p> + <p>This template looks for a <code>textobject</code> with a <code>phrase</code> child in an ancestor <code>mediaobject</code> or <code>inlinemediaobject</code> element. It uses the first available, taking conditional processing into consideration.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.inline.children.page b/doc/yelp-xsl/C/db2html.inline.children.page new file mode 100644 index 00000000..4373a886 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.inline.children.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.inline.children" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-inline" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Renders the children of an inline element.</desc></info><title>db2html.inline.children</title><p>Renders the children of an inline element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to render</p> + </item> + <item> + <title><code>children</code></title> + <p>The child elements to process</p> + </item> + </terms></synopsis> + <comment><p>Document this template</p></comment> +<list style="compact"><title>Calls Modes</title><item><p><link xref="db2html.inline.content.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.inline.content.mode.page b/doc/yelp-xsl/C/db2html.inline.content.mode.page new file mode 100644 index 00000000..3b196d1a --- /dev/null +++ b/doc/yelp-xsl/C/db2html.inline.content.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.inline.content.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-inline" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>FIXME</desc></info><title>db2html.inline.content.mode</title><p>FIXME</p> + + + <p>FIXME</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.inline.page b/doc/yelp-xsl/C/db2html.inline.page new file mode 100644 index 00000000..b1230cf5 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.inline.page @@ -0,0 +1,29 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.inline" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-inline" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Renders an inline element as an HTML <code>span</code> element</desc></info><title>db2html.inline</title><p>Renders an inline element as an HTML <code>span</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to render</p> + </item> + <item> + <title><code>children</code></title> + <p>The child elements to process</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the <code>class</code> attribute on the <code>span</code> tag</p> + </item> + <item> + <title><code>lang</code></title> + <p>The locale of the text in <code style="xslt-param">node</code></p> + </item> + <item> + <title><code>name-class</code></title> + <p>The class to use for the name of the element</p> + </item> + </terms></synopsis> + <comment><p>Document this template</p></comment> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.xlink"/></p></item><item><p><link xref="db2html.inline.children"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.link.page b/doc/yelp-xsl/C/db2html.link.page new file mode 100644 index 00000000..98337872 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.link.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.link" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-xref" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates a hyperlink from a <code>link</code> element</desc></info><title>db2html.link</title><p>Generates a hyperlink from a <code>link</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>linkend</code></title> + <p>The id of the element being linked to</p> + </item> + <item> + <title><code>target</code></title> + <p>The element being linked to</p> + </item> + </terms></synopsis> + <comment><p>Describe this template</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.tooltip"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.links.linktrail.page b/doc/yelp-xsl/C/db2html.links.linktrail.page new file mode 100644 index 00000000..59d32c7a --- /dev/null +++ b/doc/yelp-xsl/C/db2html.links.linktrail.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.links.linktrail" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-links" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.20" date="2015-09-15" status="final"/><desc>Generate links to pages from ancestor elements.</desc></info><title>db2html.links.linktrail</title><p>Generate links to pages from ancestor elements.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to generate links for.</p> + </item> + </terms></synopsis> + <p>This template outputs a trail of links for the ancestor pages of <code style="xslt-param">node</code>. If <code style="xslt-param">node</code> has no ancestors, then it calls <code style="xslt-template" xref="html.linktrails.empty">html.linktrails.empty</code> instead. This template calls <code style="xslt-template" xref="html.linktrails.prefix">html.linktrails.prefix</code> before the first link, passing <code style="xslt-param">node</code> as that template's <code>node</code> parameter.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="html.linktrails.prefix"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.tooltip"/></p></item><item><p><link xref="db.titleabbrev"/></p></item><item><p><link xref="html.linktrails.empty"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.links.next.page b/doc/yelp-xsl/C/db2html.links.next.page new file mode 100644 index 00000000..82196baa --- /dev/null +++ b/doc/yelp-xsl/C/db2html.links.next.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.links.next" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-links" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-08" status="final"/><desc>Output links to the previous and next pages.</desc></info><title>db2html.links.next</title><p>Output links to the previous and next pages.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to generate links for.</p> + </item> + <item> + <title><code>depth_of_chunk</code></title> + <p>The depth of the containing chunk in the document.</p> + </item> + </terms></synopsis> + <p>This template outputs links to the previous and next pages, if they exist. It calls <code style="xslt-template" xref="db.chunk.chunk-id.axis">db.chunk.chunk-id.axis</code> to find the previous and next pages. The block containing the links is end-floated by default. The links use the text "Previous" and "Next", although the actual page titles are used for tooltips.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.chunk.depth-of-chunk"/></p></item><item><p><link xref="db.chunk.chunk-id.axis"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.tooltip"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.links.section.page b/doc/yelp-xsl/C/db2html.links.section.page new file mode 100644 index 00000000..1bc33a1e --- /dev/null +++ b/doc/yelp-xsl/C/db2html.links.section.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.links.section" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-links" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.4" date="2011-11-08" status="final"/><desc>Output links to subsections.</desc></info><title>db2html.links.section</title><p>Output links to subsections.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to generate links for.</p> + </item> + <item> + <title><code>divisions</code></title> + <p>The division-level child elements of <code style="xslt-param">node</code> to link to.</p> + </item> + </terms></synopsis> + <p>This template outputs links to the child division-level elements of <code style="xslt-param">node</code>, whether or not they are chunked.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.xref"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.math.div.page b/doc/yelp-xsl/C/db2html.math.div.page new file mode 100644 index 00000000..98f0aa1a --- /dev/null +++ b/doc/yelp-xsl/C/db2html.math.div.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.math.div" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-math" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.8" date="2012-11-13" status="final"/><desc>Output an HTML <code>div</code> element and block-level MathML.</desc></info><title>db2html.math.div</title><p>Output an HTML <code>div</code> element and block-level MathML.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>mml:math</code> element to render.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>div</code> element for a MathML <code>mml:math</code> element, then outputs MathML content. It sets the <code>display</code> attribute on the output to <code>"block"</code> and applies <code style="xslt-mode" xref="db2html.math.mode">db2html.math.mode</code> to the child content.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="db2html.math.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.math.mode.page b/doc/yelp-xsl/C/db2html.math.mode.page new file mode 100644 index 00000000..58d1384c --- /dev/null +++ b/doc/yelp-xsl/C/db2html.math.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.math.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="db2html-math" group="modes"/><link type="guide" xref="modes" group="db2html"/><revision version="3.8" date="2012-11-13" status="final"/><desc>Output MathML and handle Mallard extension.</desc></info><title>db2html.math.mode</title><p>Output MathML and handle Mallard extension.</p> + + + <p>This mode is used for processing MathML embedded into DocBook documents. For most types of MathML content, it simply copies the input directly, except it outputs the MathML in a way that allows the namespace to stripped for non-XML output. It converts <code>xlink:href</code> attributes from MathML 2 to <code>href</code> attributes for MathML 3.</p> +</page> diff --git a/doc/yelp-xsl/C/db2html.math.span.page b/doc/yelp-xsl/C/db2html.math.span.page new file mode 100644 index 00000000..f4514947 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.math.span.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.math.span" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-math" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.8" date="2012-11-13" status="final"/><desc>Output an HTML <code>span</code> element and inline MathML.</desc></info><title>db2html.math.span</title><p>Output an HTML <code>span</code> element and inline MathML.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>mml:math</code> element to render.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>span</code> element for a MathML <code>mml:math</code> element, then outputs MathML content. It sets the <code>display</code> attribute on the output to <code>"inline"</code> and applies <code style="xslt-mode" xref="db2html.math.mode">db2html.math.mode</code> to the child content.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.lang.attrs"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="db2html.math.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.mediaobject.fallback.page b/doc/yelp-xsl/C/db2html.mediaobject.fallback.page new file mode 100644 index 00000000..6a435c33 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.mediaobject.fallback.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.mediaobject.fallback" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-media" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-11" status="final"/><desc>Outputs fallback HTML for a <code>mediaobject</code> element.</desc></info><title>db2html.mediaobject.fallback</title><p>Outputs fallback HTML for a <code>mediaobject</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>mediaobject</code> element.</p> + </item> + </terms></synopsis> + <p>This template outputs HTML for the first suitable <code>textobject</code> child element of <code style="xslt-param">node</code>. If <code style="xslt-param">node</code> is an <code>inlinemediaobject</code>, it looks for a <code>textobject</code> that contains a <code>phrase</code> element. Otherwise, it looks for a <code>textobject</code> with normal block content. It also handles conditional processing on the <code>textobject</code> elements.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.mediaobject.page b/doc/yelp-xsl/C/db2html.mediaobject.page new file mode 100644 index 00000000..841d4ca4 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.mediaobject.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.mediaobject" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-media" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-11" status="final"/><desc>Outputs HTML for a <code>mediaobject</code> element.</desc></info><title>db2html.mediaobject</title><p>Outputs HTML for a <code>mediaobject</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>mediaobject</code> element.</p> + </item> + </terms></synopsis> + <p>This template processes a <code>mediaobject</code> element and outputs the appropriate HTML. DocBook allows multiple objects to be listed in a <code>mediaobject</code> element. Processing tools are expected to choose the earliest suitable object. This template will select the first audio, image, or video object it can handle, filtering out images in non-web formats, and taking conditional processing into consideration. If no suitable non-text objects are found, this template calls <code style="xslt-template" xref="db2html.mediaobject.fallback">db2html.mediaobject.fallback</code>.</p> + <p>This template also detects MathML embedded in a DocBook 5 <code>imagedata</code> element with the <code>format</code> attribute <code>"mathml"</code>, and passes it to the templates in <file xref="db2html-math">db2html-math</file>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="db2html.mediaobject.fallback"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.page b/doc/yelp-xsl/C/db2html.page new file mode 100644 index 00000000..871a4fc7 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2html" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="db2html"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-param" xref="html.xhtml"/><link type="xslt-defines-param" xref="db.profile.outputformat"/></info><title>DocBook to HTML</title><p>Transform DocBook to HTML.</p> + + + <p>This top-level stylesheet includes all the necessary stylesheets to transform DocBook documents into HTML. It imports <file xref="db2xhtml">db2xhtml</file>, overrides parameters, and sets a namespace alias to output non-XML HTML. This stylesheet sets <code style="xslt-param" xref="html.xhtml">html.xhtml</code> to <code>false</code>.</p> +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links></page> diff --git a/doc/yelp-xsl/C/db2html.para.page b/doc/yelp-xsl/C/db2html.para.page new file mode 100644 index 00000000..9e09ec1b --- /dev/null +++ b/doc/yelp-xsl/C/db2html.para.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.para" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.10" date="2013-08-09" status="final"/><desc>Output an HTML <code>p</code> element for a block-level element.</desc></info><title>db2html.para</title><p>Output an HTML <code>p</code> element for a block-level element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The block-level element to render.</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the HTML <code>class</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>p</code> element for the given DocBook element. It passes the <code style="xslt-param">class</code> parameter to <code style="xslt-template" xref="html.class.attr">html.class.attr</code>. If the <code style="xslt-param">class</code> parameter is not provided, it uses the local name of <code style="xslt-param">node</code>.</p> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.pre.page b/doc/yelp-xsl/C/db2html.pre.page new file mode 100644 index 00000000..f25f0334 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.pre.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.pre" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-block" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.12" date="2013-11-02" status="final"/><desc>Output an HTML <code>pre</code> element for a block-level element.</desc></info><title>db2html.pre</title><p>Output an HTML <code>pre</code> element for a block-level element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The block-level element to render.</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the HTML <code>class</code> attribute.</p> + </item> + <item> + <title><code>children</code></title> + <p>The child elements to process.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML <code>pre</code> element for the given DocBook element. It passes the <code style="xslt-param">class</code> parameter to <code style="xslt-template" xref="html.class.attr">html.class.attr</code>. If the <code style="xslt-param">class</code> parameter is not provided, it uses the local name of <code style="xslt-param">node</code>.</p> + <p>If <code style="xslt-param">node</code> has the <code>linenumbering</code> attribute set to <code>"numbered"</code>, then this template will create line numbers for each line, using the <code style="xslt-template" xref="utils.linenumbering">utils.linenumbering</code> template.</p> + <p>By default, this template applies templates to all child nodes. Pass child nodes in the <code style="xslt-param">children</code> parameter to override this behavior.</p> + <p>If <code style="xslt-param" xref="html.syntax.highlight">html.syntax.highlight</code> is <code>true</code>, this template automatically outputs syntax highlighting support based on the <code>language</code> attribute of <code style="xslt-param">node</code>, using <code style="xslt-template" xref="html.syntax.class">html.syntax.class</code> to determine the correct highlighter.</p> + <p>This template handles conditional processing.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db.profile.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.linenumbering.start"/></p></item><item><p><link xref="utils.linenumbering"/></p></item><item><p><link xref="html.syntax.class"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.syntax.highlight"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.row.page b/doc/yelp-xsl/C/db2html.row.page new file mode 100644 index 00000000..11630ff2 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.row.page @@ -0,0 +1,32 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.row" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Creates a <code>tr</code> element for a <code>row</code> element</desc></info><title>db2html.row</title><p>Creates a <code>tr</code> element for a <code>row</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>row</code></title> + <p>The <code>row</code> element to process</p> + </item> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>colsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>rowsep</code></title> + <p>Whether column separators are currently enabled</p> + </item> + <item> + <title><code>spanstr</code></title> + <p>The string representation of the row spans</p> + </item> + </terms></synopsis> + <p>FIXME</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db2html.entry"/></p></item><item><p><link xref="db2html.row"/></p></item><item><p><link xref="db2html.spanstr"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.spanstr.page b/doc/yelp-xsl/C/db2html.spanstr.page new file mode 100644 index 00000000..e8529d5d --- /dev/null +++ b/doc/yelp-xsl/C/db2html.spanstr.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.spanstr" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates a string specifying the row spans in effect</desc></info><title>db2html.spanstr</title><p>Generates a string specifying the row spans in effect</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanstr</code></title> + <p>The <code style="xslt-param">spanstr</code> parameter used by the previous row</p> + </item> + </terms></synopsis> + <comment><p>This template needs to be explained in detail, but I forgot how it works.</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.entry.colnum"/></p></item><item><p><link xref="db2html.entry.colspan"/></p></item><item><p><link xref="db2html.spanstr.pop"/></p></item><item><p><link xref="db2html.spanstr"/></p></item><item><p><link xref="utils.repeat_string"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.spanstr.pop.page b/doc/yelp-xsl/C/db2html.spanstr.pop.page new file mode 100644 index 00000000..152c5788 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.spanstr.pop.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.spanstr.pop" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-table" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Calculates the remaining spans after an <code>entry</code> element</desc></info><title>db2html.spanstr.pop</title><p>Calculates the remaining spans after an <code>entry</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>colspecs</code></title> + <p>The <code>colspec</code> elements currently in scope</p> + </item> + <item> + <title><code>spanspecs</code></title> + <p>The <code>spanspec</code> elements currently in scope</p> + </item> + <item> + <title><code>colspan</code></title> + <p>The number of columns to pop</p> + </item> + <item> + <title><code>spanstr</code></title> + <p>The string representation of the column spans</p> + </item> + </terms></synopsis> + <comment><p>This template needs to be explained in detail, but I forgot how it works.</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.spanstr.pop"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.ulink.page b/doc/yelp-xsl/C/db2html.ulink.page new file mode 100644 index 00000000..3b236ceb --- /dev/null +++ b/doc/yelp-xsl/C/db2html.ulink.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.ulink" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-xref" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates a hyperlink from a <code>ulink</code> element</desc></info><title>db2html.ulink</title><p>Generates a hyperlink from a <code>ulink</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>url</code></title> + <p>The URL to link to</p> + </item> + <item> + <title><code>content</code></title> + <p>Optional content to use for the text of the link</p> + </item> + </terms></synopsis> + <comment><p>Describe this template</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.ulink.tooltip"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.videodata.page b/doc/yelp-xsl/C/db2html.videodata.page new file mode 100644 index 00000000..99fa9c5e --- /dev/null +++ b/doc/yelp-xsl/C/db2html.videodata.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.videodata" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-media" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="3.8" date="2012-11-12" status="final"/><desc>Output an HTML <code>video</code> element for a <code>videodata</code> element.</desc></info><title>db2html.videodata</title><p>Output an HTML <code>video</code> element for a <code>videodata</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>videodata</code> element.</p> + </item> + </terms></synopsis> + <p>This template creates a <code>video</code> element in the HTML output. If the containing <code>mediaobject</code> or <code>inlinemediaobject</code> element has an <code>imageobject</code> with the <code>role</code> attribute set to <code>"poster"</code>, that image will be used for the <code>poster</code> attribute on the HTML <code>video</code> element. This template calls <code style="xslt-template" xref="db2html.mediaobject.fallback">db2html.mediaobject.fallback</code> for the contents of the <code>video</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="db2html.mediaobject.fallback"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.xlink.page b/doc/yelp-xsl/C/db2html.xlink.page new file mode 100644 index 00000000..5013e7de --- /dev/null +++ b/doc/yelp-xsl/C/db2html.xlink.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.xlink" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-xref" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates a hyperlink from a DocBook 5 <code>link</code> element</desc></info><title>db2html.xlink</title><p>Generates a hyperlink from a DocBook 5 <code>link</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node in question</p> + </item> + <item> + <title><code>linkend</code></title> + <p>The ID of the element to link to</p> + </item> + <item> + <title><code>url</code></title> + <p>The URL to link to</p> + </item> + <item> + <title><code>content</code></title> + <p>Optional content to use for the text of the link</p> + </item> + </terms></synopsis> + <p>Note that this template is also called for inline elements that use DocBook 5's ubiquitous linking.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="db2html.ulink"/></p></item><item><p><link xref="db2html.link"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2html.xref.page b/doc/yelp-xsl/C/db2html.xref.page new file mode 100644 index 00000000..9e3449b7 --- /dev/null +++ b/doc/yelp-xsl/C/db2html.xref.page @@ -0,0 +1,28 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="db2html.xref" type="topic" style="xslt-template"><info><link type="guide" xref="db2html-xref" group="templates"/><link type="guide" xref="templates" group="db2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Generates a hyperlink from an <code>xref</code> element</desc></info><title>db2html.xref</title><p>Generates a hyperlink from an <code>xref</code> element</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>linkend</code></title> + <p>The id of the element being linked to</p> + </item> + <item> + <title><code>target</code></title> + <p>The element being linked to</p> + </item> + <item> + <title><code>endterm</code></title> + <p>The id of an element whose contents will be used for the link text</p> + </item> + <item> + <title><code>xrefstyle</code></title> + <p>The style of cross reference text to use</p> + </item> + <item> + <title><code>content</code></title> + <p>Optional content to use for the text of the link</p> + </item> + </terms></synopsis> + <comment><p>Describe this template</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="db.xref.target"/></p></item><item><p><link xref="db.xref.content"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="db.id.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/db2xhtml.page b/doc/yelp-xsl/C/db2xhtml.page new file mode 100644 index 00000000..34da8991 --- /dev/null +++ b/doc/yelp-xsl/C/db2xhtml.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="db2xhtml" type="guide" style="xslt-stylesheet"><?xslt-private db2html-suppressed?><info><link type="guide" xref="stylesheets" group="db2xhtml"/><revision version="3.8" date="2012-11-05" status="final"/><link type="topic" xref="db2html-bibliography" group="stylesheets"/><link type="topic" xref="db2html-block" group="stylesheets"/><link type="topic" xref="db2html-callout" group="stylesheets"/><link type="topic" xref="db2html-classsynopsis" group="stylesheets"/><link type="topic" xref="db2html-cmdsynopsis" group="stylesheets"/><link type="topic" xref="db2html-css" group="stylesheets"/><link type="topic" xref="db2html-division" group="stylesheets"/><link type="topic" xref="db2html-ebnf" group="stylesheets"/><link type="topic" xref="db2html-funcsynopsis" group="stylesheets"/><link type="topic" xref="db2html-index" group="stylesheets"/><link type="topic" xref="db2html-inline" group="stylesheets"/><link type="topic" xref="db2html-links" group="stylesheets"/><link type="topic" xref="db2html-math" group="stylesheets"/><link type="topic" xref="db2html-media" group="stylesheets"/><link type="topic" xref="db2html-list" group="stylesheets"/><link type="topic" xref="db2html-refentry" group="stylesheets"/><link type="topic" xref="db2html-table" group="stylesheets"/><link type="topic" xref="db2html-xref" group="stylesheets"/><link type="topic" xref="db2html-footnote" group="stylesheets"/><link type="xslt-defines-param" xref="db.chunk.extension"/><link type="xslt-defines-param" xref="db.profile.outputformat"/></info><title>DocBook to XHTML</title><p>Transform DocBook to XHTML.</p> + + + <p>This top-level stylesheet includes all the necessary stylesheets to transform DocBook documents into XHTML. This stylesheet sets the parameter <code style="xslt-param" xref="db.chunk.extension">db.chunk.extension</code>.</p> + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.extension"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.basename.page b/doc/yelp-xsl/C/html.basename.page new file mode 100644 index 00000000..dffc4f6b --- /dev/null +++ b/doc/yelp-xsl/C/html.basename.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.basename" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The base filename of the primary output file.</desc></info><title>html.basename</title><p>The base filename of the primary output file.</p> + + + <p>This parameter specifies the base filename of the primary output file, without the filename extension. This is used by <code style="xslt-template" xref="html.output">html.output</code> to determine the output filename, and may be used by format-specific linking code. By default, it uses the value of an <code>id</code> or <code>xml:id</code> attribute, if present. Otherwise, it uses the static string <code>index</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/html.body.attr.mode.page b/doc/yelp-xsl/C/html.body.attr.mode.page new file mode 100644 index 00000000..2e1fbdfc --- /dev/null +++ b/doc/yelp-xsl/C/html.body.attr.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.body.attr.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-06-08" status="final"/><desc>Output attributes for the HTML <code>body</code> element.</desc></info><title>html.body.attr.mode</title><p>Output attributes for the HTML <code>body</code> element.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.page">html.page</code> to output attributes on the HTML <code>body</code> element. No attributes are output by default. Importing stylesheets may implement this node to add attributes for styling, data, or other purposes.</p> +</page> diff --git a/doc/yelp-xsl/C/html.body.mode.page b/doc/yelp-xsl/C/html.body.mode.page new file mode 100644 index 00000000..42a4bc1f --- /dev/null +++ b/doc/yelp-xsl/C/html.body.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.body.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Output the main contents for an element.</desc></info><title>html.body.mode</title><p>Output the main contents for an element.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.page">html.page</code> to output the main contents of an HTML page, below the header content and above the footer content. Titles, block content, and sections should be output in this mode.</p> +</page> diff --git a/doc/yelp-xsl/C/html.bottom.custom.page b/doc/yelp-xsl/C/html.bottom.custom.page new file mode 100644 index 00000000..626bb83e --- /dev/null +++ b/doc/yelp-xsl/C/html.bottom.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.bottom.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2011-11-01" status="final"/><desc>Stub to output HTML at the bottom of the page.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.bottom.custom</title><p>Stub to output HTML at the bottom of the page.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node a page is being created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.page">html.page</code>. It is called after the <code>div.page</code> wrapper div. Override this template to provide site-specific HTML at the bottom of the page.</p> +</page> diff --git a/doc/yelp-xsl/C/html.class.attr.mode.page b/doc/yelp-xsl/C/html.class.attr.mode.page new file mode 100644 index 00000000..9c09863a --- /dev/null +++ b/doc/yelp-xsl/C/html.class.attr.mode.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.class.attr.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="3.10" date="2013-07-10" status="final"/><desc>Output additional values for an HTML <code>class</code> attribute.</desc></info><title>html.class.attr.mode</title><p>Output additional values for an HTML <code>class</code> attribute.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.class.attr">html.class.attr</code> on a source element. This mode is intended for extensions to have an easy way to add additional HTML class values for styling.</p> + <p>Note that these stylesheets use CSS classes extensively for styling and for certain JavaScript functionality. Extensions should be careful to output class values that do not conflict with those used in these stylesheets.</p> +</page> diff --git a/doc/yelp-xsl/C/html.class.attr.page b/doc/yelp-xsl/C/html.class.attr.page new file mode 100644 index 00000000..aa4f6897 --- /dev/null +++ b/doc/yelp-xsl/C/html.class.attr.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.class.attr" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="3.10" date="2013-07-10" status="final"/><desc>Output a <code>class</code> attribute for an HTML element.</desc></info><title>html.class.attr</title><p>Output a <code>class</code> attribute for an HTML element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source node for which an HTML element is being output.</p> + </item> + <item> + <title><code>class</code></title> + <p>The value of the <code>class</code> attribute provided by the calling template.</p> + </item> + </terms></synopsis> + <p>This template is called by templates that output an HTML element corresponding to a source element. This template applies <code style="xslt-mode" xref="html.class.attr.mode">html.class.attr.mode</code> to <code style="xslt-param">node</code> to gather a value from extensions stylesheets. It combines this value with the value passed in the <code style="xslt-param">class</code> parameter and, if the result is non-empty, outputs a <code>class</code> attribute.</p> +<list style="compact"><title>Calls Modes</title><item><p><link xref="html.class.attr.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.content.page b/doc/yelp-xsl/C/html.css.content.page new file mode 100644 index 00000000..90261593 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.content.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.content" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-12-23" status="final"/><desc>Output actual CSS content for an HTML output page.</desc></info><title>html.css.content</title><p>Output actual CSS content for an HTML output page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template creates the CSS content for an HTML output page. It is called by <code style="xslt-template" xref="html.css">html.css</code>. It calls the templates <code style="xslt-template" xref="html.css.core">html.css.core</code>, <code style="xslt-template" xref="html.css.elements">html.css.elements</code>, and <code style="xslt-template" xref="html.css.syntax">html.css.syntax</code>. It then calls the mode <code style="xslt-mode" xref="html.css.mode">html.css.mode</code> on <code style="xslt-param">node</code> and calls the template <code style="xslt-template" xref="html.css.custom">html.css.custom</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item><item><p><link xref="html.css.core"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="html.css.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.core.page b/doc/yelp-xsl/C/html.css.core.page new file mode 100644 index 00000000..7f19b2e7 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.core.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.core" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Output CSS that does not reference source elements.</desc></info><title>html.css.core</title><p>Output CSS that does not reference source elements.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs CSS that can be used in any HTML. It does not reference elements from DocBook, Mallard, or other source languages. It provides the common spacings for block-level elements lik paragraphs and lists, defines styles for links, and defines four common wrapper divs: <code>header</code>, <code>side</code>, <code>body</code>, and <code>footer</code>.</p> + <p>All parameters can be automatically computed if not provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.background"/></p></item><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.dark_background"/></p></item><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.link"/></p></item><item><p><link xref="color.link_visited"/></p></item><item><p><link xref="color.text"/></p></item><item><p><link xref="color.text_light"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.custom.page b/doc/yelp-xsl/C/html.css.custom.page new file mode 100644 index 00000000..769293dd --- /dev/null +++ b/doc/yelp-xsl/C/html.css.custom.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Stub to output custom CSS common to all HTML transformations.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.css.custom</title><p>Stub to output custom CSS common to all HTML transformations.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.css.content">html.css.content</code>. You can override this template to provide additional CSS that will be used by all HTML output.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.elements.page b/doc/yelp-xsl/C/html.css.elements.page new file mode 100644 index 00000000..9e41a251 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.elements.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.elements" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Output CSS for common elements from source formats.</desc></info><title>html.css.elements</title><p>Output CSS for common elements from source formats.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs CSS for elements from source languages like DocBook and Mallard. It defines them using common class names. The common names are often the simpler element names from Mallard, although there some class names which are not taken from Mallard. Stylesheets which convert to HTML should use the appropriate common classes.</p> + <p>All parameters can be automatically computed if not provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.background"/></p></item><item><p><link xref="color.blue_background"/></p></item><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.dark_background"/></p></item><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.link"/></p></item><item><p><link xref="color.text"/></p></item><item><p><link xref="color.text_error"/></p></item><item><p><link xref="color.text_light"/></p></item><item><p><link xref="color.yellow_background"/></p></item><item><p><link xref="color.yellow_border"/></p></item><item><p><link xref="icons.note"/></p></item><item><p><link xref="icons.note.bug"/></p></item><item><p><link xref="icons.note.important"/></p></item><item><p><link xref="icons.note.tip"/></p></item><item><p><link xref="icons.note.warning"/></p></item><item><p><link xref="icons.size.note"/></p></item><item><p><link xref="icons.size.quote"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.mode.page b/doc/yelp-xsl/C/html.css.mode.page new file mode 100644 index 00000000..96458586 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.mode.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Output CSS specific to the input format.</desc></info><title>html.css.mode</title><p>Output CSS specific to the input format.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="html.css.content">html.css.content</code> to output CSS specific to the input format. Importing stylesheets may implement this for any element that will be passed to <code style="xslt-template" xref="html.page">html.page</code>. If they do not, the output HTML will only have the common CSS.</p> +</page> diff --git a/doc/yelp-xsl/C/html.css.page b/doc/yelp-xsl/C/html.css.page new file mode 100644 index 00000000..2cca55c4 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-12-23" status="final"/><desc>Output all CSS for an HTML output page.</desc></info><title>html.css</title><p>Output all CSS for an HTML output page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template creates the CSS for an HTML output page, including the enclosing HTML <code>style</code> element. It calls the templates <code style="xslt-template" xref="html.css.content">html.css.content</code> to output the actual CSS contents.</p> + <p>The <code style="xslt-param">direction</code> parameter specifies the directionality of the text for the language of the document. The <code style="xslt-param">left</code> and <code style="xslt-param">right</code> parameters are based on <code style="xslt-param">direction</code>, and can be used to set beginning and ending margins or other dimensions. All parameters can be automatically computed if not provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item><item><p><link xref="html.css.content"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.css.root.page b/doc/yelp-xsl/C/html.css.root.page new file mode 100644 index 00000000..61ce24bc --- /dev/null +++ b/doc/yelp-xsl/C/html.css.root.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.root" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-12-06" status="final"/><desc>The URI root for external CSS files.</desc></info><title>html.css.root</title><p>The URI root for external CSS files.</p> + + + <p>This parameter provides a root URI for any external CSS files that are referenced from the output HTML file. If non-empty, it must end with a trailing slash character.</p> +</page> diff --git a/doc/yelp-xsl/C/html.css.syntax.page b/doc/yelp-xsl/C/html.css.syntax.page new file mode 100644 index 00000000..be6d5ed9 --- /dev/null +++ b/doc/yelp-xsl/C/html.css.syntax.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.css.syntax" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-12-06" status="final"/><desc>Output CSS for syntax highlighting.</desc></info><title>html.css.syntax</title><p>Output CSS for syntax highlighting.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create CSS for.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The directionality of the text, either <code>ltr</code> or <code>rtl</code>.</p> + </item> + <item> + <title><code>left</code></title> + <p>The starting alignment, either <code>left</code> or <code>right</code>.</p> + </item> + <item> + <title><code>right</code></title> + <p>The ending alignment, either <code>left</code> or <code>right</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs CSS to support syntax highlighting of code blocks. Syntax highlighting is done at document load time with JavaScript. Text in code blocks is broken up into chunks and wrapped in HTML elements with particular classes. This template outputs CSS to match those elements and style them with the built-in themeable colors from <file xref="color">color</file>.</p> + <p>All parameters can be automatically computed if not provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.text_light"/></p></item><item><p><link xref="html.syntax.highlight"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.extension.page b/doc/yelp-xsl/C/html.extension.page new file mode 100644 index 00000000..d1f56261 --- /dev/null +++ b/doc/yelp-xsl/C/html.extension.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.extension" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The filename extension for all output files.</desc></info><title>html.extension</title><p>The filename extension for all output files.</p> + + + <p>This parameter specifies a filename extension for all HTML output files. It should include the leading dot. By default, <code>.xhtml</code> will be used if <code style="xslt-param" xref="html.xhtml">html.xhtml</code> is true; otherwise, <code>.html</code> will be used.</p> +</page> diff --git a/doc/yelp-xsl/C/html.footer.custom.page b/doc/yelp-xsl/C/html.footer.custom.page new file mode 100644 index 00000000..a9a63e23 --- /dev/null +++ b/doc/yelp-xsl/C/html.footer.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.footer.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2011-10-27" status="final"/><desc>Stub to output custom footer content.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.footer.custom</title><p>Stub to output custom footer content.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node a page is being created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.page">html.page</code>. It is called inside the footer div, after <code style="xslt-mode" xref="html.footer.mode">html.footer.mode</code> is applied to <code style="xslt-param">node</code>. You can override this template to provide additional content at the bottom of the page.</p> +</page> diff --git a/doc/yelp-xsl/C/html.footer.mode.page b/doc/yelp-xsl/C/html.footer.mode.page new file mode 100644 index 00000000..7abd455a --- /dev/null +++ b/doc/yelp-xsl/C/html.footer.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.footer.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Output the footer content for an element.</desc></info><title>html.footer.mode</title><p>Output the footer content for an element.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.page">html.page</code> to output the contents of the footer div below the main content. Importing stylesheets may implement this mode for any element that will be passed to <code style="xslt-template" xref="html.page">html.page</code>. If they do not, the footer div will be empty.</p> +</page> diff --git a/doc/yelp-xsl/C/html.head.custom.page b/doc/yelp-xsl/C/html.head.custom.page new file mode 100644 index 00000000..d025c6a9 --- /dev/null +++ b/doc/yelp-xsl/C/html.head.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.head.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Stub to output custom content for the HTML <code>head</code> element.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.head.custom</title><p>Stub to output custom content for the HTML <code>head</code> element.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node a page is being created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.page">html.page</code>. You can override this template to provide additional elements in the HTML <code>head</code> element of output files.</p> +</page> diff --git a/doc/yelp-xsl/C/html.header.custom.page b/doc/yelp-xsl/C/html.header.custom.page new file mode 100644 index 00000000..2dd7428b --- /dev/null +++ b/doc/yelp-xsl/C/html.header.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.header.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2011-10-27" status="final"/><desc>Stub to output custom header content.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.header.custom</title><p>Stub to output custom header content.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node a page is being created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.page">html.page</code>. It is called inside the header div, before <code style="xslt-mode" xref="html.header.mode">html.header.mode</code> is applied to <code style="xslt-param">node</code>. You can override this template to provide additional content at the top of the page.</p> +</page> diff --git a/doc/yelp-xsl/C/html.header.mode.page b/doc/yelp-xsl/C/html.header.mode.page new file mode 100644 index 00000000..78647838 --- /dev/null +++ b/doc/yelp-xsl/C/html.header.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.header.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Output the header content for an element.</desc></info><title>html.header.mode</title><p>Output the header content for an element.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.page">html.page</code> to output the contents of the header div above the main content. Importing stylesheets may implement this mode for any element that will be passed to <code style="xslt-template" xref="html.page">html.page</code>. If they do not, the header div will be empty.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.content.custom.page b/doc/yelp-xsl/C/html.js.content.custom.page new file mode 100644 index 00000000..c71c6877 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.content.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.content.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2010-04-16" status="final"/><desc>Stub to output custom JavaScript common to all HTML transformations.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.js.content.custom</title><p>Stub to output custom JavaScript common to all HTML transformations.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.js.content">html.js.content</code>. You can override this template to provide additional JavaScript that will be used by all HTML output. This template is called inside a <code>script</code> tag, and is intended to include JavaScript code in the output page. See <code style="xslt-template" xref="html.js.custom">html.js.custom</code> to include a custom reference to an external JavaScript file.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.content.page b/doc/yelp-xsl/C/html.js.content.page new file mode 100644 index 00000000..f28fc2fb --- /dev/null +++ b/doc/yelp-xsl/C/html.js.content.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.content" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="3.4" date="2011-11-04" status="final"/><desc>Output JavaScript content for an HTML output page.</desc></info><title>html.js.content</title><p>Output JavaScript content for an HTML output page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="html.js">html.js</code> to output JavaScript content. It does not output an HTML <code>script</code> tag. The JavaScript output by this template or templates it calls may depend on the jQuery code referenced by <code style="xslt-template" xref="html.js.jquery">html.js.jquery</code>. This template calls the templates <code style="xslt-template" xref="html.js.core">html.js.core</code>, <code style="xslt-template" xref="html.js.ui">html.js.ui</code>, <code style="xslt-template" xref="html.js.media">html.js.media</code>, and <code style="xslt-template" xref="html.js.syntax">html.js.syntax</code>. It then calls the mode <code style="xslt-mode" xref="html.js.mode">html.js.mode</code> on <code style="xslt-param">node</code> and calls the template <code style="xslt-template" xref="html.js.content.custom">html.js.content.custom</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.js.core"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="html.js.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.core.page b/doc/yelp-xsl/C/html.js.core.page new file mode 100644 index 00000000..1496eb91 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.core.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.core" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="3.4" date="2011-11-04" status="final"/><desc>Output JavaScript for core features.</desc></info><title>html.js.core</title><p>Output JavaScript for core features.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs JavaScript to support basic features used by all documents. Currently, it outputs code to highlight a section when <code>location.hash</code> is set.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="color.yellow_background"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.custom.page b/doc/yelp-xsl/C/html.js.custom.page new file mode 100644 index 00000000..8761d306 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2010-04-16" status="final"/><desc>Stub to reference custom JavaScript common to all HTML transformations.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.js.custom</title><p>Stub to reference custom JavaScript common to all HTML transformations.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.js">html.js</code>. You can override this template to reference additional external JavaScript files. If you want to include JavaScript into the main <code>script</code> tag instead, use <code style="xslt-template" xref="html.js.content.custom">html.js.content.custom</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.jquery.page b/doc/yelp-xsl/C/html.js.jquery.page new file mode 100644 index 00000000..85e0f2f5 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.jquery.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.jquery" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-12-31" status="final"/><desc>Output references to jQuery JavaScript files.</desc></info><title>html.js.jquery</title><p>Output references to jQuery JavaScript files.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs HTML <code>script</code> tags to reference any necessary jQuery files. It always includes a reference to <code>jquery.js</code>. If <code style="xslt-param" xref="html.syntax.highlight">html.syntax.highlight</code> is <code>true</code>, it will also include a reference to <code>jquery.syntax.js</code> along with an additional <code>script</code> tag to initialize syntax highlighting. All references are output relative to <code style="xslt-param" xref="html.js.root">html.js.root</code>.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="html.js.root"/></p></item><item><p><link xref="html.syntax.highlight"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.mathjax.page b/doc/yelp-xsl/C/html.js.mathjax.page new file mode 100644 index 00000000..838ecba4 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.mathjax.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.mathjax" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2012-11-13" status="final"/><desc>Output <code>script</code> element to include MathJax.</desc></info><title>html.js.mathjax</title><p>Output <code>script</code> element to include MathJax.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>script</code> tag to reference MathJax. It only outputs a <code>script</code> element if <code style="xslt-param">node</code> has MathML descendent content. By default, this template uses <code>cnd.mathjax.org</code>. If you wish to use a local copy, override this template and provide the necessary files.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.media.page b/doc/yelp-xsl/C/html.js.media.page new file mode 100644 index 00000000..9ffa421a --- /dev/null +++ b/doc/yelp-xsl/C/html.js.media.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.media" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-01-01" status="final"/><desc>Output JavaScript to control media elements.</desc></info><title>html.js.media</title><p>Output JavaScript to control media elements.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs JavaScript that controls media elements. It provides control for audio and video elements as well as support for captions.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.text_light"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.mode.page b/doc/yelp-xsl/C/html.js.mode.page new file mode 100644 index 00000000..f324388f --- /dev/null +++ b/doc/yelp-xsl/C/html.js.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-01-01" status="final"/><desc>Output JavaScript specific to the input format.</desc></info><title>html.js.mode</title><p>Output JavaScript specific to the input format.</p> + + + <p>This template is called by <code style="xslt-template" xref="html.js.content">html.js.content</code> to output JavaScript specific to the input format. Importing stylesheets may implement this for any element that will be passed to <code style="xslt-template" xref="html.page">html.page</code>. If they do not, the output HTML will only have the common JavaScript.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.page b/doc/yelp-xsl/C/html.js.page new file mode 100644 index 00000000..da61686e --- /dev/null +++ b/doc/yelp-xsl/C/html.js.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-12-31" status="final"/><desc>Output all JavaScript for an HTML output page.</desc></info><title>html.js</title><p>Output all JavaScript for an HTML output page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template creates the JavaScript for an HTML output page. It calls the template <code style="xslt-template" xref="html.js.jquery">html.js.jquery</code> to output references to jQuery files. It then calls <code style="xslt-template" xref="html.js.custom">html.js.custom</code> to output references to custom JavaScript files. Finally, it outputs an HTML <code>script</code> tag and calls <code style="xslt-template" xref="html.js.content">html.js.content</code> to ouput the contents of that tag.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.js.jquery"/></p></item><item><p><link xref="html.js.content"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.root.page b/doc/yelp-xsl/C/html.js.root.page new file mode 100644 index 00000000..777b0128 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.root.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.root" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-12-06" status="final"/><desc>The URI root for external JavaScript files.</desc></info><title>html.js.root</title><p>The URI root for external JavaScript files.</p> + + + <p>This parameter provides a root URI for any external JavaScript files that are referenced from the output HTML file. If non-empty, it must end with a trailing slash character.</p> +</page> diff --git a/doc/yelp-xsl/C/html.js.syntax.page b/doc/yelp-xsl/C/html.js.syntax.page new file mode 100644 index 00000000..916064ee --- /dev/null +++ b/doc/yelp-xsl/C/html.js.syntax.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.syntax" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2011-04-16" status="final"/><desc>Output JavaScript for syntax highlighting</desc></info><title>html.js.syntax</title><p>Output JavaScript for syntax highlighting</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs JavaScript that does syntax highlighting. JavaScript <code style="xslt-param" xref="html.syntax.highlight">html.syntax.highlight</code> is <code>true</code>. Note that this content just initializes the syntax highlighting. The real work is done by <code>jquery.syntax.js</code>, which is included by <code style="xslt-template" xref="html.js.syntax">html.js.syntax</code>.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="html.js.root"/></p></item><item><p><link xref="html.syntax.highlight"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.js.ui.page b/doc/yelp-xsl/C/html.js.ui.page new file mode 100644 index 00000000..d5488487 --- /dev/null +++ b/doc/yelp-xsl/C/html.js.ui.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.js.ui" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2011-06-17" status="final"/><desc>Output JavaScript for UI extensions.</desc></info><title>html.js.ui</title><p>Output JavaScript for UI extensions.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create JavaScript for.</p> + </item> + </terms></synopsis> + <p>This template outputs JavaScript that implements certain common UI extensions, such as expandable blocks and sections.</p> +</page> diff --git a/doc/yelp-xsl/C/html.lang.attrs.page b/doc/yelp-xsl/C/html.lang.attrs.page new file mode 100644 index 00000000..2e79cea0 --- /dev/null +++ b/doc/yelp-xsl/C/html.lang.attrs.page @@ -0,0 +1,26 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.lang.attrs" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-06-10" status="final"/><desc>Output <code>lang</code> and <code>dir</code> attributes.</desc></info><title>html.lang.attrs</title><p>Output <code>lang</code> and <code>dir</code> attributes.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The current element in the input document.</p> + </item> + <item> + <title><code>parent</code></title> + <p>A parent node to take <code style="xslt-param">lang</code> and <code style="xslt-param">dir</code> from.</p> + </item> + <item> + <title><code>lang</code></title> + <p>The language for <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>dir</code></title> + <p>The text directionality for <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs <code>lang</code>, <code>xml:lang</code>, or <code>dir</code> attributes if necessary. If <code style="xslt-param">lang</code> is not set, it will be taken from the <code>xml:lang</code> or <code>lang</code> attribute of <code style="xslt-param">node</code>. If <code style="xslt-param">dir</code> is not set, it will be taken from the <code>its:dir</code> attribute of <code style="xslt-param">node</code> or computed based on <code style="xslt-param">lang</code>.</p> + <p>The <code style="xslt-param">parent</code> parameter defaults to an empty node set. If it is set to a non-empty node set, this template will attempt to get <code style="xslt-param">lang</code> and <code style="xslt-param">dir</code> from <code style="xslt-param">parent</code> if they are not set on <code style="xslt-param">node</code>. This is occasionally useful when a wrapper element in a source language doesn't directly create any output elements.</p> + <p>This template outputs either an <code>xml:lang</code> or a <code>lang</code> attribute, depending on whether <code style="xslt-param" xref="html.xhtml">html.xhtml</code> is <code>true</code>. It only outputs an <code>xml:lang</code> or <code>lang</code> attribute if $lang is non-empty. This template also outputs a <code>dir</code> attribute if <code style="xslt-param">dir</code> is non-empty.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.xhtml"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.linktrails.empty.page b/doc/yelp-xsl/C/html.linktrails.empty.page new file mode 100644 index 00000000..19692773 --- /dev/null +++ b/doc/yelp-xsl/C/html.linktrails.empty.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.linktrails.empty" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="3.20" date="2015-10-02" status="final"/><desc>Stub to output something when no link trails are present.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.linktrails.empty</title><p>Stub to output something when no link trails are present.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source element a page is bring created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub. It is called by templates that output link trails when there are no link trails to output. Some customizations prepend extra site links to link trails. This template allows them to output those links even when no link trails would otherwise be present.</p> +</page> diff --git a/doc/yelp-xsl/C/html.linktrails.prefix.page b/doc/yelp-xsl/C/html.linktrails.prefix.page new file mode 100644 index 00000000..aecb0bc6 --- /dev/null +++ b/doc/yelp-xsl/C/html.linktrails.prefix.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.linktrails.prefix" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="3.20" date="2015-10-02" status="final"/><desc>Stub to output extra content before a link trail.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.linktrails.prefix</title><p>Stub to output extra content before a link trail.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A source-specific element providing information about the link trail.</p> + </item> + </terms></synopsis> + <p>This template is a stub. It is called by templates that output link trails before the normal links are output. This template is useful for adding extra site links at the beginning of each link trail.</p> +</page> diff --git a/doc/yelp-xsl/C/html.mathml.namespace.page b/doc/yelp-xsl/C/html.mathml.namespace.page new file mode 100644 index 00000000..f2a2d232 --- /dev/null +++ b/doc/yelp-xsl/C/html.mathml.namespace.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.mathml.namespace" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="3.18" date="2015-05-04" status="final"/><desc>The XML namespace for MathML in the output document.</desc></info><title>html.mathml.namespace</title><p>The XML namespace for MathML in the output document.</p> + + + <p>This parameter specifies the XML namespace for MathML in output documents. It will be set automatically based on the <code style="xslt-param">html.xhtml</code> parameter, either to the MathML namespace namespace, or to the empty namespace. Stylesheets can use this parameter when using <code>xsl:element</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/html.namespace.page b/doc/yelp-xsl/C/html.namespace.page new file mode 100644 index 00000000..3524de5f --- /dev/null +++ b/doc/yelp-xsl/C/html.namespace.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.namespace" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>The XML namespace for the output document.</desc></info><title>html.namespace</title><p>The XML namespace for the output document.</p> + + + <p>This parameter specifies the XML namespace of all output documents. It will be set automatically based on the <code style="xslt-param">html.xhtml</code> parameter, either to the XHTML namespace, or to the empty namespace. Stylesheets can use this parameter when using <code>xsl:element</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/html.output.after.mode.page b/doc/yelp-xsl/C/html.output.after.mode.page new file mode 100644 index 00000000..561a35d3 --- /dev/null +++ b/doc/yelp-xsl/C/html.output.after.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.output.after.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Process an element after its content are output.</desc></info><title>html.output.after.mode</title><p>Process an element after its content are output.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.output">html.output</code> after <code>exsl:document</code> has finished. It can be used to create further output files without blocking the output of parent elements.</p> +</page> diff --git a/doc/yelp-xsl/C/html.output.page b/doc/yelp-xsl/C/html.output.page new file mode 100644 index 00000000..a7ee64ca --- /dev/null +++ b/doc/yelp-xsl/C/html.output.page @@ -0,0 +1,18 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.output" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Create an HTML output file.</desc></info><title>html.output</title><p>Create an HTML output file.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create an output file for.</p> + </item> + <item> + <title><code>href</code></title> + <p>The output filename.</p> + </item> + </terms></synopsis> + <p>This template creates an HTML output file for the source element <code style="xslt-param">node</code>. It uses <code>exsl:document</code> to output the file, and calls <code style="xslt-template" xref="html.page">html.page</code> with the <code style="xslt-param">node</code> parameter to output the actual HTML contents.</p> + <p>If <code style="xslt-param">href</code> is not provided, this template will attempt to generate a base filename and append <code style="xslt-param" xref="html.extension">html.extension</code> to it. The base filename is generated as follows: If an <code>xml:id</code> attribute is present, it is used; otherwise, if an <code>id</code> attribute is present, it is uses; otherwise, if <code style="xslt-param">node</code> is the root element, <code style="xslt-param" xref="html.basename">html.basename</code> is used; otherwise, <code>generate-id()</code> is called.</p> + <p>After calling <code>exsl:document</code>, this template calls the <code style="xslt-mode" xref="html.output.after.mode">html.output.after.mode</code> mode on <code style="xslt-param">node</code>. Importing stylesheets that create multiple output files can use this to process output files without blocking earlier output.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.page"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="html.output.after.mode"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.basename"/></p></item><item><p><link xref="html.extension"/></p></item><item><p><link xref="html.xhtml"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.page b/doc/yelp-xsl/C/html.page new file mode 100644 index 00000000..8e5b3d17 --- /dev/null +++ b/doc/yelp-xsl/C/html.page @@ -0,0 +1,99 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="html" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><link type="xslt-requires" xref="l10n"/><link type="xslt-requires" xref="color"/><link type="xslt-requires" xref="icons"/><link type="xslt-defines-template" xref="html.output"/><link type="xslt-defines-template" xref="html.page"/><link type="xslt-defines-template" xref="html.top.custom"/><link type="xslt-defines-template" xref="html.bottom.custom"/><link type="xslt-defines-template" xref="html.header.custom"/><link type="xslt-defines-template" xref="html.footer.custom"/><link type="xslt-defines-template" xref="html.head.custom"/><link type="xslt-defines-template" xref="html.linktrails.empty"/><link type="xslt-defines-template" xref="html.linktrails.prefix"/><link type="xslt-defines-template" xref="html.class.attr"/><link type="xslt-defines-template" xref="html.css"/><link type="xslt-defines-template" xref="html.css.content"/><link type="xslt-defines-template" xref="html.css.core"/><link type="xslt-defines-template" xref="html.css.elements"/><link type="xslt-defines-template" xref="html.css.syntax"/><link type="xslt-defines-template" xref="html.css.custom"/><link type="xslt-defines-template" xref="html.js"/><link type="xslt-defines-template" xref="html.js.jquery"/><link type="xslt-defines-template" xref="html.js.mathjax"/><link type="xslt-defines-template" xref="html.js.content"/><link type="xslt-defines-template" xref="html.js.core"/><link type="xslt-defines-template" xref="html.js.ui"/><link type="xslt-defines-template" xref="html.js.media"/><link type="xslt-defines-template" xref="html.js.syntax"/><link type="xslt-defines-template" xref="html.js.custom"/><link type="xslt-defines-template" xref="html.js.content.custom"/><link type="xslt-defines-template" xref="html.lang.attrs"/><link type="xslt-defines-template" xref="html.syntax.class"/><link type="xslt-implements-mode" xref="html.output.after.mode"/><link type="xslt-implements-mode" xref="html.title.mode"/><link type="xslt-implements-mode" xref="html.body.attr.mode"/><link type="xslt-implements-mode" xref="html.header.mode"/><link type="xslt-implements-mode" xref="html.footer.mode"/><link type="xslt-implements-mode" xref="html.body.mode"/><link type="xslt-implements-mode" xref="html.class.attr.mode"/><link type="xslt-implements-mode" xref="html.css.mode"/><link type="xslt-implements-mode" xref="html.js.mode"/><link type="xslt-defines-param" xref="html.basename"/><link type="xslt-defines-param" xref="html.xhtml"/><link type="xslt-defines-param" xref="html.namespace"/><link type="xslt-defines-param" xref="html.extension"/><link type="xslt-defines-param" xref="html.css.root"/><link type="xslt-defines-param" xref="html.js.root"/><link type="xslt-defines-param" xref="html.syntax.highlight"/></info><title>HTML Output</title><p>Common utilities and CSS for transformations to HTML.</p> + + + <p>This stylesheet contains common templates for creating HTML output. The <code style="xslt-template" xref="html.output">html.output</code> template creates an output file for a node in the source XML document, calling <code style="xslt-template" xref="html.page">html.page</code> to create the actual output. Output files can be either XHTML or HTML, depending on the <code style="xslt-param" xref="html.xhtml">html.xhtml</code> parameter.</p> + <p>This stylesheet matches <code>/</code> and calls <code style="xslt-template" xref="html.output">html.output</code> on the root XML element. This works for most input formats. If you need to do something different, you should override the match for <code>/</code>.</p> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="color"/></p></item><item><p><link xref="icons"/></p></item><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="l10n.align.start"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.background"/></p></item><item><p><link xref="color.blue_background"/></p></item><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.dark_background"/></p></item><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.link"/></p></item><item><p><link xref="color.link_visited"/></p></item><item><p><link xref="color.text"/></p></item><item><p><link xref="color.text_error"/></p></item><item><p><link xref="color.text_light"/></p></item><item><p><link xref="color.yellow_background"/></p></item><item><p><link xref="color.yellow_border"/></p></item><item><p><link xref="html.basename"/></p></item><item><p><link xref="html.extension"/></p></item><item><p><link xref="html.js.root"/></p></item><item><p><link xref="html.syntax.highlight"/></p></item><item><p><link xref="html.xhtml"/></p></item><item><p><link xref="icons.note"/></p></item><item><p><link xref="icons.note.bug"/></p></item><item><p><link xref="icons.note.important"/></p></item><item><p><link xref="icons.note.tip"/></p></item><item><p><link xref="icons.note.warning"/></p></item><item><p><link xref="icons.size.note"/></p></item><item><p><link xref="icons.size.quote"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>/</code></p></td></tr><tr><td><p><link xref="html.body.attr.mode">html.body.attr.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.body.mode">html.body.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.class.attr.mode">html.class.attr.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.css.mode">html.css.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.footer.mode">html.footer.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.header.mode">html.header.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.js.mode">html.js.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.output.after.mode">html.output.after.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="html.title.mode">html.title.mode</link></p></td><td><p><code>*</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/html.page.page b/doc/yelp-xsl/C/html.page.page new file mode 100644 index 00000000..9f34af48 --- /dev/null +++ b/doc/yelp-xsl/C/html.page.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.page" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Create an HTML document.</desc></info><title>html.page</title><p>Create an HTML document.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node to create HTML for.</p> + </item> + </terms></synopsis> + <p>This template creates the actual HTML output for <code style="xslt-param">node</code>. It outputs top-level elements and container divs, and calls various templates and modes to output the inner content. Importing stylesheets should implement at least <code style="xslt-mode" xref="html.title.mode">html.title.mode</code> and <code style="xslt-mode" xref="html.body.mode">html.body.mode</code> for any elements that could be passed as <code style="xslt-param">node</code> to this template.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.css"/></p></item><item><p><link xref="html.header.custom"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="html.body.attr.mode"/></p></item><item><p><link xref="html.body.mode"/></p></item><item><p><link xref="html.footer.mode"/></p></item><item><p><link xref="html.header.mode"/></p></item><item><p><link xref="html.title.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/html.svg.namespace.page b/doc/yelp-xsl/C/html.svg.namespace.page new file mode 100644 index 00000000..578962ca --- /dev/null +++ b/doc/yelp-xsl/C/html.svg.namespace.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.svg.namespace" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="3.18" date="2015-05-04" status="final"/><desc>The XML namespace for SVG in the output document.</desc></info><title>html.svg.namespace</title><p>The XML namespace for SVG in the output document.</p> + + + <p>This parameter specifies the XML namespace for SVG in output documents. It will be set automatically based on the <code style="xslt-param">html.xhtml</code> parameter, either to the SVG namespace namespace, or to the empty namespace. Stylesheets can use this parameter when using <code>xsl:element</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/html.syntax.class.page b/doc/yelp-xsl/C/html.syntax.class.page new file mode 100644 index 00000000..2e1bae57 --- /dev/null +++ b/doc/yelp-xsl/C/html.syntax.class.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.syntax.class" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><revision version="3.12" date="2013-11-02" status="final"/><desc>Output HTML class values for syntax highlighting.</desc></info><title>html.syntax.class</title><p>Output HTML class values for syntax highlighting.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source element whose content will be syntax highlighted.</p> + </item> + <item> + <title><code>mime</code></title> + <p>A MIME type identifying the content, as from a Mallard <code>mime</code> attribute.</p> + </item> + <item> + <title><code>language</code></title> + <p>A name identifying the content as from a DocBook <code>language</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template looks at <code style="xslt-param">mime</code> and <code style="xslt-param">language</code> and determines if there is a suitable syntax highlighting brush available. If so, it outputs a string that should be placed in the <code>class</code> attribute of a <code>pre</code> element by the calling template.</p> +</page> diff --git a/doc/yelp-xsl/C/html.syntax.highlight.page b/doc/yelp-xsl/C/html.syntax.highlight.page new file mode 100644 index 00000000..3b41aa64 --- /dev/null +++ b/doc/yelp-xsl/C/html.syntax.highlight.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.syntax.highlight" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-12-06" status="final"/><desc>Whether to include syntax highlighting support for code blocks.</desc></info><title>html.syntax.highlight</title><p>Whether to include syntax highlighting support for code blocks.</p> + + + <p>This parameter specifies whether syntax highlighting should be enabled for code blocks in the output HTML. Syntax highlighting is done at document load time by JavaScript.</p> +</page> diff --git a/doc/yelp-xsl/C/html.title.mode.page b/doc/yelp-xsl/C/html.title.mode.page new file mode 100644 index 00000000..f14d0ab4 --- /dev/null +++ b/doc/yelp-xsl/C/html.title.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.title.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="html" group="modes"/><link type="guide" xref="modes" group="html"/><revision version="1.0" date="2010-05-26" status="final"/><desc>Output the title of an element.</desc></info><title>html.title.mode</title><p>Output the title of an element.</p> + + + <p>This mode is called by <code style="xslt-template" xref="html.page">html.page</code> to output the contents of the HTML <code>title</code> element inside the <code>head</code> element. Importing stylesheets should implement this mode for any element that will be passed to <code style="xslt-template" xref="html.page">html.page</code>. Because this is used in the <code>head</code>, the output should be text-only.</p> +</page> diff --git a/doc/yelp-xsl/C/html.top.custom.page b/doc/yelp-xsl/C/html.top.custom.page new file mode 100644 index 00000000..94d6d341 --- /dev/null +++ b/doc/yelp-xsl/C/html.top.custom.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.top.custom" type="topic" style="xslt-template"><info><link type="guide" xref="html" group="templates"/><link type="guide" xref="templates" group="html"/><link type="guide" xref="stubs" group="html"/><revision version="1.0" date="2011-11-01" status="final"/><desc>Stub to output HTML at the top of the page.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>html.top.custom</title><p>Stub to output HTML at the top of the page.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node a page is being created for.</p> + </item> + </terms></synopsis> + <p>This template is a stub, called by <code style="xslt-template" xref="html.page">html.page</code>. It is called before the <code>div.page</code> wrapper div. Override this template to provide site-specific HTML at the top of the page.</p> +</page> diff --git a/doc/yelp-xsl/C/html.xhtml.page b/doc/yelp-xsl/C/html.xhtml.page new file mode 100644 index 00000000..864d0544 --- /dev/null +++ b/doc/yelp-xsl/C/html.xhtml.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="html.xhtml" type="topic" style="xslt-param"><info><link type="guide" xref="html" group="parameters"/><link type="guide" xref="parameters" group="html"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Whether to output XHTML.</desc></info><title>html.xhtml</title><p>Whether to output XHTML.</p> + + + <p>If this parameter is set to true, this stylesheet will output XHTML. Otherwise, the output is assumed to be HTML. Note that for HTML output, the importing stylesheet still needs to call <code>xsl:namespace-alias</code> to map the XHTML namespace to <code>#default</code>. The <code style="xslt-param" xref="html.namespace">html.namespace</code> will be set automatically based on this parameter. Stylesheets can use this parameter to check the output type, for example when using <code>xsl:element</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.base_url.page b/doc/yelp-xsl/C/icons.base_url.page new file mode 100644 index 00000000..d9ecc39b --- /dev/null +++ b/doc/yelp-xsl/C/icons.base_url.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.base_url" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-01-26" status="final"/><desc>The default URL prefix for all icons.</desc></info><title>icons.base_url</title><p>The default URL prefix for all icons.</p> + + + <p>This parameter provides a default URL prefix. All icon locations in this stylesheet reference files directly under this URL prefix by default. If you override the individual icon parameters in this stylesheet, this parameter has no effect. This parameter should end with a trailing slash.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.note.bug.page b/doc/yelp-xsl/C/icons.note.bug.page new file mode 100644 index 00000000..8ed749dd --- /dev/null +++ b/doc/yelp-xsl/C/icons.note.bug.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.note.bug" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-05-03" status="final"/><desc>The URL for the bug note icon.</desc></info><title>icons.note.bug</title><p>The URL for the bug note icon.</p> + + + <p>This parameter specifies the URL for the icon used for bug notes.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.note.important.page b/doc/yelp-xsl/C/icons.note.important.page new file mode 100644 index 00000000..4dab1ec6 --- /dev/null +++ b/doc/yelp-xsl/C/icons.note.important.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.note.important" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-05-03" status="final"/><desc>The URL for the important note icon.</desc></info><title>icons.note.important</title><p>The URL for the important note icon.</p> + + + <p>This parameter specifies the URL for the icon used for important notes.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.note.page b/doc/yelp-xsl/C/icons.note.page new file mode 100644 index 00000000..a335b9e4 --- /dev/null +++ b/doc/yelp-xsl/C/icons.note.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.note" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-05-03" status="final"/><desc>The URL for the note icon.</desc></info><title>icons.note</title><p>The URL for the note icon.</p> + + + <p>This parameter specifies the URL for the icon used for regular notes.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.note.tip.page b/doc/yelp-xsl/C/icons.note.tip.page new file mode 100644 index 00000000..5b6e99c2 --- /dev/null +++ b/doc/yelp-xsl/C/icons.note.tip.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.note.tip" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-05-03" status="final"/><desc>The URL for the tip note icon.</desc></info><title>icons.note.tip</title><p>The URL for the tip note icon.</p> + + + <p>This parameter specifies the URL for the icon used for tip notes.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.note.warning.page b/doc/yelp-xsl/C/icons.note.warning.page new file mode 100644 index 00000000..58a71673 --- /dev/null +++ b/doc/yelp-xsl/C/icons.note.warning.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.note.warning" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-05-03" status="final"/><desc>The URL for the warning note icon.</desc></info><title>icons.note.warning</title><p>The URL for the warning note icon.</p> + + + <p>This parameter specifies the URL for the icon used for warning notes.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.page b/doc/yelp-xsl/C/icons.page new file mode 100644 index 00000000..f4dda885 --- /dev/null +++ b/doc/yelp-xsl/C/icons.page @@ -0,0 +1,22 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="icons" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="icons"/><revision version="1.0" date="2010-05-25" status="final"/><link type="xslt-requires" xref="l10n"/><link type="xslt-defines-param" xref="icons.base_url"/><link type="xslt-defines-param" xref="icons.size.note"/><link type="xslt-defines-param" xref="icons.note"/><link type="xslt-defines-param" xref="icons.note.bug"/><link type="xslt-defines-param" xref="icons.note.important"/><link type="xslt-defines-param" xref="icons.note.tip"/><link type="xslt-defines-param" xref="icons.note.warning"/><link type="xslt-defines-param" xref="icons.size.quote"/></info><title>Icons</title><p>Specify common named icons to style output.</p> + + + <p>This stylesheet provides a common interface to specify icons for transformations to presentation-oreinted formats. This allows similar output for different types of input documents.</p> + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="l10n"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="icons.base_url"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/icons.size.note.page b/doc/yelp-xsl/C/icons.size.note.page new file mode 100644 index 00000000..a36f6f26 --- /dev/null +++ b/doc/yelp-xsl/C/icons.size.note.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.size.note" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="1.0" date="2010-03-05" status="final"/><desc>The size of the note icons.</desc></info><title>icons.size.note</title><p>The size of the note icons.</p> + + + <p>This parameter specifies the size of the note icons. Use an integer giving the width of the image files in pixels. Icons are assumed to be square, and all note icons are assumed to have the same size.</p> +</page> diff --git a/doc/yelp-xsl/C/icons.size.quote.page b/doc/yelp-xsl/C/icons.size.quote.page new file mode 100644 index 00000000..ad482173 --- /dev/null +++ b/doc/yelp-xsl/C/icons.size.quote.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="icons.size.quote" type="topic" style="xslt-param"><info><link type="guide" xref="icons" group="parameters"/><link type="guide" xref="parameters" group="icons"/><revision version="3.8" date="2012-09-29" status="final"/><desc>The size of the quote icons.</desc></info><title>icons.size.quote</title><p>The size of the quote icons.</p> + + + <p>This parameter specifies the size of the block quote icon. Use an integer giving the width of the image files in pixels. Icons are assumed to be square, and all quote icons are assumed to have the same size.</p> + <p>As of version 3.8, there is no longer an actual image file for the quote icon. Instead, a language-appropriate quotation character is placed in the margin. This parameters still affects the size of that character.</p> +</page> diff --git a/doc/yelp-xsl/C/l10n-numbers.page b/doc/yelp-xsl/C/l10n-numbers.page new file mode 100644 index 00000000..a1d9c080 --- /dev/null +++ b/doc/yelp-xsl/C/l10n-numbers.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="l10n-numbers" type="guide" style="xslt-stylesheet"><?xslt-private l10n.number.cjk-ideographic.private?><?xslt-private l10n.number.ionic.private?><info><link type="guide" xref="stylesheets" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="l10n.number"/><link type="xslt-defines-template" xref="l10n.number.alphabetic"/><link type="xslt-defines-template" xref="l10n.number.numeric"/><link type="xslt-defines-template" xref="l10n.number.cjk-ideographic"/><link type="xslt-defines-template" xref="l10n.number.ionic"/></info><title>Localized Numbers</title> + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links></page> diff --git a/doc/yelp-xsl/C/l10n.align.end.page b/doc/yelp-xsl/C/l10n.align.end.page new file mode 100644 index 00000000..1e36c06b --- /dev/null +++ b/doc/yelp-xsl/C/l10n.align.end.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.align.end" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-07-27" status="final"/><desc>Determine the end alignment.</desc></info><title>l10n.align.end</title><p>Determine the end alignment.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>direction</code></title> + <p>The text direction.</p> + </item> + </terms></synopsis> + <p>This template returns the string <code>right</code> for left-to-right languages and the string <code>left</code> for right-to-left languages. The result is suitable for substituting in CSS rules that are direction-dependent. If you do not pass the <code style="xslt-param">direction</code> parameter, it defaults to calling <code style="xslt-template" xref="l10n.direction">l10n.direction</code> using the default locale defined in <code style="xslt-param" xref="l10n.locale">l10n.locale</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.align.start.page b/doc/yelp-xsl/C/l10n.align.start.page new file mode 100644 index 00000000..883cc8dd --- /dev/null +++ b/doc/yelp-xsl/C/l10n.align.start.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.align.start" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-07-27" status="final"/><desc>Determine the start alignment.</desc></info><title>l10n.align.start</title><p>Determine the start alignment.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>direction</code></title> + <p>The text direction.</p> + </item> + </terms></synopsis> + <p>This template returns the string <code>left</code> for left-to-right languages and the string <code>right</code> for right-to-left languages. The result is suitable for substituting in CSS rules that are direction-dependent. If you do not pass the <code style="xslt-param">direction</code> parameter, it defaults to calling <code style="xslt-template" xref="l10n.direction">l10n.direction</code> using the default locale defined in <code style="xslt-param" xref="l10n.locale">l10n.locale</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.direction.page b/doc/yelp-xsl/C/l10n.direction.page new file mode 100644 index 00000000..ef22cfb9 --- /dev/null +++ b/doc/yelp-xsl/C/l10n.direction.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.direction" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-08-13" status="final"/><desc>Determine the text direction for a language.</desc></info><title>l10n.direction</title><p>Determine the text direction for a language.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>lang</code></title> + <p>The locale to use to determine the text direction.</p> + </item> + </terms></synopsis> + <p>This template returns the text direction for the language <code style="xslt-param">lang</code>. It returns <code>"ltr"</code> for left-to-right languages and <code>"rtl"</code> for right-to-left languages. If <code style="xslt-param">lang</code> is not provided, it defaults to <code style="xslt-param">l10n.locale</code>, the top-level locale of the document.</p> + <p>This template calls <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code> with the string <code>default:LTR</code> in the domain <code>yelp-xsl</code>. The language is right-to-left if the string <code>default:RTL</code> is returned. Otherwise, it is left-to-right. (This particular string is used to match the string used in GTK+, enabling translation memory.)</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="l10n.locale"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.format.mode.page b/doc/yelp-xsl/C/l10n.format.mode.page new file mode 100644 index 00000000..127fc4ec --- /dev/null +++ b/doc/yelp-xsl/C/l10n.format.mode.page @@ -0,0 +1,18 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.format.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="l10n" group="modes"/><link type="guide" xref="modes" group="l10n"/><revision version="3.18" date="2015-08-13" status="final"/><desc>Process format strings from <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code>.</desc></info><title>l10n.format.mode</title><p>Process format strings from <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code>.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The node being processed in the original document.</p> + </item> + <item> + <title><code>string</code></title> + <p>String content to use for certain message format nodes.</p> + </item> + </terms></synopsis> + <p>This mode is called by <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code> when its <code>format</code> parameter is set to true. It is applied to the elements and text children of the translated message that <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code> finds. This allows you to insert content in format strings, rather than concatenating multiple translations to create a translated message.</p> + <p>By default, this stylesheet provides matching templates in this mode for the elements <code>node</code> and <code>string</code>. The template for <code>node</code> applies templates with no mode to the <code style="xslt-param">node</code> parameters passed to <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code>. The template for <code>string</code> copies the text in the <code style="xslt-param">string</code> parameter passed to <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code>. Both parameters are passed to templates in this mode. Templates matching this mode should pass those parameters to child content if they process child content in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>.</p> + <p>To use format strings in your own translations, use elements with names of your choosing in your message. You can use the <code>node</code> and <code>string</code> elements without further implementation, if they fit your needs. Otherwise, take care to use element names that are unlikely to conflict with other templates using this mode.</p> +</page> diff --git a/doc/yelp-xsl/C/l10n.gettext.page b/doc/yelp-xsl/C/l10n.gettext.page new file mode 100644 index 00000000..81bd9bad --- /dev/null +++ b/doc/yelp-xsl/C/l10n.gettext.page @@ -0,0 +1,51 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.gettext" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-07-29" status="final"/><desc>Look up the translation for a string.</desc></info><title>l10n.gettext</title><p>Look up the translation for a string.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>domain</code></title> + <p>The domain to look up the string in.</p> + </item> + <item> + <title><code>msgid</code></title> + <p>The id of the string to look up, often the string in the C locale.</p> + </item> + <item> + <title><code>lang</code></title> + <p>The locale to use when looking up the translated string.</p> + </item> + <item> + <title><code>number</code></title> + <p>The cardinality for plural-form lookups.</p> + </item> + <item> + <title><code>form</code></title> + <p>The form name for plural-form lookups.</p> + </item> + <item> + <title><code>format</code></title> + <p>Whether to treat the result as a format string.</p> + </item> + <item> + <title><code>node</code></title> + <p>A context node to pass to <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>.</p> + </item> + <item> + <title><code>string</code></title> + <p>A string to pass to <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> for <code>msg:string</code> elements.</p> + </item> + </terms></synopsis> + <p>This template extracts a translated version of a source string. In simple cases, the source string is exactly the string in <code style="xslt-param">msgid</code>, though in more complex cases, the <code style="xslt-param">msgid</code> parameter is a separate unique identifier.</p> + <p>This template looks up the translation in a message catalog file based on the <code style="xslt-param">domain</code> parameter. The file must be in a <code>domains</code> subdirectory relative to the directory holding this stylesheet and be named the same as <code style="xslt-param">domain</code> with the suffix <code>.xml</code>. This template will fail if no such file is found. By default, the domain is <code>yelp-xsl</code> to reference the translations shipped with these stylesheets. Extensions and third-party stylesheets, however, can use this template by installing a file and passing the <code style="xslt-param">domain</code> parameter.</p> + <p>The message catalog file format is designed to work with the XML/PO translation tool <code>itstool</code>, using its join mode to create a single polylingual file. There is no tool to automatically extract messages from XSLT files. You must add messages to the source catalog file when adding translatable strings.</p> + <p>The message catalog file contains a set of <code>msg</code> elements, one for each string that needs translation. Each <code>msg</code> element has an <code>id</code> attribute. It is this attribute that is matched against the <code style="xslt-param">msgid</code> parameter. Each <code>msg</code> element then has one or more <code>msgstr</code> elements, each with an <code>xml:lang</code> attribute. This template tries to find a best match language with the <code style="xslt-param">lang</code> parameter, falling back to a <code>msgstr</code> element with no <code>xml:lang</code> attribute.</p> + <p>In a source message catalog file, put the string to be translated inside a singleton <code>msgstr</code> element in each <code>msg</code> element, without an <code>xml:lang</code> parameter. Add this element even if it is the same as the <code>id</code> attribute of the <code>msg</code> element. These <code>msgstr</code> elements are what <code>itstool</code> uses to create a PO file, and it provides the fallback string when no language matches.</p> + <p>The <code>xml:lang</code> attribute should contain an RFC 3066 language identifier, which is different from the POSIX locale identifiers used by gettext. To accommodate this difference, this stylesheet converts all identifiers to lowercase and replaces the characters <code>_</code>, <code>@</code>, and <code>.</code> with the character <code>-</code>. If it cannot find an exact match, it strips the part after the last <code>-</code> and looks again. It repeats this as long as the identifier contains a <code>-</code> character. If there is still no matching <code>msgstr</code> element, it looks for one with no <code>xml:lang</code> attribute.</p> + <p>Sometimes you have to provide different versions of a string for different cardinalities. While English and many other languages have singular and plural, some languages have no plural forms, while others have as many as six. These stylesheets use a numeric index for plural forms, similarly to gettext. To get the string for a plural, pass the cardinality in the <code style="xslt-param">number</code> parameter. This template gets an index for that number by calling <code style="xslt-template" xref="l10n.plural.form">l10n.plural.form</code>. The plural form index is in the <code style="xslt-param">form</code> parameter. You do not have to pass this parameter. It will be computed automatically based on the <code style="xslt-param">number</code> parameter.</p> + <p>There is currently no support for editing plural forms using the standard PO syntax. Instead, plurals are defined with an XML snippet. Instead of putting the single translated message in the <code>msgstr</code> element, plural messages have <code>msgstr</code> child elements of the <code>msgstr</code> element with the <code>xml:lang</code> attribute. Each of these child <code>msgstr</code> elements has a <code>form</code> attribute that holds the numeric index returned by <code style="xslt-template" xref="l10n.plural.form">l10n.plural.form</code>. Translators must adapt the XML snippet according to the plural rules and forms defined in this stylesheet for their language.</p> + <p>Some translations aren't simple strings, but are instead format strings where certain values are inserted. This template can handle format strings with XML marker elements to signal where values should be substituted. These values cat be the result of applying templates.</p> + <p>To enable format strings, pass set the <code style="xslt-param">format</code> parameter to <code>true()</code>. Instead of just returning the translated string, this template will instead apply templates in the mode <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> to the fragment contained in the <code>msgstr</code> element.</p> + <p>The <code style="xslt-param">node</code> and <code style="xslt-param">string</code> parameters are passed to templates in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>. This stylesheet contains matches in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> for the marker elements <code><string/></code> and <code><node/></code>. The element <code><string/></code> will be replaced by the string value of <code style="xslt-param">string</code>. The element <code><node/></code> will apply templates without a mode to <code style="xslt-param">node</code>. Text nodes are copied to the result in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>.</p> + <p>If you need any other behavior, add elements with any name of your choosing to the format string, then match on those elements in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>. You will be able to use the <code style="xslt-param">node</code> and <code style="xslt-param">string</code> parameters in your template. Try to use a name that is unique.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.plural.form"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="l10n.msgstr.key"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.locale.page b/doc/yelp-xsl/C/l10n.locale.page new file mode 100644 index 00000000..04feb14d --- /dev/null +++ b/doc/yelp-xsl/C/l10n.locale.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.locale" type="topic" style="xslt-param"><info><link type="guide" xref="l10n" group="parameters"/><link type="guide" xref="parameters" group="l10n"/><revision version="3.18" date="2015-08-13" status="final"/><desc>The top-level locale of the document.</desc></info><title>l10n.locale</title><p>The top-level locale of the document.</p> + + + <p>This parameter provides the top-level locale of the document, taken from either the <code>xml:lang</code> or the <code>lang</code> parameter of the root element. It holds the locale exactly as specified in the document, with no normalization.</p> +</page> diff --git a/doc/yelp-xsl/C/l10n.msgstr.key.page b/doc/yelp-xsl/C/l10n.msgstr.key.page new file mode 100644 index 00000000..d02f99be --- /dev/null +++ b/doc/yelp-xsl/C/l10n.msgstr.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.msgstr.key" type="topic" style="xslt-key"><info><link type="guide" xref="l10n" group="keys"/><link type="guide" xref="keys" group="l10n"/><revision version="3.4" date="2012-01-26" status="final"/><desc>Get a translated message from an ID and a language.</desc></info><title>l10n.msgstr.key</title><p>Get a translated message from an ID and a language.</p> + + + <p>This key indexes all message translations in a message catalog file. The elements are indexed by the concatenation of the message id, the string <code>__LC__</code>, and the <code>xml:lang</code> attribute converted to lowercase.</p> +</page> diff --git a/doc/yelp-xsl/C/l10n.number.alphabetic.page b/doc/yelp-xsl/C/l10n.number.alphabetic.page new file mode 100644 index 00000000..371156a1 --- /dev/null +++ b/doc/yelp-xsl/C/l10n.number.alphabetic.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.number.alphabetic" type="topic" style="xslt-template"><info><link type="guide" xref="l10n-numbers" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Formats a number using an alphabetic numbering system</desc></info><title>l10n.number.alphabetic</title><p>Formats a number using an alphabetic numbering system</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>value</code></title> + <p>The numeric value of the number to format</p> + </item> + <item> + <title><code>alphabet</code></title> + <p>A string containing the characters of the alphabet to use</p> + </item> + </terms></synopsis> + <comment><p>Talk about alphabetic numbering systems</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.number.alphabetic"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.number.cjk-ideographic.page b/doc/yelp-xsl/C/l10n.number.cjk-ideographic.page new file mode 100644 index 00000000..5d837441 --- /dev/null +++ b/doc/yelp-xsl/C/l10n.number.cjk-ideographic.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.number.cjk-ideographic" type="topic" style="xslt-template"><info><link type="guide" xref="l10n-numbers" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Formats a number using a CJK ideographic system</desc></info><title>l10n.number.cjk-ideographic</title><p>Formats a number using a CJK ideographic system</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>value</code></title> + <p>The numeric value of the number to format</p> + </item> + <item> + <title><code>format</code></title> + <p>Which ideographic system to use</p> + </item> + </terms></synopsis> + <comment><p>Talk about CJK ideographic numbering systems. Valid values of <code style="xslt-param">format</code> are <code>cjk-japanese</code>, <code>cjk-chinese-simp</code>, and <code>cjk-chinese-trad</code>.</p></comment> +</page> diff --git a/doc/yelp-xsl/C/l10n.number.ionic.page b/doc/yelp-xsl/C/l10n.number.ionic.page new file mode 100644 index 00000000..d50e0a7b --- /dev/null +++ b/doc/yelp-xsl/C/l10n.number.ionic.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.number.ionic" type="topic" style="xslt-template"><info><link type="guide" xref="l10n-numbers" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Formats a number using the Ionic numeral system</desc></info><title>l10n.number.ionic</title><p>Formats a number using the Ionic numeral system</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>value</code></title> + <p>The numeric value of the number to format</p> + </item> + <item> + <title><code>format</code></title> + <p>Which format to use</p> + </item> + </terms></synopsis> + <comment><p>Talk about the Ionic numeral system. Talk about <code style="xslt-param">format</code> See <code>http://en.wikipedia.org/wiki/Greek_numerals</code>.</p></comment> +</page> diff --git a/doc/yelp-xsl/C/l10n.number.numeric.page b/doc/yelp-xsl/C/l10n.number.numeric.page new file mode 100644 index 00000000..be8161ee --- /dev/null +++ b/doc/yelp-xsl/C/l10n.number.numeric.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.number.numeric" type="topic" style="xslt-template"><info><link type="guide" xref="l10n-numbers" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Formats a number using a numeric numbering system with any radix</desc></info><title>l10n.number.numeric</title><p>Formats a number using a numeric numbering system with any radix</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>value</code></title> + <p>The numeric value of the number to format</p> + </item> + <item> + <title><code>digits</code></title> + <p>A string containing the digits to use, starting with zero</p> + </item> + </terms></synopsis> + <comment><p>Talk about numeric numbering systems</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.number.numeric"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.number.page b/doc/yelp-xsl/C/l10n.number.page new file mode 100644 index 00000000..bccd033a --- /dev/null +++ b/doc/yelp-xsl/C/l10n.number.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.number" type="topic" style="xslt-template"><info><link type="guide" xref="l10n-numbers" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Formats a number according to a localized numbering system</desc></info><title>l10n.number</title><p>Formats a number according to a localized numbering system</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>value</code></title> + <p>The numeric value of the number to format</p> + </item> + <item> + <title><code>format</code></title> + <p>The numbering system to use</p> + </item> + </terms></synopsis> + <comment><p>Talk about numbering systems</p></comment> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.number.cjk-ideographic"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/l10n.page b/doc/yelp-xsl/C/l10n.page new file mode 100644 index 00000000..e50ef25b --- /dev/null +++ b/doc/yelp-xsl/C/l10n.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="l10n" type="guide" style="xslt-stylesheet"><?xslt-private l10n.gettext.msg?><?xslt-private l10n.gettext.msgstr?><info><link type="guide" xref="stylesheets" group="l10n"/><revision version="3.18" date="2015-07-24" status="final"/><link type="xslt-defines-template" xref="l10n.gettext"/><link type="xslt-defines-template" xref="l10n.plural.form"/><link type="xslt-defines-template" xref="l10n.direction"/><link type="xslt-defines-template" xref="l10n.align.start"/><link type="xslt-defines-template" xref="l10n.align.end"/><link type="xslt-implements-mode" xref="l10n.format.mode"/><link type="xslt-defines-param" xref="l10n.locale"/></info><title>Localized Strings</title><p>Templates for translated strings, with format strings and plural forms.</p> + + + <p>This stylesheet contains templates for getting localized strings, including format strings and plural forms. Format strings are important for proper localization, as constructing sentences from concatenation often produces poor results in many languages.</p> + <p>By default, the templates in this stylesheet work on the translations shipped with yelp-xsl, but the templates can be reused by yelp-xsl extensions (or even entirely separate stylesheets) by installing XML files with the translations under the domains subdirectory of the directory holding this file. The format of the file is designed to work well with itstool's join mode.</p> + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Keys</title><item><p><link xref="l10n.msgstr.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="l10n.locale"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:node</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:string</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/l10n.plural.form.page b/doc/yelp-xsl/C/l10n.plural.form.page new file mode 100644 index 00000000..75c9429e --- /dev/null +++ b/doc/yelp-xsl/C/l10n.plural.form.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="l10n.plural.form" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-07-29" status="final"/><desc>Extract the plural form index for a given cardinality.</desc></info><title>l10n.plural.form</title><p>Extract the plural form index for a given cardinality.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>number</code></title> + <p>The cardinality of the plural form.</p> + </item> + <item> + <title><code>lang</code></title> + <p>The locale to use when looking up the translated string.</p> + </item> + </terms></synopsis> + <p>This template returns a numeric index of a plural form for a given language, similarly to how indexes are used in gettext PO files. Different languages have different rules for plurals. Some languages have no plurals at all, while others have as many as six different forms. This plural form index is used by <code style="xslt-template" xref="l10n.gettext">l10n.gettext</code> to determine the correct string to use.</p> + <p>The rules in this template are hand-written. They are not taken from the PO files. They are written by referencing the PO files in various GNOME modules, as well as the plural rules in the Unicode CLDR.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="l10n.locale"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal-cache.page b/doc/yelp-xsl/C/mal-cache.page new file mode 100644 index 00000000..87c153d7 --- /dev/null +++ b/doc/yelp-xsl/C/mal-cache.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal-cache" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="topic" xref="mal-link" group="stylesheets"/><link type="xslt-defines-template" xref="mal.cache.id"/><link type="xslt-defines-template" xref="mal.cache.xref"/><link type="xslt-defines-template" xref="mal.cache.info"/></info><title>Mallard Cache Files</title><p>Generate Mallard cache files from cache input files.</p> + + + <p>FIXME</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>/cache:cache</code></p></td></tr><tr><td><p/></td><td><p><code>mal:page</code></p></td></tr><tr><td><p/></td><td><p><code>mal:section</code></p></td></tr><tr><td><p/></td><td><p><code>mal:title</code></p></td></tr><tr><td><p/></td><td><p><code>node() | text()</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal-gloss.page b/doc/yelp-xsl/C/mal-gloss.page new file mode 100644 index 00000000..5ae894cc --- /dev/null +++ b/doc/yelp-xsl/C/mal-gloss.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal-gloss" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal.gloss.match"/><link type="xslt-defines-template" xref="mal.gloss.terms"/></info><title>Mallard Glossaries</title><p>Common templates for the Mallard Glossary extension.</p> + + + <p>This stylesheet contains utility templates for locating and linking to terms with the Mallard Glossary extension.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal-if.page b/doc/yelp-xsl/C/mal-if.page new file mode 100644 index 00000000..8e5f4397 --- /dev/null +++ b/doc/yelp-xsl/C/mal-if.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal-if" type="guide" style="xslt-stylesheet"><?xslt-private _mal.if.test.check_token?><?xslt-private _mal.if.test.flatten_token?><info><link type="guide" xref="stylesheets" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-template" xref="mal.if.test"/><link type="xslt-defines-param" xref="mal.if.target"/><link type="xslt-defines-param" xref="mal.if.platform"/><link type="xslt-defines-param" xref="mal.if.features"/><link type="xslt-defines-param" xref="mal.if.custom"/><link type="xslt-defines-param" xref="mal.if.maybe"/></info><title>Mallard Conditionals</title><p>Support for run-time conditional processing.</p> + + + <p>This stylesheet contains utilities for handling conditional processing in Mallard documents.</p> + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.if.custom"/></p></item><item><p><link xref="mal.if.features"/></p></item><item><p><link xref="mal.if.maybe"/></p></item><item><p><link xref="mal.if.platform"/></p></item><item><p><link xref="mal.if.target"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal-link.page b/doc/yelp-xsl/C/mal-link.page new file mode 100644 index 00000000..8a17487a --- /dev/null +++ b/doc/yelp-xsl/C/mal-link.page @@ -0,0 +1,56 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal-link" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><link type="xslt-defines-template" xref="mal.link.linkid"/><link type="xslt-defines-template" xref="mal.link.xref.linkid"/><link type="xslt-defines-template" xref="mal.link.content"/><link type="xslt-defines-template" xref="mal.link.content.custom"/><link type="xslt-defines-template" xref="mal.link.desc"/><link type="xslt-defines-template" xref="mal.link.desc.custom"/><link type="xslt-defines-template" xref="mal.link.tooltip"/><link type="xslt-defines-template" xref="mal.link.tooltip.custom"/><link type="xslt-defines-template" xref="mal.link.target"/><link type="xslt-defines-template" xref="mal.link.target.custom"/><link type="xslt-defines-template" xref="mal.link.guidelinks"/><link type="xslt-defines-template" xref="mal.link.topiclinks"/><link type="xslt-defines-template" xref="mal.link.seealsolinks"/><link type="xslt-defines-template" xref="mal.link.linktrails"/><link type="xslt-defines-template" xref="mal.link.facetlinks"/><link type="xslt-defines-template" xref="mal.link.sorttitle"/><link type="xslt-implements-mode" xref="mal.link.content.mode"/><link type="xslt-defines-param" xref="mal.cache.file"/><link type="xslt-defines-param" xref="mal.cache"/><link type="xslt-defines-param" xref="mal.link.prefix"/><link type="xslt-defines-param" xref="mal.link.extension"/><link type="xslt-defines-param" xref="mal.link.default_root"/></info><title>Mallard Links</title><p>Common linking utilities for Mallard documents.</p> + + + <p>This stylesheet contains various utilities for handling links in Mallard documents. The templates in this stylesheet make it easier to handle the different linking mechanisms in Mallard, including the dynamic automatic linking systems.</p> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="utils.email_address"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item><item><p><link xref="mal.facet.all.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item><item><p><link xref="mal.cache.file"/></p></item><item><p><link xref="mal.link.default_root"/></p></item><item><p><link xref="mal.link.extension"/></p></item><item><p><link xref="mal.link.prefix"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal.link.content.mode">mal.link.content.mode</link></p></td><td><p><code>* | text()</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal-sort.page b/doc/yelp-xsl/C/mal-sort.page new file mode 100644 index 00000000..89aab5c4 --- /dev/null +++ b/doc/yelp-xsl/C/mal-sort.page @@ -0,0 +1,10 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal-sort" type="guide" style="xslt-stylesheet"><?xslt-private _mal.sort.tsort.node?><?xslt-private _mal.sort.getgroups?><info><link type="guide" xref="stylesheets" group="mal"/><revision status="incomplete" version="1.0" date="2010-07-08"/><link type="xslt-requires" xref="mal-link"/><link type="xslt-defines-template" xref="mal.sort.tsort"/></info><title>Mallard Topological Sort</title><p>Sort a Mallard document.</p> + + + <p>This stylesheet contains utilities for sorting the pages in a Mallard document based on their informational links.</p> + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Requires Stylesheets</title><item><p><link xref="mal-link"/></p></item></list><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="mal.link.topiclinks"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item><item><p><link xref="mal.link.default_root"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.cache.file.page b/doc/yelp-xsl/C/mal.cache.file.page new file mode 100644 index 00000000..1ce07eda --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.file.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.file" type="topic" style="xslt-param"><info><link type="guide" xref="mal-link" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.0" date="2010-01-02" status="final"/><desc>The location of the cache file.</desc></info><title>mal.cache.file</title><p>The location of the cache file.</p> + + + <p>In order to locate and process links between pages, this stylesheet requires a Mallard cache file. Use this parameter to pass the path to a valid cache file.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.cache.id.page b/doc/yelp-xsl/C/mal.cache.id.page new file mode 100644 index 00000000..a88ea4a6 --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.id.page @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.id" type="topic" style="xslt-template"><info><link type="guide" xref="mal-cache" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc/></info><title>mal.cache.id</title> + + +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.cache.info.page b/doc/yelp-xsl/C/mal.cache.info.page new file mode 100644 index 00000000..628ccf2d --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.info.page @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.info" type="topic" style="xslt-template"><info><link type="guide" xref="mal-cache" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc/></info><title>mal.cache.info</title> + + +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.cache.xref"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.cache.key.page b/doc/yelp-xsl/C/mal.cache.key.page new file mode 100644 index 00000000..b1b414df --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.key.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.key" type="topic" style="xslt-key"><info><link type="guide" xref="mal-link" group="keys"/><link type="guide" xref="keys" group="mal"/><revision version="3.4" date="2012-01-25" status="final"/><desc>Get a page or section from the <code>id</code> attribute.</desc></info><title>mal.cache.key</title><p>Get a page or section from the <code>id</code> attribute.</p> + + + <p>This key returns a <code>page</code> or <code>section</code> element from a Mallard cache file from the <code>id</code> attribute. In cache files, the <code>id</code> attribute of <code>section</code> elements is set to a qualified ID by prefixing it with the containing page ID and the hash character.</p> + <p>The context node must be in the document <code style="xslt-param" xref="mal.cache">mal.cache</code> when this key is called.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.cache.link.key.page b/doc/yelp-xsl/C/mal.cache.link.key.page new file mode 100644 index 00000000..5d51c5a0 --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.link.key.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.link.key" type="topic" style="xslt-key"><info><link type="guide" xref="mal-link" group="keys"/><link type="guide" xref="keys" group="mal"/><revision version="3.4" date="2012-01-25" status="final"/><desc>Get <code>link</code> elements from a link type and <code>xref</code> attribute.</desc></info><title>mal.cache.link.key</title><p>Get <code>link</code> elements from a link type and <code>xref</code> attribute.</p> + + + <p>This key returns all <code>link</code> elements from a Mallard cache file from the <code>type</code> and <code>xref</code> attributes. They key is the concatenation of the <code>type</code> attribute, the colon character, and the <code>xref</code> attribute. Only <code>link</code> elements with both a <code>type</code> and <code>xref</code> attribute are supported.</p> + <p>The context node must be in the document <code style="xslt-param" xref="mal.cache">mal.cache</code> when this key is called.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.cache.page b/doc/yelp-xsl/C/mal.cache.page new file mode 100644 index 00000000..f9314b2d --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache" type="topic" style="xslt-param"><info><link type="guide" xref="mal-link" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.0" date="2010-01-02" status="final"/><desc>The cache document as a node set.</desc></info><title>mal.cache</title><p>The cache document as a node set.</p> + + + <p>This parameter points to the root <code>cache:cache</code> element of a Mallard cache document. By default, it selects the root element from the file provided in <code style="xslt-param" xref="mal.cache.file">mal.cache.file</code>.</p> + <p>Some processing tools may create a Mallard cache document without outputting it to a file. Those tools can use this parameter directly.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.cache.xref.page b/doc/yelp-xsl/C/mal.cache.xref.page new file mode 100644 index 00000000..90015252 --- /dev/null +++ b/doc/yelp-xsl/C/mal.cache.xref.page @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.cache.xref" type="topic" style="xslt-template"><info><link type="guide" xref="mal-cache" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc/></info><title>mal.cache.xref</title> + + +</page> diff --git a/doc/yelp-xsl/C/mal.facet.all.key.page b/doc/yelp-xsl/C/mal.facet.all.key.page new file mode 100644 index 00000000..3ffd8fca --- /dev/null +++ b/doc/yelp-xsl/C/mal.facet.all.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.facet.all.key" type="topic" style="xslt-key"><info><link type="guide" xref="mal-link" group="keys"/><link type="guide" xref="keys" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Get all <code>page</code> and <code>section</code> elements with <code>facet:tag</code> elements.</desc></info><title>mal.facet.all.key</title><p>Get all <code>page</code> and <code>section</code> elements with <code>facet:tag</code> elements.</p> + + + <p>This key returns all <code>page</code> and <code>section</code> elements that have at least one <code>facet:tag</code> element in their <code>info</code> element. Pass the emptry string as the key argument.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.gloss.key.page b/doc/yelp-xsl/C/mal.gloss.key.page new file mode 100644 index 00000000..70dd991c --- /dev/null +++ b/doc/yelp-xsl/C/mal.gloss.key.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.gloss.key" type="topic" style="xslt-key"><info><link type="guide" xref="mal-gloss" group="keys"/><link type="guide" xref="keys" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Get a <code>gloss:term</code> element from its <code>id</code> attribute.</desc></info><title>mal.gloss.key</title><p>Get a <code>gloss:term</code> element from its <code>id</code> attribute.</p> + + + <p>This key returns <code>gloss:term</code> elements based on their <code>id</code> attribute. This key only applies to elements inside a cache file. Make sure to make the cache file the context document before calling this key.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.gloss.match.page b/doc/yelp-xsl/C/mal.gloss.match.page new file mode 100644 index 00000000..03f3cd8d --- /dev/null +++ b/doc/yelp-xsl/C/mal.gloss.match.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.gloss.match" type="topic" style="xslt-template"><info><link type="guide" xref="mal-gloss" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Determine whether a glossary term matches a criterion.</desc></info><title>mal.gloss.match</title><p>Determine whether a glossary term matches a criterion.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>match</code></title> + <p>A <code>gloss:match</code> element containing criteria.</p> + </item> + <item> + <title><code>term</code></title> + <p>A <code>gloss:term</code> element to attempt to match.</p> + </item> + </terms></synopsis> + <p>This template determines whether a glossary term matches a condition, as given by a <code>gloss:match</code> element. If the term matches, an empty string is output. Otherwise, a non-empty string is output.</p> + <p>To determine if a term matches a set of matches, call this template for each <code>gloss:match</code> element, then check if the concatenated result is empty.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.gloss.terms.page b/doc/yelp-xsl/C/mal.gloss.terms.page new file mode 100644 index 00000000..569df7a7 --- /dev/null +++ b/doc/yelp-xsl/C/mal.gloss.terms.page @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.gloss.terms" type="topic" style="xslt-template"><info><link type="guide" xref="mal-gloss" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Output the glossary terms for a page or section.</desc></info><title>mal.gloss.terms</title><p>Output the glossary terms for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The glossary <code>page</code> or <code>section</code> to output terms for.</p> + </item> + </terms></synopsis> + <p>This template outputs the terms that should be displayed for <code style="xslt-param">node</code>.This output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them. This template locates all terms throughout all pages and filters them based on any <code>gloss:match</code> elements in the <code>info</code> child of <code style="xslt-param">node</code>, and also excludes terms that are matched by child sections of <code style="xslt-param">node</code>.</p> + <p>The filtered terms are then grouped by matching ID. For each unique ID, this template outputs a <code>gloss:term</code> element with the corresponding <code>id</code> attribute. Each of these elements contains <code>title</code> elements reflecting the titles in the actual term definitions. These titles have duplicates removed, compared by the space-normalized string value, and are sorted.</p> + <p>These <code>gloss:term</code> elements then contain further <code>gloss:term</code> elements, which are copies of the actual terms with the same ID. These elements have an <code>xref</code> attribute added containing the ID of the containing page.</p> + <p>The top-level <code>gloss:term</code> elements and the <code>gloss:term</code> elements they contain are not sorted. Only the <code>title</code> elements in the top-level <code>gloss:term</code> elements are sorted.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.gloss.match"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.if.custom.page b/doc/yelp-xsl/C/mal.if.custom.page new file mode 100644 index 00000000..c4d75692 --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.custom.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.custom" type="topic" style="xslt-param"><info><link type="guide" xref="mal-if" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>A custom list of supported tokens.</desc></info><title>mal.if.custom</title><p>A custom list of supported tokens.</p> + + + <p>This parameter takes a space-separated list of tokens to enable for conditional processing. It is used by the template <code style="xslt-template" xref="mal.if.test">mal.if.test</code>. This parameter is meant to hold extra values enabled by hand or by a customization stylesheet.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.if.features.page b/doc/yelp-xsl/C/mal.if.features.page new file mode 100644 index 00000000..263daca2 --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.features.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.features" type="topic" style="xslt-param"><info><link type="guide" xref="mal-if" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>The list of supported feature tokens.</desc></info><title>mal.if.features</title><p>The list of supported feature tokens.</p> + + + <p>This parameter takes a space-separated list of tokens to enable for conditional processing. It is used by the template <code style="xslt-template" xref="mal.if.test">mal.if.test</code>. This parameter is meant to hold tokens that specify the capabilities of these stylesheets. It should usually be set by the primary importing stylesheet.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.if.maybe.page b/doc/yelp-xsl/C/mal.if.maybe.page new file mode 100644 index 00000000..f97b8e91 --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.maybe.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.maybe" type="topic" style="xslt-param"><info><link type="guide" xref="mal-if" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>A list of tokens that may be true.</desc></info><title>mal.if.maybe</title><p>A list of tokens that may be true.</p> + + + <p>This parameter takes a space-separated list of tokens that may be true. The template <code style="xslt-template" xref="mal.if.test">mal.if.test</code> returns special flags when a condition may be true, allowing conditional processing to be deferred (for example, to CSS media selectors). This parameter should usually be set by the primary importing stylesheet.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.if.platform.page b/doc/yelp-xsl/C/mal.if.platform.page new file mode 100644 index 00000000..e96261a0 --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.platform.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.platform" type="topic" style="xslt-param"><info><link type="guide" xref="mal-if" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>The list of supported platform tokens.</desc></info><title>mal.if.platform</title><p>The list of supported platform tokens.</p> + + + <p>This parameter takes a space-separated list of tokens to enable for conditional processing. It is used by the template <code style="xslt-template" xref="mal.if.test">mal.if.test</code>. This parameter is meant to hold tokens starting with <code>platform:</code>. It should usually be set by hand or by a customization stylesheet.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.if.target.page b/doc/yelp-xsl/C/mal.if.target.page new file mode 100644 index 00000000..5eb37b99 --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.target.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.target" type="topic" style="xslt-param"><info><link type="guide" xref="mal-if" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>The list of supported target tokens.</desc></info><title>mal.if.target</title><p>The list of supported target tokens.</p> + + + <p>This parameter takes a space-separated list of tokens to enable for conditional processing. It is used by the template <code style="xslt-template" xref="mal.if.test">mal.if.test</code>. This parameter is meant to hold tokens starting with <code>target:</code>. It should usually be set by the primary importing stylesheet.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.if.test.page b/doc/yelp-xsl/C/mal.if.test.page new file mode 100644 index 00000000..d8e4d11b --- /dev/null +++ b/doc/yelp-xsl/C/mal.if.test.page @@ -0,0 +1,19 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.if.test" type="topic" style="xslt-template"><info><link type="guide" xref="mal-if" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Test if a condition is true.</desc></info><title>mal.if.test</title><p>Test if a condition is true.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element to check the condition for.</p> + </item> + <item> + <title><code>test</code></title> + <p>The test expression.</p> + </item> + </terms></synopsis> + <p>This template evaluates the test expression <code style="xslt-param">test</code>, which is taken automatically from the <code>test</code> or <code>if:test</code> attribute of $node. It splits the expression on commas into subexpressions, then splits each subexpression on spaces into tokens. A token is taken to be true if it's in one of the space-separated lists from <code style="xslt-param" xref="mal.if.target">mal.if.target</code>, <code style="xslt-param" xref="mal.if.platform">mal.if.platform</code>, <code style="xslt-param" xref="mal.if.features">mal.if.features</code>, or <code style="xslt-param" xref="mal.if.custom">mal.if.custom</code>. If the token starts with an exclamation point, the exclamation point is stripped and the resulting truth value is negated.</p> + <p>A subexpression is true if all its tokens is true. The full test expression is true if any subexpression is true. If the test expression is true, the literal string <code>'true'</code> is returned. If the test expression is false, the empty string is returned.</p> + <p>This template can handle "maybe" values: tokens that may or may not be true, and whose truth values are deferred to post-transform time. A token is maybe if it appears in the space-separated list <code style="xslt-param" xref="mal.if.maybe">mal.if.maybe</code>. If a subexpression contains a maybe value and does not contain any false tokens, its truth value is a special string constructed from the maybe tokens and starting with the string <code>if__</code>. If any subexpressions are maybe and none of the subexpressions are false, the return value is a space-separated list of the maybe strings.</p> + <p>Maybe tokens usually must be handled specifically by the importing stylesheet. It's usually not sufficient to just add a token to <code style="xslt-param" xref="mal.if.maybe">mal.if.maybe</code>. This template will handle any maybe token, but it does not handle the actual logic of dynamically showing or hiding content based on those tokens.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.content.custom.page b/doc/yelp-xsl/C/mal.link.content.custom.page new file mode 100644 index 00000000..f0451e80 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.content.custom.page @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.content.custom" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><link type="guide" xref="stubs" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the content for a custom <code>link</code> element.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal.link.content.custom</title><p>Output the content for a custom <code>link</code> element.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal.link.content">mal.link.content</code> to create content for custom links. Use this template to support the <code>action</code> attribute or extended <code>xref</code> attributes containing slash or colon characters.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.content.mode.page b/doc/yelp-xsl/C/mal.link.content.mode.page new file mode 100644 index 00000000..efb7d859 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.content.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.content.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal-link" group="modes"/><link type="guide" xref="modes" group="mal"/><revision version="3.0" date="2010-01-02" status="final"/><desc>Output the content for a link from the contents of a <code>title</code> element.</desc></info><title>mal.link.content.mode</title><p>Output the content for a link from the contents of a <code>title</code> element.</p> + + + <p>This mode is applied to the contents of a <code>title</code> element by <code style="xslt-template" xref="mal.link.content">mal.link.content</code>. By default, it returns the string value of its input. Stylesheets that use <code style="xslt-template" xref="mal.link.content">mal.link.content</code> should map this mode to inline processing.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.content.page b/doc/yelp-xsl/C/mal.link.content.page new file mode 100644 index 00000000..e10d3943 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.content.page @@ -0,0 +1,36 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.content" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the content for a <code>link</code> element.</desc></info><title>mal.link.content</title><p>Output the content for a <code>link</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template outputs the automatic text content for a link. It should only be used for links that do not have specified content. If <code style="xslt-param">xref</code> points to a valid page or section, the appropriate link title from that page or section will be selected, based on the list of roles in <code style="xslt-param">role</code>. The first role for which a matching link title is found will be used. Otherwise, the link title without a role is used, or the primary title. The <code style="xslt-mode" xref="mal.link.content.mode">mal.link.content.mode</code> mode is applied to the contents of that title. Stylesheets using this template should map that mode to inline processing.</p> + <p>For inline links, <code style="xslt-param">node</code> should be the <code>link</code> element. For links from a <code>links</code> element, <code style="xslt-param">node</code> should be that <code>links</code> element, or the containing element when the <code>links</code> element is implicit.</p> + <p>This template first calls <code style="xslt-template" xref="mal.link.content.custom">mal.link.content.custom</code> with the same arguments. If that template returns a non-empty result, it is used as the return value, overriding any other behavior of this template.</p> + <p>If only <code style="xslt-param">href</code> is provided, that URL is used as the text content. If a target page or section cannot be found, <code style="xslt-param">xref</code> is used as the text content.</p> + <p>Normally, this template automatically looks up information from a targret node according to the <code style="xslt-param">xref</code> parameter. However, if the <code style="xslt-param">info</code> parameter is given, information in that node set is used instead. This is useful for external info links, where the target information is provided as child elements to the <code>link</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.content.custom"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal.link.content.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.default_root.page b/doc/yelp-xsl/C/mal.link.default_root.page new file mode 100644 index 00000000..1b638cb6 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.default_root.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.default_root" type="topic" style="xslt-param"><info><link type="guide" xref="mal-link" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><desc>The default root ID.</desc></info><title>mal.link.default_root</title><p>The default root ID.</p> + + + <p>This parameter provides the default ID for the page that is taken to be the root of the document. By default, <code>'index'</code> is used. This should not be changed for normal Mallard documents. It may be necessary to change it for some Mallard extension formats.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.desc.custom.page b/doc/yelp-xsl/C/mal.link.desc.custom.page new file mode 100644 index 00000000..deba83bb --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.desc.custom.page @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.desc.custom" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><link type="guide" xref="stubs" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the desc content for a custom <code>link</code> element.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal.link.desc.custom</title><p>Output the desc content for a custom <code>link</code> element.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal.link.desc">mal.link.desc</code> to create content for custom links. Use this template to support the <code>action</code> attribute or extended <code>xref</code> attributes containing slash or colon characters.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.desc.page b/doc/yelp-xsl/C/mal.link.desc.page new file mode 100644 index 00000000..2685074f --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.desc.page @@ -0,0 +1,35 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.desc" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the desc content for a <code>link</code> element.</desc></info><title>mal.link.desc</title><p>Output the desc content for a <code>link</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate desc.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template outputs the secondary desc text content for a link. If <code style="xslt-param">xref</code> points to a valid page or section, the desc from that page or section will be used. The <code style="xslt-mode" xref="mal.link.content.mode">mal.link.content.mode</code> mode is applied to the contents of that desc. Stylesheets using this template should map that mode to inline processing.</p> + <p>For inline links, <code style="xslt-param">node</code> should be the <code>link</code> element. For links from a <code>links</code> element, <code style="xslt-param">node</code> should be that <code>links</code> element, or the containing element when the <code>links</code> element is implicit.</p> + <p>This template first calls <code style="xslt-template" xref="mal.link.desc.custom">mal.link.desc.custom</code> with the same arguments. If that template returns a non-empty result, it is used as the return value, overriding any other behavior of this template.</p> + <p>Normally, this template automatically looks up information from a targret node according to the <code style="xslt-param">xref</code> parameter. However, if the <code style="xslt-param">info</code> parameter is given, information in that node set is used instead. This is useful for external info links, where the target information is provided as child elements to the <code>link</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.desc.custom"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal.link.content.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.extension.page b/doc/yelp-xsl/C/mal.link.extension.page new file mode 100644 index 00000000..e6cf6a69 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.extension.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.extension" type="topic" style="xslt-param"><info><link type="guide" xref="mal-link" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><desc>The filename extension for output files.</desc></info><title>mal.link.extension</title><p>The filename extension for output files.</p> + + + <p>When link targets are constructed by <code style="xslt-template" xref="mal.link.target">mal.link.target</code> from <code>xref</code> attributes, this string is appended. This is used to specify the file extension when creating output files from Mallard pages.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.facetlinks.page b/doc/yelp-xsl/C/mal.link.facetlinks.page new file mode 100644 index 00000000..59f61dac --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.facetlinks.page @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.facetlinks" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.0" date="2010-12-16" status="final"/><desc>Output the facet links for a facets page or section.</desc></info><title>mal.link.facetlinks</title><p>Output the facet links for a facets page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + </terms></synopsis> + <p>This template outputs all the facet links for facets page or section. Links are output for each page or section that matches all <code>facet:match</code> elements from <code style="xslt-param">node</code>, excluding those which will be included in descendant facets nodes. It outputs each of the links as a <code>link</code> element within the Mallard namespace. Each <code>link</code> element has an <code>xref</code> attribute pointing to the target page or section.</p> + <p>Each <code>link</code> element contains a <code>title</code> with <code>type="sort"</code> providing the sort title of the target page or section. The results are not sorted when returned from this template. Use <code>xsl:sort</code> on the sort titles to sort the results.</p> + <p>Each <code>link</code> element contains a copy of all the <code>facet:tag</code> elements from the <code>info</code> element of the target page or section.</p> + <p>The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.sorttitle"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.facet.all.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.guidelinks.page b/doc/yelp-xsl/C/mal.link.guidelinks.page new file mode 100644 index 00000000..b7b3e971 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.guidelinks.page @@ -0,0 +1,19 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.guidelinks" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-07" status="final"/><desc>Output the guide links for a page or section.</desc></info><title>mal.link.guidelinks</title><p>Output the guide links for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title, default <code>"guide"</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs all the guide links for a page or section, whether declared as guide links in the page or section or as topic links from another guide page. It outputs each of the links as a <code>link</code> element within the Mallard namespace. Each <code>link</code> element has an <code>xref</code> attribute pointing to the target page or section. Or, in the case of external links, the <code>link</code> element has an <code>href</code> attribute pointing to the external resource.</p> + <p>Each <code>link</code> element contains a <code>title</code> with <code>type="sort"</code> providing the sort title of the target page or section. The <code style="xslt-param">role</code> attribute is used to select a link title to sort on when a sort title is not present. The results are not sorted when returned from this template. Use <code>xsl:sort</code> on the sort titles to sort the results.</p> + <p>When a link comes from a guide link on <code style="xslt-param">node</code> that has an <code>href</code> attribute but not an <code>xref</code> attribute, it is taken to be an external link. In that case, the output link has an <code>href</code> attribute instead of an <code>xref</code> attribute, and it has an <code>info</code> child element. This element has a copy of all the child elements of the source <code>link</code> element.</p> + <p>The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="mal.link.sorttitle"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.linkid.page b/doc/yelp-xsl/C/mal.link.linkid.page new file mode 100644 index 00000000..c7b5227d --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.linkid.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.linkid" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.0" date="2010-01-02" status="final"/><desc>Output the fully qualified link ID for a page or section.</desc></info><title>mal.link.linkid</title><p>Output the fully qualified link ID for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate a link ID for.</p> + </item> + </terms></synopsis> + <p>This template outputs the fully qualified link ID for a page or section. For <code>page</code> elements, the link ID is identical to the ID. For <code>section</code> elements, however, the link ID is the containing page ID and the section ID, joined with the <code>#</code> character.</p> + <p>The link ID is used in Mallard cache files to ensure all <code>id</code> attributes are unique. All of the templates in this stylesheet that use a link ID use this template or <code style="xslt-template" xref="mal.link.xref.linkid">mal.link.xref.linkid</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.linktrails.page b/doc/yelp-xsl/C/mal.link.linktrails.page new file mode 100644 index 00000000..3bc05520 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.linktrails.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.linktrails" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.4" date="2012-01-18" status="final"/><desc>Output link trails for a page or section.</desc></info><title>mal.link.linktrails</title><p>Output link trails for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + <item> + <title><code>trail</code></title> + <p>The link trail leading to <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>root</code></title> + <p>The ID of the root page.</p> + </item> + </terms></synopsis> + <p>This template outputs lists of links, where each list is a path of topic links that leads to <code style="xslt-param">node</code>. Each link list is output as a <code>link</code> element in the Mallard namespace with an <code>xref</code> attribute pointing to the target page or section. Each <code>link</code> has a <code>title</code> element with <code>type="sort"</code> providing the sort title of the target page or section.</p> + <p>Each <code>link</code> element may also contain another <code>link</code> element providing the next link in the trail. Each of these links also contains a sort titles and may also contain another link.</p> + <p>The results are not sorted when returned from this template. Use <code>xsl:sort</code> on the nested sort titles to sort the results. The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> + <p>This template calls itself recursively. It finds the guide links for <code style="xslt-param">node</code> using <code style="xslt-template" xref="mal.link.guidelinks">mal.link.guidelinks</code>. It then calls <code style="xslt-template" xref="mal.link.linktrails">mal.link.linktrails</code> on each guide, wrapping <code style="xslt-param">trail</code> with a link to the guide as the new <code style="xslt-param">trail</code> parameter.</p> + <p>If there are no guide links for <code style="xslt-param">node</code> and <code style="xslt-param">node</code> is a <code>section</code> element, this template calls itself on the containing page, wrapping <code style="xslt-param">trails</code> with a link to that page. This <code>link</code> element has the attribute <code>child="section"</code> to indicate the link from it to its child is not a topic link.</p> + <p>Recursion stops when the ID of <code style="xslt-param">node</code> is <code style="xslt-param">root</code>. Link trails are only output if they reach <code style="xslt-param">root</code>, which is <code style="xslt-param" xref="mal.link.default_root">mal.link.default_root</code> by default.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.guidelinks"/></p></item><item><p><link xref="mal.link.linktrails"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item><item><p><link xref="mal.link.default_root"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.prefix.page b/doc/yelp-xsl/C/mal.link.prefix.page new file mode 100644 index 00000000..33191851 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.prefix.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.prefix" type="topic" style="xslt-param"><info><link type="guide" xref="mal-link" group="parameters"/><link type="guide" xref="parameters" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><desc>A prefix for link targets.</desc></info><title>mal.link.prefix</title><p>A prefix for link targets.</p> + + + <p>When link targets are constructed by <code style="xslt-template" xref="mal.link.target">mal.link.target</code> from <code>xref</code> attributes, this string is prepended. This can be used, for example, to specify absolute directories or URLs.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.seealsolinks.page b/doc/yelp-xsl/C/mal.link.seealsolinks.page new file mode 100644 index 00000000..f1ad9419 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.seealsolinks.page @@ -0,0 +1,19 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.seealsolinks" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-07" status="final"/><desc>Output the see-also links for a page or section.</desc></info><title>mal.link.seealsolinks</title><p>Output the see-also links for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title, default <code>"seealso"</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs all the see-also links for a page or section, whether declared in the page or section or in another page or section. It outputs each of the links as a <code>link</code> element within the Mallard namespace. Each <code>link</code> element has an <code>xref</code> attribute pointing to the target page or section. Or, in the case of external links, the <code>link</code> element has an <code>href</code> attribute pointing to the external resource.</p> + <p>Each <code>link</code> element contains a <code>title</code> with <code>type="sort"</code> providing the sort title of the target page or section. The <code style="xslt-param">role</code> attribute is used to select a link title to sort on when a sort title is not present. The results are not sorted when returned from this template. Use <code>xsl:sort</code> on the sort titles to sort the results.</p> + <p>When a link comes from a topic link on <code style="xslt-param">node</code> that has an <code>href</code> attribute but not an <code>xref</code> attribute, it is taken to be an external link. In that case, the output link has an <code>href</code> attribute instead of an <code>xref</code> attribute, and it has an <code>info</code> child element. This element has a copy of all the child elements of the source <code>link</code> element.</p> + <p>The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="mal.link.sorttitle"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.sorttitle.page b/doc/yelp-xsl/C/mal.link.sorttitle.page new file mode 100644 index 00000000..5bc8ea3c --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.sorttitle.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.sorttitle" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.10" date="2013-07-30" status="final"/><desc>Output the sort title for a page or section.</desc></info><title>mal.link.sorttitle</title><p>Output the sort title for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to output a sort title for.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + </terms></synopsis> + <p>This template returns a sort title for a page or section as a normalized string. If <code style="xslt-param">node</code> defines a sort title in its <code>info</code> element, the value of that title is always used first. Otherwise, if <code style="xslt-param">role</code> is defined and <code style="xslt-param">node</code> has a link title with a matching role, that title is used. Otherwise, if <code style="xslt-param">node</code> has a link title with no role, that title is used. Otherwise, the primary title is used.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.target.custom.page b/doc/yelp-xsl/C/mal.link.target.custom.page new file mode 100644 index 00000000..43e6cd12 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.target.custom.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.target.custom" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><link type="guide" xref="stubs" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><desc>Output the target URL for an element with <code>action</code> or extended <code>xref</code> attributes.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal.link.target.custom</title><p>Output the target URL for an element with <code>action</code> or extended <code>xref</code> attributes.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal.link.target">mal.link.target</code> to create URLs for custom links. Use this template to support the <code>action</code> attribute or extended <code>xref</code> attributes containing slash or colon characters.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.target.page b/doc/yelp-xsl/C/mal.link.target.page new file mode 100644 index 00000000..bfe1a789 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.target.page @@ -0,0 +1,26 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.target" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.4" date="2012-01-17" status="final"/><desc>Output the target URL for a <code>link</code> or other linking element.</desc></info><title>mal.link.target</title><p>Output the target URL for a <code>link</code> or other linking element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs a URL for a <code>link</code> element or another element using linking attributes. If <code style="xslt-param">xref</code> points to a valid page or section, it uses a file name based on the ID of the target page plus <code style="xslt-param" xref="mal.link.extension">mal.link.extension</code>. Otherwise, the link will point to <code style="xslt-param">href</code>.</p> + <p>For inline links, <code style="xslt-param">node</code> should be the <code>link</code> element. For links from a <code>links</code> element, <code style="xslt-param">node</code> should be that <code>links</code> element, or the containing element when the <code>links</code> element is implicit.</p> + <p>This template first calls <code style="xslt-template" xref="mal.link.target.custom">mal.link.target.custom</code> with the same arguments. If that template returns a non-empty string, it is used as the return value, overriding any other behavior of this template.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.target.custom"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.link.extension"/></p></item><item><p><link xref="mal.link.prefix"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.tooltip.custom.page b/doc/yelp-xsl/C/mal.link.tooltip.custom.page new file mode 100644 index 00000000..0f180cd5 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.tooltip.custom.page @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.tooltip.custom" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><link type="guide" xref="stubs" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output a tooltip for a custom <code>link</code> element.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal.link.tooltip.custom</title><p>Output a tooltip for a custom <code>link</code> element.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal.link.tooltip">mal.link.tooltip</code> to create tooltips for custom links. Use this template to support the <code>action</code> attribute or extended <code>xref</code> attributes containing slash or colon characters.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.link.tooltip.page b/doc/yelp-xsl/C/mal.link.tooltip.page new file mode 100644 index 00000000..33583564 --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.tooltip.page @@ -0,0 +1,36 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.tooltip" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output a tooltip for a <code>link</code> element.</desc></info><title>mal.link.tooltip</title><p>Output a tooltip for a <code>link</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>link</code> or other element creating the link.</p> + </item> + <item> + <title><code>action</code></title> + <p>The <code>action</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>href</code></title> + <p>The <code>href</code> attribute of <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>info</code></title> + <p>An <code>info</code> element that overrides the info found in a target node.</p> + </item> + </terms></synopsis> + <p>This template outputs a text-only tooltip for a link. If <code style="xslt-param">xref</code> points to a valid page or section, the text title from that page or section will be used. If the target does not specify a text title, the primary title is used.</p> + <p>For inline links, <code style="xslt-param">node</code> should be the <code>link</code> element. For links from a <code>links</code> element, <code style="xslt-param">node</code> should be that <code>links</code> element, or the containing element when the <code>links</code> element is implicit.</p> + <p>This template first calls <code style="xslt-template" xref="mal.link.tooltip.custom">mal.link.tooltip.custom</code> with the same arguments. If that template returns a non-empty string, it is used as the return value, overriding any other behavior of this template.</p> + <p>If only <code style="xslt-param">href</code> is provided, that URL is used as the tooltip. If a target page or section cannot be found, <code style="xslt-param">xref</code> is used as the text content. Special tooltips may be provided for certain URI schemes.</p> + <p>Normally, this template automatically looks up information from a targret node according to the <code style="xslt-param">xref</code> parameter. However, if the <code style="xslt-param">info</code> parameter is given, information in that node set is used instead. This is useful for external info links, where the target information is provided as child elements to the <code>link</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.tooltip.custom"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="utils.email_address"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.topiclinks.page b/doc/yelp-xsl/C/mal.link.topiclinks.page new file mode 100644 index 00000000..271ac00e --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.topiclinks.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.topiclinks" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the topic links for a page or section.</desc></info><title>mal.link.topiclinks</title><p>Output the topic links for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + <item> + <title><code>groups</code></title> + <p>The list of all valid link groups for <code style="xslt-param">node</code>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title, default <code>"topic"</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs all the topic links for a guide page or section, whether declared as topic links in the page or section or as guide links from another page or section. It outputs each of the links as a <code>link</code> element within the Mallard namespace. Each <code>link</code> element has an <code>xref</code> attribute pointing to the target page or section. Or, in the case of external links, the <code>link</code> element has an <code>href</code> attribute pointing to the external resource.</p> + <p>Each <code>link</code> element contains a <code>title</code> with <code>type="sort"</code> providing the sort title of the target page or section. The <code style="xslt-param">role</code> attribute is used to select a link title to sort on when a sort title is not present. The results are not sorted when returned from this template. Use <code>xsl:sort</code> on the sort titles to sort the results.</p> + <p>Each <code>link</code> element also contains a <code>group</code> attribute. The <code>group</code> attribute is normalized. It will either point to a link group declared in <code style="xslt-param">groups</code>, or it will be set to <code>#default</code>. Each <code>link</code> element also contains a <code>groupsort</code> attribute giving the numerical position of the <code>group</code> attribute in the normalized group list for <code style="xslt-param">node</code>.</p> + <p>The <code style="xslt-param">groups</code> parameter can be calculated automatically from <code style="xslt-param">node</code>.</p> + <p>When a link comes from a topic link on <code style="xslt-param">node</code> that has an <code>href</code> attribute but not an <code>xref</code> attribute, it is taken to be an external link. In that case, the output link has an <code>href</code> attribute instead of an <code>xref</code> attribute, and it has an <code>info</code> child element. This element has a copy of all the child elements of the source <code>link</code> element.</p> + <p>The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="mal.link.sorttitle"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal.link.xref.linkid.page b/doc/yelp-xsl/C/mal.link.xref.linkid.page new file mode 100644 index 00000000..37490a4a --- /dev/null +++ b/doc/yelp-xsl/C/mal.link.xref.linkid.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.link.xref.linkid" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.0" date="2010-01-02" status="final"/><desc>Output the fully qualified link ID for an <code>xref</code> attribute.</desc></info><title>mal.link.xref.linkid</title><p>Output the fully qualified link ID for an <code>xref</code> attribute.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element containing an <code>xref</code> attribute.</p> + </item> + <item> + <title><code>xref</code></title> + <p>The <code>xref</code> value to generate a link ID from.</p> + </item> + </terms></synopsis> + <p>This template outputs the fully qualified link ID for an <code>xref</code> attribute. This may simply be <code style="xslt-param">xref</code>, but if <code style="xslt-param">xref</code> starts with the <code>#</code> character, it is prefixed with the ID of the page that contains <code style="xslt-param">node</code>.</p> + <p>See <code style="xslt-template" xref="mal.link.linkid">mal.link.linkid</code> for more on link IDs.</p> +</page> diff --git a/doc/yelp-xsl/C/mal.sort.tsort.page b/doc/yelp-xsl/C/mal.sort.tsort.page new file mode 100644 index 00000000..56ef4a96 --- /dev/null +++ b/doc/yelp-xsl/C/mal.sort.tsort.page @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal.sort.tsort" type="topic" style="xslt-template"><info><link type="guide" xref="mal-sort" group="templates"/><link type="guide" xref="templates" group="mal"/><revision status="incomplete" version="1.0" date="2010-07-08"/><desc>Sort pages based on topic and next links.</desc></info><title>mal.sort.tsort</title><p>Sort pages based on topic and next links.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The current <code>page</code> in the Mallard cache file.</p> + </item> + </terms></synopsis> + <p>This template outputs links to pages sorted according to their topic and next links. Pages occur after the first guide that references them, in their sort order for that guide. Page series constructed with next links always appear in order at the sort position of their first page.</p> + <p>This template outputs <code>link</code> elements with <code>xref</code> attributes pointing to the target page. The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> + <p>You can specify a starting node with the <code style="xslt-param">node</code> parameter. By default, it uses the node pointed to by <code style="xslt-param" xref="mal.link.default_root">mal.link.default_root</code>.</p> + <p>This template does not include any nodes that are not reachable through topic or next links.</p> +<list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.link.default_root"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html-api.page b/doc/yelp-xsl/C/mal2html-api.page new file mode 100644 index 00000000..222158dd --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-api.page @@ -0,0 +1,10 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-api" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal2html.api.links.function"/><link type="xslt-defines-template" xref="mal2html.api.links.function.c"/></info><title>Mallard to HTML - API Extension</title><p>Support for Mallard API extension elements.</p> + + + <p>This stylesheet contains templates to support features from the Mallard API extension.</p> + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.links.ul"/></p></item><item><p><link xref="utils.repeat_string"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html-block.page b/doc/yelp-xsl/C/mal2html-block.page new file mode 100644 index 00000000..ab1c2cec --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-block.page @@ -0,0 +1,11 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-block" type="guide" style="xslt-stylesheet"><?xslt-private _mal2html.choose.mode?><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="1.0" date="2010-06-03" status="final"/><link type="xslt-defines-template" xref="mal2html.pre"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/><link type="xslt-implements-mode" xref="l10n.format.mode"/></info><title>Mallard to HTML - Blocks</title><p>Handle simple Mallard block elements.</p> + + + <p>This stylesheet contains templates for handling most Mallard block elements, except the list and table elements.</p> + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="utils.linenumbering"/></p></item><item><p><link xref="html.syntax.class"/></p></item><item><p><link xref="utils.strip_newlines"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.syntax.highlight"/></p></item><item><p><link xref="mal2html.editor_mode"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:comment.name</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:comment.date</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>text()</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:desc</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:code</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:comment</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:comment/mal:cite</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:div</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:example</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:figure</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:listing</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:note</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:info</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:p</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:quote</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:quote/mal:cite</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:screen</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:synopsis</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:title</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>if:choose</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>if:if</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-facets.page b/doc/yelp-xsl/C/mal2html-facets.page new file mode 100644 index 00000000..48608328 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-facets.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-facets" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal2html.facets.controls"/><link type="xslt-defines-template" xref="mal2html.facets.links"/><link type="xslt-defines-template" xref="mal2html.facets.js"/></info><title>Mallard to HTML - Facets</title><p>Support the Mallard Facets extension.</p> + + + <p>This stylesheet contains templates and supporting JavaScript for the Mallard Facets extension.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.facetlinks"/></p></item><item><p><link xref="mal2html.links.links"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html-gloss.page b/doc/yelp-xsl/C/mal2html-gloss.page new file mode 100644 index 00000000..a4d87513 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-gloss.page @@ -0,0 +1,10 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-gloss" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal2html.gloss.terms"/><link type="xslt-defines-template" xref="mal2html.gloss.js"/><link type="xslt-implements-mode" xref="mal2html.inline.mode"/></info><title>Mallard to HTML - Glossaries</title><p>Support the Mallard Glossary extension.</p> + + + <p>This stylesheet contains templates and supporting JavaScript to support the Mallard Glossary extension in HTML.</p> + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.gloss.terms"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="html.lang.attrs"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.gloss.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>gloss:term</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-inline.page b/doc/yelp-xsl/C/mal2html-inline.page new file mode 100644 index 00000000..f819ecb3 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-inline.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-inline" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="3.8" date="2012-11-13" status="final"/><link type="xslt-defines-template" xref="mal2html.span"/><link type="xslt-implements-mode" xref="mal.link.content.mode"/><link type="xslt-implements-mode" xref="mal2html.inline.mode"/><link type="xslt-implements-mode" xref="mal2html.inline.content.mode"/></info><title>Mallard to HTML - Inlines</title><p>Handle simple Mallard inline elements.</p> + + + <p>This stylesheet contains templates to handle most Mallard inline elements. It also maps <code style="xslt-mode" xref="mal.link.content.mode">mal.link.content.mode</code> to <code style="xslt-mode" xref="mal2html.inline.mode">mal2html.inline.mode</code>.</p> + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="l10n.direction"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal.link.content.mode">mal.link.content.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>node()</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>mal:guiseq</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>mal:key</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>mal:keyseq</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>mal:link</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>*</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:app</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:cmd</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:code</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:date</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:em</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:file</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:gui</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:guiseq</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:input</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>e:hi</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:key</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:keyseq</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:link</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:output</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:span</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:sys</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:var</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>text()</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-links.page b/doc/yelp-xsl/C/mal2html-links.page new file mode 100644 index 00000000..24e3dba5 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-links.page @@ -0,0 +1,36 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-links" type="guide" style="xslt-stylesheet"><?xslt-private _mal2html.links.section.ul?><?xslt-private _mal2html.links.mouseovers?><?xslt-private _mal2html.links.grid?><?xslt-private _mal2html.links.norwich?><?xslt-private _mal2html.links.divs?><?xslt-private _mal2html.links.divs.nolink.mode?><?xslt-private _mal2html.links.button?><?xslt-private _mal2html.links.heading?><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal2html.links.links"/><link type="xslt-defines-template" xref="mal2html.links.ul"/><link type="xslt-defines-template" xref="mal2html.links.ul.li"/><link type="xslt-defines-template" xref="mal2html.links.guide"/><link type="xslt-defines-template" xref="mal2html.links.prevnext"/><link type="xslt-defines-template" xref="mal2html.links.section"/><link type="xslt-defines-template" xref="mal2html.links.seealso"/><link type="xslt-defines-template" xref="mal2html.links.series"/><link type="xslt-defines-template" xref="mal2html.links.series.prev"/><link type="xslt-defines-template" xref="mal2html.links.series.next"/><link type="xslt-defines-template" xref="mal2html.links.topic"/></info><title>Mallard to HTML - Links</title> + + + <p>This stylesheet contains templates to handle automatic linking, both using the Mallard links element and implicitly.</p> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="mal2html.ui.expander.data"/></p></item><item><p><link xref="mal2html.api.links.function"/></p></item><item><p><link xref="mal2html.ui.links.tiles"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal2html.editor.badge"/></p></item><item><p><link xref="mal.link.desc"/></p></item><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="mal.link.linkid"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>mal:links</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'guide']</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'prevnext']</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'section']</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'seealso']</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'series']</code></p></td></tr><tr><td><p/></td><td><p><code>mal:links[@type = 'topic']</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-list.page b/doc/yelp-xsl/C/mal2html-list.page new file mode 100644 index 00000000..4d6bfafe --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-list.page @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-list" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="1.0" date="2010-06-04" status="final"/><link type="xslt-defines-template" xref="mal.list.start"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/><link type="xslt-implements-mode" xref="mal2html.tree.mode"/></info><title>Mallard to HTML - Lists</title><p>Handle Mallard list elements.</p> + + + <p>This stylesheet contains templates for the <code>list</code>, <code>steps</code>, <code>terms</code>, and <code>tree</code> elements in <code style="xslt-mode" xref="mal2html.block.mode">mal2html.block.mode</code>. It handles the parent list elements, as well as any special processing for child <code>item</code> elements.</p> + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="l10n.direction"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>mal:list/mal:item</code></p></td></tr><tr><td><p/></td><td><p><code>mal:steps/mal:item</code></p></td></tr><tr><td><p/></td><td><p><code>mal:terms/mal:item</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:list</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:steps</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:terms</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:tree</code></p></td></tr><tr><td><p><link xref="mal2html.tree.mode">mal2html.tree.mode</link></p></td><td><p><code>mal:item</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-math.page b/doc/yelp-xsl/C/mal2html-math.page new file mode 100644 index 00000000..be151e55 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-math.page @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-math" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="3.8" date="2012-11-13" status="final"/><link type="xslt-implements-mode" xref="mal2html.math.mode"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/><link type="xslt-implements-mode" xref="mal2html.inline.mode"/></info><title>Mallard to HTML - MathML</title><p>Handle MathML in Mallard documents.</p> + + + <p>This stylesheet matches embedded MathML in <code style="xslt-mode" xref="mal2html.block.mode">mal2html.block.mode</code> and <code style="xslt-mode" xref="mal2html.inline.mode">mal2html.inline.mode</code> and processes it in <code style="xslt-mode" xref="mal2html.math.mode">mal2html.math.mode</code>. The matched templates for the <code>mml:math</code> element automatically set the <code>display</code> attribute based on whether the element is in block or inline context.</p> + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mml:math</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mml:math</code></p></td></tr><tr><td><p><link xref="mal2html.math.mode">mal2html.math.mode</link></p></td><td><p><code>mml:*</code></p></td></tr><tr><td><p><link xref="mal2html.math.mode">mal2html.math.mode</link></p></td><td><p><code>text()</code></p></td></tr><tr><td><p><link xref="mal2html.math.mode">mal2html.math.mode</link></p></td><td><p><code>*</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-media.page b/doc/yelp-xsl/C/mal2html-media.page new file mode 100644 index 00000000..21ffbbc4 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-media.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-media" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-template" xref="mal2html.media.image"/><link type="xslt-defines-template" xref="mal2html.media.video"/><link type="xslt-defines-template" xref="mal2html.media.audio"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/><link type="xslt-implements-mode" xref="mal2html.ttml.mode"/><link type="xslt-implements-mode" xref="mal2html.inline.mode"/><link type="xslt-implements-mode" xref="mal2html.inline.content.mode"/></info><title>Mallard to HTML - Media Elements</title><p>Handle Mallard media elements.</p> + + + <p>This stylesheet contains templates for handling Mallard <code>media</code> elements. It also handles TTML inside block audio and video <code>media</code> elements.</p> + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="ttml.profile"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>tt:*</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:media</code></p></td></tr><tr><td><p><link xref="mal2html.inline.content.mode">mal2html.inline.content.mode</link></p></td><td><p><code>mal:media</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>tt:span</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>tt:br</code></p></td></tr><tr><td><p><link xref="mal2html.inline.mode">mal2html.inline.mode</link></p></td><td><p><code>mal:media</code></p></td></tr><tr><td><p><link xref="mal2html.ttml.mode">mal2html.ttml.mode</link></p></td><td><p><code>tt:tt</code></p></td></tr><tr><td><p><link xref="mal2html.ttml.mode">mal2html.ttml.mode</link></p></td><td><p><code>tt:body</code></p></td></tr><tr><td><p><link xref="mal2html.ttml.mode">mal2html.ttml.mode</link></p></td><td><p><code>tt:div</code></p></td></tr><tr><td><p><link xref="mal2html.ttml.mode">mal2html.ttml.mode</link></p></td><td><p><code>tt:p</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-page.page b/doc/yelp-xsl/C/mal2html-page.page new file mode 100644 index 00000000..3d1aa3b1 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-page.page @@ -0,0 +1,28 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-page" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-template" xref="mal2html.page.about"/><link type="xslt-defines-template" xref="mal2html.page.linktrails"/><link type="xslt-defines-template" xref="mal2html.page.linktrails.empty"/><link type="xslt-defines-template" xref="mal2html.page.linktrails.trail"/><link type="xslt-defines-template" xref="mal2html.page.linktrails.trail.prefix"/><link type="xslt-defines-template" xref="mal2html.page.linktrails.link"/><link type="xslt-defines-template" xref="mal2html.editor.badge"/><link type="xslt-defines-template" xref="mal2html.editor.banner"/><link type="xslt-defines-template" xref="mal2html.section"/><link type="xslt-implements-mode" xref="l10n.format.mode"/><link type="xslt-implements-mode" xref="html.title.mode"/><link type="xslt-implements-mode" xref="html.header.mode"/><link type="xslt-implements-mode" xref="html.footer.mode"/><link type="xslt-implements-mode" xref="html.body.mode"/><link type="xslt-implements-mode" xref="mal2html.title.mode"/><link type="xslt-implements-mode" xref="html.css.mode"/><link type="xslt-implements-mode" xref="html.js.mode"/><link type="xslt-defines-param" xref="mal2html.editor_mode"/></info><title>Mallard to HTML - Pages</title><p>Handle pages, sections, and top-level data.</p> + + + <p>This stylesheet contains templates to process Mallard <code>page</code> and <code>section</code> elements, including implementations of the interfaces provided by the common <file xref="html">html</file> stylesheet.</p> + + + + + + + + + + + + + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item><item><p><link xref="mal.link.linktrails"/></p></item><item><p><link xref="html.linktrails.empty"/></p></item><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="mal2html.links.topic"/></p></item><item><p><link xref="mal2html.links.guide"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="color.background"/></p></item><item><p><link xref="color.blue_background"/></p></item><item><p><link xref="color.blue_border"/></p></item><item><p><link xref="color.gray_background"/></p></item><item><p><link xref="color.gray_border"/></p></item><item><p><link xref="color.link"/></p></item><item><p><link xref="color.red_background"/></p></item><item><p><link xref="color.red_border"/></p></item><item><p><link xref="color.text"/></p></item><item><p><link xref="color.text_light"/></p></item><item><p><link xref="color.yellow_background"/></p></item><item><p><link xref="color.yellow_border"/></p></item><item><p><link xref="mal2html.editor_mode"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>mal:page | mal:section</code></p></td></tr><tr><td><p><link xref="html.body.mode">html.body.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="html.css.mode">html.css.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="html.footer.mode">html.footer.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="html.header.mode">html.header.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="html.js.mode">html.js.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="html.title.mode">html.title.mode</link></p></td><td><p><code>mal:page</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:copyright.years</code></p></td></tr><tr><td><p><link xref="l10n.format.mode">l10n.format.mode</link></p></td><td><p><code>msg:copyright.name</code></p></td></tr><tr><td><p><link xref="mal2html.title.mode">mal2html.title.mode</link></p></td><td><p><code>mal:title | mal:subtitle</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-svg.page b/doc/yelp-xsl/C/mal2html-svg.page new file mode 100644 index 00000000..47ee485d --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-svg.page @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-svg" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="1.0" date="2010-06-04" status="final"/><link type="xslt-implements-mode" xref="mal2html.svg.mode"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/></info><title>Mallard to HTML - SVG</title><p>Handle embedded SVG.</p> + + + <p>This stylesheet matches embedded SVG in <code style="xslt-mode" xref="mal2html.block.mode">mal2html.block.mode</code> and processes it in <code style="xslt-mode" xref="mal2html.svg.mode">mal2html.svg.mode</code>.</p> + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>svg:svg</code></p></td></tr><tr><td><p><link xref="mal2html.svg.mode">mal2html.svg.mode</link></p></td><td><p><code>svg:*</code></p></td></tr><tr><td><p><link xref="mal2html.svg.mode">mal2html.svg.mode</link></p></td><td><p><code>text()</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-table.page b/doc/yelp-xsl/C/mal2html-table.page new file mode 100644 index 00000000..b0b929f5 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-table.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-table" type="guide" style="xslt-stylesheet"><?xslt-private rowspans?><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/></info><title>Mallard to HTML - Table Elements</title> + + + <comment><p>Describe this module</p></comment> + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="utils.repeat_string"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p/></td><td><p><code>mal:tbody</code></p></td></tr><tr><td><p/></td><td><p><code>mal:thead</code></p></td></tr><tr><td><p/></td><td><p><code>mal:tfoot</code></p></td></tr><tr><td><p/></td><td><p><code>mal:tr</code></p></td></tr><tr><td><p/></td><td><p><code>mal:td | mal:th</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>mal:table</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html-ui.page b/doc/yelp-xsl/C/mal2html-ui.page new file mode 100644 index 00000000..42c953a9 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html-ui.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html-ui" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><link type="xslt-defines-template" xref="mal2html.ui.expander.data"/><link type="xslt-defines-template" xref="mal2html.ui.links.tiles"/><link type="xslt-defines-template" xref="mal2html.ui.links.hover"/><link type="xslt-defines-template" xref="mal2html.ui.links.img"/><link type="xslt-defines-template" xref="mal2html.ui.links.img.attrs"/><link type="xslt-implements-mode" xref="mal2html.block.mode"/></info><title>Mallard to HTML - UI Extension</title><p>Support for Mallard UI extension elements.</p> + + + <p>This stylesheet contains templates to support features from the Mallard UI extension.</p> + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal.link.desc"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list><table><title>Implements Templates</title><thead><tr><th><p>Mode</p></th><th><p>Match</p></th></tr></thead><tbody><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>uix:thumb</code></p></td></tr><tr><td><p><link xref="mal2html.block.mode">mal2html.block.mode</link></p></td><td><p><code>uix:overlay</code></p></td></tr></tbody></table></page> diff --git a/doc/yelp-xsl/C/mal2html.api.links.function.c.page b/doc/yelp-xsl/C/mal2html.api.links.function.c.page new file mode 100644 index 00000000..3a861e92 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.api.links.function.c.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.api.links.function.c" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-api" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Output links as a synopsis of C functions.</desc></info><title>mal2html.api.links.function.c</title><p>Output links as a synopsis of C functions.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of topic links already filtered by group.</p> + </item> + </terms></synopsis> + <p>This template outputs links as a synopsis of C functions. It is called by <code style="xslt-template" xref="mal2html.api.links.function">mal2html.api.links.function</code> when the <code>api:mime</code> attribute of <code style="xslt-param">node</code> is <code>text/x-csrc</code> or <code>text/x-chdr</code>. The target nodes of <code style="xslt-param">links</code> are expected to have at least an <code>api:name</code> element. Any links whose target does not have an <code>api:name</code> element will be passed to <code style="xslt-template" xref="mal2html.links.ul">mal2html.links.ul</code> after the synopsis.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="utils.repeat_string"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal2html.links.ul"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.api.links.function.page b/doc/yelp-xsl/C/mal2html.api.links.function.page new file mode 100644 index 00000000..1c42eb4d --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.api.links.function.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.api.links.function" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-api" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Output links as a synopsis of functions.</desc></info><title>mal2html.api.links.function</title><p>Output links as a synopsis of functions.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of topic links already filtered by group.</p> + </item> + </terms></synopsis> + <p>This template outputs links as a synopsis according to the programming language specified by the <code>api:mime</code> attribute of <code style="xslt-param">node</code>. If <code>api:mime</code> is recognized, one of the language-specific templates in this stylesheet is called. Otherwise, the links are passed to <code style="xslt-template" xref="mal2html.links.ul">mal2html.links.ul</code>.</p> + <p>This template does not handle titles or other wrapper information for <code>links</code> elements. It should be called by an appropriate template that handles the <code>links</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.api.links.function.c"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.block.mode.page b/doc/yelp-xsl/C/mal2html.block.mode.page new file mode 100644 index 00000000..e3bb0275 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.block.mode.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.block.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-block" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="1.0" date="2010-06-03" status="final"/><desc>Process Mallard elements in block mode.</desc></info><title>mal2html.block.mode</title><p>Process Mallard elements in block mode.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>restricted</code></title> + <p>Whether this is restricted block mode.</p> + </item> + </terms></synopsis> + <p>This mode is applied to elements in block context. It should be called by templates for pages, sections, and block container elements. Certain elements may appear in both block an inline mode, and the processing expectations for those elements is different depending on context.</p> + <p>Implementations of this mode should generally output a wrapper div and process the child elements, either in <code style="xslt-mode" xref="mal2html.block.mode">mal2html.block.mode</code> or <code style="xslt-mode" xref="mal2html.inline.mode">mal2html.inline.mode</code>, or using special processing for particular content models.</p> + <p>When this mode encounters unknown content, templates in the same mode are applied to the children, but the <code style="xslt-param">restricted</code> parameter is set to <code>true</code>. When <code style="xslt-param">restricted</code> is <code>true</code>, unknown block elements are ignored. This is in accordance with the Mallard specification on fallback block content.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.editor.badge.page b/doc/yelp-xsl/C/mal2html.editor.badge.page new file mode 100644 index 00000000..27f4fc7b --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.editor.badge.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.editor.badge" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output a badge for a link showing the revision status of the target.</desc></info><title>mal2html.editor.badge</title><p>Output a badge for a link showing the revision status of the target.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>target</code></title> + <p>The page or section being linked to.</p> + </item> + </terms></synopsis> + <p>This template may be called by link formatters to output a badge showing the revision status of the linked-to page or section. It only outputs a badge if <code style="xslt-param" xref="mal2html.editor_mode">mal2html.editor_mode</code> is <code>true</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal2html.editor_mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.editor.banner.page b/doc/yelp-xsl/C/mal2html.editor.banner.page new file mode 100644 index 00000000..dbff072f --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.editor.banner.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.editor.banner" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output a banner with the revision status of a page.</desc></info><title>mal2html.editor.banner</title><p>Output a banner with the revision status of a page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The top-level <code>page</code> element.</p> + </item> + </terms></synopsis> + <p>This template is called by the <code style="xslt-mode" xref="html.body.mode">html.body.mode</code> implementation for <code>page</code> elements. It outputs a banner providing information about the revision status of <code style="xslt-param">node</code>. It only outputs a banner if <code style="xslt-param" xref="mal2html.editor_mode">mal2html.editor_mode</code> is <code>true</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal2html.editor_mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.editor_mode.page b/doc/yelp-xsl/C/mal2html.editor_mode.page new file mode 100644 index 00000000..0496a64e --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.editor_mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.editor_mode" type="topic" style="xslt-param"><info><link type="guide" xref="mal2html-page" group="parameters"/><link type="guide" xref="parameters" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Add information that's useful to writers and editors.</desc></info><title>mal2html.editor_mode</title><p>Add information that's useful to writers and editors.</p> + + + <p>When this parameter is set to true, these stylesheets will output editorial comments, status markers, and other information that's useful to writers and editors.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.facets.controls.page b/doc/yelp-xsl/C/mal2html.facets.controls.page new file mode 100644 index 00000000..a24c207b --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.facets.controls.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.facets.controls" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-facets" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Output the controls to filter faceted links.</desc></info><title>mal2html.facets.controls</title><p>Output the controls to filter faceted links.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The facets <code>page</code> or <code>section</code> to generate controls for.</p> + </item> + </terms></synopsis> + <comment><p>Describe this template</p></comment> +<list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.facets.js.page b/doc/yelp-xsl/C/mal2html.facets.js.page new file mode 100644 index 00000000..4f613adf --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.facets.js.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.facets.js" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-facets" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc/></info><title>mal2html.facets.js</title> + + + <comment><p>FIXME</p></comment> +</page> diff --git a/doc/yelp-xsl/C/mal2html.facets.links.page b/doc/yelp-xsl/C/mal2html.facets.links.page new file mode 100644 index 00000000..4778c153 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.facets.links.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.facets.links" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-facets" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2010-12-16" status="final"/><desc>Output the links for a facets node.</desc></info><title>mal2html.facets.links</title><p>Output the links for a facets node.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The facets <code>page</code> or <code>section</code> element to generate links for.</p> + </item> + </terms></synopsis> + <p>This template outputs links for a facets node. It gets the links from <code style="xslt-template" xref="mal.link.facetlinks">mal.link.facetlinks</code>, sorts them, and outputs HTML <code>a</code> elements for each link. Each <code>a</code> element has data attribute for each facet tag in <code style="xslt-param">node</code> in the form of <code>data-facet-KEY="VALUES"</code>, where <code>KEY</code> is the key of the facet tag and VALUES is the values.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.facetlinks"/></p></item><item><p><link xref="mal2html.links.links"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.gloss.js.page b/doc/yelp-xsl/C/mal2html.gloss.js.page new file mode 100644 index 00000000..20a3d604 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.gloss.js.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.gloss.js" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-gloss" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc/></info><title>mal2html.gloss.js</title> + + + <comment><p>FIXME</p></comment> +</page> diff --git a/doc/yelp-xsl/C/mal2html.gloss.terms.page b/doc/yelp-xsl/C/mal2html.gloss.terms.page new file mode 100644 index 00000000..e270658c --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.gloss.terms.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.gloss.terms" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-gloss" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="0.0" date="1970-01-01" status="stub"/><desc>Display the glossary terms for a page or section.</desc></info><title>mal2html.gloss.terms</title><p>Display the glossary terms for a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The glossary <code>page</code> or <code>section</code> to output terms for.</p> + </item> + </terms></synopsis> + <p>This template shows the glossary terms for a page or section. It collects the terms with the <code style="xslt-template" xref="mal.gloss.terms">mal.gloss.terms</code> template, sorts them, and merges terms with the same primary title. Terms that are not defined in the same page as <code style="xslt-param">node</code> include a link to their defining page.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.gloss.terms"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.inline.content.mode.page b/doc/yelp-xsl/C/mal2html.inline.content.mode.page new file mode 100644 index 00000000..029e95ff --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.inline.content.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.inline.content.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-inline" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="1.0" date="2010-06-03" status="final"/><desc>Output the contents of an inline element.</desc></info><title>mal2html.inline.content.mode</title><p>Output the contents of an inline element.</p> + + + <p>This template outputs the contents of the inline element it matches. It is usually called by <code style="xslt-template" xref="mal2html.span">mal2html.span</code> to allow elements like <code>guiseq</code>, <code>keyseq</code>, and <code>link</code> output special inner contents while still using the generic wrapper template.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.inline.mode.page b/doc/yelp-xsl/C/mal2html.inline.mode.page new file mode 100644 index 00000000..3a644962 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.inline.mode.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.inline.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-inline" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="3.8" date="2012-11-13" status="final"/><desc>Process Mallard elements in inline mode.</desc></info><title>mal2html.inline.mode</title><p>Process Mallard elements in inline mode.</p> + + + <p>This mode is applied to elements in inline context. It is be called by certain block elements and inline elements to process child content. Certain elements may appear in both block and inline mode, and the processing expectations for those elements is different depending on context.</p> + <p>Implementations of this mode should handle ubiquitous linking, text directionality, and other common inline features. Note that the <code style="xslt-template" xref="mal2html.span">mal2html.span</code> template handles these things automatically, and is suitable for most inline elements. You can use the <code style="xslt-mode" xref="mal2html.inline.content.mode">mal2html.inline.content.mode</code> to output special content for the child elements.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.links.guide.page b/doc/yelp-xsl/C/mal2html.links.guide.page new file mode 100644 index 00000000..8742707b --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.guide.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.guide" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-23" status="final"/><desc>Output guide links from a page or section.</desc></info><title>mal2html.links.guide</title><p>Output guide links from a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code>, <code>page</code>, or <code>section</code> element to link from.</p> + </item> + <item> + <title><code>depth</code></title> + <p>The depth level for the HTML header element.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links from <code style="xslt-template" xref="mal.link.guidelinks">mal.link.guidelinks</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs guide links for a page or section. It does not extract the links itself. They must be passed in with the <code style="xslt-param">links</code> parameter.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.links.links"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.links.page b/doc/yelp-xsl/C/mal2html.links.links.page new file mode 100644 index 00000000..b941bec8 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.links.page @@ -0,0 +1,34 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.links" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.10" date="2013-07-30" status="final"/><desc>Output links in one of a number of formats.</desc></info><title>mal2html.links.links</title><p>Output links in one of a number of formats.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code>, <code>page</code>, or <code>section</code> element to link from.</p> + </item> + <item> + <title><code>depth</code></title> + <p>The depth level for the HTML header element.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links, as from a template in <file xref="mal-link">mal-link</file>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>divs</code></title> + <p>Whether to default to divs instead of a list.</p> + </item> + <item> + <title><code>title</code></title> + <p>A default title to use if no <code>title</code> element is found.</p> + </item> + </terms></synopsis> + <p>This is a common formatting template used by some <code>links</code> element handlers. It selects an appropriate way to render the links based on style hints and extension attributes on <code style="xslt-param">node</code>. This template (or the templates it calls) will pass through <code>class</code> and <code>data-*</code> attributes found on the <code>link</code> elements to the top-level container element of each output link.</p> + <p>This template handles link sorting.</p> + <p>If <code style="xslt-param">node</code> is a <code>links</code> element with a <code>title</code> element, that <code>title</code> element will be processed as the title. Otherwise, the optional <code style="xslt-param">title</code> parameter will be used if provided.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="mal2html.ui.expander.data"/></p></item><item><p><link xref="mal2html.api.links.function"/></p></item><item><p><link xref="mal2html.ui.links.tiles"/></p></item><item><p><link xref="mal2html.links.ul"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.prevnext.page b/doc/yelp-xsl/C/mal2html.links.prevnext.page new file mode 100644 index 00000000..35e5413a --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.prevnext.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.prevnext" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2011-06-15" status="final"/><desc>Output links to the previous and next pages.</desc></info><title>mal2html.links.prevnext</title><p>Output links to the previous and next pages.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> or <code>page</code> element to link from.</p> + </item> + </terms></synopsis> + <p>This template outputs links to the previous and next page in a Mallard series, if they exist. The block containing the links is end-floated by default. The links use the text "Previous" and "Next", although the actual page titles are used for tooltips.</p> + <p>If the <code>links</code> element has the style hint <code>top</code>, it will be inserted before the page title, instead of in its position on the page. This is handled by the calling functions in <file xref="mal2html-page">mal2html-page</file>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.section.page b/doc/yelp-xsl/C/mal2html.links.section.page new file mode 100644 index 00000000..4d0704f2 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.section.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.section" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2011-06-15" status="final"/><desc>Output links to subsections.</desc></info><title>mal2html.links.section</title><p>Output links to subsections.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The section <code>links</code> element.</p> + </item> + <item> + <title><code>depth</code></title> + <p>The depth level for the HTML header element.</p> + </item> + </terms></synopsis> + <p>This template outputs links to the child sections of the <code>page</code> or <code>section</code> element containing <code style="xslt-param">node</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.ui.expander.data"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.seealso.page b/doc/yelp-xsl/C/mal2html.links.seealso.page new file mode 100644 index 00000000..978ad336 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.seealso.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.seealso" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-23" status="final"/><desc>Output seealso links from a page or section.</desc></info><title>mal2html.links.seealso</title><p>Output seealso links from a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code>, <code>page</code>, or <code>section</code> element to link from.</p> + </item> + <item> + <title><code>depth</code></title> + <p>The depth level for the HTML header element.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links from <code style="xslt-template" xref="mal.link.seealsolinks">mal.link.seealsolinks</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs seealso links for a page or section. It does not extract the links itself. They must be passed in with the <code style="xslt-param">links</code> parameter.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.links.links"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.series.next.page b/doc/yelp-xsl/C/mal2html.links.series.next.page new file mode 100644 index 00000000..62622262 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.series.next.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.series.next" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2011-06-15" status="final"/><desc>Output following links to pages in a series.</desc></info><title>mal2html.links.series.next</title><p>Output following links to pages in a series.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The current <code>page</code> element.</p> + </item> + <item> + <title><code>links</code></title> + <p>The series <code>links</code> element.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal2html.links.series">mal2html.links.series</code> to output the pages after the starting page in the series. This template finds the next page for the page <code style="xslt-param">node</code>. It outputs a link to that page, then calls itself recursively on that page.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal2html.links.series.next"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.series.page b/doc/yelp-xsl/C/mal2html.links.series.page new file mode 100644 index 00000000..861ad60f --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.series.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.series" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2011-06-15" status="final"/><desc>Output links to pages in a series.</desc></info><title>mal2html.links.series</title><p>Output links to pages in a series.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> or <code>page</code> element to start from.</p> + </item> + </terms></synopsis> + <p>A series in Mallard is a list of page such that each page in the list has a next link to the following page. This template outputs links to each page in a series. The current page is output in its place, althought it is not a link.</p> + <p>This template calls <code style="xslt-template" xref="mal2html.links.series.prev">mal2html.links.series.prev</code> and <code style="xslt-template" xref="mal2html.links.series.next">mal2html.links.series.next</code> to find and output the links.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.ui.expander.data"/></p></item><item><p><link xref="mal2html.links.series.prev"/></p></item><item><p><link xref="mal.link.content"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.series.prev.page b/doc/yelp-xsl/C/mal2html.links.series.prev.page new file mode 100644 index 00000000..72e3080b --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.series.prev.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.series.prev" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="1.0" date="2011-06-15" status="final"/><desc>Output preceding links to pages in a series.</desc></info><title>mal2html.links.series.prev</title><p>Output preceding links to pages in a series.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The current <code>page</code> element.</p> + </item> + <item> + <title><code>links</code></title> + <p>The series <code>links</code> element.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal2html.links.series">mal2html.links.series</code> to output the pages before the starting page in the series. This template finds the previous page for the page <code style="xslt-param">node</code>. It then calls itself recursively on that page, and outputs a link to it.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal2html.links.series.prev"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item><item><p><link xref="mal.cache.link.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.topic.page b/doc/yelp-xsl/C/mal2html.links.topic.page new file mode 100644 index 00000000..b8d7374b --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.topic.page @@ -0,0 +1,28 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.topic" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-23" status="final"/><desc>Output topic links from a page or section.</desc></info><title>mal2html.links.topic</title><p>Output topic links from a page or section.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code>, <code>page</code>, or <code>section</code> element to link from.</p> + </item> + <item> + <title><code>depth</code></title> + <p>The depth level for the HTML header element.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links from <code style="xslt-template" xref="mal.link.topiclinks">mal.link.topiclinks</code>.</p> + </item> + <item> + <title><code>groups</code></title> + <p>The list of link groups for this <code>links</code> element.</p> + </item> + <item> + <title><code>allgroups</code></title> + <p>The list of all valid groups for the page or section.</p> + </item> + </terms></synopsis> + <p>This template outputs topic links for a page or section. It does not extract the links itself. They must be passed in with the <code style="xslt-param">links</code> parameter. This template only outputs links which have a group that matches <code style="xslt-param">groups</code>. The <code style="xslt-param">groups</code> parameter is not expected to have the implicit groups <code>first</code>, <code>default</code>, and <code>last</code>. These are added automatically by this template when determining which links to output.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.links.links"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.ul.li.page b/doc/yelp-xsl/C/mal2html.links.ul.li.page new file mode 100644 index 00000000..f2989e4f --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.ul.li.page @@ -0,0 +1,28 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.ul.li" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.10" date="2013-07-30" status="final"/><desc>Output a list item with a link.</desc></info><title>mal2html.links.ul.li</title><p>Output a list item with a link.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>link</code></title> + <p>The <code>link</code> element from a list of links.</p> + </item> + <item> + <title><code>xref</code></title> + <p>An <code>xref</code> string pointing to the target node.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>bold</code></title> + <p>Whether to bold the link titles.</p> + </item> + <item> + <title><code>nodesc</code></title> + <p>Whether to omit descriptions.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal2html.links.ul">mal2html.links.ul</code> to output a list item with a link for each target.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal2html.editor.badge"/></p></item><item><p><link xref="mal.link.desc"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.links.ul.page b/doc/yelp-xsl/C/mal2html.links.ul.page new file mode 100644 index 00000000..5cdaf0f6 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.links.ul.page @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.links.ul" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-links" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.10" date="2013-07-30" status="final"/><desc>Output links in an HTML <code>ul</code> element.</desc></info><title>mal2html.links.ul</title><p>Output links in an HTML <code>ul</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>links</code></title> + <p>A list of links, as from a template in <file xref="mal-link">mal-link</file>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title.</p> + </item> + <item> + <title><code>bold</code></title> + <p>Whether to bold the link titles.</p> + </item> + <item> + <title><code>nodesc</code></title> + <p>Whether to omit descriptions.</p> + </item> + </terms></synopsis> + <p>This is a common formatting template used by some <code>links</code> element handlers. It outputs an HTML <code>ul</code> element and calls <code style="xslt-template" xref="mal2html.links.ul.li">mal2html.links.ul.li</code> on each link to output a list item with a link.</p> + <p>This template handles link sorting.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.links.ul.li"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.math.mode.page b/doc/yelp-xsl/C/mal2html.math.mode.page new file mode 100644 index 00000000..577187bc --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.math.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.math.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-math" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="3.8" date="2012-11-13" status="final"/><desc>Output MathML and handle Mallard extensions.</desc></info><title>mal2html.math.mode</title><p>Output MathML and handle Mallard extensions.</p> + + + <p>This mode is used for processing MathML embedded into Mallard documents. For most types of MathML content, it simply copies the input directly, except it outputs the MathML in a way that allows the namespace to stripped for non-XML output. It checks for Mallard linking using the <code>mal:xref</code> attribute and transforms this to a MathML <code>href</code> attribute. It also converts <code>xlink:href</code> attributes from MathML 2 to <code>href</code> attributes for MathML 3.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.media.audio.page b/doc/yelp-xsl/C/mal2html.media.audio.page new file mode 100644 index 00000000..b1c79fc0 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.media.audio.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.media.audio" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-media" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output an <code>audio</code> element for an audio object.</desc></info><title>mal2html.media.audio</title><p>Output an <code>audio</code> element for an audio object.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The Mallard <code>media</code> element.</p> + </item> + <item> + <title><code>inline</code></title> + <p>Whether <code style="xslt-param">node</code> is inline.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>audio</code> element for a Mallard <code>media</code> element with the <code>type</code> attribute set to <code>"audio"</code>. It converts any fallback content in the source to the <code>audio</code> element's fallback content. If <code style="xslt-param">inline</code> is <code>false</code>, this template will process TTML child content.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item><item><p><link xref="mal2html.ttml.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.media.image.page b/doc/yelp-xsl/C/mal2html.media.image.page new file mode 100644 index 00000000..e825d8f8 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.media.image.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.media.image" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-media" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output an <code>img</code> element for an image.</desc></info><title>mal2html.media.image</title><p>Output an <code>img</code> element for an image.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The Mallard <code>media</code> element.</p> + </item> + <item> + <title><code>inline</code></title> + <p>Whether <code style="xslt-param">node</code> is inline.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>img</code> element for a Mallard <code>media</code> element with the <code>type</code> attribute set to <code>"image"</code> (or with no <code>type</code> attribute). If <code style="xslt-param">node</code> has fallback content, it is used for the <code>alt</code> attribute.</p> +<list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.media.video.page b/doc/yelp-xsl/C/mal2html.media.video.page new file mode 100644 index 00000000..5341ed7a --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.media.video.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.media.video" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-media" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output a <code>video</code> element for a video.</desc></info><title>mal2html.media.video</title><p>Output a <code>video</code> element for a video.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The Mallard <code>media</code> element.</p> + </item> + <item> + <title><code>inline</code></title> + <p>Whether <code style="xslt-param">node</code> is inline.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>video</code> element for a Mallard <code>media</code> element with the <code>type</code> attribute set to <code>"video"</code>. It converts any fallback content in the source to the <code>video</code> element's fallback content. If <code style="xslt-param">inline</code> is <code>false</code>, this template will process TTML child content.</p> + <p>If <code style="xslt-param">node</code> has a child image <code>media</code> element with the <code>style</code> attribute set to <code>"poster"</code>, that image will be used for the <code>poster</code> attribute on the HTML <code>video</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item><item><p><link xref="mal2html.ttml.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page b/doc/yelp-xsl/C/mal2html.page new file mode 100644 index 00000000..7042ccdc --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2html" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><link type="xslt-defines-param" xref="html.xhtml"/><link type="xslt-defines-param" xref="mal.if.target"/></info><title>Mallard to HTML</title><p>Transform Mallard to HTML.</p> + + + <p>This top-level stylesheet includes all the necessary stylesheets to transform Mallard documents into HTML. It imports <file xref="mal2xhtml">mal2xhtml</file>, overrides parameters, and sets a namespace alias to output non-XML HTML. In particular, this stylesheet sets <code style="xslt-param" xref="html.xhtml">html.xhtml</code> to <code>false</code> and <code style="xslt-param" xref="mal.if.target">mal.if.target</code> to <code>'target:html'</code>.</p> +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links></page> diff --git a/doc/yelp-xsl/C/mal2html.page.about.page b/doc/yelp-xsl/C/mal2html.page.about.page new file mode 100644 index 00000000..6e639adb --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.about.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.about" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Output the copyrights, credits, and license information at the bottom of a page.</desc></info><title>mal2html.page.about</title><p>Output the copyrights, credits, and license information at the bottom of a page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The top-level <code>page</code> element.</p> + </item> + </terms></synopsis> + <p>This template outputs copyright information, credits, and license information for the page. By default it is called by the <code style="xslt-mode" xref="html.footer.mode">html.footer.mode</code> implementation for the <code>page</code> element. Information is extracted from the <code>info</code> element of <code style="xslt-param">node</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.block.mode"/></p></item><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page.linktrails.empty.page b/doc/yelp-xsl/C/mal2html.page.linktrails.empty.page new file mode 100644 index 00000000..07e4a8e4 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.linktrails.empty.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.linktrails.empty" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><link type="guide" xref="stubs" group="mal2html"/><revision version="3.20" date="2015-09-17" status="final"/><desc>Deprecated stub to output something when no link trails are present.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal2html.page.linktrails.empty</title><p>Deprecated stub to output something when no link trails are present.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The top-level <code>page</code> element.</p> + </item> + </terms></synopsis> + <p>This template is deprecated. Use <code style="xslt-template" xref="html.linktrails.empty">html.linktrails.empty</code> instead. By default, this template calls <code style="xslt-template" xref="html.linktrails.empty">html.linktrails.empty</code>, passing the <code style="xslt-param">node</code> parameter.</p> + <p>This template is a stub. It is called by <code style="xslt-param">mal2html.page.linktrails</code> when there are no link trails to output. Some customizations prepend extra site links to link trails. This template allows them to output those links even when no link trails would otherwise be present.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.linktrails.empty"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page.linktrails.link.page b/doc/yelp-xsl/C/mal2html.page.linktrails.link.page new file mode 100644 index 00000000..4ed20254 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.linktrails.link.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.linktrails.link" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2011-11-19" status="final"/><desc>Output a link and the following links in a link trail.</desc></info><title>mal2html.page.linktrails.link</title><p>Output a link and the following links in a link trail.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>link</code> element from <code style="xslt-template" xref="mal.link.linktrails">mal.link.linktrails</code>.</p> + </item> + <item> + <title><code>direction</code></title> + <p>The text directionality.</p> + </item> + </terms></synopsis> + <p>This template is called by <code style="xslt-template" xref="mal2html.page.linktrails.trail">mal2html.page.linktrails.trail</code> to output the links in a trail. Link trails returned by <code style="xslt-template" xref="mal.link.linktrails">mal.link.linktrails</code> are returned as nested <code>link</code> elements. This template takes one of those elements, outputs an HTML <code>a</code> element, then calls itself recursively on the child <code>link</code> element, if it exists.</p> + <p>The <code style="xslt-param">direction</code> parameter specifies the current text directionality. If not provided, it is computed automatically with <code style="xslt-template" xref="l10n.direction">l10n.direction</code>. It determines the separators used between links.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal2html.page.linktrails.link"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page.linktrails.page b/doc/yelp-xsl/C/mal2html.page.linktrails.page new file mode 100644 index 00000000..8647dc0c --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.linktrails.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.linktrails" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2011-11-19" status="final"/><desc>Ouput trails of guide links for a page.</desc></info><title>mal2html.page.linktrails</title><p>Ouput trails of guide links for a page.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The top-level <code>page</code> element.</p> + </item> + </terms></synopsis> + <p>This template outputs all of the link trails for the page <code style="xslt-param">node</code>. It gets the trails from <code style="xslt-param">mal.link.linktrails</code>. If the result is non-empty, it outputs a wrapper <code>div</code>, sorts the trails, and calls <code style="xslt-template" xref="mal2html.page.linktrails.trail">mal2html.page.linktrails.trail</code> on each one. Otherwise, it calls the stub template <code style="xslt-template" xref="mal2html.page.linktrails.empty">mal2html.page.linktrails.empty</code>.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linktrails"/></p></item><item><p><link xref="mal2html.page.linktrails.trail"/></p></item><item><p><link xref="mal2html.page.linktrails.empty"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page.linktrails.trail.page b/doc/yelp-xsl/C/mal2html.page.linktrails.trail.page new file mode 100644 index 00000000..2043058d --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.linktrails.trail.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.linktrails.trail" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.20" date="2015-09-19" status="final"/><desc>Output one trail of guide links.</desc></info><title>mal2html.page.linktrails.trail</title><p>Output one trail of guide links.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>link</code> element from <code style="xslt-template" xref="mal.link.linktrails">mal.link.linktrails</code>.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>div</code> element containing all the links in a single link trail. It calls <code style="xslt-template" xref="html.linktrails.prefix">html.linktrails.prefix</code> (by way of <code style="xslt-template" xref="mal2html.page.linktrails.trail.prefix">mal2html.page.linktrails.trail.prefix</code>) to output a custom boilerplate prefix, then calls <code style="xslt-template" xref="mal2html.page.linktrails.link">mal2html.page.linktrails.link</code> to output the actual links.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.page.linktrails.trail.prefix"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.page.linktrails.trail.prefix.page b/doc/yelp-xsl/C/mal2html.page.linktrails.trail.prefix.page new file mode 100644 index 00000000..cc38348a --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.page.linktrails.trail.prefix.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.page.linktrails.trail.prefix" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><link type="guide" xref="stubs" group="mal2html"/><revision version="3.20" date="2015-09-17" status="final"/><desc>Deprecated stub to output extra content before a link trail.</desc><stub xmlns="http://projects.gnome.org/yelp/xsldoc/"/></info><title>mal2html.page.linktrails.trail.prefix</title><p>Deprecated stub to output extra content before a link trail.</p><note><p>This template is a stub. Customizations may override it for + additional functionality.</p></note> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>link</code> element from <code style="xslt-template" xref="mal.link.linktrails">mal.link.linktrails</code>.</p> + </item> + </terms></synopsis> + <p>This template is deprecated. Use <code style="xslt-template" xref="html.linktrails.prefix">html.linktrails.prefix</code> instead. By default, this template calls <code style="xslt-template" xref="html.linktrails.prefix">html.linktrails.prefix</code>, passing the <code style="xslt-param">node</code> parameter.</p> + <p>This template is a stub. It is called by <code style="xslt-template" xref="mal2html.page.linktrails.trail">mal2html.page.linktrails.trail</code> for each link trail before the normal links are output with <code style="xslt-template" xref="mal2html.page.linktrails.link">mal2html.page.linktrails.link</code>. This template is useful for adding extra site links at the beginning of each link trail.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.linktrails.prefix"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.pre.page b/doc/yelp-xsl/C/mal2html.pre.page new file mode 100644 index 00000000..bfac9b3a --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.pre.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.pre" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-block" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.12" date="2013-11-02" status="final"/><desc>Output an HTML <code>pre</code> element.</desc></info><title>mal2html.pre</title><p>Output an HTML <code>pre</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source element to output a <code>pre</code> for.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>pre</code> element along with a wrapper <code>div</code> element for CSS styling. It should be called for verbatim block elements. It will automatically strip leading and trailing newlines using <code style="xslt-template" xref="utils.strip_newlines">utils.strip_newlines</code>.</p> + <p>If <code style="xslt-param" xref="html.syntax.highlight">html.syntax.highlight</code> is <code>true</code>, this template automatically outputs syntax highlighting support based on the <code>mime</code> attribute of <code style="xslt-param">node</code>, using <code style="xslt-template" xref="html.syntax.class">html.syntax.class</code> to determine the correct highlighter.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.if.test"/></p></item><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="utils.linenumbering"/></p></item><item><p><link xref="html.syntax.class"/></p></item><item><p><link xref="utils.strip_newlines"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.syntax.highlight"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.section.page b/doc/yelp-xsl/C/mal2html.section.page new file mode 100644 index 00000000..5ae47929 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.section.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.section" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-page" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-01-26" status="final"/><desc>Output HTML for a Mallard <code>section</code> element.</desc></info><title>mal2html.section</title><p>Output HTML for a Mallard <code>section</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>section</code> element.</p> + </item> + </terms></synopsis> + <p>This template outputs HTML for a <code>section</code> element. It it called by the templates that handle <code>page</code> and <code>section</code> elements.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="mal2html.ui.expander.data"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.span.page b/doc/yelp-xsl/C/mal2html.span.page new file mode 100644 index 00000000..38d6e165 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.span.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.span" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-inline" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.10" date="2013-07-10" status="final"/><desc>Output an HTML <code>span</code> element.</desc></info><title>mal2html.span</title><p>Output an HTML <code>span</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source element to output a <code>span</code> for.</p> + </item> + <item> + <title><code>class</code></title> + <p>An additional string to prepend to the <code>class</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>span</code> element for a source element. It creates a <code>class</code> attribute automatically by passing the local name of <code style="xslt-param">node</code> and the <code style="xslt-param">class</code> parameter to <code style="xslt-template" xref="html.class.attr">html.class.attr</code>. To output the contents of <code style="xslt-param">node</code>, it applies the mode <code style="xslt-mode" xref="mal2html.inline.content.mode">mal2html.inline.content.mode</code> to <code style="xslt-param">node</code>.</p> + <p>This template automatically handles ubiquitous linking if <code style="xslt-param">node</code> contains an <code>xref</code> or <code>href</code> attribute.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="html.class.attr"/></p></item><item><p><link xref="html.lang.attrs"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.content.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.svg.mode.page b/doc/yelp-xsl/C/mal2html.svg.mode.page new file mode 100644 index 00000000..8b30c9f9 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.svg.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.svg.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-svg" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="3.18" date="2015-05-04" status="final"/><desc>Output SVG and handle Mallard extensions.</desc></info><title>mal2html.svg.mode</title><p>Output SVG and handle Mallard extensions.</p> + + + <p>This mode is used for processing SVG embedded into Mallard documents. For most types of SVG content, it simply copies the input directly, except it outputs the SVG in a way that allows the namespace to stripped for non-XML output. It checks for Mallard linking using the <code>mal:xref</code> attribute and transforms this to an XLink <code>xlink:href</code> attribute.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.title.mode.page b/doc/yelp-xsl/C/mal2html.title.mode.page new file mode 100644 index 00000000..1c894749 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.title.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.title.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-page" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="3.10" date="2013-07-10" status="final"/><desc>Output headings for titles and subtitles.</desc></info><title>mal2html.title.mode</title><p>Output headings for titles and subtitles.</p> + + + <p>This template is called on <code>title</code> and <code>subtitle</code> elements that appear as direct child content of <code>page</code> or <code>section</code> elements. Normal block titles are processed in <code style="xslt-mode" xref="mal2html.block.mode">mal2html.block.mode</code>.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.tree.mode.page b/doc/yelp-xsl/C/mal2html.tree.mode.page new file mode 100644 index 00000000..754cebbe --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.tree.mode.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.tree.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-list" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="1.0" date="2010-06-04" status="final"/><desc>Process an <code>item</code> element inside a <code>tree</code>.</desc></info><title>mal2html.tree.mode</title><p>Process an <code>item</code> element inside a <code>tree</code>.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>lines</code></title> + <p>Whether to draw lines indicating hierarchy.</p> + </item> + <item> + <title><code>prefix</code></title> + <p>The line markers used by the parent <code>item</code>.</p> + </item> + </terms></synopsis> + <p>This mode is used for processing <code>item</code> elements in <code>tree</code> elements. It is applied by the template for <code>tree</code> and recursively calls itself. If the parent <code>tree</code> has the style hint <code>"lines"</code>, the <code style="xslt-param">lines</code> parameter will be <code>true</code>. In this case, this template calculates a prefix based on its position and neighboring <code>item</code> elements, and passes that prefix to child elements.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.ttml.mode.page b/doc/yelp-xsl/C/mal2html.ttml.mode.page new file mode 100644 index 00000000..d1561edc --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ttml.mode.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ttml.mode" type="topic" style="xslt-mode"><info><link type="guide" xref="mal2html-media" group="modes"/><link type="guide" xref="modes" group="mal2html"/><revision version="3.8" date="2012-11-05" status="final"/><desc>Process TTML subtitles in a Mallard <code>media</code> element.</desc></info><title>mal2html.ttml.mode</title><p>Process TTML subtitles in a Mallard <code>media</code> element.</p> + + + <p>This mode is applied to TTML elements inside block audio and video elements. It outputs HTML elements that are hidden by default and shown dynamically as the parent media element is played.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.ui.expander.data.page b/doc/yelp-xsl/C/mal2html.ui.expander.data.page new file mode 100644 index 00000000..8a1ad7ae --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ui.expander.data.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ui.expander.data" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-ui" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-25" status="final"/><desc>Output data for an expander.</desc></info><title>mal2html.ui.expander.data</title><p>Output data for an expander.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The source element to output data for.</p> + </item> + <item> + <title><code>expander</code></title> + <p>Whether <code style="xslt-param">node</code> is actually an expander.</p> + </item> + </terms></synopsis> + <p>This template outputs an HTML <code>div</code> element with the <code>class</code> attribute set to <code>"yelp-data yelp-data-ui-expander"</code>. All <code>yelp-data</code> elements are hidden by the CSS. The div contains information about text directionality, the default expanded state, and optionally additional titles for the expanded and collapsed states.</p> + <p>The expander information is only output if the <code style="xslt-param">expander</code> parameter is <code>true</code>. This parameter can be calculated automatically, but it will give false negatives for blocks that produce automatic titles.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.direction"/></p></item></list><list style="compact"><title>Calls Modes</title><item><p><link xref="mal2html.inline.mode"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.ui.links.hover.page b/doc/yelp-xsl/C/mal2html.ui.links.hover.page new file mode 100644 index 00000000..5fc03ba0 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ui.links.hover.page @@ -0,0 +1,22 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ui.links.hover" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-ui" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-26" status="final"/><desc>Output links with thumbnails shown on hover.</desc></info><title>mal2html.ui.links.hover</title><p>Output links with thumbnails shown on hover.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links, as from a template in <file xref="mal-link">mal-link</file>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A link role, used to select the appropriate title and thumbnail.</p> + </item> + </terms></synopsis> + <p>This template outputs links alongside thumbnail images, using the UI extension. The thumbnail image for each link is shown when the user hovers over that link. This template calls <code style="xslt-template" xref="mal2html.ui.links.img">mal2html.ui.links.img</code> to find the best-match thumbnail and output the HTML <code>img</code> element for each link.</p> + <p>If <code style="xslt-param">node</code> contains a <code>ui:thumb</code> element, that image is used when no links are hovered.</p> + <p>This template handles link sorting.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.ui.links.img.attrs"/></p></item><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal2html.ui.links.img"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.ui.links.img.attrs.page b/doc/yelp-xsl/C/mal2html.ui.links.img.attrs.page new file mode 100644 index 00000000..bdfc696e --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ui.links.img.attrs.page @@ -0,0 +1,24 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ui.links.img.attrs" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-ui" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.4" date="2012-02-25" status="final"/><desc>Output the <code>width</code> and <code>height</code> attributes for a thumbnail image.</desc></info><title>mal2html.ui.links.img.attrs</title><p>Output the <code>width</code> and <code>height</code> attributes for a thumbnail image.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>thumbs</code></title> + <p>A list of candidate <code>uix:thumb</code> elements.</p> + </item> + <item> + <title><code>width</code></title> + <p>The width to fit thumbnails into.</p> + </item> + <item> + <title><code>height</code></title> + <p>The height to fit thumbnails into.</p> + </item> + </terms></synopsis> + <p>This template outputs <code>width</code> and <code>height</code> attributes for the HTML <code>img</code> element created from <code style="xslt-param">thumb</code>, based on the <code>uix:overflow</code> attribute on <code style="xslt-param">node</code>. The <code style="xslt-param">width</code> and <code style="xslt-param">height</code> parameters can be computed automatically from the <code style="xslt-param">node</code> element.</p> +</page> diff --git a/doc/yelp-xsl/C/mal2html.ui.links.img.page b/doc/yelp-xsl/C/mal2html.ui.links.img.page new file mode 100644 index 00000000..0189511d --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ui.links.img.page @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ui.links.img" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-ui" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-10-27" status="final"/><desc>Output an image for a link using UI thumbnails.</desc></info><title>mal2html.ui.links.img</title><p>Output an image for a link using UI thumbnails.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>thumbs</code></title> + <p>A list of candidate <code>uix:thumb</code> elements.</p> + </item> + <item> + <title><code>role</code></title> + <p>A link role, used to select the appropriate thumbnail.</p> + </item> + <item> + <title><code>width</code></title> + <p>The width to fit thumbnails into.</p> + </item> + <item> + <title><code>height</code></title> + <p>The height to fit thumbnails into.</p> + </item> + </terms></synopsis> + <p>This template selects the best-fit thumbnail from <code style="xslt-param">thumbs</code>, based on how well the aspect ratio and dimensions of each image matches the <code style="xslt-param">width</code> and <code style="xslt-param">height</code> parameters. It outputs an HTML <code>img</code> element for the best-fit thumbnail and calls <code style="xslt-param">mal2html.ui.links.img.attrs</code> to output <code>width</code> and <code>height</code> attributes.</p> + <p>Before checking for a best-fit thumbnail on dimensions, this template first looks for <code>uix:thumb</code> elements with the <code>type</code> attribute set to <code>"links"</code>. Within those, it looks for <code>uix:thumb</code> elements whose <code>role</code> attribute matches the <code style="xslt-param">role</code> parameter. This is similar to how link titles are selected.</p> + <p>If the <code style="xslt-param">thumbs</code> parameter is empty, this template attempts to use a default thumbnail provided by a <code>uix:thumb</code> child element of <code style="xslt-param">node</code>.</p> + <p>The <code style="xslt-param">width</code> and <code style="xslt-param">height</code> parameters can be computed automatically from the <code style="xslt-param">node</code> element.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal2html.ui.links.img.attrs"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2html.ui.links.tiles.page b/doc/yelp-xsl/C/mal2html.ui.links.tiles.page new file mode 100644 index 00000000..566ecca9 --- /dev/null +++ b/doc/yelp-xsl/C/mal2html.ui.links.tiles.page @@ -0,0 +1,21 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="mal2html.ui.links.tiles" type="topic" style="xslt-template"><info><link type="guide" xref="mal2html-ui" group="templates"/><link type="guide" xref="templates" group="mal2html"/><revision version="3.8" date="2012-10-27" status="final"/><desc>Output links as thumbnail tiles.</desc></info><title>mal2html.ui.links.tiles</title><p>Output links as thumbnail tiles.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>links</code> element to link from.</p> + </item> + <item> + <title><code>links</code></title> + <p>A list of links, as from a template in <file xref="mal-link">mal-link</file>.</p> + </item> + <item> + <title><code>role</code></title> + <p>A link role, used to select the appropriate title and thumbnail.</p> + </item> + </terms></synopsis> + <p>This template outputs links as thumbnail tiles, as per the UI extension. For each link, it outputs an inline-block <code>div</code> element with a thumbnail, title, and desc (unless the <code>nodesc</code> style hint is used). This template calls <code style="xslt-template" xref="mal2html.ui.links.img">mal2html.ui.links.img</code> to find the best-match thumbnail and output the HTML <code>img</code> element for each link.</p> + <p>This template handles link sorting.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.target"/></p></item><item><p><link xref="mal.link.tooltip"/></p></item><item><p><link xref="mal.link.content"/></p></item><item><p><link xref="mal.link.desc"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="mal.cache.key"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/mal2xhtml.page b/doc/yelp-xsl/C/mal2xhtml.page new file mode 100644 index 00000000..2671dfa2 --- /dev/null +++ b/doc/yelp-xsl/C/mal2xhtml.page @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="mal2xhtml" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="mal2xhtml"/><revision version="3.8" date="2012-11-05" status="final"/><link type="topic" xref="mal2html-api" group="stylesheets"/><link type="topic" xref="mal2html-block" group="stylesheets"/><link type="topic" xref="mal2html-facets" group="stylesheets"/><link type="topic" xref="mal2html-gloss" group="stylesheets"/><link type="topic" xref="mal2html-inline" group="stylesheets"/><link type="topic" xref="mal2html-links" group="stylesheets"/><link type="topic" xref="mal2html-list" group="stylesheets"/><link type="topic" xref="mal2html-math" group="stylesheets"/><link type="topic" xref="mal2html-media" group="stylesheets"/><link type="topic" xref="mal2html-page" group="stylesheets"/><link type="topic" xref="mal2html-svg" group="stylesheets"/><link type="topic" xref="mal2html-table" group="stylesheets"/><link type="topic" xref="mal2html-ui" group="stylesheets"/><link type="xslt-defines-param" xref="ttml.features"/><link type="xslt-defines-param" xref="mal.if.target"/><link type="xslt-defines-param" xref="mal.if.features"/><link type="xslt-defines-param" xref="mal.if.maybe"/><link type="xslt-defines-param" xref="mal.link.extension"/></info><title>Mallard to XHTML</title><p>Transform Mallard to XHTML.</p> + + + <p>This top-level stylesheet includes all the necessary stylesheets to transform Mallard documents into XHTML. This stylesheet sets the parameters <code style="xslt-param" xref="mal.if.target">mal.if.target</code>, <code style="xslt-param" xref="mal.if.features">mal.if.features</code>, <code style="xslt-param" xref="mal.if.maybe">mal.if.maybe</code>, <code style="xslt-param" xref="mal.link.extension">mal.link.extension</code>, and <code style="xslt-param" xref="ttml.features">ttml.features</code>.</p> +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="html.extension"/></p></item><item><p><link xref="ttml.features"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/ttml.features.page b/doc/yelp-xsl/C/ttml.features.page new file mode 100644 index 00000000..4c5cb023 --- /dev/null +++ b/doc/yelp-xsl/C/ttml.features.page @@ -0,0 +1,7 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="ttml.features" type="topic" style="xslt-param"><info><link type="guide" xref="ttml" group="parameters"/><link type="guide" xref="parameters" group="ttml"/><revision version="3.4" date="2012-03-01" status="final"/><desc>The supported features and extensions for TTML documents.</desc></info><title>ttml.features</title><p>The supported features and extensions for TTML documents.</p> + + + <p>This parameter lists the fully-qualified URIs of TTML features and extensions supported by the stylesheets. The values are in the form of a space-separated list, which MUST have both a leading and a trailing space.</p> + <p>The default value for this parameter is empty. Importing stylesheets should set this to an appropriate value.</p> +</page> diff --git a/doc/yelp-xsl/C/ttml.page b/doc/yelp-xsl/C/ttml.page new file mode 100644 index 00000000..37694749 --- /dev/null +++ b/doc/yelp-xsl/C/ttml.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="ttml" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="ttml"/><revision version="3.4" date="2012-03-01" status="final"/><link type="xslt-defines-template" xref="ttml.time.range"/><link type="xslt-defines-template" xref="ttml.time.seconds"/><link type="xslt-defines-template" xref="ttml.profile"/><link type="xslt-defines-template" xref="ttml.profile.attr"/><link type="xslt-defines-param" xref="ttml.features"/></info><title>TTML Utilities</title><p>Common templates to help with processing TTML documents.</p> + + + <p>This stylesheet contains common utilities for working with TTML documents. It contains templates for checking profiles and processing timing data.</p> + + + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links><list style="compact"><title>Calls Parameters</title><item><p><link xref="ttml.features"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/ttml.profile.attr.page b/doc/yelp-xsl/C/ttml.profile.attr.page new file mode 100644 index 00000000..c1c60e7e --- /dev/null +++ b/doc/yelp-xsl/C/ttml.profile.attr.page @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="ttml.profile.attr" type="topic" style="xslt-template"><info><link type="guide" xref="ttml" group="templates"/><link type="guide" xref="templates" group="ttml"/><revision version="3.4" date="2012-03-02" status="final"/><desc>Check whether the stylesheets conform to a <code>profile</code> attribute.</desc></info><title>ttml.profile.attr</title><p>Check whether the stylesheets conform to a <code>profile</code> attribute.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>A <code>tt:tt</code> element containing a <code>profile</code> attribute.</p> + </item> + <item> + <title><code>profile</code></title> + <p>The <code>profile</code> attribute to check.</p> + </item> + </terms></synopsis> + <p>This template checks if the stylesheets comply with a profile as specified by the <code>profile</code> attribute on a <code>tt:tt</code> element. If the profile is one of the pre-defined profiles (<code>dfxp-transformation</code>, <code>dfxp-presentation</code>, and <code>dfxp-full</code>), this template contains built-in rules for quicly checking feature compliance. Otherwise, it downloads the referenced profile and calls <code style="xslt-template" xref="ttml.profile">ttml.profile</code> on it.</p> + <p>Like <code style="xslt-template" xref="ttml.profile">ttml.profile</code>, this template returns the string <code>"true"</code> if all required features are supported, <code>"false"</code> otherwise.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="ttml.profile"/></p></item></list><list style="compact"><title>Calls Parameters</title><item><p><link xref="ttml.features"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/ttml.profile.page b/doc/yelp-xsl/C/ttml.profile.page new file mode 100644 index 00000000..b80a066c --- /dev/null +++ b/doc/yelp-xsl/C/ttml.profile.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="ttml.profile" type="topic" style="xslt-template"><info><link type="guide" xref="ttml" group="templates"/><link type="guide" xref="templates" group="ttml"/><revision version="3.4" date="2012-03-01" status="final"/><desc>Check whether the stylesheets conform to a <code>ttp:profile</code> element.</desc></info><title>ttml.profile</title><p>Check whether the stylesheets conform to a <code>ttp:profile</code> element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The <code>ttp:profile</code> element to check.</p> + </item> + </terms></synopsis> + <p>This template takes a <code>ttp:profile</code> element in the <code style="xslt-param">node</code> parameter and determines whether or not the stylesheets meet all required features and extensions, per section 5.2 of the TTML 1.0 recommendation. This template uses the <code style="xslt-param" xref="ttml.features">ttml.features</code> stylesheet parameter to determine which features are supported by the stylesheet. It returns the string <code>"true"</code> if all required features are supported, <code>"false"</code> otherwise.</p> +<list style="compact"><title>Calls Parameters</title><item><p><link xref="ttml.features"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/ttml.time.range.page b/doc/yelp-xsl/C/ttml.time.range.page new file mode 100644 index 00000000..a704dc01 --- /dev/null +++ b/doc/yelp-xsl/C/ttml.time.range.page @@ -0,0 +1,30 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="ttml.time.range" type="topic" style="xslt-template"><info><link type="guide" xref="ttml" group="templates"/><link type="guide" xref="templates" group="ttml"/><revision version="3.4" date="2012-03-02" status="final"/><desc>Return the absolute begin and end times for a timed element.</desc></info><title>ttml.time.range</title><p>Return the absolute begin and end times for a timed element.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The element containing timing attributes.</p> + </item> + <item> + <title><code>range</code></title> + <p>The absolute range for the parent element.</p> + </item> + <item> + <title><code>begin</code></title> + <p>The value of the <code>begin</code> attribute.</p> + </item> + <item> + <title><code>end</code></title> + <p>The value of the <code>end</code> attribute.</p> + </item> + <item> + <title><code>dur</code></title> + <p>The value of the <code>dur</code> attribute.</p> + </item> + </terms></synopsis> + <p>This template returns the start and end time for a TTML element, based on the <code>begin</code>, <code>end</code>, and <code>dur</code> attributes. It returns each of them as numbers of seconds, as returned by <code style="xslt-template" xref="ttml.time.seconds">ttml.time.seconds</code>, separated by a comma. Begin and end times are returned as absolute times, relative to the computed range of the parent element. The parent range may be passed in the <code style="xslt-param">range</code> parameter. If the parameter is empty, the parent range is computed automatically by calling this template on the nearest ancestor of <code style="xslt-param">node</code> with a <code>begin</code> attribute.</p> + <p>If both <code style="xslt-param">end</code> and <code style="xslt-param">dur</code> are provided, the end times for each are calculated, and the one that results in the shortest duration is used.</p> + <p>If there is no end time for the element, the string <code>∞</code> is used as the end time.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="ttml.time.range"/></p></item><item><p><link xref="ttml.time.seconds"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/ttml.time.seconds.page b/doc/yelp-xsl/C/ttml.time.seconds.page new file mode 100644 index 00000000..1db48e99 --- /dev/null +++ b/doc/yelp-xsl/C/ttml.time.seconds.page @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="ttml.time.seconds" type="topic" style="xslt-template"><info><link type="guide" xref="ttml" group="templates"/><link type="guide" xref="templates" group="ttml"/><revision version="3.4" date="2012-03-02" status="final"/><desc>Return the number of seconds for a time expression.</desc></info><title>ttml.time.seconds</title><p>Return the number of seconds for a time expression.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>time</code></title> + <p>A TTML time expression.</p> + </item> + </terms></synopsis> + <p>This template takes a time expression as used by the <code>begin</code>, <code>end</code>, and <code>dur</code> attributes and returns the number of seconds that expression respresents. Time expressions may be any number parsable by the XPath <code>number</code> function followed by one of the units <code>ms</code> (milliseconds), <code>s</code> (seconds), <code>m</code> (minutes), or <code>h</code> (hours). It returns <code>0</code> if the time expression is invalid.</p> + <p>This template provides support only for the <code>#time-offset</code> TTML feature. It does not support other methods of specifying times.</p> +</page> diff --git a/doc/yelp-xsl/C/utils.email_address.page b/doc/yelp-xsl/C/utils.email_address.page new file mode 100644 index 00000000..6e83b1d6 --- /dev/null +++ b/doc/yelp-xsl/C/utils.email_address.page @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="utils.email_address" type="topic" style="xslt-template"><info><link type="guide" xref="utils" group="templates"/><link type="guide" xref="templates" group="utils"/><revision version="3.4" date="2012-01-18" status="final"/><desc>Get an email address from a mailto URL.</desc></info><title>utils.email_address</title><p>Get an email address from a mailto URL.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>href</code></title> + <p>The mailto URL.</p> + </item> + </terms></synopsis> + <p>This template takes a mailto URL and returns an email address, stripping the URL scheme as well as any query string.</p> +</page> diff --git a/doc/yelp-xsl/C/utils.linenumbering.page b/doc/yelp-xsl/C/utils.linenumbering.page new file mode 100644 index 00000000..f899863c --- /dev/null +++ b/doc/yelp-xsl/C/utils.linenumbering.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="utils.linenumbering" type="topic" style="xslt-template"><info><link type="guide" xref="utils" group="templates"/><link type="guide" xref="templates" group="utils"/><revision version="1.0" date="2010-12-03" status="final"/><desc>Number each line in a verbatim environment.</desc></info><title>utils.linenumbering</title><p>Number each line in a verbatim environment.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>node</code></title> + <p>The verbatim element to create the line numbering for.</p> + </item> + <item> + <title><code>number</code></title> + <p>The starting line number.</p> + </item> + </terms></synopsis> + <p>This template outputs a string with line numbers for each line in a verbatim elements. Each line number is on its own line, allowing the output string to be placed to the side of the verbatim output.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="utils.linenumbering"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/utils.page b/doc/yelp-xsl/C/utils.page new file mode 100644 index 00000000..654dc637 --- /dev/null +++ b/doc/yelp-xsl/C/utils.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:str="http://exslt.org/strings" id="utils" type="guide" style="xslt-stylesheet"><info><link type="guide" xref="stylesheets" group="utils"/><revision version="1.0" date="2010-05-25" status="final"/><link type="xslt-defines-template" xref="utils.repeat_string"/><link type="xslt-defines-template" xref="utils.strip_newlines"/><link type="xslt-defines-template" xref="utils.linenumbering"/><link type="xslt-defines-template" xref="utils.email_address"/></info><title>Utilities</title><p>Common XSLT Utilities.</p> + + + <p>This stylesheet contains various useful utilities that are used throughout the Yelp stylesheets.</p> + + + + + + + + +<links type="topic" groups="stylesheets" style="linklist"><title>Stylesheets</title></links><links type="topic" groups="parameters" style="linklist"><title>Parameters</title></links><links type="topic" groups="modes" style="linklist"><title>Modes</title></links><links type="topic" groups="templates" style="linklist"><title>Templates</title></links><links type="topic" groups="keys" style="linklist"><title>Keys</title></links></page> diff --git a/doc/yelp-xsl/C/utils.repeat_string.page b/doc/yelp-xsl/C/utils.repeat_string.page new file mode 100644 index 00000000..69c4386f --- /dev/null +++ b/doc/yelp-xsl/C/utils.repeat_string.page @@ -0,0 +1,16 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="utils.repeat_string" type="topic" style="xslt-template"><info><link type="guide" xref="utils" group="templates"/><link type="guide" xref="templates" group="utils"/><revision version="1.0" date="2011-08-24" status="final"/><desc>Repeat a string a given number of times.</desc></info><title>utils.repeat_string</title><p>Repeat a string a given number of times.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>string</code></title> + <p>The string to repeat.</p> + </item> + <item> + <title><code>number</code></title> + <p>The number of times to repeat <code style="xslt-param">string</code>.</p> + </item> + </terms></synopsis> + <p>This template repeats the <code style="xslt-param">string</code> argument <code style="xslt-param">number</code> times.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="utils.repeat_string"/></p></item></list></page> diff --git a/doc/yelp-xsl/C/utils.strip_newlines.page b/doc/yelp-xsl/C/utils.strip_newlines.page new file mode 100644 index 00000000..8465ed3e --- /dev/null +++ b/doc/yelp-xsl/C/utils.strip_newlines.page @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<page xmlns="http://projectmallard.org/1.0/" id="utils.strip_newlines" type="topic" style="xslt-template"><info><link type="guide" xref="utils" group="templates"/><link type="guide" xref="templates" group="utils"/><revision version="1.0" date="2010-05-25" status="final"/><desc>Strip leading or trailing newlines from a string.</desc></info><title>utils.strip_newlines</title><p>Strip leading or trailing newlines from a string.</p> + + + <synopsis><title>Parameters</title><terms> + <item> + <title><code>string</code></title> + <p>The string to strip newlines from.</p> + </item> + <item> + <title><code>leading</code></title> + <p>Whether to strip leading newlines.</p> + </item> + <item> + <title><code>trailing</code></title> + <p>Whether to strip trailing newlines.</p> + </item> + </terms></synopsis> + <p>This template strips at most one leading and one trailing newline from <code style="xslt-param">string</code>. This is useful for preformatted block elements where leading and trailing newlines are ignored to make source formatting easier for authors.</p> +<list style="compact"><title>Calls Templates</title><item><p><link xref="utils.strip_newlines"/></p></item></list></page> |