Writerside HowTo and Best Practice
Hier befinden sich wichtige Informationen zum Umgang und Start mit Writerside im Rahmen des Adler-Projekts.
Bitte beachtet die Best-Practice-Bereiche:
Writerside Topic anlegen
In Writerside können zwei Dateiarten als Topics angelegt werden: XML und Markdown.md. Genaueres zu Writerside Topics
Beim Anlegen eines neuen Topics muss ein Topic Title und ein Topic Filename angegeben werden.
Der Topic Title ist eine beliebig zu wählende Bezeichnung.
Der Topic Filename muss eine Writerside weite ID sein. Die Eindeutigkeit wird auch von Writerside überprüft.
Speziell für die Vergabe einer Anforderungs-ID beachtet bitte: Writerside ID-Vergabe für Anforderungen
Writerside Topic umbenennen
Writerside Topic löschen
Nützliches zu Auszeichnungssprachen
Templates
Template anlegen: Aus jedem Writerside-Topic kann ein Template angelegt werden. Siehe Topic als Template.
Wie wird ein Template lokal erstellt: Rechts-Klick auf das Topic im table of contents anschließend wie folgt:
Template verwenden: Klicke mit rechter Maustaste an die Position in den table of contents an der ein neues Template erstellt werden soll und dann:
Tabellen
In Writerside können verschiedene Arten von Tabellen verwendet werden: Writerside Tabellen
Glossar Eintrag anlegen
Klicke mit rechter Maustaste an die Position in den table of contents an der ein neuer Glossareintrag erstellt werden soll und dann:
Richtlinien zum Anlegen von Glossareinträgen:
Je Glossareintrag muss ein eigenes Writerside Topic erstellt werden!
Zur Erstellung muss ein Glossar Template verwendet werden!
Das Glossar muss primär aus Einträgen bestehen die sich wie folgt zusammensetzten:
Begriff
Englischer Begriff
Definition
Die Definition des Glossareintrags muss ca. 1-3 Sätze lang sein.
Siehe auch
Akronym
Erlaubte Alternativbenennung
Verbotene Terminologie
Quelle
Die folgenden Beschreibungen müssen angegeben werden: Begriff, englischer Begriff und Definition.
Alle Topics unterhalb des Topics Glossar müssen Glossareinträge sein! Einzige Ausnahme sind die Topics die für die alphabetische Strukturierung verwendet werden.
Die Glossareinträge müssen alphabetisch sortiert werden!
Semantische Unterordner dürfen nicht erstellt werden!
Z.B. muss primitives Lernelement zu "P" und darf nicht zusammen mit Lernelement bei "L" abgelegt werden.
Weiterführende Erklärungen der Begriffe bitte auf eigene Dokumentationsseiten auslagern.
Die ausgelagerten Dokumentationsseiten dürfen gerne mit dem Glossar verlinkt werden.
Bilder
Links in Writerside
Wichtige Shortcuts:
Generelles zu Shortcuts in Writerside.
Neu formatieren: STRG + ALT + L