httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joe Orton <jor...@redhat.com>
Subject [PATCH] man page style tweaks
Date Tue, 25 Nov 2003 11:51:00 GMT
1) use .SS not .Sh for subheadings, and don't capitalize
these headings.  The groff_man manpage says .SS is the macro to
use for subheadings.

2) remove indents for <dl> lists - these just create too much
whitespace.  It's normal for man page options list to have the same
indentation level for the first line as the main text.

before'n'after from apxs.8: (sans ANSI boldness)

OPTIONS
       COMMON OPTIONS
 
              -n modname
                     This explicitly sets the module name for the -i (install)
                     and -g (template generation) option. Use this to  explic-
                     itly  specify  the  module  name.  For  option -g this is
                     required, for option -i the apxs tool tries to  determine
                     the  name  from the source or (as a fallback) at least by
                     guessing it from the filename.
 ^^too much space^^ :)


and after:

OPTIONS
   Common Options
       -n modname
              This explicitly sets the module name for the -i (install) and -g
              (template generation) option. Use this to explicitly specify the
              module  name.  For option -g this is required, for option -i the
              apxs tool tries to determine the name from the source or (as  a
              fallback) at least by guessing it from the filename.


Index: man/manpage.xsl
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/style/man/manpage.xsl,v
retrieving revision 1.4
diff -u -r1.4 manpage.xsl
--- man/manpage.xsl	29 Apr 2003 23:07:54 -0000	1.4
+++ man/manpage.xsl	25 Nov 2003 11:43:40 -0000
@@ -257,10 +257,9 @@
 <!-- ==================================================================== -->
 <xsl:template match="section/section">
 &lf;
-<xsl:text>.Sh "</xsl:text>
+<xsl:text>.SS "</xsl:text>
     <xsl:call-template name="filter.escape">
-        <xsl:with-param name="text"
-            select="normalize-space(translate(title, $lowercase, $uppercase))"/>
+        <xsl:with-param name="text" select="title"/>
     </xsl:call-template>
 <xsl:text>"</xsl:text>&lf;
 <xsl:apply-templates />
@@ -322,9 +321,7 @@
 <!-- ==================================================================== -->
 <xsl:template match="dl">
 &lf;
-<xsl:text>.RS</xsl:text>&lf;
 <xsl:apply-templates />&lf;
-<xsl:text>.RE</xsl:text>&lf;
 </xsl:template>
 
 

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Mime
View raw message