Tutorenanleitung

Anmerkung

Die Tutorenanleitung für Markdown befindet sich momentan noch in der Entstehung. Bitte haben Sie etwas Geduld.

Zielsetzung dieser Anleitung

Die vorliegende Anleitung soll studentischen Hilfskräften der Arbeitsgruppe Studium für Blinde und Sehbehinderte (AG SBS) als Richtlinie bei der Übertragung von Studienmaterialien in sehgeschädigtengerechte Form dienen. Studienmaterialien werden für blinde und sehbehinderte Studenten an der TU Dresden in ein barrierefreies HTML-Format übertragen. Die Übertragung erfolgt in der Regel durch Studenten des jeweiligen Studienfaches. Die Kenntnisse der Studenten bezüglich HTML und der Arbeitsweise sehgeschädigter Leser sind daher sehr verschieden. Motivation dieser Anleitung ist die Entstehung einheitlicher, fehlerfreier Dokumente trotz unterschiedlicher Vorkenntnisse. Es empfiehlt sich, diese Anleitung vor Beginn der Übertragungsarbeiten gründlich durchzuarbeiten. Während der Arbeit kann sie als Nachschlagewerk benutzt werden. Wichtigster Bestandteil dieser Anleitung sind die Regeln für die Gestaltung von elektronischen Dokumenten im HTML-Format. Dazu gehört die Aufbereitung von Texten, Bildern und ganzen Fachbüchern.Es werden außerdem Hinweise zum organisatorischen Ablauf der Tutorentätigkeit gegeben. Die in dieser Anleitung enthaltenen Regeln sind eine verbindliche Arbeitsgrundlage für die Gestaltung von sehgeschädigtengerechten Dokumenten an der TU Dresden. Sie müssen unbedingt eingehalten werden!

Bereitstellung von Studienmaterial an der TU Dresden

Die AG SBS unterstützt sehgeschädigte Studierende im integrativen Studium an der Technischen Universität Dresden. Eine wichtige Aktivität ist die Übertragung von Studienmaterialien wie Vorlesungsskripten, Lehrbriefen, Foliensammlungen, Aufgabensammlungen und Fachbüchern in eine sehgeschädigtengerechte Form. Diese Arbeit wird in der Regel von studentischen Hilfskräften (Tutoren) ausgeführt. Die von der AG SBS koordinierten Übertragungsarbeiten sind mit anderen Einrichtungen innerhalb des Bundesgebietes, die Texte sehgeschädigtengerecht auflesen, abgestimmt. Für einen breiteren Nutzerkreis interessante Texte, wie z.B. Fachbücher und Broschüren, werden SehKOn (Sehgeschädigtengerechter Katalog Online) an der Universität Dortmund registriert. Sie können von den sehgeschädigten Lesern per Fernleihe über die AG SBS bezogen werden. Bei den an der TU Dresden sehgeschädigtengerecht aufbereiteten Studienmaterialien handelt es sich ausschließlich um elektronische Dokumente. Tonkassetten werden nicht produziert. Die umgesetzten Studienmaterialien werden in das Elektronische Literaturverzeichnis und Informationssystem für blinde und sehbehinderte Studierende (ELVIS) der AG SBS eingestellt. Als Datenformat wird das HTML-Format verwendet, damit können die Dokumente mit allen gängigen elektronischen Hilfsmitteln, wie z.B. Braillezeilen, Sprachausgabe- und Großschriftsystemen gelesen werden. Von den Arbeitsplätzen der AG SBS kann per Rechnernetz auf den Datenbestand zugegriffen werden. Die Übertragung urheberrechtlich geschützter Veröffentlichungen ist durch eine Vereinbarung mit dem Inhaber des Copyrights abgesichert. Aus dieser Vereinbarung ergeben sich einschränkende Nutzungsbedingungen für die übertragenen Dokumente. Studenten und Tutoren werden über den Inhalt der Vereinbarung belehrt.

Wie lesen Blinde und Sehbehinderte?

