From dd1bd462d77010716d275cda236093d23f205d91 Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Tue, 11 Jul 2017 20:35:44 +0200
Subject: [PATCH] Docbook block objects
---
Doc/Common/glossary.xml | 12 +-
XmlCross/xmlcross.xml | 517 ++++++++++++++++++++++++++++++++--------
2 files changed, 434 insertions(+), 95 deletions(-)
diff --git a/Doc/Common/glossary.xml b/Doc/Common/glossary.xml
index 426ac6975..a3a1dc42b 100644
--- a/Doc/Common/glossary.xml
+++ b/Doc/Common/glossary.xml
@@ -4,6 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ns="http://docbook.org/ns/transclusion"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
@@ -53,7 +54,7 @@
xlink:href="https://en.wikipedia.org/wiki/Create,_read,_update_and_delete"><emphasis
role="bold">C</emphasis>reate, <emphasis role="bold">R</emphasis>ead,
<emphasis role="bold">U</emphasis>pdate and <emphasis
- role="bold">D</emphasis>elete operations</link> </para>
+ role="bold">D</emphasis>elete operations</link></para>
</glossdef>
</glossentry>
@@ -86,6 +87,15 @@
</glossdef>
</glossentry>
+ <glossentry xml:id="glo_Docbook">
+ <glossterm><productname>Docbook</productname></glossterm>
+
+ <glossdef>
+ <para><link xlink:href="http://tdg.docbook.org">XML based authoring
+ system</link></para>
+ </glossdef>
+ </glossentry>
+
<glossentry xml:id="glo_DOM">
<glossterm><acronym>DOM</acronym></glossterm>
diff --git a/XmlCross/xmlcross.xml b/XmlCross/xmlcross.xml
index a0c9c26aa..b23bf7e01 100644
--- a/XmlCross/xmlcross.xml
+++ b/XmlCross/xmlcross.xml
@@ -272,10 +272,10 @@
</chapter>
<chapter annotations="slide" xml:id="xmlc_chap_dbOverview">
- <title><productname>Docbook</productname> overview</title>
+ <title><productname>Docbook</productname></title>
<figure xml:id="xmlc_fig_whatIsDocbook">
- <title>What is <productname>Docbook</productname>?</title>
+ <title>What is <xref linkend="glo_Docbook"/>?</title>
<informaltable border="1">
<tr>
@@ -488,129 +488,456 @@
</informaltable>
</figure>
- <section xml:id="xmlc_sect_targetHtml">
- <title>HTML</title>
+ <figure xml:id="xmlc_fig_tools">
+ <title>Tooling / Software</title>
- <figure xml:id="xmlc_fig_targetHtml">
+ <informaltable border="1">
+ <tr>
+ <td><glosslist>
+ <glossentry>
+ <glossterm>Editing / office</glossterm>
+
+ <glossdef>
+ <itemizedlist>
+ <listitem>
+ <para><link
+ xlink:href="http://www.xmlmind.com/xmleditor">XMLmind
+ XML Editor</link></para>
+ </listitem>
+
+ <listitem>
+ <para><orgname>Oxygenxml</orgname> <link
+ xlink:href="https://www.oxygenxml.com/xml_author.html">XML
+ Author</link></para>
+ </listitem>
+ </itemizedlist>
+ </glossdef>
+ </glossentry>
+
+ <glossentry>
+ <glossterm>Editing / programming</glossterm>
+
+ <glossdef>
+ <para>emacs, vi, notepad, XML IDE, ...</para>
+ </glossdef>
+ </glossentry>
+ </glosslist></td>
+
+ <td><glosslist>
+ <glossentry>
+ <glossterm>XSLT <link
+ xlink:href="http://www.sagehill.net/docbookxsl/XSLprocessors.html#XSLTprocessors">processors</link></glossterm>
+
+ <glossdef>
+ <para><link
+ xlink:href="http://saxon.sourceforge.net/saxon6.5.5">Saxon
+ 6.5.5</link>, <link
+ xlink:href="http://xml.apache.org/xalan-j">Xalan</link>,
+ ...</para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry>
+ <glossterm>FO (PDF) processors</glossterm>
+
+ <glossdef>
+ <itemizedlist>
+ <listitem>
+ <para>Apache <productname
+ xlink:href="https://xmlgraphics.apache.org/fop">FOP</productname>
+ (Open Source)</para>
+ </listitem>
+
+ <listitem>
+ <para>RenderX <productname
+ xlink:href="http://www.renderx.com/tools/xep.html">xep</productname></para>
+ </listitem>
+
+ <listitem>
+ <para>Antenna House <productname
+ xlink:href="https://www.antennahouse.com/antenna1/formatter/">formatter</productname></para>
+ </listitem>
+ </itemizedlist>
+ </glossdef>
+ </glossentry>
+ </glosslist></td>
+ </tr>
+ </informaltable>
+ </figure>
+
+ <section xml:id="xmlc_sect_targetFormats">
+ <title>Target formats</title>
+
+ <section xml:id="xmlc_sect_targetHtml">
<title>HTML</title>
- <itemizedlist>
- <listitem>
- <para>Different HTML versions</para>
- </listitem>
-
- <listitem>
- <para>Static text</para>
- </listitem>
-
- <listitem>
- <para><link
- xlink:href="http://www.sagehill.net/docbookxsl/HtmlOutput.html">Single
- or chunked</link> output</para>
- </listitem>
-
- <listitem>
- <para>No full text search</para>
- </listitem>
- </itemizedlist>
- </figure>
+ <figure xml:id="xmlc_fig_targetHtml">
+ <title>HTML</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Different HTML versions</para>
+ </listitem>
+
+ <listitem>
+ <para>Static text</para>
+ </listitem>
+
+ <listitem>
+ <para><link
+ xlink:href="http://www.sagehill.net/docbookxsl/HtmlOutput.html">Single
+ or chunked</link> output</para>
+ </listitem>
+
+ <listitem>
+ <para>No full text search</para>
+ </listitem>
+ </itemizedlist>
+ </figure>
+
+ <figure xml:id="xmlc_fig_targetWebhelp">
+ <title>Web help</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>HTML 5 based</para>
+ </listitem>
+
+ <listitem>
+ <para>Client side full text search index by virtue of JavaScript
+ (<link xlink:href="https://lucene.apache.org">Apache
+ Lucene)</link></para>
+ </listitem>
+
+ <listitem>
+ <para>JavaScript based navigation</para>
+ </listitem>
+
+ <listitem>
+ <para>3-rd party tool integration e.g. <link
+ xlink:href="https://www.mathjax.org">MathJax</link></para>
+ </listitem>
+ </itemizedlist>
+ </figure>
+ </section>
+
+ <section xml:id="xmlc_sect_targetEclipseHelp">
+ <title>Eclipse <link
+ xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help.htm?cp=2_0_19_1">Help</link></title>
+
+ <figure xml:id="xmlc_fig_targetEclipsehelp">
+ <title>Basics</title>
+
+ <informaltable border="1">
+ <tr>
+ <td><itemizedlist>
+ <listitem>
+ <para>Application server based</para>
+ </listitem>
- <figure xml:id="xmlc_fig_targetWebhelp">
- <title>Web help</title>
-
- <itemizedlist>
- <listitem>
- <para>HTML 5 based</para>
- </listitem>
-
- <listitem>
- <para>Client side full text search index by virtue of JavaScript
- (<link xlink:href="https://lucene.apache.org">Apache
- Lucene)</link></para>
- </listitem>
-
- <listitem>
- <para>JavaScript based navigation</para>
- </listitem>
-
- <listitem>
- <para>3-rd party tool integration e.g. <link
- xlink:href="https://www.mathjax.org">MathJax</link></para>
- </listitem>
- </itemizedlist>
- </figure>
+ <listitem>
+ <para>Server based full text search</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Search scope definitions</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para><link
+ xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm?cp=2_0_19_1_0_1">Standalone</link>
+ or <link
+ xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm?cp=2_0_19_1_0_2">centralized</link></para>
+ </listitem>
+
+ <listitem>
+ <para><link
+ xlink:href="http://www.wideskills.com/eclipse-plugin-tutorial/eclipse-plugin-help-tutorial">Plugin
+ model</link>, Web App <link
+ xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_war.htm?cp=2_0_19_1_4">deployable</link></para>
+ </listitem>
+ </itemizedlist></td>
+
+ <td><mediaobject>
+ <imageobject>
+ <imagedata fileref="Ref/DbookIntro/eclipseHelpScopeDefAnnot.svg"/>
+ </imageobject>
+ </mediaobject></td>
+ </tr>
+ </informaltable>
+ </figure>
+ </section>
+
+ <section xml:id="xmlc_sect_targetPrint">
+ <title>Printed output</title>
+
+ <figure xml:id="xmlc_fig_targetPrint">
+ <title>Basics</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Focus on <link
+ xlink:href="http://www.cafeconleche.org/books/bible3/chapters/ch16.html">Formatting
+ Objects</link></para>
+ </listitem>
+
+ <listitem>
+ <para>Multiple formatting engines</para>
+ </listitem>
+
+ <listitem>
+ <para>Multiple print formats</para>
+ </listitem>
+ </itemizedlist>
+ </figure>
+ </section>
</section>
- <section xml:id="xmlc_sect_targetEclipseHelp">
- <title>Eclipse <link
- xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help.htm?cp=2_0_19_1">Help</link></title>
+ <section xml:id="xmlc_sect_importantElements">
+ <title>Selected elements</title>
+
+ <para>Block elements are <xref linkend="glo_Docbook"/>'s building
+ blocks.</para>
+
+ <figure xml:id="xmlc_fig_para">
+ <title>Paragraph</title>
+
+ <informaltable border="1">
+ <tr>
+ <th>View</th>
+
+ <th>Docbook</th>
+
+ <th>HTML</th>
+ </tr>
+
+ <tr>
+ <td valign="top"><para>Some text.</para></td>
+
+ <td valign="top"><programlisting language="xml"><para>Some text</para></programlisting></td>
+
+ <td><programlisting language="xml"><p <emphasis role="bold">style='color:red'</emphasis>
+ >Some text.</p></programlisting></td>
+ </tr>
+ </informaltable>
+
+ <para>Caution: No style / formatting related parameters in <xref
+ linkend="glo_Docbook"/>.</para>
+
+ <para>This is by design and on purpose.</para>
+ </figure>
- <figure xml:id="xmlc_fig_targetEclipsehelp">
- <title>Basics</title>
+ <figure xml:id="xmlc_fig_itemizedList">
+ <title>Itemized list</title>
<informaltable border="1">
<tr>
- <td><itemizedlist>
+ <th>View</th>
+
+ <th>Docbook</th>
+
+ <th>HTML</th>
+ </tr>
+
+ <tr>
+ <td valign="top"><itemizedlist>
<listitem>
- <para>Application server based</para>
+ <para>Bee</para>
</listitem>
<listitem>
- <para>Server based full text search</para>
-
- <itemizedlist>
- <listitem>
- <para>Search scope definitions</para>
- </listitem>
- </itemizedlist>
+ <para>Ant</para>
</listitem>
+ </itemizedlist></td>
+ <td valign="top"><programlisting language="xml"><itemizedlist>
+ <listitem>
+ <para>Bee</para>
+ </listitem>
+ <listitem>
+ <para>Ant</para>
+ </listitem>
+</itemizedlist></programlisting></td>
+
+ <td valign="top"><programlisting language="xml"><ul>
+ <li>
+ <p>Bee</p>
+ </li>
+ <li>
+ <p>Ant</p>
+ </li>
+</ul></programlisting></td>
+ </tr>
+ </informaltable>
+ </figure>
+
+ <figure xml:id="xmlc_fig_orderedList">
+ <title>Ordered list</title>
+
+ <informaltable border="1">
+ <tr>
+ <th>View</th>
+
+ <th>Docbook</th>
+
+ <th>HTML</th>
+ </tr>
+
+ <tr>
+ <td valign="top"><itemizedlist>
<listitem>
- <para><link
- xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm?cp=2_0_19_1_0_1">Standalone</link>
- or <link
- xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm?cp=2_0_19_1_0_2">centralized</link></para>
+ <para>Bee</para>
</listitem>
<listitem>
- <para><link
- xlink:href="http://www.wideskills.com/eclipse-plugin-tutorial/eclipse-plugin-help-tutorial">Plugin
- model</link>, Web App <link
- xlink:href="https://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_war.htm?cp=2_0_19_1_4">deployable</link></para>
+ <para>Ant</para>
</listitem>
</itemizedlist></td>
- <td><mediaobject>
- <imageobject>
- <imagedata fileref="Ref/DbookIntro/eclipseHelpScopeDefAnnot.svg"/>
- </imageobject>
- </mediaobject></td>
+ <td valign="top"><programlisting language="xml"><orderedlist>
+ <listitem>
+ <para>Bee</para>
+ </listitem>
+
+ <listitem>
+ <para>Ant</para>
+ </listitem>
+ </orderedlist></programlisting></td>
+
+ <td valign="top"><programlisting language="xml"><ol>
+ <li>
+ <p>Bee</p>
+ </li>
+ <li>
+ <p>Ant</p>
+ </li>
+</ol></programlisting></td>
</tr>
</informaltable>
</figure>
- </section>
- <section xml:id="xmlc_sect_targetPrint">
- <title>Printed output</title>
+ <figure xml:id="xmlc_fig_glossList">
+ <title>Glossary list</title>
- <figure xml:id="xmlc_fig_targetPrint">
- <title>Basics</title>
+ <informaltable border="1">
+ <tr>
+ <th>View</th>
- <itemizedlist>
- <listitem>
- <para>Focus on <link
- xlink:href="http://www.cafeconleche.org/books/bible3/chapters/ch16.html">Formatting
- Objects</link></para>
- </listitem>
+ <th>Docbook</th>
- <listitem>
- <para>Multiple formatting engines</para>
- </listitem>
+ <th>HTML</th>
+ </tr>
+
+ <tr>
+ <td valign="top"><glosslist>
+ <glossentry>
+ <glossterm>Bee</glossterm>
+
+ <glossdef>
+ <para>Insect</para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry>
+ <glossterm>Mouse</glossterm>
+
+ <glossdef>
+ <para>Mammal</para>
+ </glossdef>
+ </glossentry>
+ </glosslist></td>
+
+ <td valign="top"><programlisting language="xml"> <glosslist>
+ <glossentry>
+ <glossterm>Bee</glossterm>
+ <glossdef>
+ <para>Insect</para>
+ </glossdef>
+ </glossentry>
+ <glossentry>
+ <glossterm>Mouse</glossterm>
+ <glossdef>
+ <para>Mammal</para>
+ </glossdef>
+ </glossentry>
+ </glosslist></programlisting></td>
+
+ <td valign="top"><programlisting language="xml"><dl>
+ <dt>Bee</dt>
+ <dd>Insect</dd>
+ <dt>Mouse</dt>
+ <dd>Mammal</dd>
+</dl></programlisting></td>
+ </tr>
+ </informaltable>
+ </figure>
+
+ <figure xml:id="xmlc_fig_nestedLists">
+ <title>Nested lists</title>
+
+ <informaltable border="1">
+ <tr>
+ <th>View</th>
+
+ <th>Docbook</th>
+
+ <th>HTML</th>
+ </tr>
+
+ <tr>
+ <td valign="top"><orderedlist>
+ <listitem>
+ <para>Coffee</para>
+ </listitem>
+
+ <listitem>
+ <para>Tea</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>black</para>
+ </listitem>
- <listitem>
- <para>Multiple print formats</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>green</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist></td>
+
+ <td valign="top"><programlisting language="xml"><orderedlist>
+ <listitem>
+ <para>Coffee</para>
+ </listitem>
+ <listitem>
+ <para>Tea</para>
+ <itemizedlist>
+ <listitem>
+ <para>black</para>
+ </listitem>
+ <listitem>
+ <para>green</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist></programlisting></td>
+
+ <td valign="top"><programlisting language="xml"><ol>
+ <li>
+ <p>Coffee</p>
+ </li>
+ <li>
+ <p>Tea</p>
+ <ul>
+ <li>black</li>
+ <li>green</li>
+ </ul>
+ </li>
+</ol></programlisting></td>
+ </tr>
+ </informaltable>
</figure>
</section>
</chapter>
@@ -690,4 +1017,6 @@
<para/>
</chapter>
+
+ <xi:include href="../Doc/Common/glossary.xml" xpointer="element(/1)"/>
</book>
--
GitLab