[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Gnu-arch-users] Re: documentation as info
From: |
Tom Lord |
Subject: |
Re: [Gnu-arch-users] Re: documentation as info |
Date: |
Tue, 16 Sep 2003 20:31:49 -0700 (PDT) |
> From: John Goerzen <address@hidden>
> Actually, I found it the opposite. When I look at a DocBook document,
> I can tell immediately what I'm looking at: something that's supposed
> to be a program listing is labeled as <programlisting>, footnotes are
> labeled as <footnote>, etc.
> The very nice advantage of this is that it separates presentation from
> content.
That's precisely why I made my .doc format. It works quite well as a
pun for comments in C source code. The input to .doc format is _also_
the presentation of content. (It's uses in docs not derived from
source, like the tutorial, are largely a matter of "it was there; it's
convenient; i'm not adding to the list of dependencies if i use this")
> When I look at Tom's language, I can't tell what I'm seeing. For
> instance, at the top of a file, it has /* copyright statement (several
> lines here) */. Then for an apparent section, it looks like the whole
> thing is a comment. I don't know how monospaced type is indicated for
> things that occur within a paragraph, and I can *guess* that for long
> examples, if the line starts with whitespace, it's treated as
> monospace.
Other users have found that a few minutes of looking back and forth
between .html output and .doc source resolves these mysteries.
I very much do not claim that the .doc foo is a work of art or, in the
slightest degree, properly documented. It's an unfinished line of
development. But it's not nearly so mysterious as you indicate.
> What does it mean when I see:
> |whats-missing|
It means "Add an index entry for `whats-missing' referring to this
point in the text." It seemed like a reasonably unobtrusive notation
and one that could be reasonably processed by many
imprecise-yet-useful tools. Like, say, `grep'.
-t
- [Gnu-arch-users] Re: documentation as info, (continued)
- [Gnu-arch-users] Re: documentation as info, Miles Bader, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Tupshin Harper, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Colin Walters, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Tupshin Harper, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, Tom Lord, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, Colin Walters, 2003/09/17
- [OT] XML foo (was Re: [Gnu-arch-users] Re: documentation as info), Tom Lord, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, David Brown, 2003/09/17
- [OT] Re: [Gnu-arch-users] Re: documentation as info, Tom Lord, 2003/09/17
- [Gnu-arch-users] Re: documentation as info, John Goerzen, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info,
Tom Lord <=
- [Gnu-arch-users] Re: documentation as info, Mark A. Flacy, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, MJ Ray, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, Bruce Stephens, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, Miles Bader, 2003/09/17
- Re: [Gnu-arch-users] Re: documentation as info, Colin Walters, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Tom Lord, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Robert Collins, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Tupshin Harper, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Colin Walters, 2003/09/16
- Re: [Gnu-arch-users] Re: documentation as info, Andrew Suffield, 2003/09/16