From owner-freebsd-doc Wed Sep 6 7:27:44 2000 Delivered-To: freebsd-doc@freebsd.org Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66]) by hub.freebsd.org (Postfix) with ESMTP id F211137B617; Wed, 6 Sep 2000 07:27:27 -0700 (PDT) Received: (from nik@localhost) by nothing-going-on.demon.co.uk (8.11.0/8.11.0) id e869DRQ06197; Wed, 6 Sep 2000 10:13:27 +0100 (BST) (envelope-from nik) Date: Wed, 6 Sep 2000 10:13:27 +0100 From: Nik Clayton To: Mark Ovens Cc: doc@freebsd.org, Andrew Boothman Subject: Re: Ports Documentation Index - the next installment Message-ID: <20000906101327.A5252@canyon.nothing-going-on.org> References: <20000906002540.M254@parish> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <20000906002540.M254@parish>; from marko@freebsd.org on Wed, Sep 06, 2000 at 12:25:40AM +0100 Organization: FreeBSD Project Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org On Wed, Sep 06, 2000 at 12:25:40AM +0100, Mark Ovens wrote: > I've been doing some work on the perl(1) scripts that Andrew Boothman > started sometime ago that create /var/db/pkg/${PORTNAME}/+DOCS for > each installed port and then build an HTML file containing links to > all the installed docs. Great. Looks nice (there's a "but" coming, you can tell. . .) > 4. The filename is displayed instead of "Title Unknown" for > non-HTML files (although HTML files that have no > tag are still listed as "Title Unknown"). Try using the content of the first element, and falling back to the filename as a last resort. For ports with documentation split over multiple files it links to all of them, instead of just the index file. That's going to be a problem with any automated solution -- as and when porters start writing +DOCS files themselves that should be less of a problem. There's another angle I think that's worth investigating. At the O'Reilly docs summit a couple of months back, representatives from the GNOME, KDE, and Linux documentation projects were all looking at the similar problem of getting apps to register their documentation, and also to try and provide an interface over and above simple HTML. From memory, the two best people to liase with about this are Guyhelm Aznar and Eric Bischoff . 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 To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message