[yelp-xsl] xslt: Added a bunch more xsldoc

From: Shaun McCance <shaunm src gnome org>
To: commits-list gnome org
Cc:
Subject: [yelp-xsl] xslt: Added a bunch more xsldoc
Date: Mon, 5 Nov 2012 20:44:24 +0000 (UTC)
commit 8cfce4d7f39171e1b4cc1e5ce6f845c4c67435a4
Author: Shaun McCance <shaunm gnome org>
Date:   Mon Nov 5 15:36:24 2012 -0500

    xslt: Added a bunch more xsldoc

 xslt/docbook/html/db2html-division.xsl |   10 ++++--
 xslt/docbook/html/db2html.xsl          |    7 ++++
 xslt/docbook/html/db2xhtml.xsl         |    6 ++++
 xslt/mallard/common/mal-if.xsl         |   18 ++++++-----
 xslt/mallard/html/mal2html-media.xsl   |   50 +++++++++++++++++++++++++------
 xslt/mallard/html/mal2html-page.xsl    |   38 +++++++++++++++++++++---
 xslt/mallard/html/mal2html.xsl         |    7 ++++-
 xslt/mallard/html/mal2xhtml.xsl        |    7 ++++-
 8 files changed, 115 insertions(+), 28 deletions(-)
---
diff --git a/xslt/docbook/html/db2html-division.xsl b/xslt/docbook/html/db2html-division.xsl
index 5a0860f..d00313b 100644
--- a/xslt/docbook/html/db2html-division.xsl
+++ b/xslt/docbook/html/db2html-division.xsl
@@ -25,9 +25,12 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 DocBook to HTML - Divisions
-:Requires: db-chunk db-title db-xref db2html-css db2html-footnote db2html-xref l10n
+Handle division-level DocBook elements.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-REMARK: Describe this module
+This stylesheet contains templates to process top-level and sectioning elements
+in DocBook. It handles chunking and implements the interfaces provided by the
+common !{html} stylesheet.
 -->
 
 
@@ -328,8 +331,9 @@ REMARK: Talk about the different kinds of title blocks
 <!--**==========================================================================
 db2html.division.about
 Output the copyrights, credits, and license information at the bottom of a page.
-:Revision:version="3.4" date="2011-11-07"
+:Revision:version="3.8" date="2012-11-05" status="final"
 $node: A division-level element a page is being created for.
+$info: The info child element of ${node}
 
 This template outputs copyright information, credits, and license information for
 the division. By default it is called by the %{html.footer.mode} implementation.
diff --git a/xslt/docbook/html/db2html.xsl b/xslt/docbook/html/db2html.xsl
index f0099f2..34871eb 100644
--- a/xslt/docbook/html/db2html.xsl
+++ b/xslt/docbook/html/db2html.xsl
@@ -22,6 +22,13 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 DocBook to HTML
+Transform DocBook to HTML.
+:Revision:version="3.8" date="2012-11-05" status="final"
+
+This top-level stylesheet includes all the necessary stylesheets to transform
+DocBook documents into HTML. It imports !{db2xhtml}, overrides parameters, and
+sets a namespace alias to output non-XML HTML. This stylesheet sets
+ {html xhtml} to #{false}.
 -->
 
 <xsl:include href="db2xhtml.xsl" pass="true"><?pass?></xsl:include>
diff --git a/xslt/docbook/html/db2xhtml.xsl b/xslt/docbook/html/db2xhtml.xsl
index bf0422f..a6035ec 100644
--- a/xslt/docbook/html/db2xhtml.xsl
+++ b/xslt/docbook/html/db2xhtml.xsl
@@ -22,6 +22,12 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 DocBook to XHTML
+Transform DocBook to XHTML.
+:Revision:version="3.8" date="2012-11-05" status="final"
+
+This top-level stylesheet includes all the necessary stylesheets to transform
+DocBook documents into XHTML. This stylesheet sets the parameter
+ {db chunk extension} 
 -->
 
 <xsl:import href="../../common/l10n.xsl"/>
