[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: dhelp directory structure



On 12 Apr 1998, Adam P. Harris wrote:

> Marco.Budde@hqsys.antar.com (Marco Budde) writes:
> > Moin!
> > 
> > The current dhelp directory structure:
> 
> I rather like this document structure!

I don't like it :) The structure looks like it's based mostly on our
archive structure, but this structure is less than intuitive (at least,
for me, but I've heard this from a lot of users too).

I'd prefer a much `deeper' structure. Below is a first attempt for such a
structure. Notes:
 - I haven't spent a lot of time on this yet--it's really just a first
   draft to show you what I'm thinking of
 - I'm using `section titles' below, and am also giving a few examples
   for each section. We'd have to define unique shorter names for the
   sections for use by the packages. Of course, these titles will
   be language dependent. (I've included these keywords in brakets.)
 - in some places it's hard to determine the correct section of a
   manual--I'd prefer to put such manuals in several sections

Here is what I'm thinking of:

   General documents  [general]
      Debian FAQ
      Debian META Manual
      Linux HOWTO's and FAQs

   Installation instructions  [install]
      Debian Installation Manual
      dselect Beginner's Guide
      Debian Release Notes
      Linux Hardware HOWTO
   
   User's manuals  [users]

      Games  [users/games]
         GNU chess user's manual

      Text processing systems  [users/text]
         tetex user's manual
         debiandoc-sgml markup manual
  
   Developer's manuals  [devel]

      C documentation
         libc6 documentation

      Perl documentation
         Debian's Perl setup
         List of available Perl/CPAN modules

   Administrator's manuals  [admin]

      Debian's packaging system  [admin/packaging]
         dselect Beginner's Guide
         APT user's manual
         How Software Producers can produce .debs for their products

      X Windows documentation  [admin/x11]
         Debian's X README
         Setting up X...

      unsorted
         Debian Menu System

   Debian developer's documents  [debian]
      General  [debian/general]
         Debian Dictionary

      Standards  [debian/standards]
         Debian Policy Manual
         Debian Packaging Manual
         Debian Developer's Reference
         FSSTND
         FHS
         ...

      Package developer's manuals  [debian/packaging]
         Debian Packaging Manual
         Intro: Making a .deb
         Debian Menu System
      

(This is really just a first draft and very incomplete!)

Comments are welcome!


Thanks,

Chris

--                 Christian Schwarz
                    schwarz@monet.m.isar.de, schwarz@schwarz-online.com,
Don't know Perl?     schwarz@debian.org, schwarz@mathematik.tu-muenchen.de
      
Visit                  PGP-fp: 8F 61 EB 6D CF 23 CA D7  34 05 14 5C C8 DC 22 BA
http://www.perl.com     http://fatman.mathematik.tu-muenchen.de/~schwarz/



--
To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org


Reply to: