From: Jirka Kosek Date: Wed, 17 Jun 2009 21:46:38 +0000 (+0000) Subject: Reorganized to support translations X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ea831a3bdb57053cc2c6766391d608f6437f4ba0;p=docbook-dsssl Reorganized to support translations --- diff --git a/docbook/relaxng/docbook/howto/en/Makefile b/docbook/relaxng/docbook/howto/en/Makefile new file mode 100644 index 000000000..859dff7e6 --- /dev/null +++ b/docbook/relaxng/docbook/howto/en/Makefile @@ -0,0 +1,41 @@ +include ../../../../../buildtools/Makefile.incl + +HTMLSTYLE=../stylesheets/html.xsl +FOSTYLE=../stylesheets/fo.xsl +# below are customizations layers for XSL-NS stylesheets +HTMLNSSTYLE=../stylesheets/html-ns.xsl +FONSSTYLE=../stylesheets/fo-ns.xsl +VARS= + +all: howto.html howto.pdf + +# output using the namespaced stylesheets +ns: howto.ns.html howto.ns.pdf + +%.html : %.xml $(HTMLSTYLE) + jing -c ../../docbook.rnc $< + $(XSLT) $< $(HTMLSTYLE) $@ $(VARS) + +%.ns.html : %.xml $(HTMLNSSTYLE) + jing -c ../../docbook.rnc $< + $(XSLT) $< $(HTMLNSSTYLE) $@ $(VARS) + +%.fo : %.xml $(FOSTYLE) + jing -c ../../docbook.rnc $< + $(XSLT) $< $(FOSTYLE) $@ xep.extensions=1 $(VARS) + +%.ns.fo : %.xml $(FONSSTYLE) + jing -c ../../docbook.rnc $< + $(XSLT) $< $(FONSSTYLE) $@ xep.extensions=1 $(VARS) + +%.pdf : %.fo + xep $< + +%.ns.pdf : %.ns.fo + xep $< + +clean: + $(RM) howto.html + $(RM) howto.pdf + $(RM) howto.ns.html + $(RM) howto.ns.pdf diff --git a/docbook/relaxng/docbook/howto/en/TODO b/docbook/relaxng/docbook/howto/en/TODO new file mode 100644 index 000000000..a69c49b07 --- /dev/null +++ b/docbook/relaxng/docbook/howto/en/TODO @@ -0,0 +1,48 @@ +# -*- org -*- +* DONE Add information about referencing schemas used in customizations +Hi, + +I am wondering if there is an "official URI" for DocBook 5, especially for +using it inside an include element. + +Consider someone is customizing DocBook 5 and want to include the RELAX NG +Schema: + + include "docbook.rnc" { ... } + ^^^^^^^^^^^ + +Sometimes I see a path here which I consider bad style because it is +platform dependend. How can I reference to the DocBook 5 Schema +officially? Are there any plans on this? Or is the DocBook TC consider +this out of scope? I couldn't find anything in this regard in the DocBook +V5.0 Howto. + + +Thanks, +Tom + +-- Thomas Schraitle +* DONE Update links to CR4 +* DONE Add link to DocBook+ITS section in ITS BP document + +...and to other existing DB5 customizations +* DONE Add more references (NVDL, ...) + +* DONE Improve breaking of long lines +Gentlemen, + + I am trying to read the subject guide via html and find it most difficult because of the formatting. The problem is that the display is much too wide and causes horizontal scrolling. This is because the contents of the line: + +

+java -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration -jar /path/to/oNVDL/bin/onvdl.jar /path/to/docbook.nvdl document.xml
+...
+
+are all on one line (182 characters!) and the browser does not wrap 
 constructs.  The problem of excessive line length also exists in the pdf version of the book.
+
+At the Linux From Scratch project we have been using DocBook for several years and have found the best practice to be to limit any  elements to 76 characters or less.  This may not be possible in your case as the define is quite long, but how about breaking at before the -jar portion of the line?
+
+
+Thanks for your attention.
+
+  -- Bruce Dubbs
+     Editor, Linux From Scratch 
diff --git a/docbook/relaxng/docbook/howto/en/howto.xml b/docbook/relaxng/docbook/howto/en/howto.xml
new file mode 100644
index 000000000..090d1fa53
--- /dev/null
+++ b/docbook/relaxng/docbook/howto/en/howto.xml
@@ -0,0 +1,2295 @@
+  
+
+
+YES">
+NO">
+]>
+

+
+DocBook V5.0
+The Transition Guide
+
+
+Jirka Kosek
+        jirka@kosek.cz
+Norman Walsh
+        ndw@nwalsh.com
+        §convert4to5, proofreading
+Dick Hamilton
+        rlhamilton@frii.com
+        §changes-removed, customization, proofreading
+Michael(tm) Smith
+  smith@sideshowbarker.net
+  §dbxsl-ns
+
+
+
+2009-06-16
+2008-02-06
+2007-10-28
+2006-10-22
+2006-05-16
+2006-03-01
+2005-12-28
+2005-10-27
+
+
+
+This document is targeted at DocBook users who are considering
+switching from DocBook V4.x to DocBook V5.0. It describes
+differences between DocBook V4.x and V5.0 and provides some suggestions about
+how to edit and process DocBook V5.0 documents. There is
+also a section devoted to conversion of legacy documents from DocBook
+4.x to DocBook V5.0.
+
+At the time this was written the current version of DocBook V5.0
+was &version;. However, almost all of the information in this document is
+general and applies to any newer version of DocBook V5.0.
+
+
+

+Introduction
+
+The differences between DocBook V4.x and V5.0 are quite radical in
+some aspects, but the basic idea behind DocBook is still the same, and
+almost all element names are unchanged. Because of this it is very
+easy to become familiar with DocBook V5.0 if you know any previous version of
+DocBook. You can find a complete list of changes in
+DB5SPEC, here we will discuss only the most
+fundamental changes.
+
+

+Finally in a namespace
+
+All DocBook V5.0 elements are in the namespace
+http://docbook.org/ns/docbook. XMLExtensible
+Markup Language namespaces are used to distinguish
+between different element sets. In the last few years, almost all new
+XML grammars have used their own namespace. It is easy to
+create compound documents that contain elements from different XML
+vocabularies. DocBook V5.0 is following this design rule. Using
+namespaces in your documents is very easy. Consider this
+simple article marked up in DocBook V4.5:
+
+
+  Sample article
+  This is a really short article.
+
]]>
+
+The corresponding DocBook V5.0 article will look very similar:
+
+
+  Sample article
+  This is a really short article.
+]]>
+
+The only change is the addition of a default namespace declaration
+(xmlns="http://docbook.org/ns/docbook") on the root
+element. This declaration applies the namespace to the root element and
+all nested elements. Each
+element is now uniquely identified by its local name and namespace.
+
+
+The namespace name http://docbook.org/ns/docbook serves
+only as an identifier. This resource is not fetched during processing
+of DocBook documents, and you are not required to have an Internet
+connection during processing. If you access the namespace URI with a browser,
+you will find a short explanatory document about the namespace. In the
+future this document will probably conform to (some version of) RDDL
+and provide pointers to related resources.
+
+
+
+
+