Viele blinde Menschen nutzen heutzutage einen Screenreader, um sich elektronische Dokumente zugänglich zu machen. Screenreader dienen als Schnittstelle zwischen visueller Bildschirminformation und dem Leser. Anstelle der visuellen Informationen werden Daten akustisch (Sprachausgabegeräte) oder taktil (Brailleausgabe) dargeboten. Dabei können nicht nur Texte wiedergegeben werden, sondern auch Bild- und Layout-Informationen, wie zum Beispiel Menüs, Hyperlinks und andere Bedienelemente. Eine weitere Möglichkeit, visuelle Inhalte für blinde Menschen zugänglich zu gestalten, sind taktile Grafiken. Durch Ertasten der Struktur können blinde Menschen Abbildungen erfassen. Die Herstellung solcher Grafiken ist recht aufwändig. Besteht der wesentliche Informationsgehalt der Grafik jedoch in Formen und Strukturen, ist eine solche Aufbereitung jedoch von Vorteil für den Betrachter. Sehbehinderte Leser nutzen abhängig von Grad und Art ihrer Behinderung unterschiedliche Hilfsmittel, um sich elektronische Dokumente zugänglich zu machen. Dazu zählen Bildschirmlupen oder die Veränderung des Layouts per CSS. So können individuelle Probleme (z.B. eine zu kleine Schrift oder eine kontrastarme Darstellung) ausgeglichen werden. Menschen mit starker Sehbehinderung verwenden teilweise auch akustische und taktile Hilfsmittel, wie sie im oberen Abschnitt beschrieben sind. Es ist wichtig, dass Textauszeichnungen und Dokumentstrukturen dafür in einer für die Geräte lesbaren Form vorliegen. Um die Kompatibilität des HTML-Dokumentes mit diesen Hilfsmitteln zu gewährleisten, ist eine barrierefreie Gestaltung notwendig.

Anforderungen

Barrierefreiheit

"Barrierefrei sind bauliche und sonstige Anlagen, Verkehrsmittel, technische Gebrauchsgegenstände, Systeme der Informationsverarbeitung, akustische und visuelle Informationsquellen und Kommunikationseinrichtungen sowie andere gestaltete Lebensbereiche, wenn sie für behinderte Menschen in der allgemein üblichen Weise, ohne besondere Erschwernis und grundsätzlich ohne fremde Hilfe zugänglich und nutzbar sind." (Gesetz zur Gleichstellung behinderter Menschen, § 4 Barrierefreiheit)

Der Begriff der Barrierefreiheit zieht sich durch viele Gebiete des öffentlichen Lebens. Im Rahmen der Arbeit der AG SBS bezieht sich der Begriff auf die HTML-Dokumenten, welche auf Grundlage der Tutorenanleitung erstellt werden. Diese Dokumente müssen blinden und sehbehinderten Studenten in ihrem kompletten Umfang zugänglich sein. Barrierefreiheit kann hierbei durch die spezielle Aufbereitung der HTML-Dateien erreicht werden. Wichtig ist es dabei, dass Textauszeichnungen, wie z.B. Überschriften, auch nicht-visuell wahrgenommen werden können. Es muss also neben Schriftgröße und -stil andere Faktoren geben, an denen man eine Überschrift erkennt.

Zitierfähigkeit

Zitierfähig sind grundsätzlich alle Quellen, die beschaffbar bzw. zugänglich sind, d.h. von interessierten Dritten nachgeprüft werden können. Um Zitierfähigkeit auch in barrierefreien HTML-Reproduktionen von Fachliteratur zu gewährleisten, ist es wichtig, dass blinden und sehbehinderten Studenten dieselben Informationen zur Verfügung stehen, wie ihren sehenden Kommilitonen. Dies beinhaltet neben textuellen Inhalten auch die Beschreibung von Grafiken, Tabellen oder besonderen Formatierungen (Zitate, Info-Kästen, ...) ebenso wie beispielsweise die Integrität der Seitennummerierung.

Einführung in MarkDown

Empfohlene Software

Für die Bearbeitung werden folgende Programme benötigt:

• Matuc
• MikTex für die Formelgenerierung erforderlich

Folgende Programme werden empfohlen:

• PowerPoint AddIn für die schnelle Konvertierung von PowerPoint-Folien nach Markdown
• Editoren für die manuelle Bearbeitung/Erstellung von Markdown-Dateien
  • Sublime Text 3
    • die Installation das Package AGSBS Markdown Helper ist erforderlich
  • Atom
    • AGSBS Atom Package (nur interner Zugrifft derzeit, da in der Entwicklung)
• Browser zum Testen der generierten HTML-Dateien

Aufbau der Dokumente

