]> granicus.if.org Git - docbook-dsssl/commitdiff
Added support for "software" and "sectdesc" class values on
authorMichael Smith <xmldoc@users.sourceforge.net>
Sat, 8 Apr 2006 16:54:41 +0000 (16:54 +0000)
committerMichael Smith <xmldoc@users.sourceforge.net>
Sat, 8 Apr 2006 16:54:41 +0000 (16:54 +0000)
refmiscinfo; "software" is treated identically to "source", and
"setdesc" is treated identically to "manual".

xsl/common/refentry.xsl
xsl/params/man.th.extra2.max.length.xml
xsl/params/refentry.source.name.profile.xml

index 5606700bb02f7d1b1c8f6fa3d9c62673a6e5cc42..b2e09b4e9c2e31a733dcd45cbf05796de1ac376d 100644 (file)
     </itemizedlist>
     </para>
 
+    <para>The <literal>solbook(5)</literal> man page describes
+    something very much like what <literal>man(7)</literal> calls
+    "source", except that <literal>solbook(5)</literal> names it
+    "software" and describes it like this:
+    <blockquote>
+      <para>This is the name of the software product that the topic
+      discussed on the reference page belongs to. For example UNIX
+      commands are part of the <literal>SunOS x.x</literal>
+      release.</para>
+    </blockquote>
+    </para>
+
     <para>In practice, there are many pages that simply have a version
     number in the "source" field. So, it looks like what we have is a
     two-part field,
       <!-- * the source.name profile is empty; so we need to look -->
       <!-- * for a name to use -->
       <xsl:choose>
-        <xsl:when test="refmeta/refmiscinfo[@class = 'source']">
+        <xsl:when test="refmeta/refmiscinfo[@class = 'source' or @class = 'software']">
           <xsl:apply-templates 
-              select="refmeta/refmiscinfo[@class = 'source'][1]/node()"/>
+              select="refmeta/refmiscinfo[@class = 'source' or @class='software'][1]/node()"/>
         </xsl:when>
         <xsl:otherwise>
-          <xsl:message>Note: meta "source" : Missing refmiscinfo@class="source"</xsl:message>
+          <xsl:message
+              >Note: meta "source" : Missing refmiscinfo@class="source"|"software"</xsl:message>
           <xsl:choose>
             <xsl:when test="$info//productname">
               <xsl:call-template name="set.refentry.metadata">
       </listitem>
     </itemizedlist>
     </para>
+
+    <para>The <literal>solbook(5)</literal> man page describes
+    something very much like what <literal>man(7)</literal> calls
+    "manual", except that <literal>solbook(5)</literal> names it
+    "sectdesc" and describes it like this:
+    <blockquote>
+      <para>This is the section title of the reference page; for
+      example <literal>User Commands</literal>.</para>
+    </blockquote>
+    </para>
+
   </refdescription>
 
   <refparameter>
       </xsl:when>
       <xsl:otherwise>
         <xsl:choose>
-          <xsl:when test="refmeta/refmiscinfo[@class = 'manual']">
+          <xsl:when test="refmeta/refmiscinfo[@class = 'manual' or @class = 'sectdesc']">
             <xsl:apply-templates 
-                select="refmeta/refmiscinfo[@class = 'manual'][1]/node()"/>
+                select="refmeta/refmiscinfo[@class = 'manual' or @class = 'sectdesc'][1]/node()"/>
           </xsl:when>
           <xsl:otherwise>
-            <xsl:message>Note: meta "manual" : Missing refmiscinfo@class="manual"</xsl:message>
+            <xsl:message
+                >Note: meta "manual" : Missing refmiscinfo@class="manual"|"sectdesc"</xsl:message>
             <xsl:choose>
               <xsl:when test="$info//title">
                 <xsl:call-template name="set.refentry.metadata">
index 7ce0d76a52a0b272b7fd067e389bf59bc9007781..f0d643850c1738b7828331a0324e209e8e01c7c6 100644 (file)
@@ -24,7 +24,8 @@ is truncated down to the maximum permitted length.</para>
 
 <para>The content of the <literal>extra2</literal> field is usually
 displayed in the left footer of the page and is typically "source"
-data, often in the form
+data indicating the software system or product that the item
+documented in the man page belongs to, often in the form
 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>;
 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
 man page).</para>
index 22319d44bb10471708c922002d43946b4bc9ad83..c07e667b2af878e2b0c1a1ed52d3d9052ea0132b 100644 (file)
@@ -33,9 +33,10 @@ non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
 <para>A "source name" is one part of a (potentially) two-part
 <replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>
 "source" field. In man pages, it is usually displayed in the left
-footer of the page. The <literal>man(7)</literal> man page describes
-this as "the source of the command", and provides the following
-examples:
+footer of the page. It typically indicates the software system or
+product that the item documented in the man page belongs to. The
+<literal>man(7)</literal> man page describes it as "the source of
+the command", and provides the following examples:
 <itemizedlist>
   <listitem>
     <para>For binaries, use something like: GNU, NET-2, SLS