+Relaxing with DocBook
+
+For more than a decade, the DocBook schema was defined using a
+DTD. However, DTDs have serious limitations, and DocBook V5.0 is thus
+defined using a very powerful schema language called RELAX NG. Thanks
+to RELAX NG, it is now much easier to create customized versions of
+DocBook, and some content models are now cleaner and more
+precise.
+
+Using RELAX NG has an impact on the document prolog. The following
+example shows the typical prolog of a DocBook V4.x document. The version of
+the DocBook DTD (in this case 4.5) is indicated in the document type
+declaration (!DOCTYPE) which points to a particular version of the
+DTD.
+
+
+DocBook V4.5 document
+
+
+

+  Sample article
+  This is a very short article.
+
]]>
+
+
+In contrast, DocBook V5.0 does not depend on DTDs anymore. This
+mean that there is no document type declaration and the version of DocBook
+used is indicated with the version
+attribute instead.
+
+
+DocBook V5.0 document
+
+

+  Sample article
+  This is a very short article.
+
]]>
+
+
+As you can see, DocBook V5.0 is built on top of existing XML
+standards as much as possible, for example the lang attribute is superseded by the standard
+xml:lang attribute.
+
+Another fundamental change is that there is no direct indication
+of the schema used. Later in this document, you will learn how you can
+specify a schema to be used for document validation.
+
+
+Although we recommend the RELAX NG schema for DocBook
+V5.0, there are also DTD and W3C XML Schema versions available (see ) for tools that do not yet support RELAX NG.
+
+
+

+
+

+Why switch to DocBook V5.0?
+
+The simple answer is because DocBook V5.0 is the
+future. Apart from this marketing blurb, there are also more
+technical reasons:
+
+
+
+DocBook V4.x is feature frozen.DocBook V4.5
+is the last version of DocBook in the V4.x series. Any new DocBook
+development, like the addition of new elements, will be done in
+DocBook V5.0. It is only matter of time before useful, new elements
+will be added into DocBook V5.0, but they are not likely to be back
+ported into DocBook V4.x. DocBook V4.x will be in maintenance mode and
+errata will be published if necessary. 
+
+
+DocBook V5.0 offers new functionality.
+DocBook V5.0 provides significant improvements over DocBook V4.x. For
+example there is general markup for annotations, a new and flexible
+system for linking, and unified markup for information sections using
+the info element.
+
+
+DocBook V5.0 is more extensible. Having
+DocBook V5.0 in a separate namespace allows you to easily mix DocBook
+markup with other XML-based languages like SVG, MathML, XHTML or even
+FooBarML.
+
+
+DocBook V5.0 is easier to customize. RELAX
+NG offers many powerful constructs that make customization much easier
+than it would be using a DTD (see ).
+
+
+
+

+
+

+Schema jungle
+
+Schemas for DocBook V5.0 are available in several formats at
+ (or the
+mirror at ).
+Only the RELAX NG schema is normative
+and it is preferred over the other schema languages.  However, for your
+convenience there are also DTD and W3C XML Schema versions provided for DocBook
+V5.0. But please note that neither the DTD nor the W3C XML schema are able to
+capture all the constraints of DocBook V5.0. This mean that a
+document that validates against the DTD or XML schema is not necessarily
+valid against the RELAX NG schema and thus may not be a valid
+DocBook V5.0 document. See  for
+summary of constraints that are checked by different schemas.
+
+DTD and W3C XML Schema versions of the DocBook V5.0 grammar are provided
+as a convenience for users who want to use DocBook V5.0 with legacy tools
+that don't support RELAX NG. Authors are encouraged to switch to RELAX
+NG based tools as soon as possible, or at least to validate documents
+against the RELAX NG schema before further processing.
+
+Some document constraints can't be expressed in schema languages
+like RELAX NG or W3C XML Schema. To check for these additional
+constraints DocBook V5.0 uses Schematron.  We recommend that you
+validate your document against both the RELAX NG and
+Schematron schemas.
+
+
+  Schema Comparison
+  
+    
+    
+    
+    
+    
+    
+    
+      
+	Description
+	DTD
+	W3C XML Schema
+	W3C XML Schema + Schematron
+	RELAX NG
+	RELAX NG + Schematron/NVDL
+      
+    
+    
+      
+	Basic document structure
+	&yes;
+	&yes;
+	&yes;
+	&yes;
+	&yes;
+      
+      
+	ID/IDREF datatypes
+	&yes;
+	&yes;
+	&yes;
+	&yes;
+	&yes;
+      
+      
+	Datatypes
+	  In a very few places RELAX NG specifies datatype
+	  like number (mainly for length specifications) or
+	  enumeration between 0 and
+	  1.
+	  In general those datatypes can be also supported in
+	  W3C XML Schema, but currently this schema is generated
+	  from DTD which lacks datatype information.
+	
+	
+	&no;
+	&no;
+	&no;
+	&yes;
+	&yes;
+      
+      
+	Co-occurrences
+	RELAX NG grammar enforces exclusivity of several
+	elements. For example if you have title inside
+	info then it is not allowed to have another
+	title outside info. Similarly,
+	models of HTML and CALS tables are separated and validated
+	properly, where in DTD and WXS only union of both models is
+	available.
+	On other places co-occurrences enforces particular
+	content model based on presence of specific attribute or
+	attribute value.
+	Please also note that in theory co-occurences can be
+	validated using Schematron, but the current DocBook schema
+	uses RELAX NG for these definitions. Schematron can be used
+	only for validation, whereas grammar based schemas like
+	RELAX NG are useful also for other purposes like guided editing.
+	
+	&no;
+	&no;
+	&no;
+	&yes;
+	&yes;
+      
+      
+	Hooks for MathML and SVG content
+	&no;
+	&no;
+	&no;
+	&yes;
+	&yes;
+      
+      
+	Link type integrity
+	Check whether ID/IDREF links are pointing to element
+	of corresponding type. For example that
+	footnoteref points to
+	footnote.
+	&no;
+	&no;
+	&yes;
+	&no;
+	&yes;
+      
+      
+	Presence of version
+	attribute on the root element
+	&no;
+	&no;
+	&yes;
+	&no;
+	&yes;
+      
+      
+	Miscellaneous checks
+	For example consistency of segmented lists, only one
+	term inside term definition etc.
+	&no;
+	&no;
+	&yes;
+	&no;
+	&yes;
+      
+      
+	Element exclusions
+	Prevents improper nesting of elements, like admonition
+	inside admonition.
+	&no;
+	&no;
+	&yes;
+	&no;
+	&yes;
+              
+    
+  
+

+
+

+Where to get the schemas
+
+The latest versions of schemas can be obtained from . At the time this was
+written the latest version was &version;. Individual schemas are
+available at the following locations:
+
+
+
+RELAX NG schema
+
+
+
+RELAX NG schema in compact syntax
+
+
+
+DTD
+
+
+
+W3C XML Schema
+
+
+
+Schematron schema with additional checks
+
+
+
+
+These schemas are also available from the mirror at
+.
+
+