Datei- und Verzeichnisstruktur

Unterteilung in Dateien und Dateigröße

Für das schnelle Auffinden von Informationen ist es günstig, wenn umfangreiche Studienmaterialien in mehrere Dateien untergliedert werden. Dabei dient die im Originaltext verwendete Gliederung als Orientierung. Relevante Textabschnitte können dann in Zusammenhang mit dem Inhaltsverzeichnis schnell gefunden werden. Eine Unterteilung in mehrere Dateien ist auch dann vorzunehmen, wenn es sich um einen umfangreicheren Fließtext ohne hervorgehobene Gliederungspunkte handelt. Generell sind aber sehr kleine Dateien, die nur wenige Zeilen Text enthalten, zu vermeiden.

Vergabe der Dateinamen

Die Vergabe der Dateinamen erfolgt nach einem einheitlichen Schema. Umlaute und Sonderzeichen dürfen für Dateinamen nicht verwendet werden. Alle Datei- und Verzeichnisnamen innerhalb eines Buches bzw. von Lehrmaterial müssen klein geschrieben werden. Das gilt natürlich auch für die Datei-Endungen.

Namenskonvention

Nachfolgend werden die einzelnen Dateien und deren Namen benannt und erklärt.

Dateiname	Erklärung
anhxx.md	Der Dateiname enthält die Nummerierung des Anhangs, wobei xx durch eine zweistellige Ziffer ersetzt werden muss. Ob der Anhang mit einer Ziffer oder einem Buchstabenpräfix nummeriert wird, hängt lediglich von einer Konfigurationsoption ab. Beispiel.: anh01.md, anh0302.md
blattxx.md	Dieses Verzeichnis ist zu verwenden, wenn die bearbeiteten Materialien keine Kapitel, sondern z.B. Übungsblätter oder wissenschaftliche Veröffentlichungen sind.
glossar.md	Wörterverzeichnis einschließlich vorhandener Erklärungen
index.md	Index (Schlagwortverzeichnis) des Dokumentes
info.md oder readme.md	Diese Datei beinhaltet wichtige und allgemeine Informationen zur Bearbeiteten Version, wie Beispielsweise Umsetzung Tabellen in Listenform oder ähnliche Anpassung zur Erleichterung der Lesbarkeit.
inhalt.md	Diese Datei wird automatisch generiert und heißt inhalt.md oder index.md, je nach voreingestellter Sprache. Zusätzlich ist der Vermerk zum genehmigten Copyright (siehe Anhang A) aufzunehmen.
kxx.md	Text, gegliedert nach nummerierten Kapiteln. Der Text sollte nach Möglichkeit so aufgeteilt werden, dass Gliederungspunkte immer vollständig in einer Datei enthalten sind. Der Dateiname wird vom ersten Gliederungspunkt in der Datei abgeleitet. Für jede Gliederungsebene sind unbedingt zwei Ziffern zu verwenden. x ist Platzhalter für eine Ziffer. Die Unterteilung in Unterkapitel ist optional und hängt von der Länge des Kapitels ab. Beispiel: Kapitel 1: k01.md, Kapitel 5.6: k0506.md
kurz.md	Diese Datei beinhaltet das Abkürzungsverzeichnis; diese Datei wird automatisch ins Inhaltsverzeichnis übernommen.
lit.md oder bib.md	Literaturverzeichnis oder Bibliographie
symbole.md	Referenzdatei der im Orginal verwendeten Symbole und Sonderzeichen. Diese Datei ist nur bei Texten mit vielen verschiedenen Sonderzeichen und math. Symbolen notwendig, insbesondere wenn der Autor den Zeichen eine spezielle Bedeutung zuweist. Diese Symbole-Datei enthält dann in taballarischer Form das graf. Bild des Symboles, seine Umsetzung in ASCII-Mathematikschrift, seine inhaltliche Bedeutung und zusätzlich eine Beschreibung des Aussehens des Symboles.
titel.md	Haupttitelseite und deren Rückseite mit allen darauf befindlichen Informationen. Das Copyrightzeichen ist durch das Wort Copyright zu ersetzen. Zusätzlich zum Original ist der Vermerk zum genehmigten Copyright (siehe Anhang A) aufzunehmen.
vxx.md	Diese Datei(en) beinhalten das Vorwort. In den meisten Fällen existiert nur ein Vorwort, es kann aber auch vorkommen, dass mehrere Kapitel unter dem Punkt Vorwort aufgeführt sind. Beispiel: Einfches Vorwort: v01.md, Gegliedertes Vorwort: v01.md, v02.md

