From owner-freebsd-doc Sun Oct 17 11:39: 1 1999 Delivered-To: freebsd-doc@freebsd.org Received: from mailhost.netscapeonline.co.uk (mailhost.netscapeonline.co.uk [194.200.20.13]) by hub.freebsd.org (Postfix) with ESMTP id 8D82D14C28 for ; Sun, 17 Oct 1999 11:38:43 -0700 (PDT) (envelope-from andrew@ukug.uk.FreeBSD.org) Received: from userbe30.netscapeonline.co.uk ([62.124.20.207] helo=cream.org) by mailhost.netscapeonline.co.uk with esmtp (Exim 3.02 #1) id 11cv9G-0003TO-00; Sun, 17 Oct 1999 18:35:17 +0000 Content-Length: 2262 Message-ID: X-Mailer: XFMail 1.3 [p0] on FreeBSD X-Priority: 3 (Normal) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 8bit MIME-Version: 1.0 In-Reply-To: <19991017093553.A319@marder-1> Date: Sun, 17 Oct 1999 19:34:48 +0100 (BST) From: Andrew Boothman To: Mark Ovens Subject: Re: Documentation index latest Cc: FreeBSD-Doc@freebsd.org Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org On 17-Oct-99 Mark Ovens wrote: >> Excellent! How much tweaking did you find the DOCS files needed >> after they were created? I noticed that samba installs _lots_ of >> text files that the script thinks are documentation. > > Potentially a lot :( An awful lot of stuff was just labelled "Title > Unknown" including, ironically, all the stuff used by textproc/docproj, > except for jade. This is understandable for TXT files, but none of > the HTML ones have titles. I'm aware that the script seems to have issues with picking up the titles from lowercase HTML, I've been busy with other things recently, but I will get that working. >> Ultimately, I think the best person to tweak the DOCS file would be >> the maintainer of the port. You need to have access to the port's >> docs to make sure that the script has indexed them properly. And you >> need good knowledge of the port to know when some docs should be >> left out. >> > > True, but I suspect that perhaps the docs team will have to do some > of them as there are a (large?) number of ports which appear to > have no updating for a long time so are potentially no longer > maintained. Agreed. We'll see what reaction we get from -ports when we ask them. But I would think that those ports whose maintainers are 'no longer with us' will need to be updated by ourselves. >> Once we're sure about what we need them to do, this really needs to >> go to -docs, at least for commenting on if not actioning it. >> >> Your wrapper is still useful though, because it'll allow us to give >> the -ports crowd the largest possible head start, by letting us >> create a large number of DOCS file to begin with. >> >> I'm gonna fiddle with the docsmaker script a little more then, if >> no-one else has any other comments, I'll take it to -docs. >> > > One thing, docindex.pl has the old /usr/share/doc/{handbook,FAQ} > paths. I had to change it to the new > /usr/share/doc/en_US.ISO_8859-1/books/{handbook,faq} location in > the first ``if'' statement. That's another one for the TO-DO list. Thanks! The script was produced on my 3.1-R system, hence the outdated path. --- Andrew Boothman FreeBSD UK User Group http://ukug.uk.FreeBSD.org/~andrew/ http://ukug.uk.FreeBSD.org/ To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message