+
+

+DocBook documentation
+
+Detailed documentation about each DocBook V5.0 element is
+presented in the reference part
+of DocBook: The Definitive Guide.
+
+
+Other parts of DocBook: The Definitive
+Guide have not yet been updated to reflect the changes
+made in DocBook V5.0. Please do not be confused by this.
+
+
+

+
+

+
+
+
+

+Tool chain
+
+This section briefly describes tools and procedures to edit and
+process content stored in DocBook V5.0.
+
+

+Editing DocBook V5.0
+
+Because DocBook is an XML-based format and XML is a text-based
+format, you can use any text editor to create and edit DocBook V5.0
+documents. However, using dumb editors like Notepad is
+not very productive. You will do better if you use an editor that
+supports XML. Although there are DTD and W3C XML Schemas available for
+DocBook V5.0, which means you can use any editor that works with DTDs
+or W3C XML Schemas, we recommend that you use the RELAX NG grammar
+with DocBook V5.0. The rest of this section contains an overview of
+XML editors (listed in alphabetical order) that are known to work with
+RELAX NG schemas and that offer guided editing based on the RELAX NG
+schema.
+
+

+Emacs and nXML
+
+nXML
+mode is an add-on for the GNU
+Emacs text editor. By installing nXML you can turn Emacs
+into a very powerful XML editor that offers guided editing and
+validation of XML documents.
+
+

+Emacs with nXML mode provides guided editing and validation
+
+
+
+
+
+
+
+
+

+
+nXML uses a special configuration file named
+schemas.xml to associate schemas with XML
+documents. Often you will find this file in the directory
+site-lisp/nxml/schema inside the Emacs installation
+directory. Adding the following line into the configuration file,
+will associate DocBook V5.0 elements with the appropriate
+schema:
+
+<namespace ns="http://docbook.org/ns/docbook" uri="/path/to/docbook.rnc"/>
+
+
+Please note that nXML ships with a file named
+docbook.rnc. This file contains the RELAX NG grammar
+for DocBook V4.x. Be sure that you associate the DocBook V5.0 namespace
+with the corresponding DocBook V5.0 grammar.
+
+
+If you can't edit the global schemas.xml file,
+you can create this file in the same directory as your document. nXML will
+find associations placed there also. In this case you must create a
+complete configuration file like:
+
+<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
+  <namespace ns="http://docbook.org/ns/docbook" uri="/path/to/docbook.rnc"/>
+</locatingRules>
+
+

+
+

+oXygen
+
+oXygen is a feature
+rich XML editor. It has built-in support for many schema languages
+including RELAX NG and it is preconfigured with many document types
+including DocBook. oXygen will assist you with writing DocBook V5.0
+content, and you will be able to validate your documents against both
+RELAX NG and Schematron schemas.
+
+

+DocBook V5.0 document opened in oXygen
+
+
+
+
+
+

+
+

+DocBook V5.0 document opened in oXygen in Author mode
+
+
+
+
+
+

+
+

+
+

+XML Mind XML editor
+
+XML
+Mind XML editor (XXE) is a visual validating XML editor that
+provides a wordprocessor-like interface to users. It is available in
+two versions, Standard and Professional. The Standard version is free and
+provides everything you need to edit DocBook V5.0 documents.
+
+

+XML Mind XML Editor – feels almost like MS Word but real DocBook V5.0 markup is created
+
+
+
+
+
+

+
+In order to use DocBook V5.0 in XXE you have to install
+an add-on. Go to
+OptionsInstall
+Add-ons…. Then choose DocBook
+5 configuration and press the OK
+button. After restart, XXE is ready to work with DocBook V5.0
+documents.
+
+

+
+

+
+

+Validating DocBook V5.0
+
+If you are not using a RELAX NG-based validating editor when you
+create documents, we strongly recommend that you validate your
+documents against RELAX NG and Schematron schemas before processing
+them. Only after successful validation can you be sure that your
+document is really DocBook V5.0 and that processing tools will be able
+to process it correctly.
+
+For validation you can use tools that support simultaneous RELAX NG and
+Schematron validation, or you can use NVDL to orchestrate validation using
+the two schemas.
+
+

+Using RELAX NG and Schematron
+
+You can find a list of RELAX NG validators at . It is best to use
+validators with support for embedded Schematron rules inside RELAX NG
+schemas. Schematron is a rule-based validation language which is used
+to impose additional constraints on DocBook documents. Schematron rules
+assert conditions which are impossible or difficult to express 
+in a pure RELAX NG schema.
+
+Sun 
+Multi-Schema XML Validator (MSV) is able to validate an XML
+document against a RELAX NG schema and Schematron rules at the same time.
+To install and use MSV follow these steps:
+
+
+
+Download relames.zip from .
+
+
+Unpack the downloaded file into an arbitrary directory.
+
+
+Validate your document using the following command:
+java -Xss512K -jar /path/to/relames.jar /path/to/docbook.rng document.xml
+
+The switch  increases the stack size
+of the Java virtual machine. This is necessary because the DocBook schema is
+quite large. If you get stack overflow errors from MSV, increase
+this value. You may get spurious error messages if the value
+is too small, so if you get a stack overflow error, ignore any other error
+messages and try a larger value for the stack size.
+If you are not using Sun's Java implementation, please consult the
+documentation for your virtual machine to learn how to increase the stack
+size.
+
+
+
+
+There is also an on-line DocBook V5.0
+validator that validates DocBook V5.0 documents against the normative
+RELAX NG schema with embedded Schematron rules.
+
+

+
+

+Using NVDL
+
+NVDL is a meta-schema language which can validate a document 
+against several schemas. DocBook V5.0 comes with a NVDL
+schema which specifies that DocBook documents should be validated
+against both RELAX NG and Schematron schemas.
+
+You can find a list of NVDL validators at . The following procedures show how to
+install and use the oNVDL and
+JNVDL
+validators.
+
+
+oNVDL installation and usage
+
+Download onvdl-20070517.zip.
+
+
+Unpack the downloaded file into an arbitrary directory.
+
+
+Validate your document using the following command:
+java -jar /path/to/oNVDL/bin/onvdl.jar /path/to/docbook.nvdl document.xml
+
+
+
+
+JNVDL installation and usage
+
+Download the latest release of JNVDL from .
+
+
+Unpack the downloaded file into an arbitrary directory.
+
+
+Modify file jnvdl.bat (or jnvdl.sh on Unix based systems) to include  switch directly after java command.
+
+
+On Windows systems, validate your document using the following command:
+/path/to/jnvdl/jnvdl -nt -s /path/to/docbook.nvdl document.xml
+On Unix systems, validate your document using the following command:
+/path/to/jnvdl/jnvdl.sh -nt -s /path/to/docbook.nvdl document.xml
+
+
+
+

+
+

+
+

+Processing DocBook V5.0
+
+Part of DocBook's great success can be attributed to the
+availability of free
+tools that can be used to transform DocBook content into various
+target formats including HTML and PDF. The DocBook XSL Stylesheets are
+very popular tools.
+
+

