You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Joe Orton <jo...@redhat.com> on 2003/11/25 12:51:00 UTC
[PATCH] man page style tweaks
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
Re: [PATCH] man page style tweaks
Posted by Joe Orton <jo...@redhat.com>.
On Tue, Nov 25, 2003 at 01:51:45PM +0100, André Malo wrote:
> * Joe Orton <jo...@redhat.com> wrote:
>
> > 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.
>
> I'd say, go for it, except:
>
> + <xsl:with-param name="text" select="title"/>
>
> title should be still normalized-space'd, that it fits into one line.
Thanks, I checked it in with that change.
joe
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: [PATCH] man page style tweaks
Posted by André Malo <nd...@perlig.de>.
* Joe Orton <jo...@redhat.com> wrote:
> 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.
I'd say, go for it, except:
+ <xsl:with-param name="text" select="title"/>
title should be still normalized-space'd, that it fits into one line.
nd
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org