From owner-freebsd-doc Thu May 25 21:51: 4 2000 Delivered-To: freebsd-doc@freebsd.org Received: from rhenium.btinternet.com (rhenium.btinternet.com [194.73.73.93]) by hub.freebsd.org (Postfix) with ESMTP id 983A737B56C; Thu, 25 May 2000 21:51:00 -0700 (PDT) (envelope-from mark@ukug.uk.freebsd.org) Received: from [213.1.145.33] (helo=parish.my.domain) by protactinium with esmtp (Exim 2.05 #1) id 12v2Ak-0006PI-00; Thu, 25 May 2000 19:15:54 +0100 Received: (from mark@localhost) by parish.my.domain (8.9.3/8.9.3) id TAA01153; Thu, 25 May 2000 19:15:47 +0100 (BST) (envelope-from mark) Date: Thu, 25 May 2000 19:15:47 +0100 From: Mark Ovens To: Nik Clayton Cc: doc@freebsd.org Subject: Re: Why no Master Index? Message-ID: <20000525191547.B232@parish> References: <20000523194307.C233@parish> <20000524084850.A8565@kilt.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Mailer: Mutt 1.0.1i In-Reply-To: <20000524084850.A8565@kilt.nothing-going-on.org>; from nik@freebsd.org on Wed, May 24, 2000 at 08:48:50AM +0000 Organization: Total lack of Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org On Wed, May 24, 2000 at 08:48:50AM +0000, Nik Clayton wrote: > On Tue, May 23, 2000 at 07:43:07PM +0100, Mark Ovens wrote: > > Is there a reason why there is no Master Index/TOC for the FreeBSD > > docs? > > This > < much time. > > This > < many things to do. > > :-) > > > IMHO it would make sense to have a single point of entry into > > the documentation set. The handbook and FAQ are the high profile docs > > but the rest, especially the articles, are somewhat hidden from view > > being referenced from the handbook and FAQ and pointed to people in > > replies to questions. > > Couldn't agree more. > > [snip] > > Your example looked good. Do you want to turn that in to HTML (based on > the existing contents of www/en), and we can go from there. > OK, ftp://ukug.uk.freebsd.org/pub/mark/doc_index/ for my first attempt. I've put both the HTML and the SGML I made it from (sgmlnorm -d example.sgml > example.html). The links assume it is in /usr/share/doc. > You might want to take a look at http://www.freebsd.org/docs.html, and > try trimming that down. One way to do it would be to split things in two > based on whether or not they're maintained by the project. > > So have a docs/index.html that offers the reader links to the two files, > and an 'internal.html' that lists the project maintained docs, and an > 'external.html' that lists the other stuff ('internal' and 'external' are > crap names, please, come up with better ones :-) ) > > I also wouldn't mind seeing a translation table that listed all the docs, > and an indication of whether or not they've been translated. . . > > en es fr ja ru zh > Handbook x x x > FAQ x x x x x x > FDP Primer x > Porter's Handbook x x > [...] > I'm working on this now. BTW, I got some nl docs last time I cvsup'd. > This would be a separate page. > > > As Nik has just suggested having the docs as a package to be installed > > by sysinstall it would seem sensible to have something like this. In > > fact I would go so far as to suggest that sysinstall automatically > > installed a browser with the docs index as it's Home Page. Having the > > docs "in your face" doesn't seem to be inappropriate for new users. > > Ye-es. > > Go through the archives and you'll find an effort by Andrew Boothman to > create a process that would create and maintain an HTML index of all the > documentation installed by ports/packages on a particular system (subject > line was "Automatic documentation index"). Since I want to start > encouraging people to treat our docs in exactly the same way we should > (IMHO) leverage that work. Then sysinstall doesn't have to do anything > new. > > N > -- > Internet connection, $19.95 a month. Computer, $799.95. Modem, $149.95. > Telephone line, $24.95 a month. Software, free. USENET transmission, > hundreds if not thousands of dollars. Thinking before posting, priceless. > Somethings in life you can't buy. For everything else, there's MasterCard. > -- Graham Reed, in the Scary Devil Monastery -- ...and on the eighth day God created UNIX ________________________________________________________________ FreeBSD - The Power To Serve http://www.freebsd.org My Webpage http://ukug.uk.freebsd.org/~mark/ mailto:mark@ukug.uk.freebsd.org http://www.radan.com To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message