+DocBook XSL Stylesheets
+
+The DocBook stylesheets are designed to process content written in
+different versions of DocBook (for example 3.1 and 4.2). Recent
+versions of the stylesheets are also able to process DocBook V5.0
+with some limitations.
+
+You can process DocBook V5.0 documents with the DocBook XSL
+stylesheets in exactly the same way you process DocBook V4.x documents.
+You do not need special software; you can stick to your preferred
+XSLT processor, be it Saxon, xsltproc, Xalan or whatever else (but see
+the note about the lost base URI below).
+
+During document processing, the stylesheets strip
+namespaces from DocBook V5.0 to get a document which will be
+very similar to DocBook V4.x. This is necessary because from the XSLT
+point of view, elements from different namespaces are distinct and cannot 
+be easily processed by the same set of templates. This process is
+completely transparent to the user. If you are processing DocBook V5.0
+documents, the only difference is that you will see the following
+additional message:
+
+Note: namesp. cut : stripped namespace before processing
+Note: namesp. cut : processing stripped document
+
+Although you can successfully use the existing stylesheets to
+process DocBook V5.0, there are some limitations and unsupported
+features. The unsupported features include:
+
+
+general annotations;
+general XLink links on all elements.
+
+
+
+During namespace stripping, the base URI of the document is
+lost. This means that in rare situations, relatively referenced
+resources like images or programlistings can be processed incorrectly.
+The stylesheets attempt to compensate for this problem, but that is not always 
+possible. When an XSLT processor other than Saxon or Xalan is used, a warning 
+message is generated:
+
+WARNING: cannot add @xml:base to node set root element. Relative paths may not work.
+
+
+
+

+
+

+DocBook XSL-NS Stylesheets
+As you can see from reading the previous section, namespace
+  stripping has limitations that will cause trouble in some
+  situations. To overcome those limitations, Bob Stayton created a
+  build system for taking the non-namespace-aware DocBook XSL
+  stylesheets and generating namespace-aware versions from them.
+  The DocBook XSL-NS stylesheets are the result.
+
+The DocBook XSL-NS stylesheets are released side-by-side
+  with the DocBook XSL stylesheets, as a separate docbook-xsl-ns package. They are the
+recommended XSLT 1.0 stylesheets to use for transforming
+namespaced (DocBook V5.0) documents.
+

+
+

+XSLT 2.0 based re-implementation
+
+XSLT 1.0 is missing some important features. To work around
+these missing features, the current DocBook XSL stylesheets use some
+implementation-specific extensions.
+XSLT 2.0 adds many new and previously missing features into the language.
+A new set of DocBook stylesheets is being implemented based on XSLT 2.0
+to take advantage of these features and to fully support DocBook V5.0.
+
+
+The XSLT 2.0 based stylesheets have many new features, including:
+
+
+seamless integration of profiling (conditional
+documents) with external bibliographies and
+glossaries;
+no need for (most) external extensions;
+internationalized indexes;
+easy to customize titlepage templates.
+
+
+The XSLT 2.0 based stylesheets are still under development.  At
+this writing, they only support HTML and chunked HTML output.  As time
+permits, the stylesheet developers will be adding other formats.  Since
+the stylesheets are developed in the limited free time the developers
+have, there's no specific schedule.
+
+There are not very many XSLT 2.0 implementations available.
+But, if you want to try the new stylesheets, grab a snapshot of
+the development version from 
+and unpack it somewhere. Then download and install Saxon 9 from .
+
+To transform a DocBook V5.0 document to a single HTML page use the command:
+
+java -jar /path/to/saxon9.jar -o output.html document.xml /path/to/docbook-xsl2-snapshot/html/docbook.xsl
+
+To transform a DocBook V5.0 document to a set of chunked HTML pages use the command:
+
+java -jar /path/to/saxon9.jar document.xml /path/to/docbook-xsl2-snapshot/html/chunk.xsl
+
+

+
+

+
+

+
+

+Markup changes
+
+This section describes the most common markup changes
+between DocBook V4.x and V5.0.
+You can find a complete list of changes in
+DB5SPEC.
+
+

+Improved cross-referencing and linking
+
+In DocBook V4.x the attribute id is
+used to assign a unique identifier to an element. In DocBook V5.0 this
+attribute is renamed xml:id in order
+to comply with XMLID.
+
+Now you can use almost any inline element as the source of a link,
+not just xref or link. For example, the following
+DocBook 4.x content: 
+
+
+  DIR command
+  ...
+

+
+

+  LS command
+  This command is a synonym for DIR command.
+
]]>
+
+is written in DocBook V5.0 as:
+
+
+  DIR command
+  ...
+

+
+

+  LS command
+  This command is a synonym for DIR command.
+
]]>
+
+The linkend attribute was added to all
+inline elements together with the href
+attribute from the XLink namespace. This means that you can use any inline
+element as the source of a hypertext link. To use XLinks you have
+to declare the XLink namespace (most often on the root element of your
+document):
+
+
+  Test article
+
+  Emacs 
+    is my favourite text editor.]]>
+  …
+
+The ulink element was removed from DocBook V5.0
+in favor of XLink linking. Instead of the DocBook V4.x ulink
+element:
+
+DocBook site]]>
+
+you can now use link
+
+DocBook site]]>
+
+XLink links may contain a fragment identifier, which you can 
+use instead of linkend to form
+cross-references inside a document; for example:
+
+DIR]]>
+
+However XLink links are not checked during validation, while xml:id/linkend
+links are checked for ID/IDREF consistency.
+One place where the XLink-based, fragment identifier scheme is
+useful is when XInclude is being used, since XML ID/IDREF links
+cannot span XInclude boundaries.
+You can use whichever approach better suits your needs.
+
+
+

+Renamed elements
+
+Some elements were renamed to better express their meaning or to
+reduce the total number of elements available in DocBook.
+
+
+Renamed elements
+
+
+
+Old name
+New name
+
+
+
+
+sgmltag
+tag
+
+
+bookinfo, articleinfo,
+chapterinfo, *info
+info
+
+
+authorblurb
+personblurb
+
+
+collabname, corpauthor,
+corpcredit, corpname
+orgname
+
+
+isbn, issn,
+pubsnumber
+biblioid
+
+
+lot, lotentry, tocback,
+tocchap, tocfront, toclevel1,
+toclevel2, toclevel3, toclevel4,
+toclevel5, tocpart
+tocdiv
+
+
+graphic, graphicco,
+inlinegraphic, mediaobjectco
+mediaobject and inlinemediaobject
+
+
+ulink
+link
+
+
+ackno
+acknowledgements
+
+
+
+

+
+

+
+

