diff --git a/Doc/Common/glossary.xml b/Doc/Common/glossary.xml index 754a80055d4dc7f4535f5e174a7408f24fa977c5..a4a27fb1bf08ad8ea0e9f8beafee455ebc7c1299 100644 --- a/Doc/Common/glossary.xml +++ b/Doc/Common/glossary.xml @@ -95,6 +95,16 @@ </glossdef> </glossentry> + <glossentry xml:id="glo_DITA"> + <glossterm><acronym>DITA</acronym></glossterm> + + <glossdef> + <para><link + xlink:href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita">Darwin + Information Typing Architecture </link></para> + </glossdef> + </glossentry> + <glossentry xml:id="glo_DNS"> <glossterm><acronym>DNS</acronym></glossterm> diff --git a/Doc/Tdoc/projects.xml b/Doc/Tdoc/projects.xml index 84c5bff721147a4b57b8f8b4dca8e5d2d56fba97..418680b019c437a4d1853dfb0f9ff9f4d221fd5b 100644 --- a/Doc/Tdoc/projects.xml +++ b/Doc/Tdoc/projects.xml @@ -1,36 +1,120 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter version="5.1" xml:id="tdocChapProjects" +<chapter version="5.1" xml:id="tdoc_chap_projects" xmlns="http://docbook.org/ns/docbook" 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"> <title>Possible projects</title> - <orderedlist> - <listitem> - <para>Supporting multilingual documents and translations.</para> - </listitem> - - <listitem> - <para>Exporting and post processing HdM course data.</para> - </listitem> - - <listitem> - <para>Displaying version differences related to revisions of a given - document.</para> - </listitem> - - <listitem> - <para>Build process implementation supporting image / video - entities.</para> - </listitem> - - <listitem> - <para>Implementing end user editor support and style sheets for a - dedicated XML document schema.</para> - </listitem> - </orderedlist> + <glosslist> + <glossentry> + <glossterm><xref linkend="glo_DITA"/> based lecture notes</glossterm> + + <glossdef> + <para>The promising <xref linkend="glo_DITA"/> standard allows for + <link + xlink:href="https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture#Topic_orientation">topic + oriented</link> documents.</para> + + <para>Current lecture notes are <link + xlink:href="https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures/tree/master/Doc">being + represented</link> as <xref linkend="glo_Docbook"/> in a + <quote>linear</quote> fashion. Employing DITA requires:</para> + + <itemizedlist> + <listitem> + <para>Identify sample topics.</para> + </listitem> + + <listitem> + <para>Identify topic relationships for building maps.</para> + </listitem> + + <listitem> + <para>Customizing target format generators (<xref + linkend="glo_HTML"/>, <xref linkend="glo_PDF"/>, ...).</para> + </listitem> + </itemizedlist> + + <para>The current lecture notes content may serve as a starting point + for creating appropriate assets. Other content may be used as well: + The project's goal is providing a self-consistent prototype.</para> + + <para>Both <xref linkend="glo_XMLMind"/> and <xref + linkend="glo_OxygenXml"/> support <xref linkend="glo_DITA"/> documents + and related topic maps in particular.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Assembly based lecture notes</glossterm> + + <glossdef> + <para>This suggestion is related to the latter. Starting from <link + xlink:href="https://tdg.docbook.org/tdg/5.1">DocBook version + 5.1</link> support for <link + xlink:href="https://tdg.docbook.org/tdg/5.2/ch06.html">assemblies</link> + is being provided. These are another means addressing topic oriented + content creation.</para> + + <para><xref linkend="glo_XMLMind"/> and <xref + linkend="glo_OxygenXml"/> provide assembly support.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Enhanced Maven/Gradle archetype</glossterm> + + <glossdef> + <para>Deriving targets from <link + xlink:href="https://tdg.docbook.org/tdg/5.1">DocBook</link> content + may be effected by using appropriate <link + xlink:href="https://mvnrepository.com/artifact/org.docbook">Maven + archetypes</link>.</para> + + <para>While these archetypes provide a good build automation they fall + short when transformations require preprocessing of images with + respect to a given target format.</para> + + <para>Example: An author may provide a PDF image by virtue of <tag + class="starttag">imagedata fileref="image.pdf"</tag>. Generated <xref + linkend="glo_HTML"/> or <xref linkend="glo_EPUB"/> targets will + require a transformation to e.g. <xref linkend="glo_SVG"/> or <xref + linkend="glo_PNG"/>.</para> + + <para>Likewise embedded video assets may also require type + transformations for <link + xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats">supporting + different browsers</link>.</para> + </glossdef> + </glossentry> + </glosslist> + + <section xml:id="tdoc_chap_pastProjects"> + <title>Past projects</title> + + <orderedlist> + <listitem> + <para>Supporting multilingual documents and translations.</para> + </listitem> + + <listitem> + <para>Exporting and post processing HdM course data.</para> + </listitem> + + <listitem> + <para>Displaying version differences related to revisions of a given + document.</para> + </listitem> + + <listitem> + <para>Implementing end user editor support and style sheets for a + dedicated XML document schema.</para> + </listitem> + </orderedlist> + </section> </chapter>