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 @@
<chapter 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"
......@@ -10,89 +11,84 @@
xmlns:db="http://docbook.org/ns/docbook">
<title>Possible projects</title>
<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="sdi_sect_projectBiBTeX">
<title>Representing and editing <acronym>BiBTeX</acronym> data</title>
<figure xml:id="sdi_fig_exampleBibtexData">
<title>Example BiBTeX data</title>
<programlisting language="tex">@inproceedings{ah2006,
author={Aggarwal, Gagan and Hartline, Jason D.},
year={2006},
title={Knapsack auctions},
booktitle={Proceedings of the 17th Annual ACM-SIAM
Symposium on Discrete Algorithms},
pages={1083-1092},
publisher={Association for Computing Machinery},
address={New York}
}</programlisting>
</figure>
<figure xml:id="sdi_fig_BibtexData_tasks">
<title>Tasks</title>
<itemizedlist>
<listitem>
<para>Database schema design (Relational, NoSQL)</para>
</listitem>
<listitem>
<para>Import / export</para>
</listitem>
<listitem>
<para>Web based editor</para>
</listitem>
<listitem>
<para>Multi user / multiple databases support.</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>Desired features</title>
<itemizedlist>
<listitem>
<para>Multiple language support: SQL, XML Schema, Java OO</para>
</listitem>
<listitem>
<para>Author 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</para>
</listitem>
<listitem>
<para>Possibly animated solution presentation</para>
</listitem>
</itemizedlist>
</figure>
</section>
<section xml:id="tdoc_chap_pastProjects">
<title>Past projects</title>
......@@ -116,5 +112,90 @@
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>
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