+Removed elements
+
+The following elements were removed from DocBook V5.0 without
+direct replacements: action, beginpage, highlights,
+interface, invpartnumber, medialabel, modespec,
+structfield, structname.
+If you use one or more of these elements, here are some suggestions
+as to how to re-code them in DocBook V5.0.
+
+
+
+Recommended mapping for removed elements
+
+
+
+Old name
+Recommended mapping
+
+
+
+
+action
+Use <phrase remap="action">.
+
+
+beginpage
+Remove: beginpage is advisory only
+and has tended to cause confusion.  A processing instruction or
+comment should be a workable replacement if one is needed.
+
+
+highlights
+Use abstract.  Note that because highlights has a broader content model, you may
+need to wrap contents in a para inside
+abstract.
+
+
+interface
+Use one of the gui* elements
+(guibutton, guiicon, guilabel,
+guimenu, guimenuitem, or
+guisubmenu).
+
+
+invpartnumber
+Use <biblioid class="other"
+otherclass="medialabel">.  The
+productnumber element is another alternative.
+
+
+medialabel
+Use <citetitle
+pubwork="mediatype">,
+where mediatype is the type of media being
+labeled (e.g.,cdrom or dvd).
+
+
+modespec
+No longer needed.  The current processing model for
+olink renders modespec
+unnecessary.
+
+
+structfield, structname
+Use varname. If you need to distinguish between the
+two, use <varname
+remap="structname or
+structfield">.  In some contexts, it
+may also be appropriate to use property for structfield.
+
+
+
+

+
+

+
+
+
+

+Converting DocBook V4.x documents to DocBook V5.0
+
+The DocBook V5.0 schema ships with an XSLT 1.0 stylesheet that
+is designed to transform valid DocBook V4.x documents to valid
+DocBook V5.0 documents.
+
+To convert your document, doc.xml in the
+examples below, follow these steps:
+
+
+
+Check the validity of your DocBook XML V4.x document. The
+conversion tool assumes that the input document is valid. If the input
+document contains markup errors, the results will be unpredictable at
+best.
+
+
+Transform doc.xml to
+newdoc.xml with the
+db4-upgrade.xsl stylesheet included in the
+DocBook V5.0 distribution that you are using.
+
+
+Check the validity of your DocBook XML V5.0 document against
+the DocBook V5.0 RELAX NG grammar.
+
+
+
+In the vast majority of cases, the resulting document should
+be valid and your conversion process is finished.
+
+If the document is not valid, please report the problem.
+(Over time, we'll have more experience with the sorts of things
+that can go wrong and we'll update this document to reflect that
+experience.)
+
+

+What About Entities?
+
+Using XSLT to transform existing documents to DocBook V5.0 has
+one potential disadvantage: it removes all entity references from 
+your document.
+
+If preserving entities is an important aspect of your production
+work flow, you will have to engage in a semi-manual process to
+preserve them.
+
+
+
+Open your existing document using your favorite editing tool.
+You must use a tool that is not XML-aware, or one
+that allows you to edit markup “in the raw”.
+
+
+Replace all occurrences of the entity references that you want
+to preserve with some unique string. For example, if you want to preserve
+“&Product;” references, you could replace them
+all with “[[[Product]]]” (assuming that the string
+“[[[Product]]]” doesn't occur anywhere else in your document).
+
+
+Copy the document type declaration off of your document and save
+it some place. The document type declaration is everything from
+“<!DOCTYPE” to the closing “]>”.
+
+
+
+Perform the conversion described in .
+
+
+
+Open the new document using your favorite editing tool. Replace
+all occurrences of the unique string you used to save the entity references
+with the corresponding entity references.
+
+
+Paste the document type declaration that you saved onto the top
+of your new document.
+
+
+Remove the external identifier (the PUBLIC
+and/or SYSTEM keywords) from the document type
+declaration. A document that begins:
+
+]>]]>
+is perfectly well-formed. If you don't remove the references to
+the DTD, then your parser will likely try to validate against DocBook
+V4.0 and that's not going to work. Alternatively, you could refer
+to the DocBook V5.0 DTD.
+
+
+
+
+Steps 2 and 5 from previous procedure can be automated using the
+cloak
+script written by Michael Smith.
+
+
+

+External Parsed Entities
+
+External parsed entities, entities which load part of a document
+from another file, are a special case. These can often be replaced
+with XInclude elements.
+
+The Perl script db4-entities.pl, also included
+in the DocBook V5.0 distribution attempts to perform this replacement
+for you. To use the script, perform the following steps:
+
+
+
+Process your document with db4-entities.pl.
+The script expects a single filename and prints the XInclude version
+on standard output.
+
+
+Process the XInclude version as described in .
+
+
+
+

+

+
+

+
+

+  Customizing DocBook V5.0
+  
+
+  
+    It's much easier to customize DocBook V5.0 than it was to
+    customize earlier releases.  This is partly because RELAX NG
+    provides better support for modifications than DTDs and partly
+    because the DocBook schema is designed to take full advantage
+    of the capabilities RELAX NG provides.
+    This section describes the organization of the RELAX NG schema for
+    DocBook, methods and examples for adding, removing, and modifying elements
+    and attributes, and conventions for naming and versioning
+    DocBook customizations.
+    It assumes some familiarity with RELAX NG.  If you are unfamiliar
+    with RELAX NG, you can find a tutorial introduction in
+    RNCTUT.
+  
+  

