On Monday 09 December 2002 11:27 am, Peter Simons wrote:
> > [XIncludes]
>
> I can see the problem. From an aesthetic point of view, it would be
> nice if all the documents were effectively one to the parser so that
> we are guaranteed to have unique IDs throughout the documentation --
> among other things. This would also allow for sophisticated
> cross-indexing, etc. I personally tend to organize my documents so
> that the "main" document just includes the bits from other files. This
> way, I am free to refer to those parts from other documents as well.
My assumption was that we would do XIncludes first, XSLT transformation
second. This way, all documents included by the document you start with will
be (effectively) merged together into one big document. XIncludes let us do
this, but let us decide where to start from: For instance, I could generate
just the reference for Boost.Function, or a document with Boost.Function and
Boost.Bind together, or perhaps a big document with all of Boost. XIncludes
make this feasible.
> It is clear, though, that we cannot expect all documentation authors
> to adapt this technique. Particularly not, if they're working with
> tools that do not directly support split documents the way Emacs/psgml
> does.
Another point for XIncludes: even if these authors _think_ they are writing a
standalone document, we can just XInclude it in the top-level "boost.xml" and
everything gets integrated automatically.
> I added definitions for the XInclude elements to the DTD, but they're
> not integrated into DocBook yet, meaning that the definitions
> effectively do nothing. xmllint(1) will verify the documents fine if
> you use "-postvalid" instead of "-valid", because then the validator
> won't see the XInclude tags anymore.
>
> -peter
Sounds good.
Doug
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
