Dateienstruktur bei der AGSBS: Unterschied zwischen den Versionen

Aus ELVIS-Wiki
Zur Navigation springenZur Suche springen
(→‎Vierte Ebene - Bearbeitungsstruktur: Einleitung, Kapitelordner verfasst)
(→‎Lecture Meta Data: Text verfasst)
Zeile 63: Zeile 63:


==== Lecture Meta Data ====
==== Lecture Meta Data ====
Die Metadatei (<code>.lecture_meta_data.dcxml</code>) ist eine von Matuc generierte und für Matuc notwendige Datei, welche die Daten für die Bearbeitung und zur Quelle bereithält. Bei der Konvertierung werden diese Daten genutzt, um sie als Metadaten der HTML-Datei anzulegen oder aus ihr Bedingungen für die Art und Weise der Bearbeitung abzuleiten.
Die Datei kann dabei direkt über die Eingabeaufforderungen per Matuc, über [[Atom-AGSBS-Package|Atom]] oder mit dem PowerPoint-Plugin erzeugt werden. Alle erforderlichen Daten können mit einem Editor jederzeit nachträglich manuell bearbeitet werden.
* '''<code>MAGSBS:sourceAuthor</code>''': Angabe über Autoren der Quelle (z.b. Buchautor, Dozent der Lehrveranstaltung oder Herausgeber)
* '''<code>dc:source</code>''': Angabe zur Art der Quelle (z.B. Präsentation des Lehrstuhls für Mensch-Computer-Interaktion, Handbuch)
* '''<code>dc:publisher</code>''': Angabe zum Verlag bzw. zur Institution, bei der die Quelle veröffentlicht wurde (z.B. Springer, TU Dresden)
* '''<code>dc:format</code>''': Angabe zum Format der vorliegenden Quelldatei
* '''<code>dc:contributor</code>''': Angabe zum Bereitsteller des barrierefreien Dokuments (Voreinstellung: AGSBS)
* '''<code>MAGSBS:tocDepth</code>''': Angabe zur Tiefe des von Matuc generierten Inhaltsverzeichnis; wird aus den Überschriften innerhalb der Kapiteldokumente heraus gelesen (Voreinstellung: 5)
* '''<code>MAGSBS:pageNumberingGap</code>''': Angabe zum Abstand der Seitenlinks an der Ober- und Unterseite jedes Kapiteldokuments, die durch Matuc generiert werden (Voreinstellung: 5)
* '''<code>dc:rights</code>''': Angabe zur Lizenz der Benutzung (Voreinstellung: Access limited to members)
* '''<code>dc:creator</code>''': Angabe zum Bearbeiter; Name wird automatisch vom Benutzernamen des Computers ausgelesen
* '''<code>MAGSBS:generateToc</code>''': (Voreinstellung: 1)
* '''<code>dc:date</code>''': Angabe zum Jahr der Veröffentlichung der Quelle (z.b. 1990, WS 2017/18)
* '''<code>dc:title</code>''': Angabe zum Titel der Literatur bzw. zur Veranstaltung
* '''<code>dc:language</code>''': Angabe zur Sprache der Quelle (''de'' für Deutsch, ''eng'' für Englisch)
* '''<code>MAGSBS:appendixPrefix</code>''': (Voreinstellung: 0)
* '''<code>MAGSBS:version</code>''': Angabe zur gegenwärtigen Matuc-Version, während der Bearbeitung (Stand März 2018: Matuc 0.7)


==== Inhaltsdateien ====
==== Inhaltsdateien ====

Version vom 20. März 2018, 20:26 Uhr

Einer der Grundpfeiler der Arbeitsgruppe Studium für Blinde und Sehbehinderte ist die Übertragung von Literatur und Vorlesungsmaterialien wie Präsentationsfolien oder Übungsblättern in ein digitales, barrierefreies Format. Aus diesem Grunde nutzt die AGSBS die Auszeichnungssprache Markdown und (La)TeX sowie das Konvertierungsprogramm Matuc oder das PowerPoint-Plugin, um daraus barrierefreies HTML zu gewinnen. Das Zusammenspiel dieser Absichten, Formate und Programme entwickelte über die Jahre bei der AGSBS eine komplexe Ordnerstruktur, die Übersichtlichkeit für den Bearbeiter und erleichterte Navigation für die Leserschaft sowohl für Bücher, als auch andere Studienmaterialien, erleichtern sollen.