+    DocBook RELAX NG schema organization
+    
+      The DocBook RELAX NG schema is highly modular, using named
+      patterns extensively.  Every element, attribute, attribute
+      list, and enumeration has its own named pattern.  In addition,
+      there are named patterns for logical combinations of elements
+      and attributes.  These named patterns provide hooks
+      into the schema that allow you to do a wide range of customization
+      by simply redefining one or more of the named patterns.
+    
+    
+      An important design characteristic of the schema is that
+      duplication is minimized.  This is done through the use of
+      named patterns for common groupings that can be re-used.
+      For example, the imagedata and videodata
+      elements each have an align attribute
+      that takes the same set of enumerated values.  Rather than
+      repeating those values, a single pattern,
+      db.halign.enumeration is referenced by
+      the db.videodata.align.enumeration
+      and db.imagedata.align.enumeration patterns,
+      which are in turn referenced by the
+      db.videodata.align.attribute
+      and db.imagedata.align.attribute patterns.
+      While this may seem like overkill, it allows a customizer to modify
+      the allowed enumerations for these two attributes separately or together,
+      or to completely re-define the allowed content of either or both,
+      by redefining one or more of these named patterns.
+    
+    
Pattern Names
+    
+      Because named patterns are used extensively, the RELAX NG schema uses
+      several naming conventions.  These are:
+      
+        
+          
+            Names have two or more parts, separated by dots .
+          
+        
+        
+          
+            The first part of each name is the prefix db
+          
+        
+        
+          
+            Each element has a named pattern in the form
+            db.elementname.
+            Elements that have different content models in different
+            contexts will also have patterns in the form
+            db.context.elementname.  For example, db.figure.info
+            defines the content model for the info element
+            when it appears as a child of the figure element.
+            Context may have several parts.
+            For example, db.cals.entrytbl.thead.
+          
+        
+        
+          
+            Most attributes have a named pattern in the form
+            db.attributename.attribute.
+            Attributes that have different content models in different
+            contexts will also have patterns in the form
+            db.context.attributename.attribute.
+            For example,
+            db.olink.localinfo.attribute defines the content
+            model of the localinfo attribute when
+            it appears in olink.
+            There are a few attributes that do not have individual named
+            patterns.  For example, the effectivity attributes are grouped
+            into db.effectivity.attributes and not identified
+            separately.
+          
+        
+        
+          
+            Each element has a named pattern for its attribute list in
+            the form
+            db.elementname.attlist
+
+            that defines the list of attributes for that element.
+            Elements that have different attribute lists in different
+            contexts will also have patterns in the form
+            db.context.elementname.attlist
+            For example, db.html.table.attlist defines
+            the attribute list for the html table element and
+            db.cals.table.attlist defines the attribute
+            list for a cals table element.
+          
+        
+        
+          
+            Each attribute that has enumerated values has a
+            named pattern in the form
+            db.[context.]attributename.enumeration.
+            If the enumeration for a particular attribute depends on
+            context, optional context is provided.
+            For example,
+            db.verbatim.continuation.enumeration defines
+            the enumeration values for the
+            continuation attribute that is used
+            in verbatim contexts like screen.
+            Unlike elements and attributes, there is not necessarily a
+            named pattern for enumerated attributes outside their context.
+            For example, there is no db.class.enumeration
+            because the class attribute has
+            a broad and non-intersecting range of uses.
+          
+        
+        
+          
+            There are several different groupings of elements and attributes.
+            Here are the major ones:
+            
+              
+                inlines
+                
+                  
+                    Combinations of inline elements, for example,
+                    db.error.inlines, which contains
+                    db.errorcode,
+                    db.errortext, etc.
+                  
+                
+              
+              
+                blocks
+                
+                  
+                    Combinations of block elements, for example,
+                    db.verbatim.blocks, which contains
+                    db.programlisting,
+                    db.screen, etc.
+                  
+                
+              
+              
+                attributes
+                
+                  
+                    Combinations of attributes, for example,
+                    db.effectivity.attributes,
+                    which contains the attributes
+                    arch,
+                    condition,
+                    conformance, etc.
+                  
+                
+              
+              
+                components
+                
+                  
+                    High level components of the schema, for example,
+                    db.navigation.components, which contains
+                    db.glossary,
+                    db.bibliography,
+                    db.index, and
+                    db.toc, and is used inside the
+                    content model for chapter, appendix,
+                    and preface.
+                  
+                
+              
+              
+                contentmodel
+                
+                  
+                    Shared content models, for example,
+                    db.admonition.contentmodel, which contains
+                    the content model for tip, warning,
+                    note, etc.
+                  
+                
+              
+            
+          
+          
+            There are a couple of other groupings designed to minimize
+            duplication, but these are the most important.
+          
+        
+      
+    
+  

+

+

+  General customization considerations
+  
+    Creating a customized schema is similar to
+    creating a customization layer for XSL.  The schema customization
+    layer is a new RELAX NG schema that defines your changes and
+    includes the standard docbook schema.  You then validate using
+    the schema customization as your schema.
+  
+  
+     is an empty
+    RELAX NG customization that does nothing
+    except define the name spaces and include the standard DocBook schema.
+    The href attribute of the
+    include element points to
+    the location of the standard DocBook V5.0
+    schema.The examples in this section use
+    docbook.rng as the schema location. If you want
+    to create a portable schema customization you should use a standard
+    web-accessible location like
+    http://docbook.org/xml/&version;/rng/docbook.rng and
+    then use XML
+    catalogs to resolve this location to your local copy of the
+    schema for improved performance. Unfortunately, at the time of
+    this writing not all RELAX NG validators support XML catalogs.
+    All of the examples are given in both RNG and RNC form.
+Empty customization file
+
+
+  
+
+  
+
+]]>
+
+
+  
+

+  

+    Elements
+    

+      Adding elements
+      
+        Adding an element typically takes two definitions.
+        The first defines the new element and
+        its content model, and the second adds the
+        new element into the schema.  We'll show two examples.
+      
+      
+        
+        adds a new element,
+        person, with the same
+        content model as author.  The new element will be
+        allowed to appear wherever author can appear.
+      
+      
+        The db.author pattern is copied
+        and renamed dbx.person, defining
+        a new element called person.
+        Then, the db.author pattern is redefined
+        to be a choice of the current value or dbx.person.
+        The combine attribute tells
+        RELAX NG to combine this pattern with the existing named
+        pattern.  In this case, the value
+        of the combine attribute is
+        choice, which tells the parser that either
+        the original pattern or this new pattern is a valid match.
+      
+Adding a new element by duplicating an existing one
+
+
+  
+  
+  
+    
+        
+        
+    
+  
+  
+  
+    
+  
+]]>
+
+
+    
+      The preceding method works well when you'd like a new element
+      to be a clone or near-clone of an existing element.  It gives
+      you complete control over the content model, but
+      only limited control over where the element is allowed.  It
+      works well when you want to allow the element in the same places
+      as an existing element, and for this example that works
+      nicely, since author is allowed in four different
+      named patterns, each of which would have had to be redefined to
+      allow person.
+      But, if you can't find an existing element that is allowed in
+      exactly the places you need, this method doesn't work as well.
+    
+    
+      
+      adds two new elements by combining them into
+      a higher level pattern.  In this example, we'll add
+      two new inline elements for writing about assembly language,
+      register and 
+      instruction.
+      We will allow them wherever programming inlines
+      or operating system inlines are allowed.
+      
+      defines the two elements, creates a new named pattern
+      (dbx.asm.inlines) that contains them, and adds
+      that pattern to db.programming.inlines and
+      db.os.inlines.  Since these two patterns
+      don't have any elements in common, the strategy used in 
+      
+      would require selecting two different elements to clone,
+      which would be messy.
+    
+Adding new inline elements
+
+
+  
+  
+  
+    
+      
+    
+  
+  
+    
+      
+    
+  
+  
+  
+    
+      
+      
+    
+  
+  
+    
+      
+    
+    
+      
+    
+]]>
+
+
+    

+    

+      Deleting elements
+      
+        Deleting elements is straightforward, but takes some
+        care and planning.   deletes
+        the important admonition element by redefining
+        it with a content model of notAllowed.
+        Note that in this example, the redefinition is inside
+        the include element.
+        This is required for
+        redefinitions that completely replace an existing pattern.
+      
+      
+        Be careful; If you delete an element that is a required part
+        of another element's content model, you can make it
+        impossible to create a valid document.
+        For example, if you delete the title
+        element, you won't be able to validate a book
+        because a book requires a title.
+      
+Deleting an element
+
+
+  
+    
+    
+      
+    
+  
+]]>
+
+
+    

+    

+      Customizing the content model of existing elements
+      
+         
+         expands the definition of author to include two
+         new elements, born and
+         died.
+         The author element allows two content models,
+         db.person.author.contentmodel, which
+         defines an author who is a person, and
+         db.org.author.contentmodel, which
+         defines an author that is an organization.  We will modify
+         db.person.author.contentmodel so that
+         only authors who are persons can have the new elements.
+Modifying the content model of an element
+
+
+  
+
+  
+    
+      
+        
+          
+        
+      
+      
+        
+          
+        
+      
+    
+  
+]]>
+
+
+      
+      
+        This modification will allow instances like this:
+
+  Babe Ruth
+  02/06/1895
+  08/16/1948
+]]>
+but because we only modified the content model for authors
+who are human, it won't allow an instance like this, which
+uses db.org.author.contentmodel:
+
+
+  Boston Red Sox
+  1919
+  2004
+]]>
+      
+    

