From owner-freebsd-doc Tue Jan 16 6:51:49 2001 Delivered-To: freebsd-doc@freebsd.org Received: from k2.vol.cz (k2.vol.cz [195.250.128.30]) by hub.freebsd.org (Postfix) with ESMTP id D318A37B402 for ; Tue, 16 Jan 2001 06:51:31 -0800 (PST) Received: from localhost (horcicka@localhost) by k2.vol.cz (8.11.0/8.9.3) with ESMTP id f0GEpYs65577 for ; Tue, 16 Jan 2001 15:51:35 +0100 (CET) (envelope-from horcicka@vol.cz) X-Authentication-Warning: k2.vol.cz: horcicka owned process doing -bs Date: Tue, 16 Jan 2001 15:51:34 +0100 (CET) From: Martin Horcicka To: Subject: man, TOC, xml... Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org Hi, I have some questions related to manual pages: 1. classification ----------------- In my opinion this is the main problem of man. Pages are classified to nine sections but these are too few to find the right page quickly when one is searching by subject. I am not sure if more sections would help - maybe it would be better to develop some mechanism to automatically create table of contents or something like this. On the other hand, the independence of particular manual pages is surely one of the key features bringing the wide usage of the whole manual system. Maybe some compromise would be OK. The first thing coming to my mind is a separate database keeping some tree structure of sections and related manual pages (e.g. every manual page would be mentioned in one or more sections). It would be very simple to create new sections, subsub...sections and to assign manual page links to them. The operations would be as simple as creating directories, files and symlinks. All the pages in the OS distribution would be assigned to proper sections and the pages from ports could (but need not) register in the TOC database. Program used to browse the tree of sections would find the unassigned pages and would present them separately. 2. internal structure --------------------- groff is really not my favourite typesetting system and -mdoc macro package tries to do with it something which is usually used sgml or xml for. In addition, use of groff brings the unability to check the correctness of the man page internal structure (in contrast to xml), not mentioning easy internationalization etc. Would not it be better to develop a DTD for xml and some format transformation system to create new manual system in xml? It should not be a problem to make the old and the new system coexist together. 3. manual browser ----------------- I am sure, some hypertext browser would be really better than the presently used more/less. In conjunction with the xml manual system it would be maybe easier to write it. These are my ideas. Could you tell me yours? Martin To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message