[gnu-internal] Re: [vsipl++] [patch] Quickstart updates for ref-impl

[Carlos O'Donell]

On Tue, Jan 30, 2007 at 10:24:15AM -0500, Stefan Seefeld wrote:
> Jules Bergmann wrote:
> > Also, what list should I CC csl-docbook patches to?
> 
> gnu-internal seems to be the closest match. (I will CC it as I raise
> a docbook-related question.)
> 
> > Index: doc/quickstart/quickstart.xml
> > ===================================================================
> > --- doc/quickstart/quickstart.xml	(revision 161463)
> > +++ doc/quickstart/quickstart.xml	(working copy)
> > @@ -9,6 +9,7 @@
> >  [
> >   <!ENTITY opl.xml SYSTEM "../csl-docbook/fragments/opl.xml">
> >   <!ENTITY gpl.xml SYSTEM "../csl-docbook/fragments/gpl.xml">
> > + <!ENTITY bsd.xml SYSTEM "../csl-docbook/fragments/bsd.xml">
> 
> Question to everyone: It looks like those 'fragments' are actually
> valid xml documents. Is there any particular reason for using external
> entities here ? Could we xi:include them instead ?

I *love* entities.

1. It's easier to write '&opl.xml;' than it is to type "<xi:include...>"
2. If opl.xml is moved, none of the XML has to change.
3. If your project is not always in the same relative location to 
   csl-docbook, you can put these entities into a DTD and use configure
   to do AC_SUBST on the path reference.
   e.g. <!ENTITY opl.xml SYSTEM "@PATH_TO_CSL_DOCBOOK@/fragments/opl.xml">

My rule-of-thumb is:

If the XML file exists out side your current project, then use an entity
defined in a DTD to include the file.

There *are* alternatives, but I find them more cumbersome and error
prone e.g. xi:include + catalog.

Cheers,
Carlos.
-- 
Carlos O'Donell
CodeSourcery
carlos at codesourcery.com
(650) 331-3385 x716