Alle Dateien, welche eine Nummerierung beinhalten, müssen in ein separates Unterverzeichnis, welches nach der gleichen Bezeichnung und Hauptkapitelnummer benannt ist. Das gilt für Blätter, Kapitel, Anhänge und Vorwortkapitel. Zu beachten ist, dass mehrfach untergliederte Dateien trotzdem nur in ein Hauptverzeichnis gehören.

Beispiele:

• k01
  • k01.md
• k02
  • k0201.md
  • k0202.md
• anh01
  • anh01.md

ToDo: Was ist mit:

• beilagen.html steht, dass nicht in der readme.de
• loe.html

Umsetzung

In diesem Kapitel werden alle Fragen zur Umsetzung des Ausgangsmaterials nach Markdown behandelt. Einige der nachfolgenden Code-Beispiele wurden von Markdown-Referenz entnommen.

Allgemeines

Grundsätzlich soll der übertragene Text die Gestaltung der Vorlage so gut wie möglich wiedergeben. In einigen Punkten muss aber von diesem Grundsatz, zum Zwecke der besseren Lesbarkeit, aber auch aus den in Kapitel 3(Referenz überarbeiten) genannten Überlegungen heraus, abgewichen werden.

In der Auszeichnungssprache Markdown können auch HTML-Tags genutzt werden. Jedoch wird dies nicht empfohlen, wenn ein HTML-Tag erlaubt und genutzt werden soll, wird es in dieser Anleitung benannt.

Absätze und Zeilenumbrüche

Absätze werden in Markdown durch eine Leerzeile vor und hinter dem Absatztext abgegrenzt.

Das ist der 1. Absatz und wenn ein neuer Absatz eingefügt werden soll.

Wird einfach eine Zeile davor frei gelassen.

Zeilenumbrüchen werden mit dem Backslash oder
gekennzeichnet.

In dieser Zeile wird ein Zeilenumbruch \
mit einem Backslash erzwungen.

Es ist aber auch erlaubt mit <br />
die Zeile umzubrechen.

Überschriften

Für die Gliederung des Textes können Überschriften der Ebene 1 bis Ebene 6 verwendet werden. Jedes Verzeichnis wie z.B. kXX wird vom Konverter als Kapitel angesehen, daher darf es im gesamten Verzeichnis nur eine Überschrift der Ebene 1 geben. Ausnahme hierbei ist die Datei mit den Bildbeschreibungen (z.B. bilder.md oder images.md), da diese nur ausgelagerte Bildbeschreibungen enthält und nicht zum Kapitel gehört.

Überschriften der Ebene 1 und Ebene 2 können auf 2 Weisen ausgezeichnet werden.

Ansonsten gibt die Anzahl des Raute-Zeichen die Überschriftenebene an.

Wichtig - Vor und hinter der Überschriftenauszeichnung muss immer eine leere Zeile sein.

Erklärung	Auszeichung	Bemerkung
Überschriften Ebene 1	Das ist eine Überschrift Ebene 1 ======================= # Das ist eine Überschrift Ebene 1	Darf nur einmal in jedem Kapitel vorkommen
Überschrift Ebene 2	## Überschrift Ebene 2
Überschrift Ebene 3	### Überschrift Ebene 3
Überschrift Ebene 4	#### Überschrift Ebene 4
Überschrift Ebene 5	##### Überschrift Ebene 5
Überschrift Ebene 6	###### Überschrift Ebene 6

Überschriften werden vom Konverter automatisch nummeriert, deshalb ist es wichtig diese nicht mit in die Überschrift zu übernehmen und die Namenskonvention der Dateinamen einzuhalten.

Seitenzahlen

Seitenzahlen werden mit "||" eingeleitet und müssen das Format <Bezeichner> <Zahl> haben, wobei "Bezeichner" entweder "Seite, Folie, slide, page" ist. Jede Seitenzahl MUSS ein eigener Absatz sein. Beispiel:

Beispiel für eine Seite

|| - Seite 80 -

Beispiel für eine Folie

|| - Folie 80 -

Seitenzahlen werden u.a. genutzt, um die Navigationsleiste zu generieren.

