Quelltext der Seite Eigenheiten und Probleme in der Auszeichnungssprache der AGSBS

Die Auszeichnungssprache [[Markdown - Eine Übersicht|Markdown]] eignet sich aufgrund seiner simplen Syntax sehr gut, um Personen ohne großes Wissen über die Werkzeuge digitaler Dokument- und Texterstellung an das Thema heranzuführen. Doch im Vergleich zu HTML sind die Möglichkeiten von Markdown begrenzt und auch die Konvertierung durch das von der [[Arbeitsgruppe Studium für Blinde und Sehbehinderte|AGSBS]] zur Verfügung gestellte Programm [[Matuc]] führt zu dem ein oder anderen Problem.

== Seitenzahlen ==

Die Angabe von Seitenzahlen ist aus zwei Gründen von großer Bedeutung: 

# Unterstützung der Navigation und Orientierung 
# [[Ziel und Anforderung der Bearbeitung#Zitierfähigkeit|Zitierfähigkeit]]

Seitenzahlen werden bei der AGSBS an den Anfang einer Seite gestellt - auch wenn auf der Quelldatei eventuell keine Seitenzahl direkt vermerkt ist. Damit weiß der Leser, dass alle nachfolgenden Inhalte einer Seitenzahl sich in der Quelldatei auf eben dieser Seite befinden.

Markdown besitzt keine Auszeichnung für Seitenzahlen innerhalb eines Dokuments, weil es in der Auszeichnungssprache nicht notwendig ist, diese gesondert hervorzuheben. Die Dateienstruktur der AGSBS sowie das Konvertierungsprogramm benötigen allerdings eine gesonderte Auszeichnung, damit die Navigation erleichtert wird. Diese Auszeichnung erfolgt mit Binde- und vertikalen Strichen: 

:<pre>|| - Seite x -</pre>

Diese Auszeichnung benötigt ihre eigene Zeile im Markdown-Dokument und muss auch ober- sowie unterhalb jeweils von einer Leerzeile umrahmt werden. Nur dann erkennt Matuc die Seitenzahlen und kann diese für die Referenzierung nutzen. Alternativ können auch die Begriffe <code>Folie</code> bei Präsentationsmaterial sowie <code>page</code> und <code>slide</code> (Äquivalente in englischer Sprache), sowie römische Ziffern verwendet werden.

Zusätzlich ist es möglich eine Reihe von Seiten zu referenzieren, z.B. <code>|| - Seite 17-22 -</code>. Dies ist vor allem dann hilfreich, wenn sich die betreffenden Seiten nach und nach aufbauen und dabei Inhalte stetig wiederholt werden würden. In einem solchen Fall bietet es sich an, wenn man innerhalb dieser Seitenmenge den Wechsel von Seite zur Seite mit einer Anmerkung erwähnt.

== HTML-Ausnahmen in der Auszeichnungssprache der AGSBS ==

Der Kreativität einiger Autoren, Lehrkräfte und Designer sind wahrlich keine Grenzen gesetzt. So gibt es diverse grafische Objekte in Fachbüchern und Lehrmaterialien, die sich nicht mithilfe von LaTeX beschreiben lassen oder deren [[Bildbeschreibungen|Bildbeschreibung]] unter Umständen unverhältnismäßig lang werden würden. Um solche Sonderfälle so nachvollziehbar wie möglich für die Leserschaft zu gestalten, nutzt die AGSBS in den Markdown-Dokumenten vereinzelte Ausnahmen, die mit HMTL beschrieben werden sollen.

=== Anmerkungen des Bearbeiters ===

Bei der Arbeit mit den unterschiedlichsten Fachmaterialien kann es immer wieder vorkommen, dass ein Bearbeiter auf ein Problem stößt, was sich mit den herkömmlichen Mitteln nicht lösen lässt. Für solche Fälle ist es dem Bearbeiter möglich, eine '''Anmerkung''' hinzuzufügen. 

Eine solche Anmerkung wird anhand eines '''div'''-Bereichs in das Markdown-Dokument eingetragen. In diesen Bereich, der im HTML-Dokument mit einem schwarzen Rahmen dargestellt wird, schreibt der Bearbeiter das hinein, was ihm bei der korrekten Darstellung des vorliegenden Quellmaterials behilfreich ist. Im HTML-Dokument wird zudem vor dem geschriebenen Text der Abschnitt "Anmerkung des Bearbeiters:" automatisch hinzugefügt. Die Leserschaft weiß auf diese Weise, dass sich der Text innerhalb dieser Anmerkung nicht im Originaldokument befindet und aus diesem Grunde nicht zitierfähig ist.

