28 lines
1.4 KiB
Plaintext
28 lines
1.4 KiB
Plaintext
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
|
||
|
|
<dita>
|
||
|
|
<topic id="topic_nb3_hrx_5db">
|
||
|
|
<title>Documentation Source Files</title>
|
||
|
|
<body>
|
||
|
|
<p>Unlike all other documentation in the GnuPG Project, including the initial version of
|
||
|
|
this HOWTO, this version was <i>not</i> written in Emacs Org-Mode. Nor was it written in
|
||
|
|
LaTeX, Texinfo or even directly in HTML. Instead it was written using the Darwin Information
|
||
|
|
Typing Architecture (DITA) XML.</p>
|
||
|
|
<p>This was done for two main reasons:</p>
|
||
|
|
<p>
|
||
|
|
<ol id="ol_k3b_wrx_5db">
|
||
|
|
<li>A bug in either Org-Mode or Babel prevented the more complex examples included in the
|
||
|
|
HOWTO from displaying correctly.</li>
|
||
|
|
<li>To demonstrate some of the advantages of DITA XML over existing documentation
|
||
|
|
productionsoftware used in the project (particularly Texinfo and LaTeX).</li>
|
||
|
|
</ol>
|
||
|
|
</p>
|
||
|
|
<p>The XML format definitely supports displaying all the more complex Python code correctly,
|
||
|
|
as well as being designed to produce standards compliant print and HTML output. Whereas
|
||
|
|
currently the existing tools utilised by the GnuPG Project can't display the example code in
|
||
|
|
a way which would actually pass the project's own git commit ruleset.</p>
|
||
|
|
<p> </p>
|
||
|
|
</body>
|
||
|
|
</topic>
|
||
|
|
</dita>
|