Ordnerhierarchie der AGSBS

Die Hierarchie der Ordner und Dateien bei der Übertragung von einem Format in das von der AGSBS genutzte Format verläuft insgesamt über vier bis sechs Ebenen. Deren Anzahl ist von den jeweiligen Voraussetzungen der Quelle abhängig.

Ordner und Dateien folgen dabei mehr oder weniger zwingenden Namenskonventionen, die von den notwendigen Programmen gelesen und für die Konvertierung benötigt werden.

Erste Ebene - Oberordner

Screenshot des Projektordners in Atom
Struktur 01 Oberordner.jpg

Der oberste Ordner dient der Zuordnung der jeweiligen Inhalte. Dabei wird aktuell unterschieden zwischen Büchern und Lehrveranstaltungen (Paper bzw. Essays sollen folgen), denen im Verwaltungssystem der AGSBS bei korrekter Einordnung ein spezieller Wert zugeordnet wird.

  • Buchprojekt
    • Die Namenskonvention eines Oberordners für Fachliteratur folgt dabei der ID, die das Redmine einem Bucheintrag zuweist, dem Nachnamen des Autors bzw. Herausgebers sowie dem Titel des Buches. Die ID besteht dabei aus der Ziffer für das jeweilige Buch im Gesamtkatalog der AGSBS seit Einführung des Verwaltungssystems (z.B. B-255) sowie dem Veröffentlichungsjahr der jeweils vorliegenden Auflage.
  • Lehrveranstaltungsprojekt
    • Die Namenskonvention eines Oberordners für Lehrveranstaltungen folgt dabei der ID, die das Redmine den Lehrmitteln zuweist, sowie dem Namen der jeweiligen Veranstaltung. Eine Unterscheidung zwischen Vorlesung, Seminar und Übung erfolgt erst später bzw. nicht. Die ID besteht dabei aus der Ziffer für die jeweilige Lehrveranstaltung im Gesamtkatalog der AGSBS seit Einführung des Verwaltungssystems (z.B. L-122) sowie dem Jahr des jeweiligen Semesters.

Zweite Ebene - Bearbeitung und Quellen

Screenshot des Projektordners in Atom
Struktur 02 Bearbeitung-Quellen.jpg

In der zweiten Ebene gibt es lediglich zwei Ordner. Der Ordner bearbeitet beinhaltet das gesamte übertragene Dokument sowie alle Medien- und sonstigen Dateien, die für das barrierefreie Dokument notwendig sind. Im Ordner quellen wiederum befinden sich alle Dateien, die der Übertragung vorangehen bzw. aus der Quellmaterialvorbereitung stammen.

Dritte Ebene - Vorlesung und Übung

Screenshot des Projektordners in Atom
Struktur 03 Vorlesung-Übung.jpg

Die dritte Ebene ist ein Sonderfall innerhalb des Bearbeitungsordners, der vorwiegend bei Lehrveranstaltungen Verwendung findet. Die Ordner in dieser Ebene weisen die Dokumente der jeweiligen Lehrveranstaltung den unterschiedlichen Einheiten der Veranstaltung zu. Dies trifft in den meisten Fällen auf Vorlesungen (hier werden auch Seminare mit Dauerpräsentationen dazu gezählt) sowie Übungen zu. Die gesamte Bearbeitung der jeweiligen Dokumente findet in diesen einzelnen Ordnern statt. Es bietet sich in einem solchen Fall an, dass der Quellordner dieselbe Unterteilung aufweist, um auf diese Weise die Übersicht und Zuordnung zu verbessern.

Vierte Ebene - Bearbeitungsstruktur

Screenshot des Projektordners in Atom
Struktur 04 Bearbeitungsstruktur.jpg

Innerhalb der vierten Ebene findet die eigentliche Bearbeitung statt. Dabei spiegelt die Struktur dieser letzten Endes bearbeiteten Dokumente bei Büchern das Inhaltsverzeichnis und bei Lehrveranstaltungen den angedachten Semesterplan wieder. In den Ordnern Vorlesung und Übung befinden sich die jeweiligen Ordner der Kapitel bzw. Übungsblätter, eine Lecture-Meta-Datei sowie das von Matuc generierte Inhaltsverzeichnis dieser jeweiligen Bearbeitung.