In den meisten Fällen sind Anmerkungen von der jeweiligen Quelldatei abhängig und die Entscheidung liegt beim Bearbeiter, ob eine Anmerkung in diesem individuellen Fall notwendig ist oder nicht. Doch es gibt vereinzelte Fälle, wo eine Anmerkung direkt empfohlen wird oder sogar notwendig ist:

* '''Darstellung einer leeren Seite oder fehlender Inhalte'''
** Besitzt das Quellmaterial leere Seiten oder sind deutliche Einschnitte in den Inhalten erkennbar, sollte eine Anmerkung verwendet werden, um der Leserschaft auf den Zustand der Quelle an dieser Stelle zu verweisen. Um die Zitierfähigkeit zu gewährleisten, ist es für Studierende wichtig zu wissen, ob sie der vorliegenden Bearbeitung in ihrer Gesamtheit vertrauen können. Dies trifft auch zu, wenn ein Fließtext plötzlich unterbrochen wird und die ergänzenden Abschnitte nicht in der Quelldatei vorhanden sind.
* '''Fehlerhafte Darstellung wegen Problemen beim Quellmaterial'''
** Unter Umständen kann es vorkommen, dass die Qualität des Quellmaterials, welches der AGSBS zur Verfügung gestellt wird, zu wünschen übrig lässt. Dies ist vor allem bei regulären Scans oftmals der Fall. Dann kann es durchaus vorkommen, dass Texte oder einzelne Elemente für den Bearbeiter ebenfalls nicht korrekt erkennbar sind. Auch hier sollte eine Anmerkung hinzugefügt werden, um die Studierenden über den Missstand ihrer Lehrmaterialien aufzuklären.


{| class="wikitable"
! Markdown-Beispiel
! Darstellung nach Konvertierung
|-
|<pre><div class="annotation">Leere Seite</div></pre> 
| [[Datei:Beispiel_Anmerkung.jpg‎‎]]
|}

Eine Anmerkung sollte allerdings keine Bildbeschreibung ersetzen und Interpretationen beinhaltet. Kurz und knapp sollte eine Anmerkung die wichtigsten Informationen übermitteln, für die der Bearbeiter die jeweilige Anmerkung als notwendig erachtet.

=== Textboxen und -rahmen ===

Ein häufig wiederkehrendes Element in Fachliteratur und Vorlesungsmaterialien ist die grafische Hervorhebung eines bestimmten Bereichs. Damit werden Informationen, seien sie in Textform oder anderer Darstellungart, vom Fließtext abgetrennt. Diese Darstellung tritt häufig bei Exkursen oder Definitionen auf, allerdings zeigt die Übertragungspraxis, dass den Ideen diesbezüglich keine Grenzen gesetzt sind.

Ähnlich wie bei Anmerkungen werden diese Textboxen und Textrahmen anhand von '''div'''-Bereichen markiert. Dabei ist es mit dem '''class'''-Tag ''box'' oder ''frame'' gefolgt von einer Farbe möglich, die wichtigsten Informationen für Studierende mit Sehbehinderung zusammenzufassen. Ein zusätzlicher '''span'''-Bereich gewährt dem Bereich zudem eine Überschrift. 

{| class="wikitable"
! Markdown-Beispiel
! Darstellung nach Konvertierung
|-
|<pre><div class="box red">
<span class="title">Definition</span>
Textboxen sind Bereiche, die mit der jeweiligen Farbe unterlegt sind.

</div>

\

<div class="frame grey">
Textrahmen sind umschließende Bereiche, deren Rahmenfarbe angegeben ist.
</div></pre> 
| [[Datei:Beispiel_Boxen-Rahmen.jpg‎‎‎]]
|}

Innerhalb der Bereiche sind alle Elemente möglich, die Markdown unterstützt, selbst weitere farbige Rahmen und Boxen. Eine Mischform aus beiden Elementen ist allerdings derzeit nicht möglich, in einem solchen Fall ist es empfohlen, den Bereich als Box zu markieren.

