projects.xml

<?xml version="1.0" encoding="UTF-8"?>
<chapter annotations="slide" version="5.1" xml:id="tdoc_chap_projects"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xila="http://www.w3.org/2001/XInclude/local-attributes"
         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>Project proposals</title>

  <section xml:id="sdi_sect_projectRevealFramework">
    <title><productname>Authoring reveal.js
    presentations</productname></title>

    <figure xml:id="sdi_sect_projectRevealPrinciple">
      <title>reveal.js authoring tools: Principle</title>

      <itemizedlist>
        <listitem>
          <para>The <link xlink:href="https://revealjs.com">reveal.js</link>
          framework allows for web based presentations</para>
        </listitem>

        <listitem>
          <para>Based on HTML 5 + JavaScript</para>
        </listitem>
      </itemizedlist>
    </figure>

    <figure xml:id="sdi_sect_projectRevealFeatures1">
      <title>reveal.js features #1 of 3</title>

      <itemizedlist>
        <listitem>
          <para>Customizable transitions</para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/2">Vertical
          slides</link></para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/4">Code
          highlighting</link> using <link
          xlink:href="https://highlightjs.org">highlight.js</link></para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/5/0/0">Code
          animations</link></para>
        </listitem>
      </itemizedlist>
    </figure>

    <figure xml:id="sdi_sect_projectRevealFeatures2">
      <title>reveal.js features #2 of 3</title>

      <itemizedlist>
        <listitem>
          <para><link xlink:href="https://revealjs.com/#/6">Overview slide
          sets</link></para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/7">Auto
          animations</link> across slides</para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/10">Touch
          support</link></para>
        </listitem>

        <listitem>
          <para><link
          xlink:href="https://revealjs.com/#/13/1">Fragments</link></para>
        </listitem>

        <listitem>
          <para>Configurable <link
          xlink:href="https://revealjs.com/#/transitions">slide
          transitions</link></para>
        </listitem>
      </itemizedlist>
    </figure>

    <figure xml:id="sdi_sect_projectRevealFeatures3">
      <title>reveal.js features #3 of 3</title>

      <itemizedlist>
        <listitem>
          <para><link xlink:href="https://revealjs.com/#/15">Configurable
          backgrounds</link> and transitions</para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/25">PDF
          handouts</link> (Do you really need those??)</para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/#/27">Custom
          events</link> supporting own extensions</para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://revealjs.com/markdown">Markdown
          support</link></para>
        </listitem>

        <listitem>
          <para><link xlink:href="https://www.mathjax.org">Mathjax</link>
          based <link xlink:href="https://revealjs.com/math">math
          support</link></para>
        </listitem>
      </itemizedlist>
    </figure>

    <figure xml:id="sdi_sect_projectRevealObservations">
      <title>reveal.js observations</title>

      <itemizedlist>
        <listitem>
          <para>Low level HTML / JavaScript editing</para>
        </listitem>

        <listitem>
          <para>Unsuitable for non-programmers</para>
        </listitem>

        <listitem>
          <para>Alternative: <link xlink:href="https://slides.com/">Slides
          editor</link> (commercial)</para>
        </listitem>
      </itemizedlist>
    </figure>

    <figure xml:id="sdi_sect_projectRevealGoals">
      <title>Authoring tool project goals</title>

      <itemizedlist>
        <listitem>
          <para>Creating an editor providing a restricted feature set</para>
        </listitem>

        <listitem>
          <para>Easy to use</para>
        </listitem>

        <listitem>
          <para>Support for images, animations, source code and math.</para>
        </listitem>

        <listitem>
          <para>Configurable by profiles</para>
        </listitem>
      </itemizedlist>
    </figure>
  </section>

  <section xml:id="sdi_sect_projectDocbookPages">
    <title><productname>Gitlab</productname> pages integration of
    <productname>Docbook</productname></title>

    <figure xml:id="sdi_sect_projectDocbookPagesPrinciple">
      <title>Principle</title>

      <itemizedlist>
        <listitem>
          <para>XSLT based transformation <productname>docbook
          </productname>to <productname>webhelp</productname>.</para>
        </listitem>

        <listitem>
          <para>Abstraction by using docker</para>
        </listitem>

        <listitem>
          <para>Publishing to <productname>gitlab</productname> pages on
          release / tag events.</para>
        </listitem>
      </itemizedlist>
    </figure>
  </section>

  <section xml:id="sdi_sect_projectCodingbat">
    <title><productname
    xlink:href="https://codingbat.com">Codingbat</productname>
    reloaded</title>

    <figure xml:id="sdi_fig_codingBatFeatures">
      <title><productname>Codingbat</productname>: Desired features</title>

      <itemizedlist>
        <listitem>
          <para>Training exercises providing automated feedback</para>
        </listitem>

        <listitem>
          <para>Multiple language support: <xref linkend="glo_SQL"/>, XML
          Schema, <xref linkend="glo_Java"/> <acronym>OO</acronym>, ...</para>
        </listitem>

        <listitem>
          <para>Target language independent authoring interface</para>
        </listitem>
      </itemizedlist>
    </figure>
  </section>

  <section xml:id="sdi_sect_projectExerciseCompilation">
    <title>XML based exercise compilations</title>

    <figure xml:id="sdi_fig_exerciseCompilationDesiredFeatures">
      <title>Desired features</title>

      <itemizedlist>
        <listitem>
          <para>Exercise definitions for E-learning contexts.</para>
        </listitem>

        <listitem>
          <para>Reusable asset definitions.</para>
        </listitem>

        <listitem>
          <para>Animated presentation of solutions.</para>
        </listitem>

        <listitem>
          <para>Step by step explanations</para>
        </listitem>
      </itemizedlist>
    </figure>
  </section>

  <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>

    <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>
</chapter>