Date: Mon, 8 Jan 2007 20:37:23 +0100 From: Johann Kois <jkois@freebsd.org> To: freebsd-doc@freebsd.org Subject: Re: Documentation newbie; SGML how-to? Message-ID: <200701082037.29179.jkois@freebsd.org> In-Reply-To: <45A291EF.6080502@wmptl.com> References: <45A291EF.6080502@wmptl.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--nextPart1187309.JciXnUhmZn Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Hello, On Monday, 8 January 2007 19:48 Nathan Vidican wrote: > I've written several tutorials in the past, and tutored quite a few > people over the years and would like to start contributing some of my > work back to the community who prompted it in the first-place. Cool. Thanks for wanting to contribute to the project. Any help is appreciated. > Herein lies the new challenge for me; what documentation tools are > everyone using to generate documents the likes of the FreeBSD FAQ and > Handbook? From what I understand it's SGML, (a new language to me - but > no fears there) but what authoring tools are out there; what's best to =20 > use? What's easiest to get along with, and is there a collection or > package one can utilize for stylesheets, templates, etc? Are indexes and > HTML output generated by hand, or manually? etc... There is the port "textproc/docproj" (a meta-port which installs all requir= ed tools). It is described in the FreeBSD Documentation Project Primer (aka as fdp-primer, see the link below). > So, long story short - where do I get started; any good tutorials, > tools, templates reccomended for SGML documentation? Something along the > lines of 'if one were to submit a section to the handbook, what > tools/format should one do so in?' Anything you can offer would be > greatly appreciated. I recommand reading the FDP-Primer (http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/) and to visit the website of the FreeBSD Documentation Project (http://www.freebsd.org/docproj/). These two sources should cover most of your questions. J. Kois --nextPart1187309.JciXnUhmZn Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (FreeBSD) iD8DBQBFop15/rDr791hwtgRAjyIAKCDq56WoPuwuN1tMmLpKxS1i1Wu1QCgo5RX YZuabNc2H/qFOdqRm5g2fac= =8oCK -----END PGP SIGNATURE----- --nextPart1187309.JciXnUhmZn--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200701082037.29179.jkois>