Date: Sat, 15 Apr 1995 14:11:22 -0400 (EDT) From: John Fieber <jfieber@cs.smith.edu> To: core@freebsd.org, doc@freebsd.org Subject: Proposal to move the FreeBSD FAQ and handbook Message-ID: <199504151811.OAA25031@grover.graceland.org>
next in thread | raw e-mail | index | archive | help
As the documentation project is progressing, it is outgrowing the
scope implied by the nome of the directory in which it lives,
namely /usr/share/FAQ. In light of this, I am proposing to
moving the contents from /usr/share/FAQ to /usr/share/doc with
the following subdirectories:
/usr/share/doc/FAQ: home for the existing FAQ
/usr/share/doc/handbook: home for the FreeBSD handbook that is
currently coming into existance
The organization of of the handbook is somewhat in flux and I
have no sentimental attachment to calling the directory
"handbook". In FreeBSD-current, the handbook exists as a
separate user guide and administration guide, but I gan almost
guarantee that the structure will change a fair amount between
now and the release of 2.1. It is likely that it be processed as
a single piece, i.e, turning it into a LaTeX file will generate a
single, integrated FreeBSD handbook. (This also greatly
simplifies making cross-references that become hypetext links in
the HTML version.)
A good share of what currently lives in the existing FAQ
directory, excluding the FAQ itself, has been brought into the
the handbook already.
The documents to go in these directories are written in SGML
using the linuxdoc DTD. The tools for turning the SGML files
into HTML, LaTeX and ascii will be brougt into the source tree.
This will bring in the sgmls package (3 binaries), a perl script,
the linuxdoc DTD and some related files used by sgmlsasp to
perform the conversions. The plan is to install an HTML version
of the handbook for use as an on-line help resource.
Over time, the relevant material from the existing contents of
/usr/src/share/doc should be integrated into the FreeBSD
(handbook|manual|guide).
Comments? Suggestions? Flames?
-john
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199504151811.OAA25031>