On Mon, Aug 25, 2014 at 09:22:59PM +0400, Roman Grazhdan wrote: > >I've spent weeks to add the proper markup to the original fvwm man > >pages before they were converted to xml. I won't accept any > >documentation format that throws all this extra information away > >for no reason. > > So Dominik, you would set requirements later so that I could check > what I'm doing against them?
> I like the current manual very much, it's really helpful and as > close to easy to use as a documentation for something like fvwm > can get, and I'd like it to stay this way. Me too. My only personal requirements are that (a) the final, rendered man page should mostly look like it looks now (not losing the markup I mentioned, although we have a bit too much at the moment), and (b) that I'll be able document new features in the future without much overhead. I've always been very happy with the roff format we had before the switch to xml. Before xml there were these short instructions about editing the man pages right at the top (e.g. in the 2.4.0 tarball): -- .\" Formating instructions for the fvwm man page: .\" .\" - Do not use \f... formatting instructions. .\" - Avoid single and double quotes wherever possible. .\" .\" For further details, please refer to the Linux Man-Page how-to. .\" .\" context typeface example .\" ---------------------------------- -------------- ----------------- .\" filenames: italics (.I) .I .fvwm2rc .\" command line options of fvwm2 cmd: bold (.B) .B \-cmd .\" arguments of command line options: italics (.I) .BI \-cmd command .\" built in commands: bold (.B) .B Move .\" references to built in commands: bold (.B) .RB See Move .\" references to man page sections: bold (.B) .RB See SYNOPSIS .\" references to style options: italics (.I) .RI See Lenience .\" built in command options: italics (.I) .BI "Move " "0 0" .\" command syntax: bold/ita. (.BI) .BI "Move [" "x y" "]" .\" environment variables: italics (.I) .I $DISPLAY .\" key names: small (.SM) .SM Tab .\" style names and strings: double quotes "stylename", "x" .\" single characters: single quotes '@' .\" module names: bold (.B) .B FvwmTheme .\" links to web pages: bold (.B) .B http://fvwm.org .\" acronyms: small (.SM) .SM ICCCM .\" .\" .\" The name fvwm is written in lower case throughout this man page. .\" .\" Note that the word "will" is rarely correct in a man page or any document. .\" Describe what fvwm does, not what it will do, even if you haven't .\" written the feature yet. dje 2/3/01. .\" .\" A note to everyone who needs to write dates. Don't use 2/3/01 notation, .\" a non-american person simply can't parse such sequence of digits. .\" Please use 3-Feb-2001 or 2001-02-03 forms. migo 16/May/2001. -- Ciao Dominik ^_^ ^_^ -- Dominik Vogt