diff --git a/xslt/mallard/common/mal-if.xsl b/xslt/mallard/common/mal-if.xsl
index 9333c82..d5cf80f 100644
--- a/xslt/mallard/common/mal-if.xsl
+++ b/xslt/mallard/common/mal-if.xsl
@@ -29,7 +29,7 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 <!--!!==========================================================================
 Mallard Conditionals
 Support for run-time conditional processing.
-:Revision:version="1.0" date="2011-04-28" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This stylesheet contains utilities for handling conditional processing
 in Mallard documents.
@@ -39,7 +39,7 @@ in Mallard documents.
 <!--@@==========================================================================
 mal.if.target
 The list of supported target tokens.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This parameter takes a space-separated list of tokens to enable for conditional
 processing. It is used by the template *{mal.if.test}. This parameter is meant
@@ -52,7 +52,7 @@ importing stylesheet.
 <!--@@==========================================================================
 mal.if.platform
 The list of supported platform tokens.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This parameter takes a space-separated list of tokens to enable for conditional
 processing. It is used by the template *{mal.if.test}. This parameter is meant
@@ -65,7 +65,7 @@ by a customization stylesheet.
 <!--@@==========================================================================
 mal.if.features
 The list of supported feature tokens.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This parameter takes a space-separated list of tokens to enable for conditional
 processing. It is used by the template *{mal.if.test}. This parameter is meant
@@ -80,7 +80,7 @@ mallard:1.0
 <!--@@==========================================================================
 mal.if.custom
 A custom list of supported tokens.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This parameter takes a space-separated list of tokens to enable for conditional
 processing. It is used by the template *{mal.if.test}. This parameter is meant
@@ -92,7 +92,7 @@ to hold extra values enabled by hand or by a customization stylesheet.
 <!--@@==========================================================================
 mal.if.maybe
 A list of tokens that may be true.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 This parameter takes a space-separated list of tokens that may be true. The
 template *{mal.if.test} returns special flags when a condition may be true,
@@ -114,7 +114,7 @@ stylesheet.
 <!--**==========================================================================
 mal.if.test
 Test if a condition is true.
-:Revision:version="1.0" date="2012-01-17" status="review"
+:Revision:version="3.8" date="2012-11-05" status="final"
 $node: The element to check the condition for.
 $test: The test expression.
 
@@ -123,7 +123,7 @@ from the #{test} or #{if:test} attribute of $node. It splits the expression on
 commas into subexpression, 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
 @{mal.if.target}, @{mal.if.platform}, @{mal.if.features}, or @{mal.if.custom}.
-If the token starts with an examation point, the exclamation point is stripped
+If the token starts with an exclamation point, the exclamation point is stripped
 and the resulting truth value is negated.
 
 A subexpression is true if all its tokens is true. The full test expression is
@@ -230,6 +230,7 @@ of dynamically showing or hiding content based on those tokens.
   </xsl:choose>
 </xsl:template>
 
+<!--#* _mal.if.test.check_token -->
 <xsl:template name="_mal.if.test.check_token">
   <xsl:param name="token"/>
   <xsl:choose>
@@ -247,6 +248,7 @@ of dynamically showing or hiding content based on those tokens.
   </xsl:choose>
 </xsl:template>
 
+<!--#* _mal.if.test.flatten_token -->
 <xsl:template name="_mal.if.test.flatten_token">
   <xsl:param name="token"/>
   <xsl:for-each select="str:split($token, '')">
