From owner-freebsd-hackers Tue Aug 3 7:55:38 1999 Delivered-To: freebsd-hackers@freebsd.org Received: from gatewaya.anheuser-busch.com (gatewaya.anheuser-busch.com [151.145.250.252]) by hub.freebsd.org (Postfix) with SMTP id D429B14F51; Tue, 3 Aug 1999 07:55:17 -0700 (PDT) (envelope-from Matthew.Alton@anheuser-busch.com) Received: by gatewaya.anheuser-busch.com; id JAA14101; Tue, 3 Aug 1999 09:55:13 -0500 Received: from stlexggtw002-pozzoli.fw-users.busch.com(151.145.101.130) by gatewaya.anheuser-busch.com via smap (V5.0) id xma013701; Tue, 3 Aug 99 09:54:33 -0500 Received: from stlabcexg006.anheuser-busch.com ([151.145.101.161]) by 151.145.101.130 (Norton AntiVirus for Internet Email Gateways 1.0) ; Tue, 03 Aug 1999 14:52:37 0000 (GMT) Received: by stlabcexg006.anheuser-busch.com with Internet Mail Service (5.5.2448.0) id ; Tue, 3 Aug 1999 09:52:22 -0500 Message-ID: From: "Alton, Matthew" To: "'doc@freebsd.org'" Cc: "'Matthew Dillon'" , "David E. Cross" , freebsd-hackers@FreeBSD.ORG Subject: RE: DOC volunteer WAS:RE: userfs help needed. Date: Tue, 3 Aug 1999 09:52:27 -0500 MIME-Version: 1.0 X-Mailer: Internet Mail Service (5.5.2448.0) Content-Type: text/plain Sender: owner-freebsd-hackers@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG I'll follow these guidelines. Thank you. > -----Original Message----- > From: Nik Clayton [SMTP:nik@nothing-going-on.demon.co.uk] > Sent: Friday, July 30, 1999 6:47 PM > To: Alton, Matthew > Cc: 'Nik Clayton'; 'Matthew Dillon'; David E. Cross; > freebsd-hackers@FreeBSD.ORG; doc@freebsd.org > Subject: Re: DOC volunteer WAS:RE: userfs help needed. > > [ cc'd to -doc, reply-to points there ] > > On Fri, Jul 30, 1999 at 04:09:20PM -0500, Alton, Matthew wrote: > > I prefer to work in flat ASCII. Perhaps the doc project can HTMLize > > the final product. > > We can, it just takes longer, that's all. > > It would make life simpler if you can follow the general structure, which > basically consists of an overall document, containing zero or more parts, > each part containing one or more chapters, each chapter containing zero > or more sections, each section divided in to zero or more subsections > (and so on, down to sub-sub-sub-sub-sub-sections). Each part, chapter, > and section has a mandatory title. > > The Handbook is a good example of a document that uses parts, further > divided in to chapters, and the Doc. Proj. primer is a good example of > a document that dispenses with parts, and just uses chapters and sections. > > Generally, something like > > Title > > Abstract > > ..................... > ..................... > ..................... > > Chapter 1: Overview > > ..................... > ..................... > ..................... > > and then further chapters as necessary. > > Within the text, set off things that are 'out of band' information, like > notes, tips, and important information. > > If you include instructions for the user to follow, please use "#" for > the root prompt, and "%" for the regular user prompt. > > Refer to commands as 'command(n)', and assume that in the web (and PDF) > version that will be generated that this will automatically turn in to > a link to the manual page. > > The Doc. Proj. primer has a (sparse) writing style chapter that covers > things like contractions, serial commas, and so on. > > Of course, you don't have to do any of this, it just makes it harder for > whoever turns it in to DocBook (which will probably be me) to do the > conversion. > > Once again, thanks for volunteering to do this. > > N > -- > [intentional self-reference] can be easily accommodated using a blessed, > non-self-referential dummy head-node whose own object destructor severs > the links. > -- Tom Christiansen in <375143b5@cs.colorado.edu> > > > To Unsubscribe: send mail to majordomo@FreeBSD.org > with "unsubscribe freebsd-hackers" in the body of the message To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-hackers" in the body of the message