Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 16 Jan 2001 09:34:12 +0000
From:      Nik Clayton <nik@freebsd.org>
To:        Chris Costello <chris@calldei.com>
Cc:        doc@FreeBSD.org
Subject:   Re: Reorganizing entities in doc/.
Message-ID:  <20010116093412.A3294@canyon.nothing-going-on.org>
In-Reply-To: <20010113160051.B4539@holly.calldei.com>; from chris@calldei.com on Sat, Jan 13, 2001 at 04:00:51PM -0600
References:  <20010113160051.B4539@holly.calldei.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Jan 13, 2001 at 04:00:51PM -0600, Chris Costello wrote:
>    As I worked on the mailing-lists.ent move, a thought occured
> to me--how far should I go?  There are other language-specific
> general entities that are mostly lumped into the Handbook.  There
> are language-specific authors.ent files to overload the stock
> authors.ent from the Handbook, there's newsgroups.ent files, and
> of course mailing-lists.ent.
> 
>    I propose the following reorganization:

Looks pretty OK from here.  The only thing I might change is the
location of the mailing-lists.ent file.  I'd be tempted to put the
English version in doc/share/sgml, and probably split the entities out
in to something like

   <!ENTITY mail.doc "doc@FreeBSD.org">
   
   <!ENTITY mail.doc.comment "The FreeBSD Documentation Project">

   <!ENTITY mail.doc.descr "Longer blurb about the list here.">

The translations can override the .comment and .descr entities in their
own directories.

This allows a new translation to bootstrap with buildable documentation
much faster (although, of course, we could keep the file in en*/share/,
and then a new translation just has to copy it out of there instead).

My basic aim has always been that documentation should be buildable
after doing

   co doc/share
   co doc/<lang>/share
   co doc/<lang>/<format>/<document>

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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010116093412.A3294>