+  

+  

+    Attributes
+    

+      Adding attributes
+      
+        The simplest way to add an attribute to a single element
+        is to add it to the attlist pattern for that element.
+        
+        adds the optional attributes born
+        and died to the attribute
+        list for author.
+        The db.author.attlist
+        named pattern is redefined with the
+        combine attribute set to
+        interleave, which interleaves the two new
+        optional attributes with the existing attributes on the list.
+      
+Adding attributes
+
+
+  
+
+  
+    
+      
+        
+          
+        
+      
+      
+        
+          
+        
+      
+    
+  
+]]>
+
+
+    
+      Unlike
+      ,
+       allows
+      the new attributes to appear on any author
+      element, not just those using the person content model.
+    
+    
+       shows
+      how you could limit the use of these attributes to authors who
+      are persons.  In this example, the new attributes are interleaved
+      with the db.person.author.contentmodel.  
+      The only difference between this example and 
+       is
+      that the added patterns are identified as attributes rather than
+      elements.  This shows some of the flexibility of RELAX NG, which
+      treats attributes and elements very consistently.
+Adding attributes; alternate method
+
+
+  
+  
+  
+    
+      
+        
+          
+        
+      
+      
+        
+          
+        
+      
+    
+  
+]]>
+
+
+There is one difference in the treatment of attributes and elements
+that is worth noting.  By the XML 1.0 definition, the relative order
+of attributes is not significant.  Therefore, the
+interleave block is not required for
+attributes, though it does no harm.  
+    
+    

+    

+      Deleting attributes
+      
+        Deleting an attribute is similar to deleting an element,
+        except that you use the RELAX NG empty
+        pattern rather than notAllowed.
+        
+        deletes the linking attributes, which are collected in the
+        db.common.linking.attributes pattern,
+        by defining that pattern as empty.
+      
+Deleting an attribute
+
+
+  
+    
+      
+    
+  
+]]>
+
+
+      
+        Generally, empty is used when deleting
+        attributes and notAllowed is used when
+        deleting elements.
+      
+    

+    

+      Changing permitted content of attributes
+      
+        
+        modifies db.spacing.enumeration to
+        add the additional value large.  Note
+        that to remove a value from an enumeration, you need
+        to redefine the entire enumeration, minus the values
+        you don't need.
+      
+Deleting an attribute
+
+
+  
+  
+  
+    large
+  
+]]>
+
+
+    

+  

+
+

+Naming and versioning DocBook customizations
+
+DocBook V5.0 is not tightly coupled with some particular
+validation technology like DTDs. This also means that DocBook V5.0
+documents don't have to (and usually don't) start with a
+document type declaration (<!DOCTYPE…>) to specify the schema
+(DTD) to use. Instead, DocBook V5.0 instances can be easily
+distinguished from other XML vocabularies by using elements in the
+http://docbook.org/ns/docbook namespace. This namespace is
+enough to distinguish DocBook from other XML based formats. But the
+DocBook schema evolves over time and there are several versions of
+DocBook (e.g. 3.1, 4.2, 4.5 and 5.0).  Since DocBook version 5.0, the
+actual version used is indicated in the version attribute on a root element.
+
+
+  …
+]]>
+
+Future versions of DocBook documents will start with the same
+markup, except the version number will be raised, for example to 5.1
+or 6.0.
+The namespace will remain the same until the semantics of the elements
+change in a backward incompatible way, which is very unlikely to happen.
+
+If you create a DocBook schema customization you must change the version attribute to distinguish your
+customization from the official DocBook.  Changing the
+namespace is not recommended because that would break the processing
+tools.  Remember that changing namespaces is the same as renaming all
+elements in the namespace.
+
+When you customize the schema, use the following syntax to
+identify your DocBook derivation:
+
+base_version-[subset|extension|variant] [name[-version]?]+
+
+For example:
+
+5.0-subset simplified-1.0
+5.0-variant ASMBook
+5.0-variant ASMBook-2006
+5.0-extension MathML-2.0 SVG-1.1
+
+The first part of the version identifier is the version number of the
+DocBook schema from which you derived your customization.
+
+If your schema is a proper subset, you can advertise this status
+by using the subset keyword in the description. If
+your schema contains any markup model extensions, you can advertise
+this status by using the extension keyword. If
+you'd rather not characterize your variant specifically as a subset or
+an extension, use the variant keyword.
+
+After these keywords you may add a whitespace separated list of
+customization identifiers. Each name may be optionally followed by its
+version number.
+
+

+
+

+
+

+FAQ
+
+
+
+Authoring
+
+
+
+How do I attach a schema to a DocBook V5.0 document when I do not
+want to use DTDs and !DOCTYPE?
+
+
+There is no standard way of associating a RELAX NG schema with a
+document. Most tools provide some mechanism for performing this
+association, consult the documentation for your application. In some
+tools you must specify schema manually each time you want to
+edit/process your document.
+
+
+
+
+
+How do I use entities like ndash in
+DocBook V5.0?
+
+
+Modern schema languages (including RELAX NG and W3X XML Schema)
+do not provide any means to define entities that can be used for easier
+typing of special characters. Some editors provide functions or
+special toolbars that allow you to easily pick necessary character
+and insert it into document as a raw Unicode character or a numeric
+character reference.
+Another possibility is to include entity definitions in the
+prolog of your document. Entity definition
+files are now maintained by W3C. You can reference definition
+files with entity definitions you are interested in and then reference
+imported entities. For example:
+
+
+%isopub;
+]>
+

+DocBook V5.0 – the superb documentation format]]>
+…
+For your convenience there is also flattened entity definition
+file which contains all entity definitions.
+
+
+%allent;
+]>
+