Kapitelordner

Die Ordner für die einzelnen Abschnitte des vorliegenden Quellmaterials werden in Anlehnung an das Wort "Kapitel" mit k sowie der nachfolgenden, zweistelligen Rangfolgenziffer benannt. Dasselbe gilt für Anhänge (anh) eines Werkes sowie im Falle von Übungsblättern mit dem Präfix blatt. Letzteres wird allerdings seltener genutzt. Das Vorwort (v01) kann ebenfalls mehrere Abschnitte aufweisen, dies ist in der Regel allerdings nicht der Fall. Die Einschränkung auf einen Bereich von 100 maximal möglichen Kapiteln (oder Anhängen) ist aus der praxisorientierten Erfahrung der AGSBS erwachsen - sicherlich kann es Werke geben, die über weitaus mehr Kapitel verfügen.

  • Kapitel: k00, k01, k02, ..., k{..}
  • Vorwort: v01
  • Anhang: anh00, anh01, anh02, ..., anh{..}
  • Blatt: blatt01, blatt 02, ..., blatt{..}


Lecture Meta Data

Die Metadatei (.lecture_meta_data.dcxml) ist eine von Matuc generierte und für Matuc notwendige Datei, welche die Daten für die Bearbeitung und zur Quelle bereithält. Bei der Konvertierung werden diese Daten genutzt, um sie als Metadaten der HTML-Datei anzulegen oder aus ihr Bedingungen für die Art und Weise der Bearbeitung abzuleiten.

Die Datei kann dabei direkt über die Eingabeaufforderungen per Matuc, über Atom oder mit dem PowerPoint-Plugin erzeugt werden. Alle erforderlichen Daten können mit einem Editor jederzeit nachträglich manuell bearbeitet werden.

  • MAGSBS:sourceAuthor: Angabe über Autoren der Quelle (z.b. Buchautor, Dozent der Lehrveranstaltung oder Herausgeber)
  • dc:source: Angabe zur Art der Quelle (z.B. Präsentation des Lehrstuhls für Mensch-Computer-Interaktion, Handbuch)
  • dc:publisher: Angabe zum Verlag bzw. zur Institution, bei der die Quelle veröffentlicht wurde (z.B. Springer, TU Dresden)
  • dc:format: Angabe zum Format der vorliegenden Quelldatei
  • dc:contributor: Angabe zum Bereitsteller des barrierefreien Dokuments (Voreinstellung: AGSBS)
  • MAGSBS:tocDepth: Angabe zur Tiefe des von Matuc generierten Inhaltsverzeichnis; wird aus den Überschriften innerhalb der Kapiteldokumente heraus gelesen (Voreinstellung: 5)
  • MAGSBS:pageNumberingGap: Angabe zum Abstand der Seitenlinks an der Ober- und Unterseite jedes Kapiteldokuments, die durch Matuc generiert werden (Voreinstellung: 5)
  • dc:rights: Angabe zur Lizenz der Benutzung (Voreinstellung: Access limited to members)
  • dc:creator: Angabe zum Bearbeiter; Name wird automatisch vom Benutzernamen des Computers ausgelesen
  • MAGSBS:generateToc: (Voreinstellung: 1)
  • dc:date: Angabe zum Jahr der Veröffentlichung der Quelle (z.b. 1990, WS 2017/18)
  • dc:title: Angabe zum Titel der Literatur bzw. zur Veranstaltung
  • dc:language: Angabe zur Sprache der Quelle (de für Deutsch, eng für Englisch)
  • MAGSBS:appendixPrefix: (Voreinstellung: 0)
  • MAGSBS:version: Angabe zur gegenwärtigen Matuc-Version, während der Bearbeitung (Stand März 2018: Matuc 0.7)

Inhaltsdateien

Fünfte Ebene - Im Kapitelordner

Screenshot des Projektordners in Atom
Struktur 05 Kapitelordner.jpg

Dokumentendatei

Bildbeschreibungsdatei

Bilderordner

Screenshot des Projektordners in Atom
Struktur 06 Bilderordner.jpg