Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 22 May 2001 14:44:30 +0200
From:      "Karsten W. Rohrbach" <karsten@rohrbach.de>
To:        freebsd-hackers@freebsd.org
Cc:        freebsd-doc@freebsd.org
Subject:   what is a good toolkit for multitarget documentation?
Message-ID:  <20010522144430.Q88529@mail.webmonster.de>

next in thread | raw e-mail | index | archive | help
hey folks, 

i am currently evaluating different styles of implementing documentation
for some multiplatform software stuff. first i though about html only
docs, but this is not sufficient. then i thought about tex docs but this
wont work out either.

the idea is to have a single 'master repo' style document tree that can
be used to dump out 
- html all-in-one-file and chapters
- tex for pretty printing and pdf output
- man pages
- README, CHANGES and auxiliary documentation text files

is sgml/docbook the way to go? i've seen that the freebsd handbook and
other documents obviously are written using the docbook dtd, but i
cannot find any pointers what software are involved in creating readable
documents. 

i actually found a short editor/opensp/jadetex/tex howto but this would
just replace the main functionality of latex, and that's not what i
want. i guess my tex speaking skills are better than sgml ;-)

as this seems to be arbitrary complicated, depending on the parsers and
filters used, is there 
a) a simpler way of doing this?
b) a recommended, standard, way?

another question is, if it is possible to 'fold' certain paragraphs or
whole chapters based on the assumption that we generate one handbook for
beginners and a slightly different one for advanced users and one with
source code snippets -- or even whole source files with annotations --
for developers.

thx in advance!

cheers,
/k

-- 
> Worry is interest paid before a debt is due.
KR433/KR11-RIPE -- WebMonster Community Founder -- nGENn GmbH Senior Techie
http://www.webmonster.de/ -- ftp://ftp.webmonster.de/ -- http://www.ngenn.net/
karsten&rohrbach.de -- alpha&ngenn.net -- alpha&scene.org -- catch@spam.de
GnuPG 0x2964BF46 2001-03-15 42F9 9FFF 50D4 2F38 DBEE  DF22 3340 4F4E 2964 BF46

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010522144430.Q88529>