This is the mail archive of the
docbook-apps@lists.oasis-open.org
mailing list .
Re: how to comment programlisting or source code
- From: Bob Stayton <bobs at caldera dot com>
- To: "Robert P. J. Day" <rpjday at mindspring dot com>,docbook apps list <docbook-apps at lists dot oasis-open dot org>
- Date: Thu, 22 Aug 2002 10:41:07 -0700
- Subject: Re: DOCBOOK-APPS: how to comment programlisting or source code
- References: <Pine.LNX.4.44.0208220731150.9268-100000@dhcp-942-45>
On Thu, Aug 22, 2002 at 07:35:44AM -0400, Robert P. J. Day wrote:
>
> i asked this question before and remember getting a response, and
> managed to lose it somewhere.
>
> for the time being, i'm just generating HTML from my docbook source,
> writing courseware manuals. i'd like to comment the lines of source
> code that i include (most likely in a <programlisting>) so that the
> comments are nicely lined up (left-justified) and in italics.
>
> i know -- i can't actually say italics, so i'd probably tag the
> comments as, what, lineannotation? but it's the lining up that i don't
> know how to do.
>
> any helpful hints? i'm still looking for that previous response ...
> argh.
Since programlisting is a verbatim block, can't you
just line up your annotations manually as you write them?
Maybe I'm not understanding what you are trying to do.
If you are doing long comments that wrap, perhaps you could
use callouts?
--
Bob Stayton 400 Encinal Street
Publications Architect Santa Cruz, CA 95060
Technical Publications voice: (831) 427-7796
Caldera International, Inc. fax: (831) 429-1887
email: bobs@caldera.com