+DocBook V5.0 – the superb documentation format]]>
+…
+
+
+
+
+
+How to modularize documents?
+
+
+You can use XInclude for this
+task. There is an alternative schema for DocBook V5.0 that
+contains XInclude elements. This is necessary to make some XML editors
+happy. This schema can be found in files that end with letters xi, e.g.
+docbookxi.rnc instead of
+docbook.rnc.
+
+
+
+
+
+How to validate documents which are composed by XInclude?
+
+
+If you are using XIncludes you should make sure that the final
+document after resolving all inclusions is valid DocBook V5.0
+instance. This means that all XIncludes should be processed before
+validation takes place. The following command can be used to enable
+XInclude processing in oNVDL.
+java -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration -jar /path/to/oNVDL/bin/onvdl.jar /path/to/docbook.nvdl document.xml
+For JNVDL you can use switch  to enable XInclude processing.
+
+
+
+
+
+
+Stylesheets
+
+
+
+Will the current DocBook XSL stylesheets (XSLT 1.0 based
+implementation) be maintained and improved in the future since work on
+a new XSLT 2.0 based implementation has started?
+
+
+Yes, the current stylesheets (like 1.73.x) will be supported and
+improved further because they are very widely deployed and work with
+many existing XSLT processors.
+Surely there will be a point in a future when all new development
+will be switched to the XSLT 2.0 based implementation. But this
+will not happen until all features of the current stylesheets are
+implemented in the new stylesheets, and until there is more than
+one usable XSLT 2.0 processor available.
+
+
+
+
+
+
+Schema customizations
+
+
+
+How can I extend the DocBook schema with MathML elements?
+
+
+The basic DocBook schema allows elements from the MathML namespace
+to appear inside the equation element.  This means that you can
+validate a DocBook+MathML document, but MathML content will be ignored
+during the validation. You will also not be able to use guided editing
+for the MathML content.
+If you need strict validation of MathML content or guided
+editing for MathML, you can easily extend the base DocBook schema with
+the MathML schema.
+
+Extending the DocBook schema with the MathML schema
+
+Download the MathML RELAX NG schema from  and unpack it
+somewhere (e.g. into a mathml subdirectory).
+
+
+Create a schema customization in compact syntax—dbmathml.rnc:
+namespace html = "http://www.w3.org/1999/xhtml"
+namespace mml = "http://www.w3.org/1998/Math/MathML"
+namespace db = "http://docbook.org/ns/docbook"
+
+include "/path/to/docbook.rnc" {
+  db._any.mml = external "mathml/mathml2.rnc"
+  db._any =
+    element * - (db:* | html:* | mml:*) {
+      (attribute * { text }
+       | text
+       | db._any)*
+    }
+}
+Or, alternatively, you can use the XML syntax of RELAX NG—dbmathml.rng:
+
+
+
+
+  
+    
+  
+
+  
+    
+      
+        
+          
+          
+          
+        
+      
+      
+        
+          
+            
+          
+          
+          
+        
+      
+    
+  
+
+
+]]>
+
+
+Now use the customized schema (dbmathml.rnc
+or dbmathml.rng) instead of the original
+DocBook schema.
+
+
+
+
+
+
+
+How can I extend the DocBook schema with SVG elements?
+
+
+The situation is the same as with MathML support. You can use
+elements from the SVG namespace inside the imageobject
+element.
+
+Extending the DocBook schema with the SVG schema
+
+Download the SVG RELAX NG schema from  and unpack it
+somewhere (e.g. into an svg subdirectory).
+
+
+Create a schema customization in compact syntax—dbsvg.rnc:
+namespace html = "http://www.w3.org/1999/xhtml"
+namespace db = "http://docbook.org/ns/docbook"
+namespace svg = "http://www.w3.org/2000/svg"
+
+include "/path/to/docbook.rnc" {
+  db._any.svg = external "svg/svg11.rnc"
+  db._any =
+    element * - (db:* | html:* | svg:*) {
+      (attribute * { text }
+       | text
+       | db._any)*
+    }
+}
+Or, alternatively, you can use the XML syntax of RELAX NG—dbsvg.rng:
+
+
+
+
+  
+    
+  
+
+  
+    
+      
+        
+          
+          
+          
+        
+      
+      
+        
+          
+            
+          
+          
+          
+        
+      
+    
+  
+
+
+]]>
+
+
+Now use the customized schema (dbsvg.rnc
+or dbsvg.rng) instead of the original
+DocBook schema.
+
+
+
+
+
+
+
+Is it possible to use the previous two customizations for MathML
+and SVG together?
+
+
+Yes, you can create a special schema customization that combines
+both MathML and SVG with the DocBook schema. In compact syntax, the merged
+schema is:
+namespace html = "http://www.w3.org/1999/xhtml"
+namespace mml = "http://www.w3.org/1998/Math/MathML"
+namespace db = "http://docbook.org/ns/docbook"
+namespace svg = "http://www.w3.org/2000/svg"
+
+include "/path/to/docbook.rnc" {
+  db._any.mml = external "mahtml/mathml2.rnc"
+  db._any.svg = external "svg/svg11.rnc"
+  db._any =
+    element * - (db:* | html:* | mml:* | svg:*) {
+      (attribute * { text }
+       | text
+       | db._any)*
+    }
+}
+Or alternatively in the full RELAX NG syntax:
+
+
+
+
+  
+    
+  
+
+  
+    
+  
+
+  
+    
+      
+        
+          
+          
+          
+          
+        
+      
+      
+        
+          
+            
+          
+          
+          
+        
+      
+    
+  
+
+
+]]>
+
+
+
+
+
+Are there any other examples of schema customization
+available?
+
+
+Sure. Some of the are listed bellow:
+
+Sample
+customization of ITS and DocBook
+Examples on
+DocBook WiKi
+
+
+
+
+
+
+
+Tool specific problems
+
+
+
+I'm using Altova XMLSpy to validate DocBook V5.0 instances
+against the W3C XML Schema (docbook.xsd). XMLSpy
+complains about undefined xml:id
+attributes?
+
+
+XMLSpy always uses its own bundled version of
+xml.xsd which unfortunately doesn't define the xml:id attribute. The bundled version of
+xml.xsd is hardwired into the program and cannot
+be replaced by a newer version. To solve this problem you must upgrade
+to version 2006 SP1.
+
+
+
+
+
+
+

+
+
+
+
+RNCTUT
+Clark, James – Cowan, John – MURATA, Makoto: RELAX NG Compact Syntax Tutorial.
+Working Draft, 26 March 2003. OASIS. 
+
+
+
+NVDLTUT
+Nálevka, Petr:
+NVDL Tutorial.
+
+
+
+
+XMLID
+Marsh, Jonathan – 
+Veillard, Daniel –
+Walsh, Norman: xml:id Version 1.0. W3C Recommendation, 9 September 2005. 
+
+
+
+DB5SPEC
+Norman, Walsh: The DocBook Schema.
+Working Draft 5.0a1, OASIS, 29 June 2005.
+
+
+
+
+
+
diff --git a/docbook/relaxng/docbook/howto/en/images/emacs.png b/docbook/relaxng/docbook/howto/en/images/emacs.png
new file mode 100644
index 000000000..92e215a15
Binary files /dev/null and b/docbook/relaxng/docbook/howto/en/images/emacs.png differ
diff --git a/docbook/relaxng/docbook/howto/en/images/oxygen4.png b/docbook/relaxng/docbook/howto/en/images/oxygen4.png
new file mode 100644
index 000000000..8a86a65e6
Binary files /dev/null and b/docbook/relaxng/docbook/howto/en/images/oxygen4.png differ
diff --git a/docbook/relaxng/docbook/howto/en/images/oxygen5.png b/docbook/relaxng/docbook/howto/en/images/oxygen5.png
new file mode 100644
index 000000000..5e767a28f
Binary files /dev/null and b/docbook/relaxng/docbook/howto/en/images/oxygen5.png differ
diff --git a/docbook/relaxng/docbook/howto/en/images/xxe.png b/docbook/relaxng/docbook/howto/en/images/xxe.png
new file mode 100644
index 000000000..3cd9ff75a
Binary files /dev/null and b/docbook/relaxng/docbook/howto/en/images/xxe.png differ