[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff] Re: Simplifying groff documentation
From: |
Werner LEMBERG |
Subject: |
[Groff] Re: Simplifying groff documentation |
Date: |
Mon, 25 Dec 2006 10:25:48 +0100 (CET) |
> I don't want to go down a technical rathole of adding complexity and
> not actually solving the problem. Gunnar shows us that the real
> problem here is these special macros are too complicated for
> anything but groff to interpret. That's the issue that needs to be
> fixed, not kluged around with excessive cleverness in my software --
> even if the cleverness would be fun for me to implement.
We are getting nearer. I can live with what you say above.
However...
> So by inserting a few .br requests in the Synopsis section, I can
> both mostly restore the visual appearance of the Synopsis in troff
> output and duplicate it rather closely in generated HTML.
... this is too simplistic IMHO. See my other mail.
> It would take the markup on these pages back down towards
> presentation level, yes -- but as a matter of reality troff is
> irremediably stuck there anyway.
I want a presentation which works equally well for all output devices.
I'm willing to restrict the involved macros to something doclifter can
understand (and this stuff could be then documented properly in a
guide).
> Bernd's experiment art getting to structural level was a good try,
> but it creates more problems than it solves.
Probably you are right. BTW, what about -mdoc? This package has a
much richer set of commands, and there is rarely a need to define a
command by yourself. And it can produce nicely formatted SYNOPSIS
sections without the aid of low-level groff stuff. Perhaps I shall
convert some of the problematic man pages to that format...
Werner
[Groff] Re: Simplifying groff documentation, Werner LEMBERG, 2006/12/23
- [Groff] Re: Simplifying groff documentation, Eric S. Raymond, 2006/12/24
- [Groff] Re: Simplifying groff documentation, Werner LEMBERG, 2006/12/24
- [Groff] Re: Simplifying groff documentation, Eric S. Raymond, 2006/12/24
- [Groff] Re: Simplifying groff documentation,
Werner LEMBERG <=
- [Groff] Re: Simplifying groff documentation, Eric S. Raymond, 2006/12/26
- [Groff] Re: Simplifying groff documentation, Werner LEMBERG, 2006/12/27
- [Groff] Re: Simplifying groff documentation, Eric S. Raymond, 2006/12/27
- Re: [Groff] Re: Simplifying groff documentation, Gunnar Ritter, 2006/12/27
- Re: [Groff] Re: Simplifying groff documentation, Eric S. Raymond, 2006/12/27
- Re: [Groff] Re: Simplifying groff documentation, Gunnar Ritter, 2006/12/27
- [Groff] The case against the case against .EX/.EE & .DS/.DE, Eric S. Raymond, 2006/12/27
- Re: [Groff] The case against the case against .EX/.EE & .DS/.DE, Werner LEMBERG, 2006/12/28
- Re: [Groff] The case against the case against .EX/.EE & .DS/.DE, Meg McRoberts, 2006/12/28
- Re: [Groff] The case against the case against .EX/.EE & .DS/.DE, Eric S. Raymond, 2006/12/28