Textrahmen werden dabei in HTML simpel mit einem zusätzlichen Rahmen in der gewählten Farbe dargestellt, sowie Textabschnitten für den Anfang und das Ende des jeweiligen Bereiches. Textboxen hingegen, deren Äquivalent im Quellmaterial durch einen farbigen Hintergrund definiert sind, werden mit einem gestrichelten Rahmen in der gewählten Farbe dargestellt. Weil Studierende mit Sehbehinderungen unter Umständen durch Kontraste und Farben die Informationen aus solchen Boxen nicht lesen können, wird hier von der Originalgetreuheit des Dokumentes bewusst abgewichen. Die schwarze Schrift auf weißem Grund in der HTML-Ansicht stellt in einem solchen Fall die beste Lesemöglichkeit dar.

Bei der Auswahl der Farben muss man in Zusammenarbeit mit Matuc bedenken, dass derzeit nur englische Begriffe verwendet werden können. Aktuell implementierte Farben für Textboxen und -rahmen sind:

* Rot (''red'')
* Schwarz (''black'')
* Grün (''green'')
* Gelb (''yellow'')
* Orange (''orange'')
* Blau (''blue'')
* Braun (''brown'')
* Grau (''grey'')
* Violet (''violet'')

== Bisher ungelöste Problematiken ==

Die Benutzung von Markdown auf Seiten der Bearbeiter sowie den unterschiedlichsten Möglichkeiten und Grenzen assistiver Technologien auf Seiten der Leserschaft wirft allerdings auch Probleme auf, für die es zum gegenwärtigen Zeitpunkt keine Lösung gibt bzw. an deren Lösung derzeit noch gearbeitet wird.

=== Formatierte und Farbige Schriften ===

Grundsätzlich sind Texte in Büchern und auf Vorlesungsmaterialien meist in schwarzer Schrift auf weißem Grund verfasst. Sollen dann vereinzelte Worte oder Abschnitte betont werden, werden zumeist [[Markdown - Eine Übersicht#Textformatierung|Fett- und Kursivmarkierungen]] genutzt. Viele Screenreader sind allerdings nicht in der Lage, unterstrichenen Text (könnte in Markdown eh nicht dargestellt werden) oder durchgestrichenen Text anzuzeigen. Genauso sieht es mit farbigen Textelementen aus. Farbige Schrift wird nicht als solche erkannt und lediglich als "normaler" Text dargestellt. Dies könnte unter Umständen für einen Studierenden mit Sehbehinderung zur Folge haben, dass er betonte Begriffe nicht in deren Wichtigkeit für den Absatz einordnen kann.

Der Bearbeiter muss aus diesem Grund den Kompromiss eingehen und die Schrift - sofern es möglich ist - an diesen Stellen '''fett markieren'''. Kursive Markierung kann unter Umständen Studierenden mit Sehbehinderungen nicht ordentlich gelesen werden, da die Schrift optisch stärker verfälscht wird.

Dasselbe Phänomen trott bei Schriftgrößen auf. Hiermit werden allerdings seltener Informationen oder Bedeutungen mit übermittelt, weswegen es ausreicht den Text in Markdown blank so zu schreiben, wie er vorliegt. 

=== Tabellen mit verbundenen Zellen ===

Sehr häufig werden Tabellen genutzt, um Informationen übersichtlich, geordnet oder im Kontrast zueinander darzustellen. Die AGSBS nutzt in Markdown sogenannte [[Markdown - Eine Übersicht#Tabellen|Grid Tables]], weil sich mit dieser Form der Tabellenauszeichnung ein Großteil der bekannten Formalia nutzen lassen (z.B. Listen oder Bilder in einzelnen Zellen der Tabelle). 

Die Auszeichnungssprache Markdown unterstützt allerdings sogenannte "colspan" und "rowspan" Attribute nicht, d.h. über Zeilen und/oder Spalten verbundene Zellen können nicht korrekt dargestellt werden. In der Theorie unterstützt Markdown das Einbinden von Tabellen im HTML-Format, allerdings können gesonderte HTML-Auszeichnungen, die nicht in die Ausnahmen hinzugefügt wurden, Probleme bei der Konvertierung mit Matuc verursachen. HTML-Tabellen wiederum sind unter Umständen zu komplex, um sie als Ausnahme bei Matuc einzuplanen.

--[[Benutzer:SRitter|SRitter]] ([[Benutzer Diskussion:SRitter|Diskussion]]) 11:02, 15. Mär. 2018 (CET)