[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Single source documentation

From: Colin Watson <cjwatson_at_flatline.org.uk>
Date: 2003-11-14 12:22:36 CET

On Thu, Nov 13, 2003 at 09:33:37PM -0500, John R. Daily wrote:
> One of the major remaining showstoppers is figuring out how to
> prevent groff from treating an apostrophe at the beginning of a
> line as a command sequence. groff allows that character to be
> redefined, but there is no completely safe character to use; I'd
> rather just turn it off entirely.

The correct fix is to put \& (a zero-width space) in front of "." or "'"
at the start of lines when you don't want those lines to be treated as
requests.

> <!-- Ideally, variablelists would use the .TP macro, and itemized lists
> might use .IP, but I can't get the macros to work as documented. Not sure
> what I'm doing wrong. -->

What does the groff output look like when you try? I'd be happy to
suggest fixes.

I'm somewhat inclined to suggest that the mdoc macro set would be a
better fit to DocBook than the man macro set, too, although it might be
more work. The traditional SysV man macros are mostly physical markup,
while the BSD mdoc macros have quite rich semantic content.

> <xsl:template match="screen|literallayout|programlisting">
> <xsl:text>.nf
> </xsl:text>
> <xsl:apply-templates/><xsl:text>
> .fi
> </xsl:text>
> </xsl:template>

Perhaps also use a constant-width font here?

  .nf
  .ft CW
  ...
  .ft R
  .fi

(Perl's man pages do this.)

Cheers,

-- 
Colin Watson                                  [cjwatson@flatline.org.uk]
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Nov 14 12:23:24 2003

This is an archived mail posted to the Subversion Dev mailing list.