[ANN] New XInclude standard

[Paul W. Frields]

Hi gang,

We have moved to using XIncludes for some specific functions in FDP
docs-common stuff.  This was necessitated by a number of issues Karsten
alluded to in a previous email to the list[1].  The pain this should
cause is going to be very minimal, and after you make a few minor
changes to your documents, builds will work again now.

Here are the changes you need to make, only two very small steps:

1.  Update to using the DocBook V4.4 DTD.  To do this, change your
DOCTYPE declaration at the top of your document to read like this one:

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!ENTITY % FEDORA-ENTITIES-EN SYSTEM
"../../docs-common/common/fedora-entities-en.ent">
%FEDORA-ENTITIES-EN;

]>


2.  Remove the FDP-INFO entity declaration, and replace its occurrence
in the text (&FDP-INFO;) with the following XML element.  Make sure you
self-close the tag, and that you use the proper language for the HREF
attribute.

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="fdp-info-en.xml" />


3.  Run "make distclean" to clean out cruft.

* * * THAT'S IT! * * *

You can see an example of steps 1 and 2 in a recent commit of mine[2].  

Many people have taken to putting funky editor-specific code either at
the top or bottom of a "child" document, to allow proper context editing
(colors, indentation, etc.).  If you use an XInclude instead of an
external entity declaration, you should put a DOCTYPE declaration in
every included file -- *exactly* the same as the one shown above in Step
1 -- and your content-aware editor will now work automagically.  (Note
that if you do this, you need to declare the root element of your
"child" file, such as "section".)

As always, if you have any questions or comments, reply here please.
Thanks all!

= = =

[1]
http://www.redhat.com/archives/fedora-docs-list/2006-February/msg00082.html
[2]
http://www.redhat.com/archives/fedora-docs-commits/2006-February/msg00255.html


-- 
Paul W. Frields, RHCE                          http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20060212/59c6a514/attachment.sig>