Hello all,

A while back I said I would be doing this -- looking at replacing the
current Docbook system with asciidoc.  I've made a start [1] on this --
sorry it's taken me such a long time.

Note that everything is contained within the Documentation/ directory.  This
is deliberate, I want this branch to still be buildable as-is, and also we
already have (rather confusingly) doc/ and docs/ directories as it is.

What I've done is looked at the groupedCommands.html page we currently have
[2] and thought this was a fairly good place to start thinking about how we
can actually split up the monolithic fvwm page once and for all (it's
always seemed odd that the HTML versions of what we have, despite coming
from the same source, is not reflected in multiple man pages for fvwm
currently).  So I've given it a go...

I've converted the individual files referenced in the
groupedCommands [2] page to text, and grouped all of them into different
directories.  I've tried to keep the number of sections down.  Then, for
each section I've "converted" over, I've created a .txt file which is the
man page (i.e., contains NAME, SYNOPSIS, DESCRIPTION headers) and simply
included all of the snippets of information for all files under the
corresponding directory.  Just take a look at
Documentation/fvwmconditionals.txt to see what I'm referring to.

Asciidoc's man page driver enforces the three sections of NAME, SYNOPSIS,
and DESCRIPTION, which makes writing generic top-level descriptions for
sections a pain, but see what I've done for the SYNOPSIS section by simply
using "fvwm *" -- I think that'll be sufficient.

I can't/won't convert all of this by myself.  It's simply too much work for
me.  Of the sections I've tentatively converted, all have top-level .txt
files under Documentation/

I've added a TODO list as well, and a little shell-script under
Documentation/ you can use to build all of this.

I know this is a little vague; I just wanted to try and get the ball rolling
on this.

Any questions, please ask.

-- Thomas Adam

[1]  https://github.com/ThomasAdam/fvwm/tree/ta/asciidoc
[2]  http://fvwm.org/doc/unstable/groupedCommands.html

-- 
"Deep in my heart I wish I was wrong.  But deep in my heart I know I am
not." -- Morrissey ("Girl Least Likely To" -- off of Viva Hate.)

Reply via email to