Despite my initial optimism regarding using linuxdoc, I have not been able to
get a WYSIWYM editor to create passable linuxdoc format.
I initially played around with lyx version 1.1.6fix3 (installed by rpm into
GUI looks great. Editing was easy. However, when exporting to docbook I was
loosing tags, and sometimes getting the wrong tags.
Eg, I was getting <p> when I should be getting <para>.
Secondly, when importing docbook files the file either would not import (as
happened with the lyx docbook example) or the file lost tags, converting
stardard text into heading text.
So it was not possible to go from lyx format => linuxdoc format => lyx format.
On top of this, Rob reported problems installing lyx on linux due to
dependancy problems and the windows version has a complicated setup involving
cygwin, LaTeX and X Server.
There is currently talk of releasing a version 2 soon which may be more
robust, but for the moment I don't think lyx is suitable.
I also played around a little with xxe version M1.3p1. This is written in
java so solves cross platform issues.
I have not tested this as well after being a bit burnt out by lyx.
However the output of xxe was not passable by openjade because it did not
seem to be true linuxdoc format. This may be fixable using settings
somewhere or setting up a template, but it was not obvious from the quick
look I did.
Also, there is not much on the web that I could find so it does not seem to
have a large user base supporting it.
I did not investigate any commercial editors.
Some text editors (like vi) provide context highlighting.
I did not do much research here, but the Linux Documentation Project
recommends a few.
jade and openjade
These are the rendering tools which convert .sgml files (linuxdoc) into html.
This bit was quite successful, and I was able to produce nice html pages as
long as I had doctored the souce using vi.
Free What You See Is What You Mean (WYSIWYM) editors for
linuxdoc/docbook/.sgml files are not up to scratch yet.
However, if you are prepared to edit your document using standard text
editors then going from .sgml->html is fine.
For the moment, I suggest we write our documentation in html, and convert it
to .sgml when there is a decent free WYSIWYM editor available.