Hinweise für unsere Autoren

Transkript

1 Open Source Press Hinweise für unsere Autoren Open Source Press

2 Alle in diesem Buch enthaltenen Programme, Darstellungen und Informationen wurden nach bestem Wissen erstellt. Dennoch sind Fehler nicht ganz auszuschließen. Aus diesem Grunde sind die in dem vorliegenden Buch enthaltenen Informationen mit keiner Verpflichtung oder Garantie irgendeiner Art verbunden. Autor(en), Herausgeber, Übersetzer und Verlag übernehmen infolgedessen keine Verantwortung und werden keine daraus folgende Haftung übernehmen, die auf irgendeine Art aus der Benutzung dieser Informationen oder Teilen davon entsteht, auch nicht für die Verletzung von Patentrechten, die daraus resultieren können. Ebensowenig übernehmen Autor(en) und Verlag die Gewähr dafür, dass die beschriebenen Verfahren usw. frei von Schutzrechten Dritter sind. Die in diesem Werk wiedergegebenen Gebrauchsnamen, Handelsnamen, Warenbezeichnungen usw. werden ohne Gewährleistung der freien Verwendbarkeit benutzt und können auch ohne besondere Kennzeichnung eingetragene Marken oder Warenzeichen sein und als solche den gesetzlichen Bestimmungen unterliegen. Dieses Werk ist urheberrechtlich geschützt. Alle Rechte, auch die der Übersetzung, des Nachdrucks und der Vervielfältigung des Buches oder Teilen daraus vorbehalten. Kein Teil des Werkes darf ohne schriftliche Genehmigung des Verlags in irgendeiner Form (Druck, Fotokopie, Mikrofilm oder einem anderen Verfahren), auch nicht für Zwecke der Unterrichtsgestaltung, reproduziert oder unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt oder verbreitet werden. Bibliografische Information der Deutschen Nationalbibliothek Die Deutsche Nationalbibliothek verzeichnet diese Publikation in der Deutschen Nationalbibliografie; detaillierte bibliografische Daten sind im Internet über abrufbar. Copyright 2015 Open Source Press GmbH Satz: textovia web application ( ISBN: 000 (gedruckte Ausgabe)

3 Inhaltsverzeichnis Liebe Autorinnen und Autoren! 7 1 Einführung 9 I Die Web-Applikation 13 2 Editor Aufbau des Editor-Moduls Navigation Projektstruktur Projektstruktur bearbeiten Kommunikator Chat Bearbeitungsbereich Aufbau Toolbar Konfliktvermeidung Live-Vorschau & Kommentare Live-Vorschau Kommentare Texteingabe und Markup Grundregeln Überschriften

4 Inhaltsverzeichnis 3.3 Fließtext Inline-Elemente Hervorhebungen URLs Adressen Maschinenschrift/Code Anführungszeichen Gedankenstrich Tasten Menüs Block-Elemente Listen Abbildungen Tabellen Hinweisblöcke Zitate Fußnoten Indexeinträge Querverweise Code-Listings Wenn etwas fehlt Fehler und Fehlersuche Strukturprüfung Fehler in der Projektstruktur Fehler bei Überschriften Fehler bei Querverweisen II Der OSP Build Service 55 5 Das Web-Interface 57 4

5 Inhaltsverzeichnis 6 Das Command Line Interface (CLI) Installation Nutzung III Sprache und Stil 65 7 Wie sage ich s am besten? 67 Index 71 5

6

7 Liebe Autorinnen und Autoren! Wir freuen uns, dass Sie gemeinsam mit uns ein Buch veröffentlichen möchten! Dieses Handbuch dient Ihnen als Einstieg in die Manuskriptarbeit und erste Anlaufstelle bei technischen Fragen. Wir bemühen uns, Ihre Fragen und Anregungen unmittelbar einfließen zu lassen, um Unklarheiten möglichst erst gar nicht aufkommen zu lassen. Wenn die Erläuterungen hier nicht weiterhelfen, stehen wir Ihnen natürlich auch gerne direkt zur Verfügung. Noch ein sprachlicher Hinweis: Allein aus Gründen der besseren Lesbarkeit verwenden wir meist die maskulinen Formen für alle Akteurinnen und Akteure ( Autor, Benutzer, Administrator etc.). Wir bitten für die Entscheidung, im Kontext eines Handbuchs Sprachfluss vor Geschlechtersensibilität zu stellen, um Verständnis und möchten betonen, dass wir uns dieses Dilemmas bewusst sind. Viel Spaß beim Publizieren! Ihr Team von Open Source Press 7

8

9 1 Kapitel Einführung Die Bücher von Open Source Press entstehen in einem von uns eigens entwickelten Publishing-System namens textovia, das Sie auf verschiedene Weise und mehr oder weniger intensiv nutzen können. Wichtig ist jedoch, dass zuletzt das gesamte Manuskript von textovia verarbeitet und für die sehr unterschiedlichen Veröffentlichungsformate von Print- PDF bis EPUB aufbereitet wird. Das textovia-system stellt u.a. folgende Services bereit: Versionskontrolle Texte und Abbildungen des Manuskripts liegen auf unserem Server und werden dort fortlaufend revisioniert, so dass bei Bedarf auch frühere Fassungen wiederhergestellt werden können. Jede Änderung wird auf diese Weise protokolliert. 9

10 1 Einführung Backup Mit unserer regelmäßigen Datensicherung haben Sie eine Sorge weniger. Build-System Der Server wandelt das Manuskript, das nach unseren Markup-Vorgaben ausgezeichnet wurde (siehe Kapitel 3), in die gewünschten Ausgabeformate um (PDF für den Druck, EPUB, MOBI, HTML, ). Web-Applikation Die Web-Anwendung, die Sie in jedem gängigen Browser (Firefox, IE, Safari, Chrome, ) unter jedem gängigen Betriebssystem (Linux, Windows, Mac OS X) nutzen können, stellt sämtliche Funktionen in einer ansprechenden Oberfläche zur Verfügung. Darüber hinaus verfügt sie über einen Editor der die korrekte Auszeichnung der Manuskripte deutlich vereinfacht. Mit integriertem Chat-Modul, Kommentarfunktion und vielen weiteren Features unterstützt er moderne, kollaborative Textarbeit in Echtzeit, z.b. auch durch Zugriffssteuerung so dass nur derjenige eine Datei bearbeiten kann, der sie als erster geöffnet hat; für alle anderen Beteiligten am Projekt ist sie in diesem Moment zwar lesbar, aber schreibgeschützt. Die Arbeitsweisen, Arbeitsumgebungen und Tools unserer Autoren sind allerdings sehr verschieden; dem tragen wir dadurch Rechnung, dass Sie textovia in unterschiedlichem Maße und zu unterschiedlichen Phasen der Manuskriptarbeit in Ihre Prozesse integrieren. Grundsätzlich gibt es zwei Varianten, wie Sie mit textovia arbeiten (Abbildung 1.1): Variante A (Web-Applikation) Sie nutzen sämtliche Features der modernen Benutzeroberfläche; die gesamte Textarbeit erfolgt online im Webbrowser. Variante B (OSP Build Service) Sie erstellen die Texte in Ihrer eigenen, gewohnten Arbeitsumgebung, übertragen die Ergebnisse in das Versionskontrollsystem und nutzen den OSP Build Service nur, um sich vom aktuellen Stand eine PDFoder HTML-Version generieren zu lassen. 10

11 Abbildung 1.1: Wie nutzen Sie textovia? Die folgende Tabelle zeigt noch einmal einige Kriterien, anhand derer Sie entscheiden, wie Sie textovia nutzen möchten. Funktion Variante A Variante B Versionskontrolle x x Backup x x Editor x Zugriffssteuerung x Internetverbindung permanent bei Bedarf Eigene Text-Tools x Bevor Sie mit dem Schreiben beginnen oder Ihre Texte für die Veröffentlichung bearbeiten, sollten Sie mit uns die Nutzung von textovia abstimmen. Gerne finden wir gemeinsam in einigen Tests heraus, welche Arbeitsweise Ihnen am besten entgegenkommt. TIPP Im Folgenden beschreiben wir die beiden oben genannten Ansätze separat. Sie können also zunächst nur die Variante lesen, für die Sie sich entschieden haben. Da Sie aber auch zwischen beiden Varianten wechseln 11

12 1 Einführung können, sei Ihnen bei Gelegenheit die Lektüre unserer gesamten Dokumentation empfohlen. WICHTIG Ihr Manuskript muss in jedem Fall den in Kapitel 3 beschriebenen Vorgaben zum Markup folgen! 12

13 Teil I Die Web-Applikation

14

15 2 Kapitel Editor Der Editor ist sicher das textovia-modul, mit dem Sie am intensivsten in Berührung kommen, denn hier geschieht nicht nur die eigentliche Textarbeit; hier finden Sie auch die Funktionen zur Kommunikation, sei diese flüchtig, wie im Chat (Abschnitt 2.3.1), oder umfangreich und später noch nachvollziehbar, wie bei Kommentaren (Abschnitt 2.5.2). 15

16 2 Editor 2.1 Aufbau des Editor-Moduls Haben Sie sich mit Ihren Zugangsdaten am System angemeldet, landen Sie automatisch im Editor-Fenster Benutzer in anderen Rollen wählen im Dashboard das Modul über den entsprechenden Button. 1 Abbildung 2.1: Der leere Editor nach dem Login Das zunächst recht spartanisch anmutende Fenster ist (grob) dreigeteilt: Navigation Über ein Drop-Down-Menü (oben links) haben Sie Zugriff auf die Projekte, die Ihnen vom Projektverantwortlichen oder vom Verlag zugewiesen wurden. Abbildung 2.2: Projektauswahl in der Navigation Kommunikator Er ist die Anlaufstelle für die Echtzeit-Kommunikation mit anderen Projektbeteiligten in What s App -Manier. Bearbeitungsbereich Solange Sie noch kein Projekt ausgewählt und keine Datei zur Bearbeitung geöffnet haben, ist der mittlere Fensterbereich leer. Sobald Sie 1 textovia kennt verschiedene Benutzerrollen mit unterschiedlichen Berechtigungen. Als Autor, Korrektor oder Übersetzer steht Ihnen zunächst, wie hier beschrieben, nur das Editor-Modul zur Verfügung. 16

17 2.2 Navigation aber ein Projekt in der Navigation auswählen und anschließend einen Text mit einfachem Mausklick öffnen, erscheint nicht nur dieser in der Bildschirmmitte zur Bearbeitung, sondern am rechten Fensterrand ein weiterer Bereich: Live-Vorschau & Kommentare Über zwei Reiter haben Sie Zugriff auf die gleichnamigen Funktionen, nämlich die HTML-Ansicht des geöffneten Textes oder die zu einzelnen Absätzen hinterlegten Kommentare. Die Bereiche sind durch breitere, graue Streifen voneinander getrennt. Indem Sie mit der Maus darauf stehenbleiben, verwandelt sich der Mauszeiger in einen beidseitigen Pfeil; halten Sie dann die linke Maustaste gedrückt, können Sie den Rand verschieben und damit die Größenverhältnisse der anliegenden Bereiche ändern. Über den kleinen grauen Pfeil in der Ecke oben rechts blenden Sie den jeweiligen Bereich vollständig aus und machen ihn mit einem erneuten Klick wieder sichtbar. TIPP 2.2 Navigation Über das Drop-Down-Menü Projekt wählen Sie über einen Kurztitel ein Projekt aus, das für Sie zur Bearbeitung freigegeben ist. In einer Browser-Session können Sie übrigens immer nur ein Projekt öffnen, nicht mehrere gleichzeitig. Haben Sie Zugriffsrechte für mehrere Projekte, eines geöffnet und möchten nun ein anderes bearbeiten, wählen Sie es über das Menü Projekt aus, wodurch das aktuelle automatisch geschlossen wird. Haben Sie ein Projekt ausgewählt, erscheint eine von vielen Desktop- Anwendungen bekannte Verzeichnis- und Dateistruktur in Baum- Ansicht. Dahinter verbergen sich einige nützliche Funktionen für die tägliche Textarbeit, die nicht unmittelbar sichtbar sind Projektstruktur Der Verzeichnisbaum ist umgekehrt-hierarchisch aufgebaut: Ganz oben sehen Sie die Wurzel (als Icon offenes Buch ), die das gesamte Projekt über den Kurztitel repräsentiert. Ein Verzeichnis, das ja wiederum weitere Verzeichnisse oder einzelne Dateien enthalten kann, erkennen Sie an 17

18 2 Editor dem kleinen Plus-Zeichen vor dem Icon. Per Klick klappen Sie diesen Teil des Baumes aus und sehen den Inhalt des jeweiligen Verzeichnisses, während sich das Plus- in ein Minus-Zeichen verwandelt. Ein Klick darauf klappt den Ast des Baumes wieder ein. Abbildung 2.3: Baumstruktur des Projekts Jedes Projekt verfügt von Anfang an über einige Standardverzeichnisse: Vorschauen (Icon Auge ) Hier landen die aus dem Editor heraus generierten Vorschaudateien, die Sie jederzeit aus dem aktuellen Stand des Projekts erzeugen können (Abschnitt 2.4.2). Medienobjekte (Icon Kamera ) Einfach gesagt, enthält dieses Verzeichnis alle Projekt-Inhalte, die nicht Text sind; bereiten Sie ein Buch für den Druck oder für die Online-Publikation vor, so sind dies in der Regel Abbildungen ggf. in verschiedenen Auflösungen und/oder Formaten, abhängig vom Zielformat. Wollen Sie aber ein Bild, das in der Druckausgabe veröffentlicht wird, z. B. in der EPUB3-Variante durch eine kurze Video- Sequenz ersetzen, so liegt auch diese im Verzeichnis Medienobjekte. Inhalt (Icon Liste ) Auf den ersten Blick enthält dieses Verzeichnis eine Liste der Textdateien des Projekts. Jedes Kapitel sollte einer Datei entsprechen. Doch diese Liste ist bereits eine Abstraktion der Dateien, denn sie zeigt nicht die Dateinamen (wie in einem Dateimanager), sondern die Kapitelüberschriften in der Reihenfolge im Projekt. Sie haben hier also unmittelbaren Überblick über das Inhaltsverzeichnis des Buches. 18

19 2.2 Navigation Projektstruktur bearbeiten Der Verzeichnis- und Dateibaum in der Navigation dient nicht nur der Übersicht über den Inhalt der Publikation, sondern auch der unmittelbaren Bearbeitung der Struktur. Kapitelreihenfolge ändern Die Reihenfolge der Dateien/Kapitel ändern Sie, indem Sie auf eine Kapitelüberschrift klicken, die Maustaste gedrückt halten, die Überschrift an die gewünschte Stelle im Baum ziehen und dann die Maustaste loslassen (Drag&Drop). Weitere wichtige Operationen an der Dokumentstruktur erfolgen über das Kontextmenü, also einen Rechtsklick mit der Maus an der entsprechenden Stelle im Dateibaum. Diese sind: Neuer Buchteil/Neues Kapitel Das Menü erreichen Sie per Rechtsklick über der Wurzel des Inhaltsverzeichnisses, also über der Zeile Inhalt. Wählen Sie Neues Kapitel, fordert Sie ein Eingabefenster dazu auf, eine Überschrift einzugeben. Nach der Bestätigung und einem kurzen Speichervorgang erscheint das neue Kapitel bereits im Verzeichnisbaum; Sie können es anklicken und damit unmittelbar zur Bearbeitung öffnen, oder auch, wie oben beschrieben, per Drag&Drop an die gewünschte Position verschieben. Ein Neuer Teil ist kein Inhaltselement, sondern dient der Gliederung der Publikation; so lassen sich größere inhaltliche Teile voneinander unterscheiden und jeweils mit einer (Zwischen-)Überschrift versehen, z.b. zur Abgrenzung eines Anhangs. Abbildung 2.4: Kontextmenü zum Anlegen eines Teils oder Kapitels Über den einzelnen Kapitelüberschriften bietet das Kontextmenü (per Rechtsklick) andere spezifische Funktionen. 19

20 2 Editor Abbildung 2.5: Kontextmenü für Kapitel Öffnen öffnet die Datei zur Bearbeitung; praktischer ist aber meist ein einfacher Linksklick auf die Überschrift. Löschen hält, was es verspricht, allerdings erst nach Bestätigung einer entsprechenden Rückfrage. Eigenschaften gibt Ihnen differenzierte Eingriffsmöglichkeiten auf das Inhaltsverzeichnis: Unsichtbar sorgt dafür, dass die Datei in der Publikation nicht auftaucht, was für vorläufige Kapitel oder Materialsammlungen sinnvoll sein kann. Eine als Vorwort markierte Datei übernimmt etwaige Sonderformatierungen für Abschnitte dieser Art (z. B. Verzicht auf eine Kapitelnummer); gleiches gilt für Anhang, wo z. B. keine Kapitelnummern, sondern Buchstaben oder andere Layout-Besonderheiten hinterlegt sind. Abbildung 2.6: Kontextmenü für Kapitel All diese Zuweisungen haben auf die Bearbeitung der Kapitel keine Auswirkungen diese ist immer dieselbe. Es geht hier lediglich darum, unterschiedliche Kategorien im Hintergrund zu erfassen, um diese später bei der Ausgabe der Zielformate zu berücksichtigen. 2.3 Kommunikator Unterhalb des Bereiches Navigation befindet sich der Kommunikator, also eine Plattform für den Austausch mit all jenen, die 20

21 2.3 Kommunikator 1. ebenfalls Zugriff auf das von Ihnen gerade berarbeitete Projekt haben und 2. dieses zeitgleich zur Bearbeitung geöffnet haben. Das impliziert bereits eine wichtige Eigenschaft dieser Kommunikation: sie ist flüchtig. Wie ein Gespräch währt sie nur für den Moment, sie wird nicht gespeichert und ist damit auch nicht wieder aufrufbar. Abbildung 2.7: Der leere Kommunikator Unter dem Reiter Online sehen Sie die Namen derer, die aktuell für eine Kontaktaufnahme zur Verfügung stehen. Per Klick wählen Sie einen Gesprächspartner aus. Am unteren Rand dieses Reiters bestimmen Sie in der Auswahlliste Mein Status, ob und wie Sie selbst erreichbar bzw. von anderen Nutzern zu erkennen sind. Wollen Sie beispielsweise an dem Projekt arbeiten, aber nicht für andere Nutzer sichtbar sein, also nicht in deren Online-Liste stehen, wählen Sie Unsichtbar. Alternativ signalisieren Sie, dass Sie das Projekt zwar gerade ebenfalls bearbeiten, aber entweder nicht vor dem Rechner sitzen (Abwesend) oder einfach nicht gestört werden möchten (Beschäftigt). Abbildung 2.8: Die Liste der aktuellen Benutzer Aktuell bietet der Kommunikator nur den direkten Chat zwischen zwei Teilnehmern, keinen Gruppen-Chat. 21

22 2 Editor Chat Haben Sie einen anderen Nutzer per Doppelklick auf dessen Namen unter Online kontaktiert, öffnet sich ein neuer Tab mit dem Namen dieses Gesprächsteilnehmers. Darin finden Sie am unteren Rand eine Eingabezeile, in die Sie Ihre kurze Textnachricht schreiben und per Enter-Taste abschicken. Ihre Nachricht erscheint dann, farbig hinterlegt, im Hauptfeld dieses Reiters. Reagiert der andere Nutzer mit einer Nachricht, erscheint diese ebenfalls in der Reitermitte, mit einer anderen Farbe hinterlegt. Auf diese Weise haben Sie stets einen direkten Überblick über Ihr Zwiegespräch. Versand und Empfang von Nachrichten sind übrigens von einem akustischen Signal begleitet, sofern Sie Lautsprecher oder Kopfhörer aktiviert haben. Abbildung 2.9: Ein Chat zwischen Projektbeteiligten Als Gimmick stehen Ihnen über ein Auswahlmenü links von der Eingabezeile einige Smileys zur Verfügung, die in dieser tonlosen Konversation oftmals nützlich sind, um Stimmungs- oder Gefühlszustände auszudrücken, die Arbeitsatmosphäre aufzulockern und Missverständnisse zu vermeiden. Der Chat ist also die Möglichkeit, projektspezifische Kleinigkeiten auf die Schnelle mit anderen Beteiligten zu klären. Indem er nur dann zur Verfügung steht, wenn die Nutzer ohnehin gleichzeitig am selben Projekt arbeiten, ist er die deutlich bessere Wahl als oder Telefon, da der Gesprächskontext nicht erst geschaffen werden muss. Hinzu kommt, dass er innerhalb von textovia selbst bereitsteht, Sie also weder das Kommunikationsmittel noch die Anwendung wechseln müssen. Der Chat bietet sich auch an, um in zuvor vereinbarten Arbeitssitzungen offene Punkte gemeinsam durchzugehen und diese in der zeitgleichen Arbeit am Text konfliktfrei zu schließen. 2.4 Bearbeitungsbereich Die Erfassung und Bearbeitung von Texten ist eine zentrale Aufgabe von textovia als Redaktionssystem. Entsprechend nimmt der Bearbeitungsbe- 22

23 2.4 Bearbeitungsbereich reich in der Mitte des Editor-Moduls den größten Raum ein. Beim Öffnen eines Projekts noch leer, füllt er sich und zeigt seine Funktionen, sobald Sie einen Abschnitt per Klick zur Bearbeitung öffnen. Mit dem Text in der Mitte wird am rechten Rand der Bereich Live-Vorschau & Kommentare sichtbar, den Abschnitt beschreibt. Abbildung 2.10: Der Editor im Überblick Hier geht es um das Herzstück des Editor-Moduls, das wir im Folgenden der Einfachheit halber selbst Editor nennen, da es die Funktionen bietet, die man von einem Programm zur Textbearbeitung erwartet. Aus diesem Grund findet man sich auch als textovia-neuling rasch darin zurecht, da sich der Aufbau an anderen Schreibprogrammen wie MS Word oder LibreOffice orientiert. Da seine Aufgabe aber nicht darin besteht, einen Text in seinem (späteren) Layout abzubilden, sondern alle Nutzer entsprechend ihrer jeweiligen Rolle bei der inhalts- und strukturbezogenen Arbeit zu unterstützen, rücken einige Funktionen in den Vordergrund, die sog. WYSIWYG-Programme 2 nicht haben oder verstecken Aufbau Mit dem Öffnen eines Textes erscheint am oberen Rand des Editors ein gleichnamiger Tab mit Text-Icon. Da Sie beliebig viele Kapitel eines Projekts gleichzeitig offen haben können, aber immer nur eines zur tatsächlichen Bearbeitung im Vordergrund ist, erfolgt der Wechsel am einfachs

24 2 Editor ten per Klick auf den jeweiligen Tab. Das Kapitel im Vordergrund ist auch an der helleren Färbung des Tab erkennbar. Gleich unterhalb des/der Tabs sehen Sie die Toolbar, also eine Icon-Leiste mit den wichtigsten Bearbeitungsfunktionen, wie Sie sie aus anderen Anwendungen kennen. Sie besteht aus drei Icon-Zeilen: Die obere umfasst Funktionen, die Aussehen und Verhalten des Editors beeinflussen oder Operationen über das gesamte Projekt hinweg auslösen. Die beiden unteren vereinfachen die Texteingabe, indem sie Ergänzungen an der aktuellen Cursor-Position vornehmen. Wir sehen uns diese später genauer an, wenn es um das Markup geht (Kapitel 3). Sie können die dritte Zeile übrigens per Klick auf den Pfeil am Ende der zweiten Toolbar-Zeile ein- oder ausklappen. Am unteren Rand des Editor-Fensters steuern Sie dessen Erscheinungsbild in weiteren Details: Ein- bzw. Ausblenden der Absatznummerierung am linken Textrand, Anzahl der eingefügten Leerzeichen bei Drücken der Tabulator-Taste (wichtig z. B. bei der Eingabe von Code-Beispielen), die Textbreite in Zeichen (Standard ist 72) und die (Un)Sichtbarkeit von Steuerzeichen wie Zeilenumbrüchen oder Absätzen. In der unteren rechten Ecke dieser Zeile erkennen Sie zudem zwei durch Doppelpunkt getrennte Ziffern: Sie geben die aktuelle Cursor-Position an, und zwar Absatz-Nummer und Zeichen innerhalb dieses Absatzes. Diese Koordinaten sind sehr hilfreich, wenn Sie mit einem anderen Nutzer zeitgleich Details im Text besprechen und Textstellen präzise angeben möchten (z.b. im Chat). Abbildung 2.11: Editor-Einstellungen Toolbar Die Icons der oberen Toolbar-Zeile sollten Ihnen weitgehend vertraut sein. Eine Erklärung bietet im Zweifel auch der Tooltip, also ein kurzer Hilfetext, der erscheint, sobald Sie mit dem Mauszeiger über einem Icon verharren. Abbildung 2.12: Die Toolbar im Überblick 24

25 2.4 Bearbeitungsbereich Speichern Was Sie auf Ihrem Rechner als Speichern kennen, also in der Regel das Schreiben einer Datei auf die Festplatte, ist in textovia ein deutlich komplexerer Vorgang. Zunächst erfolgt die Übertragung des Textes bzw. Ihrer Änderungen über das Internet, so dass der Vorgang ggf. etwas länger dauern oder sogar unterbrochen werden kann. Das sind Tücken, die mit dem Arbeiten übers Netz einhergehen und nichts mit der Zuverlässigkeit der Webanwendung selbst zu tun haben. Sie sollten sich allerdings angewöhnen, häufiger zu speichern als auf Ihrem lokalen Rechner, denn jede (noch so kurze) Unterbrechung der Internet-Verbindung kann den Verlust Ihrer Arbeit seit dem letzten Speichervorgang bedeuten. Doch das ist nicht der einzige Unterschied zum normalen Speichern: textovia legt nicht den gesamten Text in den Speicher, sondern ausschließlich die Änderungen seit dem letzten Speichern, so dass deutlich weniger Daten zu übertragen sind. Außerdem wird jeder Speichervorgang protokolliert: wer, wann, was auf diese Weise bleibt die gesamte Historie eines Textes erhalten, und beliebige Zwischenschritte können (von dazu befugten Benutzern) wiederhergestellt werden. Rückgängig machen / Wiederherstellen Ihre letzte Textbearbeitung machen Sie mit dem ersten Pfeil rückgängig; danach steht Ihnen mit dem zweiten Pfeil auch die Möglichkeit offen, das so rückgängig Gemachte wiederherzustellen. Suchen / Suchen/Ersetzen Diese Grundfunktionen sind Ihnen aus anderen Anwendungen vertraut. Einige Besonderheiten: Zum nächsten oder vorangehenden Vorkommen des Suchbegriffs gelangen Sie über die Pfeilsymbole. Die Suche differenzieren Sie, indem Sie Groß-/Kleinschreibung bei der Suche berücksichtigen oder festlegen, ob die Zeichenfolge nur dann gefunden wird, wenn sie selbständig steht (Ganze Wörter): So würde die Zeichenfolge bald etwa nicht gefunden, wenn sie zum Wort Sobald gehört. Für technische versiertere Nutzer ist der Einsatz von Regulären Ausdrücken (Regular Expressions) 3 ein echtes Schmankerl, da sich so auch sehr komplexe Suchen nach ähnlichen Zeichenfolgen oder Zeichenfolgen in bestimmten Kontexten durchführen lassen

26 2 Editor Abbildung 2.13: Suchen und Ersetzen in verschiedenen Modi Ansicht vergrößern / Ansicht verkleinern Hier geht es um die Schriftgröße im Editor, also die Lesbarkeit des Textes im Browser-Fenster, nicht um die Schriftgröße im Zielformat der Publikation. Vollbild ein/aus Um sich ganz auf die Textarbeit zu konzentrieren, kann es hilfreich sein, den Browser auf die gesamte Größe des Desktop zu maximieren und über dieses Icon wiederum den Editor-Bereich zu maximieren; so bleiben zahlreiche, aktuell ungenutzte und darum vielleicht störende Funktionen ausgeblendet. Strukturprüfung aktivieren/deaktivieren Diese Funktion lässt sich per Klick auf den Button ein- oder ausschalten per Default ist sie aktiviert. Die Strukturprüfung erleichtert Ihnen die Arbeit dadurch, dass sie schon bei der Eingabe bzw. beim Speichern des Textes das Markup, also die Auszeichnung, prüft. Das zahlt sich spätestens bei der Generierung von Vorschauen und Produkten aus, denn ohne korrekte Auszeichnungen bricht dieser Prozess ab. (Details zum Markup behandelt Kapitel 3, während sich Kapitel 4 der Vermeidung von Syntaxfehlern widmet.) Abbildung 2.14: Strukturprüfung Vorschau Hinter diesem unscheinbaren Button verbirgt sich ein Großteil der textovia-magie, denn über einen einfachen Klick verwandeln Sie den Quelltext Ihres Projekts in das von Ihnen gewünschte Zielformat, das dann auch sämtliche hinterlegten Layout-Informationen umsetzt. Damit haben Sie jederzeit Zugriff auf den aktuellen Stand der Publikation im nahezu endgültigen Layout. Einzelheiten der komplexen Umwandlungsprozesse sollen uns hier nicht interessieren, aber 26

27 2.4 Bearbeitungsbereich Da textovia die strukturierte Texteingabe hier im Editor strikt von der Umwandlung in formatspezifische Layouts (im Hintergrund) trennt, ist es essentiell, dass die von Ihnen eingegebene Struktur korrekt ist! Jede Strukturinformation muss in eine Layout-Anweisung übersetzt werden können andernfalls bricht der gesamte Umwandlungsprozess ab. Dieses Prinzip ist gerade zu Beginn der Arbeit mit textovia gewöhnungsbedürftig und vielleicht sogar frustrierend, da das System tatsächlich nicht den kleinsten Fehler zulässt: Ist die Struktur nicht eindeutig oder falsch (technisch gesprochen: nicht valide), wird kein Zielformat erzeugt, und Sie sehen z.b. keine PDF-Vorschau! Abbildung 2.15: Vorschau erzeugen Index-Einträge bearbeiten Insbesondere die Prüfung und Korrektur der erfassten Index-Einträge (wie diese erfasst werden, beschreibt Abschnitt 3.5.7) ist in vielen Systemen überaus mühsam. Mit diesem Button erhalten Sie eine Liste aller Index-Einträge des Projekts, und zwar so, wie sie erfasst wurden. Sie entspricht nicht dem Sachregister, wie es später in der Publikation erscheint (also mit der Zusammenfassung gleicher Einträge), sondern listet jedes einzelne Vorkommen eines Eintrags. Das gibt Ihnen die Möglichkeit, nicht nur Einträge zu korrigieren, anzugleichen und aufeinander abzustimmen, sondern diese auch per Doppelklick direkt in den Textquellen anzusteuern und zu bearbeiten. Abbildung 2.16: Index-Einträge bearbeiten 27

28 2 Editor Die beiden unteren Zeilen der Toolbar vereinfachen die Strukturierung des Textes, indem sie Ihnen die Markup-Syntax über bekannte Icons bereitstellen: Überschriften, Textauszeichnungen, Listen, Bilder, Fußnoten oder Indexeinträge sind bei Bedarf darüber einzufügen. Ob dies auf die Dauer einfacher/schneller ist als das Markup direkt zu tippen, müssen Sie für sich herausfinden. Eine gute Hilfe, wenn Sie bei der ein oder anderen Anweisung unsicher sind, ist es allemal. Das Verhältnis dieser Buttons und Menüs zum Markup der Texte beschreibt Kapitel 3. Gerade zu Beginn der Arbeit empfiehlt sich aber die Benutzung der Toolbar, da sich dadurch zahlreiche und schwierig zu findende Fehler in der Auszeichnung vermeiden lassen. TIPP Die Auszeichnungen über die Toolbar fügen die notwendige Syntax an der aktuellen Cursor-Position ein, zum Beispiel zwei Sternchen zur Hervorhebung von Wörtern. Wenn Sie zuerst das betreffende Wort markieren, und danach das gewünschte Element in der Toolbar anklicken, wird die Syntax auf das gewählte Wort angewendet Konfliktvermeidung textovia ist als kollaboratives System darauf vorbereitet, dass mehrere Benutzer auf dieselben Daten zugreifen wollen. Das führt darum nicht zu einer simplen Fehlermeldung, sondern zu einer konstruktiven Lösung des möglichen Konflikts. Ein Beispiel: Autorin Amy möchte das Kapitel Lorem bearbeiten und öffnet es im Editor. Da Mike die Datei aber gerade bearbeitet, erhält Amy einen entsprechenden Hinweis am oberen Fensterrand. Abbildung 2.17: Datei ist durch einen anderen Benutzer gesperrt Über den Button am rechten Rand Um Freigabe dieser Datei bitten sendet sie Mike eine Anfrage, die Datei zu schließen und damit freizugeben. Kommt er dieser Bitte (über einen entsprechenden Button, der nun auf seiner Seite erscheint) nach, erhält sie eine Meldung und kann dann die Datei neu laden, um ggf. auch Mikes aktuelle Änderungen zu übernehmen. 28

29 2.5 Live-Vorschau & Kommentare Durch diesen Mechanismus ist ausgeschlossen, dass mehrere Benutzer gleichzeitig Änderungen an einer Datei vornehmen und damit Konflikte entstehen. Abbildung 2.18: Datei nach der Freigabe neu laden 2.5 Live-Vorschau & Kommentare In diesem Bereich am rechten Rand des Editor-Moduls, der erst mit dem Öffnen einer Datei sichtbar wird, finden Sie zwei Tabs Live-Vorschau textovia generiert bei jedem Speichern einer Datei automatisch eine HTML-Version des Textes und zeigt sie unter diesem Tab an. Abbildung 2.19: Live-Vorschau Damit haben Sie nicht nur einen besseren Überlick über den Text, um ihn etwa inhaltlich zu kontrollieren, sondern zugleich eine erste Kontrolle, ob die Struktur korrekt erfasst wurde. Die falsche Auszeichnung von Überschriften oder anderen Elementen bedingt in der Regel auch Fehler in der HTML-Ausgabe. Umgekehrt heißt das aber nicht, dass eine mehr oder weniger korrekte HTML-Version auch eine problemlose Umwandlung in andere Formate wie z.b. PDF erlaubt. HTML ist aufgrund seiner Historie deutlich fehlertoleranter als andere Formate; die Live-Vorschau ist darum nur eine erste, schnelle Kontrollmöglichkeit, kein Test im Hinblick auf die syntaktische Korrektheit des Textes! 29

30 2 Editor Wenn Sie im Bearbeitungsfenster im Text scrollen, wandert die Live- Vorschau mit und zeigt den entsprechenden Text an. Dieser Abgleich ist allerdings nicht immer verlässlich. Der Grund liegt darin, dass die Textposition im Editor nur sehr schwierig mit der in der HTML-Vorschau abzugleichen ist, da hier die Größe z. B. von Abbildungen und anderen Layout-Elementen hineinspielt Kommentare Während die Chat-Funktion im Kommunikator (Abschnitt 2.3.1) dem flüchtigen Austausch der Nutzer dient, haben Sie mit Kommentaren die Möglichkeiten, auch komplexe Fragen mit den Beteiligten zu diskutieren oder Statusmeldungen im Text zu hinterlegen. Im Grunde sind Kommentare unsichtbarer Text, der zwar in den Quelltexten steht, bei der Umwandlung in verschiedene Ausgabeformate aber nicht berücksichtigt wird. Sie sollten sich daran gewöhnen, Kommentare jeweils vor den Absatz zu setzen, auf den sie sich beziehen. Sie markieren solchen Text, indem Sie ihn oberhalb und unterhalb mit einer Reihe von Schrägstrichen einfassen. Am besten nutzen Sie dafür den entsprechenden Button der Toolbar, denn er fügt bereits Ihren Benutzernamen und eine aktuelle Datums- und Zeitangabe ein, was die spätere Bearbeitung deutlich vereinfacht: ////////// Amy Author, :08 Der folgende Abschnitt ist noch nicht deutlich genug. ////////// Sämtliche Kommentare in einer Datei finden Sie auch unter dem Tab Kommentare neben der Live-Vorschau als Übersicht. Ein Doppelklick setzt den Cursor unmittelbar an die betreffende Stelle, so dass Sie die fraglichen Stellen rasch finden und bearbeiten können. Abbildung 2.20: Kommentarübersicht 30

31 3 Kapitel Texteingabe und Markup Damit der eine, für alle Beteiligten zu jedem Zeitpunkt des Projektverlaufs identische Quelltext in beliebige Zielformate zur Veröffentlichung umgewandelt werden kann, ist seine Struktur zu erfassen. Eine Überschrift ist zum Beispiel ein kurzes Textelement, das auf den Inhalt des folgenden Textes oder weiterer Abschnitte verweist und den Gesamttext gliedert. Das hat nichts damit zu tun, wie diese Überschrift einmal aussehen soll: Position, Farbe, Größe, Abstände etc. spielen hier (also bei der Textbearbeitung im Editor-Modul) keine Rolle, denn diese Parameter können in den sehr unterschiedlichen Endformaten sehr unterschiedlich definiert sein. Die Eingabe im Editor hat folglich zum Ziel, die verschiedenen Elemente Ihrer künftigen Publikationen auszuzeichnen, und das geschieht über möglichst einfache Zeichenfolgen mit einer sehr einfachen Syntax. 31

32 3 Texteingabe und Markup Im Folgenden beschreiben wir die wichtigsten Strukturelemente und wie Sie diese in textovia mit Hilfe sog. Makros auszeichnen; sind in Ihrer Publikation weitere, ganz spezifische Elemente notwendig, wenden Sie sich bitte an den Verlag. Gemeinsam entwickeln wir eine Syntax zur optimalen Strukturierung Ihrer Projekte und ggf. deren Umsetzung im Layout der Publikationen. Die wichtigsten Auszeichnungselemente erreichen Sie bequem über die Toolbar (Abschnitt 2.4.2). Deren Buttons und Menüs stellen wir Ihnen hier genauer vor. Gerade für den Einstieg sind diese sehr hilfreich, da sie nicht nur Tipparbeit sparen, sondern v. a. zahlreiche Fehlerquellen vermeiden, die durch die Eingabe des Markup allein über die Tastatur entstehen. Bearbeiten Sie Ihre Texte außerhalb der textovia Web-Applikation gelten die hier beschriebenen Regeln uneingeschränkt auch für Sie! WICHTIG Alle Projektbeteiligten müssen sich konsequent an die definierte Syntax halten andernfalls ist die Umwandlung des Projekts in veröffentlichungsreife Endformate nicht möglich. 3.1 Grundregeln Bevor wir zur eigentlichen Textauszeichnung kommen, hier einige Grundregeln: 1. Alles, was den Text nach Bedeutung bzw. für das Layout strukturiert, wird unmittelbar in den Text hineingeschrieben (Markup). 2. Absätze werden durch eine (oder mehrere, beliebig viele) Leerzeilen erzeugt. 3. Zwischen zwei Wörtern können beliebig viele Leerzeichen stehen, die im Layout stets als eines umgesetzt werden. 4. Das Markup erfolgt mit sehr einfachen Mitteln/Zeichen. Sollten Ihnen Auszeichnungselemente fehlen, setzen Sie sich bitte mit uns in Verbindung. 3.2 Überschriften Sie zeichnen Überschriften für Kapitel, Abschnitte, Unterabschnitte etc. aus, indem Sie diesen Gleichheitszeichen voranstellen. Die Anzahl der 32

33 3.3 Fließtext Gleichheitszeichen markiert die Hierarchieebene; in den Kapiteln stehen 4 Ebenen zur Verfügung: Kapitel (1. Ebene) == Kapitel Abschnitt (2. Ebene) === Abschnitt Unterabschnitt (3. Ebene) ==== Unterabschnitt Unterunterabschnitt (4. Ebene) ===== Unterunterabschnitt Die hierarchische Struktur muss strikt eingehalten werden Sie dürfen also keine Ebene überspringen: Auf Ebene 2 folgt also entweder eine weitere Ebene 2 oder eine Ebene 3, aber nie eine Ebene 4. WARNUNG Abbildung 3.1: Überschrift Über diesen genannten Kapitel- und Abschnittsüberschriften, die Sie in der Toolbar über das Ausklappmenü (Überschrift 1 bis Überschrift 4) erreichen, steht in der Hierarchie noch die Überschrift für einen Teil, die Sie allerdings nicht in Kapiteldateien verwenden dürfen (siehe Abschnitt 2.2.2). 3.3 Fließtext Wörter trennen Sie mit einem (oder mehreren) Leerzeichen, Absätze mit einer (oder mehreren) Leerzeilen. 33

34 3 Texteingabe und Markup Diese ist der erste Absatz. Dies ist der zweite Absatz. 3.4 Inline-Elemente Inline-Elemente sind solche, die Sie im Fließtext zur Auszeichnung spezieller Zeichen, Wörter oder Phrasen einsetzen. Je detaillierter die Auszeichnungen, desto vielfältiger sind die Möglichkeiten der Textgestaltung. Abbildung 3.2: Texthervorhebungen Hervorhebungen Wie hervorgehobener Text später im Layout erscheint, entscheidet sich im späteren Prozess der Formatgenerierung. Zwei häufige Varianten, nämlich fett und kursiv, sind in der Toolbar bereits mit den typischen Icons vorgesehen. Das entsprechende Markup sind Sternchen (*) bzw. Unterstriche: Markierung *fetter* und _kursiver_ Wörter ergibt Markierung fetter und kursiver Wörter Welche Variante Sie für welchen Zweck einsetzen, hängt, wie gesagt, vom späteren Layout bzw. den Vorgaben des Verlags ab. Hier empfehlen sich eine frühe Abstimmung und der konsistente Einsatz der jeweiligen Variante URLs URLs, die auch in den späteren Ausgabeformaten als solche anzusteuern ( klickbar ) sein sollen, sind vollständig (also immer einschließlich http(s)://, ftp:// o.ä.) zu hinterlegen und nicht gesondert auszuzeichnen. 34

35 3.4 Inline-Elemente ergibt Achten Sie darauf, dass Sie wirklich nur funktionierende URLs so auszeichnen, keine Teil-, Beispiel- oder Fantasie-Adressen wie Diese markieren Sie wie Programmcode in sog. Backticks (Abschnitt 3.4.4) Adressen Ähnlich wie URLs zeichnen Sie auch -Adressen aus: Soll die E- Mail-Adresse vollständig erscheinen und je nach Ausgabeformat auch anklickbar sein, so schreiben Sie sie unverändert, also: ergibt Auch hier verhindert die Notation als Programmcode, dass eine Adresse z.b. per Klick nutzbar ist (Abschnitt 3.4.4) Maschinenschrift/Code Vor allem in technischer Dokumentation ist Maschinenschrift wichtig, um z.b. Code-Beispiele, Systemausgaben, Datei- und Verzeichnisnamen etc. kenntlich zu machen. Setzen Sie solche Elemente im Fließtext in einfache rückwärtige Anführungszeichen ( Backticks ), also das obere Zeichen auf der Taste rechts neben dem ß. die Dateiendung `myfile.txt` ergibt: die Dateiendung myfile.txt Anführungszeichen Anführungszeichen sind in der Typographie eine Wissenschaft für sich insbesondere wenn es um verschiedene Sprachen geht. Darum werden sie so notiert, dass keine Verwechslungen entstehen und sehr spezifische Umsetzungen im Layout möglich bleiben: Backtick(s) vor und einfache(s) gerade(s) Anführungszeichen nach der Phrase, also der `eine' Begriff und der ``andere'' Begriff 35

36 3 Texteingabe und Markup ergibt: der eine Begriff und der andere Begriff Die Toolbar stellt ein Menü dafür bereit. Abbildung 3.3: Anführungszeichen Gedankenstrich Einen Gedankenstrich, der länger als ein Trenn- oder Bindestrich ist, steht auf den meisten Tastaturen durch die Kombination +- zur Verfügung, also Gedanke Nebengedanke wieder Gedanke ergibt: Gedanke Nebengedanke wieder Gedanke Tasten Zur Wiedergabe von Tasten auf der Computertastatur dient das Makro key:[<taste>], also die Taste key:[ctrl] ergibt: die Taste Um, wie in technischer Dokumentation häufig, Tastenkombinationen zu kennzeichnen, verbinden Sie die Tasten innerhalb des Makros mit einem Komma: die Tastenkombination key:[ctrl,c] ergibt: die Tastenkombination +C 36

37 3.5 Block-Elemente Menüs Ebenfalls für die Beschreibung von Software von Bedeutung ist die Auszeichnung von Menüs, Buttons oder anderen Elementen der Programmoberfläche (GUI). Dafür steht das Makro <Name> zur Verfügung: Wählen Sie menu:[datei,speichern unter...] ergibt: Wählen Sie Datei Speichern unter Auch hier verbinden Sie mehrere Einträge, durch Komma getrennt, in einem Makro. 3.5 Block-Elemente Block-Elemente sind von vorhergehendem und nachfolgendem Text mit Leerzeile abgesetzte, abgeschlossene Bereiche mit eigener Formatierung Listen Unterschieden werden drei Listentypen: Punktliste, nummerierte Liste und Definitionsliste. Abbildung 3.4: Listen Grundsätzlich sind Listen jeder Form von Tabelle vorzuziehen, da sie sich deutlich verlässlicher in andere Formate übertragen lassen! WICHTIG Punktliste Für eine einfache Liste gleichgeordneter Elemente ( unsortierte Liste ) stellen Sie diesen einen Stern * voran: * Element 1 * Element 2 * Element 3 37

38 3 Texteingabe und Markup ergibt Element 1 Element 2 Element 3 Nummerierte Liste Für Aufzählungen (z. B. Arbeitsschritte) stellen Sie den Elementen einen Punkt und ein Leerzeichen voran:. Schritt. noch ein Schritt. und ein letzter Schritt 1. Schritt 2. noch ein Schritt 3. und ein letzter Schritt Definitionsliste Solche Listen bieten sich für Begriffs-, Parameter- oder andere kurze Erklärungen an. Dem Begriff folgt nach zwei Doppelpunkten die Erläuterung. Begriff A:: Hier folgt die ausführliche Erläuterung zu Begriff A. Begriff B:: Hier folgt die ausführliche Erläuterung zu Begriff B. Begriff A Hier folgt die ausführliche Erläuterung zu Begriff A. Begriff B Hier folgt die ausführliche Erläuterung zu Begriff B Abbildungen Für die Einbindung von Abbildungen sollten zwei Voraussetzungen erfüllt sein: 38

39 3.5 Block-Elemente Sämtliche Abbildungsdateien liegen im Verzeichnis Medienobjekte Ihres Projekts. Die Abbildungen liegen in guter Qualität, in einem webfähigen Format (vorzugsweise.png oder.jpg) vor. Folgende Angaben sind für die Einbindung notwendig bzw. möglich: 1. <Dateiname> der Abbildung inkl. Dateiendung (z.b..jpg) 2. <Bildüberschrift> in möglichst kurzer Form (optional, abhängig vom Layout) 3. <Sprungmarke>, über die man auf diese Abbildung verweisen kann. Die Syntax lautet allgemein:.<bildüberschrift> image:<dateiname>[id="<sprungmarke>",width="<wert>%"] Um nun beispielsweise die Datei textovia-logo.png in das Dokument einzubinden, lautet die vollständige Angabe:.Das Logo von textovia image::textovia-logo.png[id="fig ",width="100%"] Und das Ergebnis sieht wie folgt aus: Abbildung 3.5: textovia Logo Die Angabe der Breite (width) in Prozent der Satzbreite setzen Sie beliebig, z.b. immer auf 75% sie wird später bei der endgültigen Textgestaltung angepasst. All das lässt sich auch bequem und weniger fehleranfällig über die Toolbar vorbereiten. 39

40 3 Texteingabe und Markup Abbildung 3.6: Einbinden einer Abbildung Tabellen WICHTIG Verzichten Sie, wenn irgend möglich, auf Tabellen, da deren komplexe Struktur nicht immer verlässlich in verschiedene Layouts umzuwandeln ist. Meist erfüllen Listen (Abschnitt 3.5.1) ebenso gut den gewünschten Effekt. Sollten Sie nicht auf eine Tabelle verzichten können, gelten folgende Minimal-Vorschriften: Tabellen beginnen und enden mit der Zeile ============== Die Anzahl der Gleichheitszeichen ist beliebig, es sollten aber mindestens fünf sein. Die Zellen einer Zeile sind durch das Pipe-Zeichen ( ) voneinander getrennt, das Sie durch die Tastenkombination +< erzeugen (auf einem Mac durch die Tastenkombination +7). Eine Überschrift steht vor der Tabelle in einer eigenen, durch einen Punkt (ohne folgendes Leerzeichen!) eingeleiteten Zeile. Hier ein einfaches Beispiel:.Tabellenüberschrift ============================= 40

41 3.5 Block-Elemente 1.a 1.b 1.c 1.d 2.a 2.b 2.c 2.d 3.a 3.b 3.c 3.d ============================= 1.a 1.b 1.c 1.d 2.a 2.b 2.c 2.d 3.a 3.b 3.c 3.d Tabelle 3.1: Tabellenüberschr ift Wenn Sie einen Tabellenkopf (also eine besonders ausgezeichnete erste Tabellenzeile) benötigen, verwenden Sie [options="header"] nach der Tabellenüberschrift. Die erste Zeile wird dann zum Tabellenkopf. All dies (einschließlich ID für eventuelle Verweise auf diese Tabelle) bereiten auch Button und Menü in der Toolbar vor: Abbildung 3.7: Tabelle [[tab ]].die Beispieltabelle [options="header"] ================================== ================================== 41

42 3 Texteingabe und Markup Hinweisblöcke Es gibt drei verschiedene Hinweisblöcke; wie intensiv Sie davon Gebrauch machen, hängt nicht zuletzt vom Charakter der Publikation bzw. den Vorgaben des Verlags ab. Es gibt: [TIP] für einen (meist praktischen) Hinweis im Zusammenhang mit eher theoretischen Ausführungen [NOTE] für allgemeine Bemerkungen am Rande [IMPORTANT] für Warnhinweise, die bei Benutzung oder Unterlassung beschriebener Aktionen wichtig sind Die Syntax für diese Hinweisblöcke ist folgende, wobei die Überschrift optional ist: [NOTE].Achten Sie auf Hinweise ======================================================== Das ist besonders wichtig ======================================================== HINWEIS Achten Sie auf Hinweise Das ist besonders wichtig Im eckigen Klammerpaar steht jeweils das oben genannte Signalwort, gefolgt von einer mit Punkt eingeleiteten (optionalen) Überschrift. Der Hinweis-Text steht dann zwischen zwei Linien aus Gleichheitszeichen. Auch hier hilft die Toolbar weiter. Abbildung 3.8: Hinweis 42

43 3.5 Block-Elemente Zitate Längere Zitate sind durch Linien aus Unterstrichen abgesetzt; darüber stehen in eckigen Klammern, durch Komma getrennt, der Typ und die Angaben zu Urheber und Quelle: [quote, Richard Stallman, The Free Software Definition] ``Free software'' means software that respects users' freedom and community. Roughly, the users have the freedom to run, copy, distribute, study, change and improve the software. With these freedoms, the users (both individually and collectively) control the program and what it does for them. Free software means software that respects users' freedom and community. Roughly, the users have the freedom to run, copy, distribute, study, change and improve the software. With these freedoms, the users (both individually and collectively) control the program and what it does for them. Richard Stallman The Free Software Definition Der entsprechende Button der Toolbar liefert das Gerüst. Abbildung 3.9: Zitat Fußnoten Fußnoten notieren Sie dort, wo die Fußnotenziffer stehen soll. 1 Fußnotenziffer stehen soll.{empty}footnote:[hier steht der Fußnotentext.] Es empfiehlt sich, vor den Marker footnote die Zeichenfolge {empty} zu setzen; sie trennt die Fußnote deutlich ab, wenn sie z. B. unmittelbar auf ein Wort folgt. Die Toolbar erledigt das auf Knopfdruck. 1 Hier steht der Fußnotentext. 43

44 3 Texteingabe und Markup Abbildung 3.10: Fußnote Indexeinträge Der Index hat in der Regel max. 2 Hierarchieebenen, also nur Einträge und optionale Untereinträge. Das Makro schließt den Eintrag in 3(!) Paare aus runden Klammern ein. Aus Gründen der Übersichtlichkeit empfiehlt es sich, Index-Einträge grundsätzlich vor den betreffenden Absatz setzen, und zwar jeden Eintrag in eine eigene Zeile, also zum Beispiel: (((Eintrag A))) (((Eintrag B))) Das Makro schließt den Eintrag in 3(!) Paare aus runden Klammern ein. Aus Gründen der Übersichtlichkeit empfiehlt es sich,... Nebeneinträge stehen, durch Komma getrennt, direkt hinter dem Haupteintrag, also: (((Haupteintrag,Nebeneintrag))) Nun kann es notwendig sein, dass in einem Index-Eintrag ein Komma als Teil des Eintrags berücksichtigt wird, also nicht als Trenner dient. In diesem Fall setzen Sie den gesamten Eintrag in doppelte Anführungszeichen, also z.b.: ((("Bach, Johann Sebastian"))) Verweise von einem auf einen anderen Index-Eintrag nach dem Muster Eintrag A siehe Eintrag B stellen Sie wie folgt her: indextermsee:[eintrag A,Eintrag B] Einen Verweis von einem auf einen ergänzenden Eintrag ( siehe auch ) setzen Sie wie folgt: indextermseealso:[eintrag A,Eintrag B] Das entsprechende Menü in der Toolbar erleichtert die Eingabe, indem es das passende Makro einfügt: 44

45 3.5 Block-Elemente Abbildung 3.11: Index Wie Sie die Indexeinträge eines Projekts am schnellsten bearbeiten, beschreibt Abschnitt Querverweise Verweise auf andere Stellen im Dokument sind eine durchaus heikle Angelegenheit, wenn man bedenkt, wie unterschiedlich sie in verschiedenen Ausgabeformaten gehandhabt werden: In HTML als Link, im PDF als Verweis auf einen Abschnitt etc. Das Problematische: Eine Auszeichnung im Quelltext soll all diese auch technisch sehr verschiedenen Fälle abdecken. Es geht also darum, an solchen Stellen sog. Sprungmarken oder Ziel-ID zu setzen (auch Anker genannt), auf die in allen Zielformaten irgendwie verwiesen werden kann. Dafür bieten sich zuallererst nummerierte Elemente an, also Überschriften, Abbildungen, Tabellen etc. Der Sprungmarken-Text steht in doppelten eckigen Klammern und darf keine Leerzeichen, keine Umlaute und keine Doppelpunkte enthalten. Außerdem darf er nicht mit einer Ziffer beginnen. Der Sprungmarken-Text muss im gesamten Projekt eindeutig sein, darf also nicht mehrfach vergeben werden, da andernfalls der Umwandlungsprozess in andere Formate abbricht. WICHTIG Nutzen Sie die Toolbar zur Auszeichnung solch nummerierter Elemente, werden eindeutige Sprungmarken bereits automatisch ergänzt, z.b. [[heading ]] == Überschrift Hier beginnt das Kapitel... 45

46 3 Texteingabe und Markup Sie verweisen nun von einer beliebigen Stelle im Dokument auf die z.b. mit [[heading ]] markierte Stelle, indem Sie die Ziel-ID in doppelte spitze Klammern setzen: und hier der Verweis auf <<heading >> WICHTIG Achtung bei Querverweisen Verweise sollen nicht das Element nennen, auf das sie verweisen, sondern ausschließlich die Sprungsmarke (Ziel-ID)! Schreiben Sie also z.b.: Wie in <<heading >> bereits erwähnt... Also ohne Angabe von Kapitel, Abschnitt, Abbildung etc. Verweise auf Seiten(zahlen) sind nicht möglich, da es in einigen Formaten (z.b. EPUB) keine Seiten gibt Code-Listings Code-Blöcke trennen Sie durch gestrichelte Linien vor und nach dem Code ab: Hier steht der Code Am besten ist es, Sie umbrechen lange Code-Zeilen von Hand entsprechend den Regeln der jeweiligen Programmiersprache. Ein übliches Maximum sind 70 Zeichen pro Zeile. Bei längeren Zeilen erfolgt andernfalls ein automatischer Umbruch, der ggf. mit einem speziellen Zeichen im Ausgabeformat markiert ist. 3.6 Wenn etwas fehlt Die hier beschriebenen Elemente/Makros bilden eine Art Grundausstattung zur Textstrukturierung. Ob sie aber überhaupt zur Verfügung stehen bzw. genutzt werden sollten, hängt von den Stylesheets ab, die einem Projekt zugewiesen sind und die dafür sorgen, dass Struktur- in Layout-Anweisungen transformiert werden. Es gilt: Nutzen Sie im Quelltext Makros, die die Style-Sheets nicht kennen, werden die Zielformate unformatierten Text enthalten. 46

47 3.6 Wenn etwas fehlt Und umgekehrt: Verlangen die Zielformate spezielle Elemente, müssen diese im Quelltext mit bestimmten Makros entsprechend ausgezeichnet und vorbereitet sein. Daraus folgt, dass Sie sich vor der Texterfassung und -bearbeitung mit dem Verlag darüber verständigen müssen 1. welche Makros zur Verfügung stehen und 2. wie diese einzusetzen sind Das können alle der hier beschriebenen sein oder nur ein Teil; es können aber auch andere sein, die eigens entwickelt wurden und die darum keinen Eingang in dieses Handbuch finden. Wann immer es Unklarheiten gibt, wie bestimmte Elemente im Quelltext zu markieren sind, sollten sich alle Beteiligten rechtzeitig darüber verständigen und eine bestimmte Vorgehensweise definieren. Nur so sind überflüssige Nacharbeiten zu vermeiden. WICHTIG 47

48

49 4 Kapitel Fehler und Fehlersuche Wie wichtig die korrekte Struktur (Syntax) bei der Auszeichnung der Texte ist, haben wir bereits mehrfach betont. Doch nicht alle Fehler haben dieselbe Wirkung: Manche verhindern, dass aus den Textquellen andere Formate generiert werden können, und behindern Sie dadurch unmittelbar bei der Manuskriptarbeit; andere sorgen nur für Layout- Fehler, die sich rasch erkennen und in der Regel auch beheben lassen. Sehen wir uns die Fehlertypen genauer an: Schwere Syntaxfehler sorgen dafür, dass die Quellen nicht in andere (Zwischen-)Formate umgewandelt werden. Sie müssen beseitigt werden, bevor Sie PDF-, HTML- oder EPUB-Dokumente erzeugen. Die entsprechende Fehlermeldung lautet: Bei der Formatgenerierung ist ein Fehler aufgetreten. 49

50 4 Fehler und Fehlersuche Leichte Syntaxfehler sind solche, die die Umwandlung in die Zielformate nicht verhindern, dort aber für unerwünschte Ergebnisse sorgen; oft erkennen Sie diese schon in der Live-Vorschau. Sie sind durch kleine Korrekturen in den Quelltexten zu beheben. Style-Sheet-Fehler sind im eigentlichen Sinne keine Fehler. So kann im Quelltext die Syntax korrekt sein, aber in den Style-Sheets fehlt die Information, wie ein Element im Layout behandelt werden soll. Das ist meist der Fall, wenn Auszeichnungsmakros kunden- oder projektspezifisch definiert und verwendet werden. Abbildung 4.1: Strukturprüfung 4.1 Strukturprüfung Der Editor unterstützt Sie bei der Eingabe: Per Klick auf das Icon in der Toolbar aktivieren bzw. deaktivieren Sie die Strukturprüfung. Abbildung 4.2: Syntaxfehler im Editor Erkennt der Editor Syntaxfehler, markiert er die betroffenen Zeilen nach dem Speichern in der Randspalte mit einem roten Warnzeichen. HINWEIS Die Strukturprüfung durch den Editor befindet sich noch in der Entwicklung und kann zudem nicht alle möglichen Eingabekombinationen berücksichtigen. Betrachten Sie sie darum ähnlich wie eine automatische Rechtschreibprüfung als erste Hilfe, die nicht alle Fehler vermeiden hilft. Wenn Sie trotz solcher Fehlerhinweise eine Vorschau oder ein Produkt erzeugen wollen, erscheint ein Warnhinweis, den Sie allerdings auch 50

51 4.1 Strukturprüfung ignorieren können. Die Warnung wird übrigens auch dann angezeigt, wenn die Strukturprüfung deaktiviert ist. Abbildung 4.3: Hinweis auf Strukturfehler vor der Formatgenerierung Ein Tooltip liefert jeweils weitergehende Hinweise zu einem Warnzeichen am Rand. Sehen wir uns diese und die dahinter stehenden Syntax- Regeln im Folgenden näher an Fehler in der Projektstruktur Ein Buchteil befindet sich an einer ungültigen Position (z. B. am Ende des Buchs oder unmittelbar nach einem anderen Teil). Dieser Fehler entsteht nicht bei der Texteingabe im Editor, sondern als Folge einer falschen Struktur im Projektbaum. Die Fehlermeldung erscheint also erst, sobald Sie die Umwandlung des Textes in eine Vorschau oder ein Produkt anstoßen Fehler bei Überschriften Ein Kapitel darf keine Überschrift für einen Buch-Teil enthalten. Der Hinweis erscheint, wenn Sie in einem Kapitel eine Überschrift der höchsten Kategorie setzen, die nur für Buch-Teile vorgesehen ist und die mit einem einfachen Gleichheitszeichen markiert wird (vgl. Abschnitt 3.2). Folgendes ist also nicht erlaubt: == Lorem Consetetur sadipscing elitr, sed diam _nonumy_ eirmod... = Tempor invidunt Ut labore et dolore magna aliquyam erat, sed diam... Ein Buch-Teil muss mit einer entsprechenden Überschrift beginnen, z. B.: = Die Überschrift Ein Teil muss mit einer Sprungmarke und einer Teil-Überschrift beginnen; betrachten Sie dazu auch die folgende Meldung: 51