diff --git a/xslt/mallard/html/mal2html-media.xsl b/xslt/mallard/html/mal2html-media.xsl
index f952a18..e098c70 100644
--- a/xslt/mallard/html/mal2html-media.xsl
+++ b/xslt/mallard/html/mal2html-media.xsl
@@ -26,15 +26,24 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 Mallard to HTML - Media Elements
+Handle Mallard media elements.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-REMARK: Describe this module
+This stylesheet contains templates for handling Mallard #{media} elements.
+It also handles TTML inside block audio and video #{media} elements.
 -->
 
+
 <!--**==========================================================================
 mal2html.media.image
-FIXME
+Output an #{img} element for an image.
+:Revision:version="3.8" date="2012-11-05" status="final"
+$node: The Mallard #{media} element.
+$inline: Whether ${node} is inline.
 
-FIXME
+This template outputs an HTML #{img} element for a Mallard #{media} element
+with the #{type} attribute set to #{"image"} (or with no #{type} attribute).
+If ${node} has fallback content, it is used for the #{alt} attribute.
 -->
 <xsl:template name="mal2html.media.image">
   <xsl:param name="node" select="."/>
@@ -80,9 +89,15 @@ FIXME
 
 <!--**==========================================================================
 mal2html.media.video
-FIXME
+Output a #{video} element for a video.
+:Revision:version="3.8" date="2012-11-05" status="final"
+$node: The Mallard #{media} element.
+$inline: Whether ${node} is inline.
 
-FIXME
+This template outputs an HTML #{video} element for a Mallard #{media} element
+with the #{type} attribute set to #{"video"}. It converts any fallback content
+in the source to the #{video} element's fallback content. If ${inline} is
+#{false}, this template will process TTML child content.
 -->
 <xsl:template name="mal2html.media.video">
   <xsl:param name="node" select="."/>
@@ -128,9 +143,15 @@ FIXME
 
 <!--**==========================================================================
 mal2html.media.audio
-FIXME
+Output an #{audio} element for an audio object.
+:Revision:version="3.8" date="2012-11-05" status="final"
+$node: The Mallard #{media} element.
+$inline: Whether ${node} is inline.
 
-FIXME
+This template outputs an HTML #{audio} element for a Mallard #{media} element
+with the #{type} attribute set to #{"audio"}. It converts any fallback content
+in the source to the #{audio} element's fallback content. If ${inline} is
+#{false}, this template will process TTML child content.
 -->
 <xsl:template name="mal2html.media.audio">
   <xsl:param name="node" select="."/>
@@ -166,6 +187,15 @@ FIXME
 
 <xsl:template mode="mal2html.block.mode" match="tt:*"/>
 
+<!--%%==========================================================================
+mal2html.ttml.mode
+Process TTML subtitles in a Mallard #{media} element.
+:Revision:version="3.8" date="2012-11-05" status="final"
+
+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.
+-->
 <xsl:template mode="mal2html.ttml.mode" match="tt:tt">
   <xsl:variable name="profile">
     <xsl:choose>
diff --git a/xslt/mallard/html/mal2html-page.xsl b/xslt/mallard/html/mal2html-page.xsl
index 23ee4dc..c8215b4 100644
--- a/xslt/mallard/html/mal2html-page.xsl
+++ b/xslt/mallard/html/mal2html-page.xsl
@@ -30,14 +30,19 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 Mallard to HTML - Pages
+Handle pages, sections, and top-level data.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-REMARK: Describe this module
+This stylesheet contains templates to process Mallard #{page} and #{section}
+elements, including implementations of the interfaces provided by the common
+!{html} stylesheet.
 -->
 
 
 <!--@@==========================================================================
 mal2html.editor_mode
 Add information that's useful to writers and editors.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
 When this parameter is set to true, these stylesheets will output editorial
 comments, status markers, and other information that's useful to writers and
@@ -49,7 +54,7 @@ editors.
 <!--**==========================================================================
 mal2html.page.about
 Output the copyrights, credits, and license information at the bottom of a page.
-:Revision:version="3.4" date="2011-11-06"
+:Revision:version="3.8" date="2012-11-05" status="final"
 $node: The top-level #{page} element.
 
 This template outputs copyright information, credits, and license information for
