<oXygen/> User Guide

XInclude

XInclude est un standard pour construire des documents XML à partir de pièces plus petites, en remplacement des entitées externes. Les entitées externes peuvent être un problème car elles ne peuvent avoir une déclaration DOCTYPE, et sont par conséquent des documents non-valides.

L'usage principal est dans les structures de documentation où les documents peuvent être composés de nombreux fichiers, XInclude permettant la validation du fichier maître ainsi que des sections individuelles.

Les avantages d'une documentation modulaire sont : unités de contenu réutilisables, unités de fichier plus petites qui peuvent être éditées, meilleur contrôle de version, distribution des auteurs.

Voici un exemple de fichier chapitre et livre qui inclut le chapitre en utilisant XInclude.

Fichier chapitre introduction.xml :

<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 
<chapter id="introduction">
<title>Getting Started</title>
<section id="Installing Oxygen">
...
</chapter>
            

Fichier principal du livre :

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book>
<title>User Guide</title>
<para>This guide shows you how to use the editor.</para>
<xi:include
   xmlns:xi="http://www.w3.org/2001/XInclude"  href="introduction.xml" />
   ...
</book>
            

Le support de XInclude dans Oxygen est désactivé par défaut. Vous pouvez l'activer en utilisant l'option Options/Préférences/XML/Analyseur XML, l'entrée Permettre le traitement XInclude.