summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShaun McCance <shaunm@redhat.com>2020-10-16 11:53:48 -0400
committerShaun McCance <shaunm@redhat.com>2020-10-16 11:53:48 -0400
commit16a890af7de8fe55f7cafeb3200b47e6b41c3649 (patch)
treed24d2694b778b6d2118f8fb6228ec64004653166
parentf26a7f86b10197d011f0084765564d332e19e14f (diff)
downloadyelp-xsl-16a890af7de8fe55f7cafeb3200b47e6b41c3649.tar.gz
Some doc updates for text templates
-rw-r--r--doc/yelp-xsl/C/html.css.core.page33
-rw-r--r--doc/yelp-xsl/C/html.css.elements.page54
-rw-r--r--doc/yelp-xsl/C/html.css.syntax.page36
-rw-r--r--doc/yelp-xsl/C/html.page57
-rw-r--r--doc/yelp-xsl/C/tmpl.file.page2
-rw-r--r--doc/yelp-xsl/C/tmpl.page2
-rw-r--r--doc/yelp-xsl/C/tmpl.text.page2
-rw-r--r--xslt/common/html.xsl12
-rw-r--r--xslt/common/tmpl.xsl6
9 files changed, 39 insertions, 165 deletions
diff --git a/doc/yelp-xsl/C/html.css.core.page b/doc/yelp-xsl/C/html.css.core.page
index 374ca1eb..fa25af26 100644
--- a/doc/yelp-xsl/C/html.css.core.page
+++ b/doc/yelp-xsl/C/html.css.core.page
@@ -33,35 +33,11 @@
common spacings for block-level elements like paragraphs and lists, defines
styles for links, and defines four common wrapper divs: <sys>header</sys>, <sys>side</sys>,
<sys>body</sys>, and <sys>footer</sys>.</p>
+ <p>This template uses text templates to keep the actual CSS content in a
+ separate file, <sys>css/core.css.tmpl</sys>, and do simple param substitutions.
+ This makes it easier to update the CSS without working with XSLT.</p>
<p>All parameters can be automatically computed if not provided.</p>
<list style="compact">
- <title>Calls Parameters</title>
- <item>
- <p><link xref="color.bg"/></p>
- </item>
- <item>
- <p><link xref="color.bg.dark"/></p>
- </item>
- <item>
- <p><link xref="color.bg.gray"/></p>
- </item>
- <item>
- <p><link xref="color.fg"/></p>
- </item>
- <item>
- <p><link xref="color.fg.blue"/></p>
- </item>
- <item>
- <p><link xref="color.fg.dark"/></p>
- </item>
- <item>
- <p><link xref="color.fg.purple"/></p>
- </item>
- <item>
- <p><link xref="color.gray"/></p>
- </item>
- </list>
- <list style="compact">
<title>Calls Templates</title>
<item>
<p><link xref="l10n.align.end"/></p>
@@ -72,5 +48,8 @@
<item>
<p><link xref="l10n.direction"/></p>
</item>
+ <item>
+ <p><link xref="tmpl.file"/></p>
+ </item>
</list>
</page>
diff --git a/doc/yelp-xsl/C/html.css.elements.page b/doc/yelp-xsl/C/html.css.elements.page
index 8e2a48fd..4da538ff 100644
--- a/doc/yelp-xsl/C/html.css.elements.page
+++ b/doc/yelp-xsl/C/html.css.elements.page
@@ -33,56 +33,11 @@
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>This template uses text templates to keep the actual CSS content in a
+ separate file, <sys>css/elements.css.tmpl</sys>, and do simple param substitutions.
+ This makes it easier to update the CSS without working with XSLT.</p>
<p>All parameters can be automatically computed if not provided.</p>
<list style="compact">
- <title>Calls Parameters</title>
- <item>
- <p><link xref="color.bg"/></p>
- </item>
- <item>
- <p><link xref="color.bg.blue"/></p>
- </item>
- <item>
- <p><link xref="color.bg.dark"/></p>
- </item>
- <item>
- <p><link xref="color.bg.gray"/></p>
- </item>
- <item>
- <p><link xref="color.bg.yellow"/></p>
- </item>
- <item>
- <p><link xref="color.blue"/></p>
- </item>
- <item>
- <p><link xref="color.fg"/></p>
- </item>
- <item>
- <p><link xref="color.fg.blue"/></p>
- </item>
- <item>
- <p><link xref="color.fg.dark"/></p>
- </item>
- <item>
- <p><link xref="color.fg.gray"/></p>
- </item>
- <item>
- <p><link xref="color.fg.red"/></p>
- </item>
- <item>
- <p><link xref="color.gray"/></p>
- </item>
- <item>
- <p><link xref="color.red"/></p>
- </item>
- <item>
- <p><link xref="color.yellow"/></p>
- </item>
- <item>
- <p><link xref="icons.size.quote"/></p>
- </item>
- </list>
- <list style="compact">
<title>Calls Templates</title>
<item>
<p><link xref="l10n.align.end"/></p>
@@ -96,5 +51,8 @@
<item>
<p><link xref="l10n.gettext"/></p>
</item>
+ <item>
+ <p><link xref="tmpl.file"/></p>
+ </item>
</list>
</page>
diff --git a/doc/yelp-xsl/C/html.css.syntax.page b/doc/yelp-xsl/C/html.css.syntax.page
index 1b95d85d..32cafba7 100644
--- a/doc/yelp-xsl/C/html.css.syntax.page
+++ b/doc/yelp-xsl/C/html.css.syntax.page
@@ -33,40 +33,13 @@
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 <code xref="color">color</code>.</p>
+ <p>This template uses text templates to keep the actual CSS content in a
+ separate file, <sys>css/syntax.css.tmpl</sys>, and do simple param substitutions.
+ This makes it easier to update the CSS without working with XSLT.</p>
<p>All parameters can be automatically computed if not provided.</p>
<list style="compact">
<title>Calls Parameters</title>
<item>
- <p><link xref="color.bg.green"/></p>
- </item>
- <item>
- <p><link xref="color.bg.red"/></p>
- </item>
- <item>
- <p><link xref="color.fg.blue"/></p>
- </item>
- <item>
- <p><link xref="color.fg.dark"/></p>
- </item>
- <item>
- <p><link xref="color.fg.gray"/></p>
- </item>
- <item>
- <p><link xref="color.fg.green"/></p>
- </item>
- <item>
- <p><link xref="color.fg.orange"/></p>
- </item>
- <item>
- <p><link xref="color.fg.purple"/></p>
- </item>
- <item>
- <p><link xref="color.fg.red"/></p>
- </item>
- <item>
- <p><link xref="color.fg.yellow"/></p>
- </item>
- <item>
<p><link xref="html.syntax.highlight"/></p>
</item>
</list>
@@ -81,5 +54,8 @@
<item>
<p><link xref="l10n.direction"/></p>
</item>
+ <item>
+ <p><link xref="tmpl.file"/></p>
+ </item>
</list>
</page>
diff --git a/doc/yelp-xsl/C/html.page b/doc/yelp-xsl/C/html.page
index 5edd6d26..b148fca8 100644
--- a/doc/yelp-xsl/C/html.page
+++ b/doc/yelp-xsl/C/html.page
@@ -34,66 +34,15 @@
<list style="compact">
<title>Calls Parameters</title>
<item>
- <p><link xref="color.bg"/></p>
- </item>
- <item>
- <p><link xref="color.bg.blue"/></p>
- </item>
- <item>
- <p><link xref="color.bg.dark"/></p>
- </item>
- <item>
<p><link xref="color.bg.gray"/></p>
</item>
<item>
- <p><link xref="color.bg.green"/></p>
- </item>
- <item>
- <p><link xref="color.bg.red"/></p>
- </item>
- <item>
- <p><link xref="color.bg.yellow"/></p>
- </item>
- <item>
- <p><link xref="color.blue"/></p>
- </item>
- <item>
- <p><link xref="color.fg"/></p>
- </item>
- <item>
- <p><link xref="color.fg.blue"/></p>
- </item>
- <item>
<p><link xref="color.fg.dark"/></p>
</item>
<item>
- <p><link xref="color.fg.gray"/></p>
- </item>
- <item>
- <p><link xref="color.fg.green"/></p>
- </item>
- <item>
- <p><link xref="color.fg.orange"/></p>
- </item>
- <item>
- <p><link xref="color.fg.purple"/></p>
- </item>
- <item>
- <p><link xref="color.fg.red"/></p>
- </item>
- <item>
- <p><link xref="color.fg.yellow"/></p>
- </item>
- <item>
<p><link xref="color.gray"/></p>
</item>
<item>
- <p><link xref="color.red"/></p>
- </item>
- <item>
- <p><link xref="color.yellow"/></p>
- </item>
- <item>
<p><link xref="html.basename"/></p>
</item>
<item>
@@ -111,9 +60,6 @@
<item>
<p><link xref="html.xhtml"/></p>
</item>
- <item>
- <p><link xref="icons.size.quote"/></p>
- </item>
</list>
<list style="compact">
<title>Calls Templates</title>
@@ -135,6 +81,9 @@
<item>
<p><link xref="l10n.gettext"/></p>
</item>
+ <item>
+ <p><link xref="tmpl.file"/></p>
+ </item>
</list>
<list style="compact">
<title>Calls Modes</title>
diff --git a/doc/yelp-xsl/C/tmpl.file.page b/doc/yelp-xsl/C/tmpl.file.page
index 5d4179b7..8cfb8206 100644
--- a/doc/yelp-xsl/C/tmpl.file.page
+++ b/doc/yelp-xsl/C/tmpl.file.page
@@ -4,7 +4,7 @@
<link type="guide" xref="tmpl" group="templates"/>
<link type="guide" xref="templates" group="tmpl"/>
<desc>Perform text substitutions on a file.</desc>
- <revision version="40" date="FIXME" status="FIXME"/>
+ <revision version="40" date="2020-10-16" status="final"/>
</info>
<title>tmpl.file</title>
<synopsis>
diff --git a/doc/yelp-xsl/C/tmpl.page b/doc/yelp-xsl/C/tmpl.page
index 1715bc39..f0419a63 100644
--- a/doc/yelp-xsl/C/tmpl.page
+++ b/doc/yelp-xsl/C/tmpl.page
@@ -3,7 +3,7 @@
<info>
<link type="guide" xref="stylesheets" group="tmpl"/>
<desc>Perform simple substitutions in text files.</desc>
- <revision version="40" date="FIXME" status="FIXME"/>
+ <revision version="40" date="2020-10-16" status="final"/>
</info>
<title>Text Templates</title>
<p>This stylesheet contains templates to perform simple substitutions on text
diff --git a/doc/yelp-xsl/C/tmpl.text.page b/doc/yelp-xsl/C/tmpl.text.page
index 4f4f5901..375e9ece 100644
--- a/doc/yelp-xsl/C/tmpl.text.page
+++ b/doc/yelp-xsl/C/tmpl.text.page
@@ -4,7 +4,7 @@
<link type="guide" xref="tmpl" group="templates"/>
<link type="guide" xref="templates" group="tmpl"/>
<desc>Perform text substitutions on some text.</desc>
- <revision version="40" date="FIXME" status="FIXME"/>
+ <revision version="40" date="2020-10-16" status="final"/>
</info>
<title>tmpl.text</title>
<synopsis>
diff --git a/xslt/common/html.xsl b/xslt/common/html.xsl
index 453d205c..17778344 100644
--- a/xslt/common/html.xsl
+++ b/xslt/common/html.xsl
@@ -1222,6 +1222,10 @@ common spacings for block-level elements like paragraphs and lists, defines
styles for links, and defines four common wrapper divs: `header`, `side`,
`body`, and `footer`.
+This template uses text templates to keep the actual CSS content in a
+separate file, `css/core.css.tmpl`, and do simple param substitutions.
+This makes it easier to update the CSS without working with XSLT.
+
All parameters can be automatically computed if not provided.
-->
<xsl:template name="html.css.core">
@@ -1266,6 +1270,10 @@ 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.
+This template uses text templates to keep the actual CSS content in a
+separate file, `css/elements.css.tmpl`, and do simple param substitutions.
+This makes it easier to update the CSS without working with XSLT.
+
All parameters can be automatically computed if not provided.
-->
<xsl:template name="html.css.elements">
@@ -1377,6 +1385,10 @@ 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 {color}.
+This template uses text templates to keep the actual CSS content in a
+separate file, `css/syntax.css.tmpl`, and do simple param substitutions.
+This makes it easier to update the CSS without working with XSLT.
+
All parameters can be automatically computed if not provided.
-->
<xsl:template name="html.css.syntax">
diff --git a/xslt/common/tmpl.xsl b/xslt/common/tmpl.xsl
index 4df8e1ed..c52a95cf 100644
--- a/xslt/common/tmpl.xsl
+++ b/xslt/common/tmpl.xsl
@@ -24,7 +24,7 @@ along with this program; see the file COPYING.LGPL. If not, see
<!--!!==========================================================================
Text Templates
Perform simple substitutions in text files.
-@revision[version=40 date=FIXME status=FIXME]
+@revision[version=40 date=2020-10-16 status=final]
This stylesheet contains templates to perform simple substitutions on text
and files containing text. The primary purpose of these templates is to allow
@@ -48,7 +48,7 @@ This stylesheet was added in version 40.
<!--**==========================================================================
tmpl.file
Perform text substitutions on a file.
-@revision[version=40 date=FIXME status=FIXME]
+@revision[version=40 date=2020-10-16 status=final]
[xsl:params]
$file: The filename of the file to process for substitutions.
@@ -100,7 +100,7 @@ This template was added in version 40.
<!--**==========================================================================
tmpl.text
Perform text substitutions on some text.
-@revision[version=40 date=FIXME status=FIXME]
+@revision[version=40 date=2020-10-16 status=final]
[xsl:params]
$text: The text to process for substitutions.