Date: Wed, 27 Oct 1999 14:32:18 +0100 From: Nik Clayton <nclayton@lehman.com> To: Andrew Boothman <andrew@dogma.freebsd-uk.eu.org>, FreeBSD-Doc@FreeBSD.org Subject: Re: Documentation index latest Message-ID: <19991027143218.C15134@lehman.com> In-Reply-To: <XFMail.991016165806.andrew@ukug.uk.FreeBSD.org>; from Andrew Boothman on Sat, Oct 16, 1999 at 04:58:06PM %2B0100 References: <XFMail.991016165806.andrew@ukug.uk.FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Oct 16, 1999 at 04:58:06PM +0100, Andrew Boothman wrote: > Furthering this automatically created index of documentation installed by > ports, I've written a tool that looks through the CONTENTS file of a port in > /var/db/pkg/* and has a guess at what files to put in the new DOCS file. > > It's all _very_ rough, and I'm gonna try and improve it a bit more before we > take the idea to -ports. > > The script is available on http://ukug.uk.freebsd.org/~andrew/docindex/docsmaker > > With information about the index itself on > http://ukug.uk.freebsd.org/~andrew/docindex/ > > As ever, all comments/help/flames welcome! This rocks. It's great to see someone actually working on this (it's so frustrating when I don't have the time to implement half the stuff I want to). A few comments: * The Doc. Proj. docs can be installed in multiple languages and encodings, as well as all the different formats, so you might want a way of representing that in the output. * I'm an HTML purist, so going from "<h2>" to "<h4>" in the output without an intervening "<h3>" grates. * I think we should reserve a directory under /usr/local/share/doc, to contain additional information about this process. For example, the generated page should probably contain a link at the bottom, something like: This page is automatically generated, please do not edit it by hand. _More information_ about the process used to generate it is available. where _More information_ is the link (or similar). We can also put graphics in this directory to jazz things up a bit (FreeBSD logo, icons for HTML, PS, PDF, that sort of thing). We can also include links to things like the: "New ports in the past two weeks" page The script that checks to see which installed ports are out of date * Statistics? Perhaps a "X ports are installed on this machine" or similar at the bottom? * Configurability -- the local SA probably has software installed that isn't in the ports tree. It would be nice if they could maintain their own +DOCS file (in the same format) somewhere central (perhaps /usr/local/share/+DOCS, although that's a fairly poor name), so that the documentation list can include local applications as well. Just a few thoughts there, anyway. Great work! N -- --+==[ Systems Administrator, Year 2000 Test Lab, Lehman Brothers, Inc. ]==+-- --+==[ 1 Broadgate, London, EC2M 7HA 0171-601-0011 x5514 ]==+-- --+==[ Year 2000 Testing: It's about time. . . ]==+-- 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?19991027143218.C15134>