Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 15 May 1999 23:12:41 +0200
From:      Wolfram Schneider <wosch@panke.de.freebsd.org>
To:        nclayton@lehman.com, doc@FreeBSD.ORG
Cc:        cvs@FreeBSD.ORG
Subject:   Re: doc/<lang>/books/*, doc/<lang>/articles/*, and docs.freebsd.org
Message-ID:  <19990515231241.20872@panke.de.freebsd.org>
In-Reply-To: <19990510104605.D14492@lehman.com>; from nclayton@lehman.com on Mon, May 10, 1999 at 10:46:05AM %2B0100
References:  <19990504163533.S14492@lehman.com> <19990509011527.18124@panke.de.freebsd.org> <19990510104605.D14492@lehman.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On 1999-05-10 10:46:05 +0100, nclayton@lehman.com wrote:
> Of these, doc/FAQ needs converting to DocBook, as do almost all of 
> doc/en/tutorials.
> 
> I don't think these conversions should be done "in place" as it where.
> When I converted the Handbook from LinuxDoc to DocBook the converted files
> were placed in doc/en/handbook, instead of sitting on a branch of 
> doc/handbook.  I'd like to do the same thing with the DTD migration for
> the FAQ and the majority of the tutorials.
> 
> This entails no more CVS bloat than will be incurred by the DTD migration
> anyway.
> 
> Being more precise
> 
>   LinuxDoc (current)                   DocBook (new)
>   ------------------------------------------------------------------------
>   doc/FAQ                          ->  doc/en/articles/FAQ
>   doc/en/tutorials/ddwg            ->  doc/en/articles/writing-device-drivers
>   doc/en/tutorials/devel           ->  doc/en/articles/programming-tools
>   doc/en/tutorials/diskformat      ->  doc/en/articles/formatting-media
>   doc/en/tutorials/disklessx       ->  doc/en/articles/diskless-X
> * doc/en/tutorials/docproj-primer  ->  doc/en/books/FDP-primer
>   doc/en/tutorials/fonts           ->  doc/en/articles/fonts
>   doc/en/tutorials/mh              ->  doc/en/articles/mh
>   doc/en/tutorials/multios         ->  doc/en/articles/multios
>   doc/en/tutorials/newuser         ->  doc/en/articles/newuser
>   doc/en/tutorials/ppp             ->  doc/en/books/ppp
> 
>  * = Repository copy required, because this is already in DocBook format

devel, diskformat, disklessx, fonts, mh, multios and newuser
are also in DocBook format. Only ddwg and ppp are still in linuxdoc.


>   Note:  As you can see, I'm in favour of longer names to be more
>          explicit, in general.  The *vast* majority of people are going
>          to click on these as URLs, so won't care how long they are.  Those
>          of us that are actually maintaining them have TAB-completion on
>          our shell, so it's no big deal.

IMHO filenames should be in lowercase if possible.

-- 
Wolfram Schneider <wosch@freebsd.org> http://wolfram.schneider.org


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?19990515231241.20872>