@@ -399,6 +404,16 @@ separators used between links.
 </xsl:template>
 
 
+<!--**==========================================================================
+mal2html.editor.badge
+Output a badge for a link showing the revision status of the target.
+:Revision:version="3.8" date="2012-11-05" status="final"
+$target: The page or section being linked to.
+
+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
+ {mal2html editor_mode} is #{true}.
+-->
 <xsl:template name="mal2html.editor.badge">
   <xsl:param name="target" select="."/>
   <xsl:if test="$mal2html.editor_mode">
@@ -419,7 +434,6 @@ separators used between links.
         <xsl:attribute name="class">
           <xsl:value-of select="concat('status status-', $revision/@status)"/>
         </xsl:attribute>
-        <!-- FIXME: i18n -->
         <xsl:choose>
           <xsl:when test="$revision/@status = 'stub'">
             <xsl:call-template name="l10n.gettext">
@@ -462,6 +476,17 @@ separators used between links.
   </xsl:if>
 </xsl:template>
 
+
+<!--**==========================================================================
+mal2html.editor.banner
+Output a banner with the revision status of a page.
+:Revision:version="3.8" date="2012-11-05" status="final"
+$node: The top-level #{page} element.
+
+This template is called by the %{html.body.mode} implementation for #{page}
+elements. It outputs a banner providing information about the revision status
+of ${node}. It only outputs a banner if @{mal2html.editor_mode} is #{true}.
+-->
 <xsl:template name="mal2html.editor.banner">
   <xsl:param name="node" select="."/>
   <xsl:if test="$mal2html.editor_mode">
@@ -785,9 +810,12 @@ templates that handle #{page} and #{section} elements.
 
 <!--%%==========================================================================
 mal2html.title.mode
-FIXME
+Output headings for titles and subtitles.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-FIXME
+This template is called on #{title} and #{subtitle} elements that appear as
+direct child content of #{page} or #{section} elements. Normal block titles
+are processed in %{mal2html.block.mode}.
 -->
 <!-- = subtitle = -->
 <xsl:template mode="mal2html.title.mode" match="mal:subtitle">
diff --git a/xslt/mallard/html/mal2html.xsl b/xslt/mallard/html/mal2html.xsl
index a906d8d..0da6249 100644
--- a/xslt/mallard/html/mal2html.xsl
+++ b/xslt/mallard/html/mal2html.xsl
@@ -23,8 +23,13 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 Mallard to HTML
+Transform Mallard to HTML.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-REMARK: Describe this module
+This top-level stylesheet includes all the necessary stylesheets to transform
+Mallard documents into HTML. It imports !{mal2xhtml}, overrides parameters, and
+sets a namespace alias to output non-XML HTML. In particular, this stylesheet
+sets @{html.xhtml} to #{false} and @{mal.if.target} to #{'target:html'}.
 -->
 
 <xsl:param name="html.xhtml" select="false()"/>
diff --git a/xslt/mallard/html/mal2xhtml.xsl b/xslt/mallard/html/mal2xhtml.xsl
index cc22884..4d0c87b 100644
--- a/xslt/mallard/html/mal2xhtml.xsl
+++ b/xslt/mallard/html/mal2xhtml.xsl
@@ -25,8 +25,13 @@ Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 
 <!--!!==========================================================================
 Mallard to XHTML
+Transform Mallard to XHTML.
+:Revision:version="3.8" date="2012-11-05" status="final"
 
-REMARK: Describe this module
+This top-level stylesheet includes all the necessary stylesheets to transform
+Mallard documents into XHTML. This stylesheet sets the parameters
+ {mal if target}, @{mal.if.features}, @{mal.if.maybe}, @{mal.link.extension},
+and @{ttml.features}.
 -->
 
 <xsl:import href="../../common/l10n.xsl"/>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]