Listen

Bei den Listen wird zwischen geordneten (nummerierten) und unsortierte (mittels Anstrichen) Listen unterschieden. Listen sind ein Blockelement und müssen daher von Leerzeilen umgeben sein.

Nummerierte Listen

Bei nummerierten Listen können arabische und römische Zahlen, sowie Buchstaben zur Numerrierung verwendet werden. Dabei muss auf das Aufzählungszeichen entweder ein Punkt folgen, eine runde Klammer oder das Aufzählungszeichen muss vollständig in runde Klammern eingeschlossen sein (siehe unten).

Unterbrochene Aufzählungen können forgesetzt werden, z.B. nach einem Seitenumbruch. Dafür beginnt man einfach mit der jeweiligen Nummer.

Beispiele

1.  Eier
2.  Mehl
3.  Kartoffel

I.  Cäsar
II.  Konstantin

(1) Beispiel
(2) Mehr Beispiel

a)  Brot
b)  Käse
(c) auch legitim

Unsortierte Listen

Unsortierte Listen können mit den Zeichen `+, *` oder `-` umgesetzt werden. Welches Zeichen verwendet wird, ist dabei dem Bearbeiter feigestellt.

Beispiele

-   Pizza
-   Döner

Weitere Aufzählung:

+   Schokolade
+   Kekse

Verschachtelte Listen

Wie alle Blockelemente, so können auch Listen verschachtelt werden. Hierbei ist zu beachten, dass eine Verschachtelte Liste um 4 Zeichen eingerückt werden muss. Ferner muss jede Liste wieder ein Absatz sein, wie im folgendne Beispiel illustriert. Nummerierte und geschachtelte Listen können frei ineinander verschachtelt werden, aber nur bis einer Tiefe von vier Ebenen.

Beispiel

Im folgenden Beispiel gehört der einführende Text noch zum Anstrich der Aufgabenstellung, die verschachtelte Aufzählung hingegen steht in ihrem eigenen Absatz.

1.  Aufgabe:
    Beschreiben Sie den Wissenserwerb im Internet.

    a)  Welche Vorteile bietet die unkomplizierte Verfügbarkeit der Informationen?
    b)  Welche Risiken bietet die Partizipation vieler Menschen, erörtern Sie:

        -   Objektivität der Informationen
        -   Validität der Information
2.  Aufgabe
    ...

Quellcode

In der Informatik müssen neben Standardtextformatierung auch Quellcode-Ausschnitt formatiert. In Markdown gibt es 2 Möglichkeiten für die Formatierung von Quellcode

Formatierung mittels Einrückungen

Quellcode-Beispiele müssen mit einem Tab oder 4 Leerzeichen eingerückt werden.

    # Mein erstes Python-Programm
    print("Hello World")

Umschließende Formatierung

Die Verwendung der Formatierung mit Einrückungen ist nicht immer gut geeignet. Es können auch Quellcode-Beispiele mit mindesten 3 oder mehr Tilden (~) ausgezeichnet werden. Es ist wichtig, dass der geöffnete Codeblock auch wieder geschlossen wird.

~~~~~~
# Mein erstes Python-Programm
print("Hello World")
~~~~~~

Wenn in dem Quellcode jedoch Tilden vorkommen, müssen die umschließenden Tildenreihen länger sein als die im Code enthaltenden Tilden.

~~~~~~~~~~~~~~~~
~~~~~~~~~~
Dieser Code enthält Tilden
~~~~~~~~~~
~~~~~~~~~~~~~~~~

Backslash-Maskierung

In Markdown sind einige Zeichen reserviert, um z.B. den Text zu formatieren, Listen zu kennzeichnen usw. Daher müssen diese Zeichen mit einem Backslash maskiert werden.

Um ein Zeichen zu maskieren, muss ein Backslash vor dem Zeichen eingefügt werden

*Das ist ein kursiver Text.*

\* Dieser  Text steht in Sternchen.\*  

Die folgenden Zeichen müssen maskiert werden

$ Dollarzeichen
\   Backslash
`   Backtick
*   Sternchen
_   Unterstrich
{}  Geschweifte Klammern
[]  Eckige Klammern
()  Runde Klammern
#   Raute
+   Plus-Zeichen
-   Minus-Zeichen (Bindestrich)
.   Punkt
!   Ausrufezeichen