Skip to content
Snippets Groups Projects
Commit ba9cf068 authored by Goik Martin's avatar Goik Martin
Browse files

Tech. Doc. project ideas

parent b90193e8
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 164 additions and 83 deletions
Doc/Tdoc/projects.xml
+ 164
− 83
View file @ ba9cf068
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
<chapter version="5.1" xml:id="tdoc_chap_projects" <chapter version="5.1" xml:id="tdoc_chap_projects"
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" 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:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns="http://docbook.org/ns/transclusion" xmlns:ns="http://docbook.org/ns/transclusion"
...@@ -10,89 +11,84 @@ ...@@ -10,89 +11,84 @@
xmlns:db="http://docbook.org/ns/docbook"> xmlns:db="http://docbook.org/ns/docbook">
<title>Possible projects</title> <title>Possible projects</title>
<glosslist> <section xml:id="sdi_sect_projectBiBTeX">
<glossentry> <title>Representing and editing <acronym>BiBTeX</acronym> data</title>
<glossterm><xref linkend="glo_DITA"/> based lecture notes</glossterm>
<figure xml:id="sdi_fig_exampleBibtexData">
<glossdef> <title>Example BiBTeX data</title>
<para>The promising <xref linkend="glo_DITA"/> standard allows for
<link <programlisting language="tex">@inproceedings{ah2006,
xlink:href="https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture#Topic_orientation">topic author={Aggarwal, Gagan and Hartline, Jason D.},
oriented</link> documents.</para> year={2006},
title={Knapsack auctions},
<para>Current lecture notes are <link booktitle={Proceedings of the 17th Annual ACM-SIAM
xlink:href="https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures/tree/master/Doc">being Symposium on Discrete Algorithms},
represented</link> as <xref linkend="glo_Docbook"/> in a pages={1083-1092},
<quote>linear</quote> fashion. Employing DITA requires:</para> publisher={Association for Computing Machinery},
address={New York}
<itemizedlist> }</programlisting>
<listitem> </figure>
<para>Identify sample topics.</para>
</listitem> <figure xml:id="sdi_fig_BibtexData_tasks">
<title>Tasks</title>
<listitem>
<para>Identify topic relationships for building maps.</para> <itemizedlist>
</listitem> <listitem>
<para>Database schema design (Relational, NoSQL)</para>
<listitem> </listitem>
<para>Customizing target format generators (<xref
linkend="glo_HTML"/>, <xref linkend="glo_PDF"/>, ...).</para> <listitem>
</listitem> <para>Import / export</para>
</itemizedlist> </listitem>
<para>The current lecture notes content may serve as a starting point <listitem>
for creating appropriate assets. Other content may be used as well: <para>Web based editor</para>
The project's goal is providing a self-consistent prototype.</para> </listitem>
<para>Both <xref linkend="glo_XMLMind"/> and <xref <listitem>
linkend="glo_OxygenXml"/> support <xref linkend="glo_DITA"/> documents <para>Multi user / multiple databases support.</para>
and related topic maps in particular.</para> </listitem>
</glossdef> </itemizedlist>
</glossentry> </figure>
</section>
<glossentry>
<glossterm>Assembly based lecture notes</glossterm> <section xml:id="sdi_sect_projectCodingbat">
<title><productname
<glossdef> xlink:href="https://codingbat.com">Codingbat</productname>
<para>This suggestion is related to the latter. Starting from <link reloaded</title>
xlink:href="https://tdg.docbook.org/tdg/5.1">DocBook version
5.1</link> support for <link <figure xml:id="sdi_fig_codingBatFeatures">
xlink:href="https://tdg.docbook.org/tdg/5.2/ch06.html">assemblies</link> <title>Desired features</title>
is being provided. These are another means addressing topic oriented
content creation.</para> <itemizedlist>
<listitem>
<para><xref linkend="glo_XMLMind"/> and <xref <para>Multiple language support: SQL, XML Schema, Java OO</para>
linkend="glo_OxygenXml"/> provide assembly support.</para> </listitem>
</glossdef>
</glossentry> <listitem>
<para>Author interface</para>
<glossentry> </listitem>
<glossterm>Enhanced Maven/Gradle archetype</glossterm> </itemizedlist>
</figure>
<glossdef> </section>
<para>Deriving targets from <link
xlink:href="https://tdg.docbook.org/tdg/5.1">DocBook</link> content <section xml:id="sdi_sect_projectExerciseCompilation">
may be effected by using appropriate <link <title>XML based exercise compilations</title>
xlink:href="https://mvnrepository.com/artifact/org.docbook">Maven
archetypes</link>.</para> <figure xml:id="sdi_fig_exerciseCompilationDesiredFeatures">
<title>Desired features</title>
<para>While these archetypes provide a good build automation they fall
short when transformations require preprocessing of images with <itemizedlist>
respect to a given target format.</para> <listitem>
<para>Exercise definitions</para>
<para>Example: An author may provide a PDF image by virtue of <tag </listitem>
class="starttag">imagedata fileref="image.pdf"</tag>. Generated <xref
linkend="glo_HTML"/> or <xref linkend="glo_EPUB"/> targets will <listitem>
require a transformation to e.g. <xref linkend="glo_SVG"/> or <xref <para>Possibly animated solution presentation</para>
linkend="glo_PNG"/>.</para> </listitem>
</itemizedlist>
<para>Likewise embedded video assets may also require type </figure>
transformations for <link </section>
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"> <section xml:id="tdoc_chap_pastProjects">
<title>Past projects</title> <title>Past projects</title>
...@@ -116,5 +112,90 @@ ...@@ -116,5 +112,90 @@
dedicated XML document schema.</para> dedicated XML document schema.</para>
</listitem> </listitem>
</orderedlist> </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> </section>
</chapter> </chapter>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment