blog/archive/2023/11/11.rss

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <rss version='2.0' xmlns:lj='http://www.livejournal.org/rss/lj/1.0/'>
   3         <channel>
   4                 <title>Petter Reinholdtsen - Entries from November 2023</title>
   5                 <description>Entries from November 2023</description>
   6                 <link>https://people.skolelinux.org/pere/blog/</link>
   7
   8
   9         <item>
  10                 <title>Test framework for DocBook processors / formatters</title>
  11                 <link>https://people.skolelinux.org/pere/blog/Test_framework_for_DocBook_processors___formatters.html</link>
  12                 <guid isPermaLink="true">https://people.skolelinux.org/pere/blog/Test_framework_for_DocBook_processors___formatters.html</guid>
  13                 <pubDate>Sun, 5 Nov 2023 13:00:00 +0100</pubDate>
  14                 <description>&lt;p&gt;All the books I have published so far has been using
  15 &lt;a href=&quot;https://docbook.org/&quot;&gt;DocBook&lt;/a&gt; somewhere in the process.
  16 For the first book, the source format was DocBook, while for every
  17 later book it was an intermediate format used as the stepping stone to
  18 be able to present the same manuscript in several formats, on paper,
  19 as ebook in ePub format, as a HTML page and as a PDF file either for
  20 paper production or for Internet consumption.  This is made possible
  21 with a wide variety of free software tools with DocBook support in
  22 Debian.  The source format of later books have been docx via rst,
  23 Markdown, Filemaker and Asciidoc, and for all of these I was able to
  24 generate a suitable DocBook file for further processing using pandoc,
  25 a2x and asciidoctor, as well as rendering using
  26 &lt;a href=&quot;https://tracker.debian.org/pkg/xmlto&quot;&gt;xmlto&lt;/a&gt;,
  27 &lt;a href=&quot;https://tracker.debian.org/pkg/dbtoepub&quot;&gt;dbtoepub&lt;/a&gt;,
  28 &lt;a href=&quot;https://tracker.debian.org/pkg/dblatex&quot;&gt;dblatex&lt;/a&gt;,
  29 &lt;a href=&quot;https://tracker.debian.org/pkg/dblatex&quot;&gt;docbook-xsl&lt;/a&gt; and
  30 &lt;a href=&quot;https://tracker.debian.org/pkg/fop&quot;&gt;fop&lt;/a&gt;.&lt;/p&gt;
  31
  32 &lt;p&gt;Most of the books I have published are translated books, with
  33 English as the source language.  The use of
  34 &lt;a href=&quot;https://tracker.debian.org/pkg/po4a&quot;&gt;po4a&lt;/a&gt; to
  35 handle translations using the gettext PO format has been a blessing,
  36 but publishing translated books had triggered the need to ensure the
  37 DocBook tools handle relevant languages correctly.  For every new
  38 language I have published, I had to submit patches dblatex, dbtoepub
  39 and docbook-xsl fixing incorrect language and country specific issues
  40 in the framework themselves.  Typically this has been missing keywords
  41 like &#39;figure&#39; or sort ordering of index entries.  After a while it
  42 became tiresome to only discover issues like this by accident, and I
  43 decided to write a DocBook &quot;test framework&quot; exercising various
  44 features of DocBook and allowing me to see all features exercised for
  45 a given language.  It consist of a set of DocBook files, a version 4
  46 book, a version 5 book, a v4 book set, a v4 selection of problematic
  47 tables, one v4 testing sidefloat and finally one v4 testing a book of
  48 articles.  The DocBook files are accompanied with a set of build rules
  49 for building PDF using dblatex and docbook-xsl/fop, HTML using xmlto
  50 or docbook-xsl and epub using dbtoepub.  The result is a set of files
  51 visualizing footnotes, indexes, table of content list, figures,
  52 formulas and other DocBook features, allowing for a quick review on
  53 the completeness of the given locale settings.  To build with a
  54 different language setting, all one need to do is edit the lang= value
  55 in the .xml file to pick a different ISO 639 code value and run
  56 &#39;make&#39;.&lt;/p&gt;
  57
  58 &lt;p&gt;The &lt;a href=&quot;https://codeberg.org/pere/docbook-example/&quot;&gt;test framework
  59 source code&lt;/a&gt; is available from Codeberg, and a generated set of
  60 presentations of the various examples is available as Codeberg static
  61 web pages at
  62 &lt;a href=&quot;https://pere.codeberg.page/docbook-example/&quot;&gt;https://pere.codeberg.page/docbook-example/&lt;/a&gt;.
  63 Using this test framework I have been able to discover and report
  64 several bugs and missing features in various tools, and got a lot of
  65 them fixed.  For example I got Northern Sami keywoards added to both
  66 docbook-xsl and dblatex, fixed several typos in Norwegian bokmål and
  67 Norwegian Nynorsk, support for non-ascii title IDs added to pandoc,
  68 Norwegian index sorting support fixed in xindy and initial Norwegian
  69 Bokmål support added to dblatex.  Some issues still remains, though.
  70 Default index sorting rules are still broken in several tools, so the
  71 Norwegian letters æ, ø and å are more often than not sorted properly
  72 in the book index.&lt;/p&gt;
  73
  74 &lt;p&gt;The test framework recently received some more polish, as part of
  75 publishing my latest book.  This book contained a lot of fairly
  76 complex tables, which exposed bugs in some of the tools.  This made me
  77 add a new test file with various tables, as well as spend some time to
  78 brush up the build rules.  My goal is for the test framework to
  79 exercise all DocBook features to make it easier to see which features
  80 work with different processors, and hopefully get them all to support
  81 the full set of DocBook features.  Feel free to send patches to extend
  82 the test set, and test it with your favorite DocBook processor.
  83 Please visit these two URLs to learn more:&lt;/p&gt;
  84
  85 &lt;ul&gt;
  86 &lt;li&gt;&lt;a href=&quot;https://codeberg.org/pere/docbook-example/&quot;&gt;https://codeberg.org/pere/docbook-example/&lt;/a&gt;&lt;/li&gt;
  87 &lt;li&gt;&lt;a href=&quot;https://pere.codeberg.page/docbook-example/&quot;&gt;https://pere.codeberg.page/docbook-example/&lt;/a&gt;&lt;/li&gt;
  88 &lt;/ul&gt;
  89
  90 &lt;p&gt;If you want to learn more on Docbook and translations, I recommend
  91 having a look at the &lt;a href=&quot;https://docbook.org/&quot;&gt;the DocBook
  92 web site&lt;/a&gt;,
  93 &lt;a href=&quot;https://doccookbook.sourceforge.net/html/en/&quot;&gt;the DoCookBook
  94 site&lt;a/&gt; and my earlier blog post on
  95 &lt;a href=&quot;https://people.skolelinux.org/pere/blog/From_English_wiki_to_translated_PDF_and_epub_via_Docbook.html&quot;&gt;how
  96 the Skolelinux project process and translate documentation&lt;/a&gt;.&lt;/p&gt;
  97
  98 &lt;!--
  99
 100 https://github.com/docbook/xslt10-stylesheets/issues/205 (docbook-xsl: sme support)
 101 https://bugs.debian.org/968437 (xindy: index sorting rules for nb/nn)
 102 https://bugs.debian.org/856123 (pandoc: markdown to docbook with non-english titles)
 103 https://bugs.debian.org/864813 (dblatex: missing nb words)
 104 https://bugs.debian.org/756386 (dblatex: index sorting rules for nb/nn)
 105 https://bugs.debian.org/796871 (dbtoepub: index sorting rules for nb/nn)
 106 https://bugs.debian.org/792616 (dblatex: PDF metadata)
 107 https://bugs.debian.org/686908 (docbook-xsl: index sorting rules for nb/nn)
 108 https://sourceforge.net/tracker/?func=detail&amp;atid=373747&amp;aid=3556630&amp;group_id=21935 (docbook-xsl: nb/nn support)
 109 https://bugs.debian.org/684391 (dblatex: initial nb support)
 110
 111 --&gt;
 112
 113 &lt;p&gt;As usual, if you use Bitcoin and want to show your support of my
 114 activities, please send Bitcoin donations to my address
 115 &lt;b&gt;&lt;a href=&quot;bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b&quot;&gt;15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b&lt;/a&gt;&lt;/b&gt;.&lt;/p&gt;
 116 </description>
 117         </item>
 118
 119         </channel>
 120 </rss>