6. Glossar

Das Glossar bietet Übersetzungen einiger Begriffe aus adoc Studio, die ursprünglich aus dem Vokabular von AsciiDoc stammen und daher englischsprachig sind. Diese Übersetzungen führen zu einer Mischung aus englischen und deutschen Begriffen. Das Glossar hilft Ihnen, sich in diesem Sprachgemisch zurechtzufinden.


6.1. Inhalt

[ A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z ]


A

Abgegrenzte Blöcke

Ein abgegrenzter Block ist ein Bereich des Inhalts, der auf beiden Seiten von einem Paar identischer Abgrenzungszeichen in separaten Zeilen begrenzt wird. Solche Blöcke dienen entweder dazu, andere Blöcke zu umfassen (z.B. mehrere Absätze) oder um das Inhaltsmodell des enthaltenen Inhalts festzulegen (z.B. wortwörtlicher Text).

Absatz

In den meisten Dokumenten ist der Absatz der wichtigste Blocktyp. Dieser braucht keine speziellen Markierungen oder Attribute. Ob Sie für jeden Satz eine eigene Zeile verwenden oder alles hintereinander schreiben, der Inhalt wird immer zu einem Absatz. Erst eine Leerzeile trennt Absätze voneinander.

Abschnitt

Unterteilt ein AsciiDoc-Dokument in eine Inhaltshierarchie. Ein Abschnitt wird durch einen Abschnittstitel definiert, dem ein oder mehrere Gleich-Zeichen (=) vorangestellt sind. Der Abschnitt umfasst alle Inhalte, die auf den Abschnittstitel folgen, bis zum nächsten gleichrangigen oder übergeordneten Abschnittstitel oder zum Ende des Dokuments.

Abschnittstitel

Kennzeichnet den Beginn eines Abschnitts und dient gleichzeitig als Überschrift für diesen Abschnitt. Anhand der vorangestellten Abschnittsmarkierung (Gleich-Zeichen) definieren Sie die Abschnittsebene. In adoc Studio werden die Gleich-Zeichen im linken Rand des Editors angezeigt.

Abstrakt

Ein Abstrakt ist ein kurzer Überblick oder eine Zusammenfassung eines Dokuments. Manchmal wird der Begriff auch als ein Synonym zur Präambel verwendet.

Admonition

siehe Hinweis

adoc

Die Kurzform für adoc Studio und gleichzeitig die Endung der Textdateien für AsciiDoc.

adoc Studio

Der Name dieser App.

Anhang

Der Abschnittsstil Anhang kann in Büchern und Artikeln verwendet werden und kann weitere Unterabschnitte haben. Obwohl die AsciiDoc-Struktur es erlaubt, Anhänge an beliebiger Stelle zu platzieren, ist es üblich, sie ans Endes eines Dokuments zu stellen.

Anker

Ein Anker ist ein Sprungziel, das über das ID-Attribut definiert wird.

Artikel

Der Artikel ist der Standard-Doctype in adoc Studio. Er umfasst optional die Abschnitte Anhang, Zusammenfassung, Bibliographie, Glossar und Index.

ASCII

Ist ein Akronym für American Standard Code for Information Interchange. Dieser Standard definiert 128 Zeichen, bestehend aus 33 nicht druckbaren sowie 95 druckbaren Zeichen und dem Leerzeichen. In AsciiDoc steht Ascii mehr für „alles ist Text – auch die Emoji“. AsciiDoc verwendet den vollen Unicode Zeichensatz.

AsciiDoc

Ist eine ausgereifte, leichtgewichtige und semantische Auszeichnungssprache, die hauptsächlich für die Erstellung von strukturierten Dokumenten entwickelt wurde. Sie konvertieren AsciiDoc-Dateien nach HTML oder PDF mit Programmen wie adoc Studio oder Asciidoctor. Die Sprache AsciiDoc wurde 2002 von Stuart Rackham entwickelt. Eine Neuimplementierung ist Asciidoctor, welches seit 2013 von Dan Allen entwickelt wird. Seit 2020 arbeitet die Eclipse Foundation, mit der AsciiDoc Working Group an der Standardisierung von AsciiDoc.

Asciidoctor

Ist ein Kommandozeilen-Werkzeug zum Parsen vonAsciiDoc-Dateien und deren Konvertierung in Ausgabeformate wie HTML und anderen Formaten. Um PDF-Dokumente zu erstellen, wird Asciidoctor PDF benötigt. Im Grunde ist es ein ähnliches Programm wie adoc Studio, aber ohne die Projektintegration, ohne Editor, ohne Textvervollständigung und ohne Vorschau. Asciidoctor ist OpenSource und wird seit 2013 von Dan Allen entwickelt und gepflegt.

Asciidoctor PDF

Ist ein Kommandozeilen-Werkzeug zum Parsen vonAsciiDoc-Dateien und deren Konvertierung in das Ausgabeformat PDF. Asciidoctor PDF ist OpenSource und wird von Dan Allen entwickelt.

Attribut

Werden in AsciiDoc verwendet, um Dokumente zu konfigurieren und Variablen zu speichern. Ein Dokumentattribut ist ab der Definition im Dokument verfügbar. Manche Attribute müssen aber am Anfang eines Dokuments stehen. Attributeinträge werden auch häufig zum Umschalten von Funktionen verwendet. Ein Attributeintrag besteht aus zwei Teilen: einem Attributnamen und einem Attributwert.

Attributliste (oder auch attrlist)

Die Definition von Attributen, die für ein Element verwendet wird, wird als attrlist bezeichnet. Eine Attributliste ist immer von einem Paar eckiger Klammern umgeben. Dies gilt sowohl für Elementattribute als auch für Attribute in einem Block oder Inline-Makro.

Auszeichnungssprache

Eine Auszeichnungssprache ist eine maschinenlesbare Sprache für die Gliederung und Formatierung von Texten und anderen Daten. Der bekannteste Vertreter ist die Hypertext Markup Language (HTML), die Kernsprache des World Wide Webs.

Autor

Der Verfasser eines Dokuments. Er kann in AsciiDoc Dokumenten unter dem Titel angegeben werden und wird automatisch im Attribut :author: gespeichert. Zusätzlich sind weitere Attribute im Zusammenhang mit dem Autor möglich.

B

Benutzerdefiniertes Attribut

Ist ein vom Autor definiertes Dokumentattribut, das zum Speichern wiederverwendbarer Inhalte und zur Steuerung der bedingten Einbindung verwendet wird.

Bibliografie (oder Bibliographie)

Ist ein eigenständiges Verzeichnis von Literaturnachweisen bzw. die Erstellung oder die Lehre von der Erstellung eines solchen Verzeichnisses. In adoc Studio kann sie im Büchern und Artikeln eingesetzt werden.

Block

Legen in einem AsciiDoc-Dokument die Struktur des Dokuments fest. Einige Blöcke enthalten andere Blöcke, so dass die Dokumentstruktur von Natur aus hierarchisch ist (d.h. eine Baumstruktur). Sie erkennen diese Blockstruktur in der Vorschau, indem Sie z.B. das automatische Inhaltsverzeichnis aktivieren. Beispiele für Blöcke sind Absätze, Abschnitte, Listen, abgegrenzte Blöcke, Tabellen und Hinweise.

Blockname

Verweist auf benutzerdefinierte Blöcke, die einen beliebigen Namen einem oder mehreren Kontexten zuordnen. Er hat eine ähnliche Funktion wie der Stil für einen eingebauten Block, z.B. einen Hinweis-Block.

Blockstil

Ist eine Zusatzinformation, die den Kontext eines Blocks spezialisiert. So kann ein Source-Block zusätzlich mit der Sprache des verwendeten Source ergänzt werden.

Bold

siehe Fett

Boolesches Attribut

Ist ein eingebautes Attribut, das wie ein Umschalter funktioniert. Es kann nur zwei Zustände angeben: wahr oder falschan oder aus. Der Nutzen besteht also darin, eine Funktion oder ein Verhalten zu aktivieren.

Buch

Baut auf dem Doctype Artikel auf und bietet zusätzlich die Möglichkeit, einen Top-Level-Titel als Teiltitel zu verwenden. Es enthält den Anhang, die Widmung, das Vorwort, die Bibliographie, das Glossar, den Index und das Kolophon. Ein Buch kann entweder nur Kapitel, oder zusätzlich verschiedene Teile enthalten, die wiederum ein oder mehrere Kapitel enthalten.

C

CLI

Ist die Abkürzung für die Kommandozeile (engl.: command-line interface). Häufig wird diese auch als Befehlszeile, Konsole oder Terminal bezeichnet. Man versteht darunter einen Eingabebereich für die Steuerung einer Software. Dies findet typischerweise im Textmodus statt.

CSS (Cascading Style Sheets)

Ist ein Satz von Anweisungen oder eine Vorlage mit Einstellungen zur Gestaltung eines Dokuments. Durch unterschiedliche CSS wird ein Dokument oder eine Webseite gleichen Inhalts völlig anders dargestellt. In adoc Studio gestalten Sie sowohl HTML als auch PDF mit CSS. Zusätzlich binden Sie optional eigene .css-Dateien in ein Projekt per :stylesheet: ein.

D

DocBook

Ist ein Dokumentformat, das in einer für Standard Generalized Markup Language (SGML) und Extensible Markup Language (XML) vorliegenden Dokument-Typ-Definition (DTD) festgelegt ist. Es eignet sich zur Erstellung von Büchern, Artikeln und Dokumentationen im technischen Umfeld (Hardware oder Software). DocBook ist ein offener Standard, der von der Organization for the Advancement of Structured Information Standards (OASIS) gepflegt wird.

DocInfo

Diese Funktion von AsciiDoc ermöglicht es Ihnen, benutzerdefinierte Inhalte in den Kopf, die Kopfzeile oder die Fußzeile eines Ausgabedokuments einzufügen. Dieser Inhalt wird von Konvertern aus Dateien gelesen, die als Docinfo-Dateien bekannt sind. Docinfo-Dateien ergänzen bequem die von einem Konverter erzeugte Ausgabe. Beispiele umfassen das Einfügen von zusätzlichen Metadaten, Stylesheets und Skriptlogik, die vom Konverter nicht bereits unterstützt wird.

Dokument (oder auch alleinstehendes Dokument)

Eine Datei in adoc Studio nennen wir Dokument. Es liegt im reinen Textformat vor. Ein Dokument kann aus einem einzigen Satz (oder einem einzigen Zeichen, um genau zu sein) bestehen.

Dokumentattribut

Werden verwendet, um entweder das Verhalten im Prozessor zu konfigurieren oder Informationen über das Dokument und seine Umgebung zu übermitteln. Eine Ergänzung zu den Dokumentattributen sind die Elementattribute. Es gibt eingebaute und benutzerdefinierte Attribute.

Docs as Code (Dokumentieren wie Programmieren)

Bezieht sich auf die Philosophie, die Dokumentation mit den gleichen Mitteln wie den Programmcode einer Software schreiben sollte. Das bedeutet, dass die gleichen Arbeitsabläufe wie Entwicklungsteams zu befolgen und in das Produktteam zu integrieren sind. So wird eine Kultur ermöglicht, in der sich sowohl Autoren als auch Entwickler für die Dokumentation verantwortlich fühlen und gemeinsam daran arbeiten, sie so gut wie möglich zu gestalten.

Dokumentkopf (Document Header)

Ein AsciiDoc-Dokument beginnt mit einem Dokumentkopf. Der Dokumentkopf kann den Dokumenttitel, Autoren- und Revisionsinformationen, dokumentweite Attribute und andere Metadaten zum Dokument enthalten. Weiterhin müssen im Dokumentkopf viele Dokumentattribute definiert sein.

Dokumententyp (Doctype)

Legt die erwartete Struktur eines AsciiDoc-Dokuments fest. In adoc Studio werden Artikel (als Standard) und Bücher angeboten.

E

Editor

Ist ein Programm(-teil) für die Erstellung und Modifikation von Texten. In adoc Studio ist der Editor im mittleren Fensterbereich angeordnet. Er bietet Spezialfunktionen, wie die intelligente Textvervollständigung, um beim Schreiben zu unterstützen. Der Editor kann in adoc Studio durch in einer Programm-Einstellung gestaltet werden.

Eingebautes Attribut

Ist ein Dokumentattribut für die Verarbeitung des AsciiDoc-Dokuments. Es kann die Integration, das Styling, die Lokalisierung und mehr steuern.

Element

Ist ein identifizierbarer Teil des Inhalts in einem Dokument. Ein AsciiDoc-Dokument ist immer eine Komposition aus allen darin enthaltenen Elementen.

Elementattribut

Definieren die integrierten und benutzerdefinierten Einstellungen und Metadaten. Sie werden auf ein einzelnes Blockelement oder Inline-Element in einem Dokument (einschließlich Makros) angewendet.

Encoding

Die meisten AsciiDoc-Verarbeiter – wie auch adoc Studio – gehen davon aus, dass der Text in der Datei die Kodierung UTF-8 verwendet. Kodierungen in UTF-16 werden nur unterstützt, wenn die Datei mit einem BOM beginnt.

Ermahnung

siehe Hinweise

Export

Die Ausgabe einer adoc-Datei erfolgt in einem Format, wie HTML oder PDF. Ein Export kann eigene Stile und Attribute haben, die entweder im AsciiDoc-Dokument, oder im Export-Dialog vergeben werden. Die Ausgabe kann in eine Datei erfolgen und optional direkt mit anderen Programmen geteilt werden.

F

Feste Zeilenumbrüche

Da benachbarte Textzeilen in AsciiDoc bei der Konvertierung zu einem Absatz zusammengefasst werden, setzen Sie jeden Satz oder jede Phrase in eine eigene Zeile. Die Zeilenumbrüche werden in der Ausgabe nicht angezeigt. Um Absätze voneinander zu trennen, genügt eine zusätzliche Leerzeile. Dieses Verfahren wird gerne im Arbeitsprinzip Doc as Code angewandt. Wenn Sie jedoch möchten, dass die Zeilenumbrüche in einem Absatz erhalten bleiben, geben Sie ein Leerzeichen gefolgt von einem Pluszeichen (+) ein, oder fügen die Option "Harte Umbrüche" [%hardbreaks] für den Absatz ein.

Fett

Bei fett gedruckter Text hebt sich das Gewicht eines Texts mit einer dickeren und/oder dunkleren Schriftart vom normalen Text ab. Das Formatierungszeichen für Fettdruck ist ein Sternchen * vor und hinter dem Wort.

In adoc Studio wird die Darstellung des fett ausgegebenem Text in PDF und HTML durch CSS bestimmt.

Formatierungszeichen und -paare

Eine Formatierungsmarke ist ein symbolisches Zeichen wie *, _ oder ~, das den Inline-Stil angibt, den der AsciiDoc-Konverter auf den Text anwenden soll. Formatierungszeichen gibt es immer in Paaren. Ein Formatierungspaar besteht aus einem identischen öffnenden und schließenden Zeichen, das den zu formatierenden Text umschließt. Der formatierte Text (d.h. der von einem Formatierungspaar umschlossene Text) kann sich über mehrere, zusammenhängende Zeilen erstrecken. Die Anfangsmarke gibt an, wo die Formatierung beginnen soll. Die Schlussmarkierung gibt an, wo die Formatierung enden soll.

G

Git

Das ist eine freie Software zur verteilten Versionsverwaltung von Dateien, die 2005 durch Linus Torvalds initiiert wurde. Alle Texte und Medien aus adoc Studio werden in einem Git Repository versioniert.

Gliederung

Eine Gliederung ist die strukturelle Aufteilung eines Ganzen – in adoc Studio eines Textes – in logisch angeordnete Teile, um Übersichtlichkeit zu schaffen.

adoc Studio enthalt in der Programmobverzusätzliche Gliederungen: Der Dateinavigator und Abschnittsnavigator in der Seitenleiste, die Überschriftsstruktur über dem Editor und weitere.

Glossar

Ein Glossar ist eine Liste von Wörtern mit beigefügten Bedeutungserklärungen oder Übersetzungen. Als Anhang eines Werkes wird ein Glossar auch als Wörterverzeichnis bezeichnet, ein eigenständiges Glossar als Wörterbuch. Sie lesen gerade im Glossar von adoc Studio.

H

Header-Attribut

Ein Header-Attribut ist ein Dokumentattribut, das im Kopfbereich eines Dokuments definiert ist. Es ist von allen Knoten im Dokument aus sichtbar und wird oft für globale Attribute benötigt, z.B. für den Icon-Modus: :icons: font.

Hervorhebung

siehe Markierung

Hinweis (engl. Admonition)

Mit Hinweisen lenken Sie die Aufmerksamkeit auf bestimmte Aussagen, indem Sie den Block oder Absatz aus dem Fluss des Inhalts herausnehmen. Mit einem von fünf Typen (NOTE, TIP, IMPORTANT, CAUTION, WARNING) definieren Sie die Darstellung. Ein Hinweis kann als Absatz oder als Absatz definiert werden.

Hochgestellt (engl. superscript)

Hochgestellter Text wird häufig in mathematischen Ausdrücken und chemischen Formeln verwendet. Das Formatierungszeichen für hochgestellte Schrift ist ein Caret.

HTML

Die Hypertext Markup Language (HTML) ist eine textbasierte Auszeichnungssprache zur Strukturierung elektronischer Dokumente wie Texte mit Hyperlinks, Bildern und anderen Inhalten. HTML-Dokumente sind die Grundlage des World Wide Web und werden von Webbrowsern dargestellt.

I

ID-Attribut oder Anker

Mit einem Anker können Sie einem Block- oder Inline-Element einen Identifikator (d.h. einen eindeutigen Namen) zuweisen. Es dient dazu, das Element bei der Verknüpfung als Sprungziel oder der Gestaltung zu identifizieren.

Index

Sie können Indexbegriffe in AsciiDoc-Inhalten explizit markieren. Indexbegriffe bilden ein kontrolliertes Vokabular, mit dem Sie ausgehend von einem Index nach Stichworten im Dokument navigieren können.

Inhaltsmodell

Das Inhaltsmodell eines Blocks bestimmt, welche Art von Inhalt der Block haben kann und wie dieser Inhalt verarbeitet wird (z.B. einfach, zusammengesetzt, wortwörtlich, unbearbeitet, usw.).

Inline

Der Inline-Doctype ermöglicht es dem AsciiDoc-Prozessor, die gesamte Bandbreite an Anwendungen abzudecken, von unstrukturiertem (Inline-)Text bis hin zu vollständigen, eigenständigen Dokumenten.

Inline-Element

Ein Inline-Element ist eine Phrase (d.h. eine Inhaltsspanne) innerhalb eines Blockelements oder eines seiner Attribute in einem AsciiDoc-Dokument. Sie werden zur Formatierung von Text und zur Durchführung verschiedener Arten von Textersetzungen verwendet. Inline-Elemente und die Syntax von Inline-Elementen werden in den Konfigurationsdateien definiert. Die Konvertierung von Inline-Dokumenten ist in adoc Studio noch nicht implementiert.

Italic

siehe Kursiv

Integrierte Schreibumgebung (Integrated Writing Environment – kurz: IWE)

Ist eine Software, die umfassende Schreib- und Wissensmanagement-Funktionen für Autoren und Informationsmitarbeiter bietet. So auch adoc Studio. IWEs ermöglichen es Autoren und Informationsmitarbeitern, eine Vielzahl von Aufgaben im Zusammenhang mit dem Dokument in der IWE in einer einzigen Umgebung durchzuführen. Im optimalen Fall werden auch Prinzipien, wie Docs as Code unterstützt. Dies sorgt für einen ablenkungsfreien Arbeitsbereich und eine optimierte Schreibumgebung.

J

K

Kapitel

Ist eine inhaltlich trennende Unterteilung in Texten. In adoc Studio sprechen wir bei den Dateien in Sammeldokumenten von Kapiteln.

Keywords

Das Attribut :keywords: enthält eine Liste von durch Kommata getrennten Werten, die dem HTML <meta>-Element zugewiesen werden.

Kodierung

siehe Encoding

Kolophon (auch Subskription)

Ist ein Element eines Buches und steht in der Regel am Schluss. Enthalten sind Informationen unter anderem über Inhalt, Verfasser, Ort, Zeit, Hersteller, Auftraggeber und Produktionsdetails der Veröffentlichung.

Konverter

Ist eine Softwarekomponente, die ein AsciiDoc-Prozessor aufruft, um ein AsciiDoc-Dokument in ein bestimmtes Ausgabeformat zu konvertieren.

Kursiv (engl. Italic)

Text wird oft kursiv gesetzt, um ein Wort oder einen Satz zu betonen, einen Sprecher zu zitieren oder einen Begriff einzuführen. Kursive Schrift ist leicht nach rechts geneigt und kann, je nach Schriftart, kursive Schwünge und Schnörkel aufweisen. Das Formatierungszeichen für kursiv ist ein Unterstrich.

L

M

Makro

Ist eine Syntax zur Darstellung von Nicht-Text-Elementen oder einer Syntax, die sich mithilfe der bereitgestellten Metadaten in Text verwandelt. Siehe Makro, um mehr über die Bedeutung dieses Begriffs zu erfahren.

Makro-Attribut

Ist ein Attribut, das mit einem Block- oder Inline-Makro verbunden wird. Diese Attribute können die Verarbeitung des Makros beeinflussen, können aber nicht über eine Attributreferenz referenziert werden.

Markdown

Eine vereinfachte Auszeichnungssprache, die im Dezember 2004 von John Gruber und Aaron Swartz veröffentlicht wurde.

Markierung

Eine weitere Möglichkeit, die Aufmerksamkeit auf Text zu lenken, ist es diesen durch eine Markierung hervorzuheben. Dieser semantische Stil wird zu Referenz- oder Notationszwecken verwendet oder um die Bedeutung eines wichtigen Themas oder Punktes hervorzuheben. Das Formatierungszeichen für Markierung ist eine Raute #.

Medienordner

In adoc Studio hat der Medienordner einige besondere Funktionen. Wird er selektiert, werden alle enthaltenen Medien als Vorschau angezeigt. Es können beliebig viele Medienordner angelegt werden.

Metadaten

Sind strukturierte Daten, die übergreifende Informationen über eine Ressource - wie Bücher, Webdokumente, Videos oder Bilder - beinhalten. Auf ein Dokument bezogen sind es z.B. eine Beschreibung des Dokuments, Schlüsselwörter und benutzerdefinierte Informationen, die als Attribute im DokumentenKopf zugewiesen werden können. Bei der Konvertierung in HTML entsprechen die Werte dieser Attribute den Elementen, die im <head>-Abschnitt eines HTML-Dokuments enthalten sind.

Monospace

Bei technischen Inhalten muss der Text oft so gestaltet werden, dass er auf einen Befehl oder einen Quellcode hinweist. Solcher Text wird in der Regel mit einer Schriftart mit fester Breite (d.h. Monospace) hervorgehoben. Das Formatierungszeichen für Monospace ist ein Backtick (auch Gravis oder Gravis Akzent).

N

O

Ordner

Ist ein Verzeichnis innerhalb einer Datenstruktur. In adoc Studio können beliebig viele Ordner – auch verschachtelt – angelegt werden. In Sammeldokumenten kann ein Ordner selektiert werden um die darin enthaltenen Kapitel in der Vorschau kombiniert anzuzeigen.

P

Parser

Ein Parser ist ein Computerprogramm, das in der Informatik für die Zerlegung und Umwandlung einer Eingabe in ein für die Weiterverarbeitung geeigneteres Format zuständig ist. Für technisch interessierte: Der Parser in adoc Studio ist nach Vorbild von AsciiDoc in Swift geschrieben. Es ist eine Migration, keine Kopie oder direkte Portierung.

PDF (Portable Document Format)

Ist ein plattformunabhängiges Dateiformat, das 1992 von Adobe Inc. entwickelt und veröffentlicht wurde. Elektronische Dokumente in diesem Dateiformat können unabhängig vom ursprünglichen Anwendungsprogramm, vom Betriebssystem oder von der Hardwareplattform originalgetreu wiedergegeben werden.

Seit v4 wird durch setzen des Attributs :ads-pdf-ua: die barrierefreie Version des PDF-Standards unterstützt.

Plaintext

Bezeichnet in der IT die Daten, die ohne eine Formatierung versehen, menschenlesbar sind und daher unmittelbar unter Verwendung von Schriftzeichen in Text umgesetzt werden können. Die AsciiDoc-Dokumente in adoc Studio verwenden Plaintext.

Präambel

Ist der Inhalt des ersten Abschnitts nach dem Ende des Dokumentenkopfs. Eine Präambel ist in AsciiDoc optional.

Präprozessoranweisung

Ist eine Funktion, die die Zeilen steuert, die in den Parser eingegeben werden. Eine bedingte Präprozessoranweisung kann Zeilen so konfigurieren, dass sie aufgrund des Vorhandenseins eines Attributs (ifdef, ifndef) oder einer anderen beliebigen Bedingung (ifeval) einbezogen oder ausgeschlossen werden. Eine Include-Direktive kann dem Dokument zusätzliche Zeilen hinzufügen, die aus einem anderen Dokument stammen.

Preprocessor Directive

siehe Präprozessoranweisung

Produkte

Sind eine logische Zusammenfassung vieler Exports. Innerhalb eines Produktes können viele Exporte angelegt werden, die wiederum eigene Stile und Attribute und Ausgabeformate haben können.

Produktstile

In adoc Studio ist Text von der Gestaltung getrennt. Also muss eine Technik beide miteinander verbinden. Diese Aufgabe erfolgt mithilfe der Produktstile. Ein Produktstil ist ein Datei-Bundle, in dem sich mindestens neben einer Informationsdatei, die Stildatei im CSS-Format befindet. Optional können weitere Ressourcen wie Medien oder Schriften enthalten sein.

Projekt

Ist in adoc Studio eine Zusammenfassung aller AsciiDoc-Dateien und Ordner, inkl. der Medienordner. Zusätzlich können Projekte auch weitere Dateien, wie CSS-Dateien und andere, enthalten. Es wird in adoc Studio über den Projekt-Navigator organisiert und verwaltet. Zusätzlich findet mit dem Verzeichnis im Betriebssystem einen stetige Synchronisierung statt. So kann das Projekt auch im Finder modifiziert werden.

Q

Quelltext

Ist ein für Menschen lesbarer in einer Programmiersprache geschriebener Text eines Computerprogramms. In dem Arbeitsprinzip Docs as Code wird der AsciiDoc-Text auch oft als Quelltext bezeichnet.

R

Rolle

Blöcken und den meisten anderen Inline-Elementen können mit dem Attribut role eine oder mehrere Rollen zuweisen. Eine Rolle fügt einem Element zusätzliche Semantik hinzu, um zum Beispiel einen zusätzlichen Stil zu vergeben (über einen CSS-Selektor).

RTF (Rich Text Format)

Ist ein proprietäres Dateiformat für Texte, das 1987 von Microsoft eingeführt wurde. Es kann als Austauschformat zwischen Textverarbeitungsprogrammen verschiedener Hersteller auf verschiedenen Betriebssystemen dienen. In adoc Studio kann die Vorschau auf Text eingestellt werden, was dem Rich Text Format entspricht. Auch für den Export und innerhalb der Produkte ist dieses Format wählbar.

S

Sammeldokument

Ist in adoc Studio eine eigene Dokumentart und steht im Kontrast zu den alleinstehenden Dokumenten. Sie sammeln viele Kapitel zu einem großen Dokument. Es können innerhalb eines Sammeldokuments viele Ordner und Medienordner für die weitere Strukturierung angelegt werden. Alle Ordner können selektiert werden, um die darunter liegenden Kapitel in der Vorschau kombiniert darzustellen. Attribute, die irgendwo im Sammeldokument definiert wurden, können in jedem Kapitel des Sammeldokuments verwendet werden.

Schlüsselwörter

siehe Keywords

Section

siehe Abschnitt

Stylesheet

Ist am ehesten mit einer Formatvorlage zu vergleichen. Grundidee hierbei ist die Trennung von Text und Darstellung. Das Programm, das das Stylesheet auswertet, interpretiert die zugewiesenen Daten (Text, Tabellen, Grafiken etc.) und formatiert sie nach den vorgegebenen Regeln. Die Cascading Stylesheets sind wohl das bekannteste Beispiel für ein Stylesheet. In adoc Studio können eigene Stylesheets als .css-Dateien in das Projekt gelegt und mit dem Attribut :stylesheet: genutzt werden.

Sub-Titel

Ein Dokument-Titel kann um einen zweiten Titel (auch Untertitel genannt) ergänzt werden. Entgegen der Definition in AsciiDoc, wird dieser in adoc Studio nicht nur imPDF, sondern auch im HTML gesetzt.

Syntax

Man versteht im allgemeinen darunter ein Regelsystem zur Kombination verschiedener Zeichen, die zu einem natürlichen oder künstlichen Systemen zusammengesetzt werden. Die Regeln der Syntax stehen hierbei den Interpretationsregeln der Semantik gegenüber. Der Befehlsumfang einer Sprache, wie AsciiDoc, wird gerne als Syntax bezeichnet.

T

Teil (engl. Part)

Im Sinne eines mehrteiligen Buchs ist ein Teil eine zusätzliche Unterteilung. Ein Teil kann wiederum eigene Kapitel oder Anhänge enthalten.

Text

Umgeben von den Markierungen, Begrenzungszeichen und Metadatenzeilen befindet sich der Text. Der Text ist der Schwerpunkt eines Dokuments und der Grund, warum die AsciiDoc-Syntax ihm so viel Raum zum Atmen gibt. Text findet sich am häufigsten in den Zeilen eines Blocks (z. B. Absatz), im Blocktitel (z. B. Abschnittstitel), in Listenelementen und anderen Stellen. Text unterliegt Ersetzungen. Ersetzungen interpretieren Markup als Textformatierung, ersetzen Makros durch Text oder Nicht-Text-Elemente, erweitern Attributreferenzen und führen andere Arten von Textersetzungen durch. Normaler Text unterliegt allen Ersetzungen, sofern nicht anders angegeben. Wörtlicher Text unterliegt einem minimalen Satz von Ersetzungen, damit er in der Ausgabe so angezeigt werden kann, wie er im Quelltext erscheint. Es ist auch möglich, alle Ersetzungen zu deaktivieren, um den Text unverändert (d. h. unbearbeitet) an die Ausgabe weiterzugeben. Das Parsen des Textes besteht aus einer Mischung von Inline-Elementen und anderen Formen von Transformationen.

Text-Clipping v3

Wird Text aus dem Editor oder der Vorschau auf den Schreibtisch oder in ein Finder-Fenster gezogen, erstellt adoc Studio automatisch ein Text-Clipping in dem entsprechenden Format. Dieses Text-Clipping kann wiederum in adoc Studio und andere Apps gezogen werden, um den enthaltenen Text dort einzufügen.

Textformatierung

AsciiDoc stellt eine Reihe von Formatierungszeichen zur Verfügung, mit denen Sie Ihr Dokument optisch hervorheben und typografische Interpunktion verwenden können. Sie können auf diese grundlegenden Formatierungszeichen mit Hilfe von integrierten und benutzerdefinierten Rollen aufbauen. Beispiele sind: fett, kursiv, hervorheben usw.

Textvervollständigung (intelligente oder automatische)

Eine Technik, die nach der Eingabe von zwei bis drei Buchstaben im Editor erkennt, dass an der aktuellen Schreibposition zum Kontext passende Attribute, Makros oder anderes möglich ist. Wichtig ist dabei, dass der Mensch im Schreibfluss nicht blockiert, sonder nur unterstützt wird. Sie wird auch gerne zur Zeitersparnis eingesetzt.

Tiefgestellt (engl. subscript)

Tiefgestellter Text wird häufig in mathematischen Ausdrücken und chemischen Formeln verwendet. Das Formatierungszeichen für tiefgestellt ist eine Tilde.

U

Umgebungsattribut

Ein Umgebungsattribut ist ein dynamisches Dokumentattribut, das sich auf die Laufzeitumgebung bezieht oder Informationen darüber liefert.

UTF-8

siehe Encoding

V

Versionsverwaltung

Eine Versionverwaltung (wie zum Beispiel Git) dient dazu mehrere Versionen eines Dokumentes platzsparend zu verwalten. Bei den meisten Versionsverwaltungssystemen wird neben dem Originaldokument, nur noch die Änderungen gespeichert, die notwendig sind um eine bestimmte Version zu erzeugen. Ausserdem wird durch eine Versionsverwaltung das gemeinsame Arbeiten an ein und demselben Dokument ermöglicht.

Vordefiniertes Attribut

Ein vordefiniertes Attribut ist ein Dokumentattribut, das aus Gründen der Bequemlichkeit definiert wurde. Es wird oft zum Einfügen von Sonderzeichen für den Inhalt verwendet.

Vorschau

In der Vorschau stellt adoc Studio alle Inhalte vom Editor in verschiedenen Formaten dar. Es steht HTML, PDF und RTF Text zur Verfügung. Jedes Ausgabeformat kann mit einem Stil formatiert werden.

Vorwort

Ein Vorwort ist ein besonderer Abschnitt, der dem ersten Kapitel eines Buches oder eines Buchteils vorausgeht. In AsciiDoc ist das Vorwort ein eigener Blocktyp, der vorzugsweise in Büchern verwendet wird.

W

Webseite

Ist ein Produkt oder Export, der ein Projekt als eigenständige Webseite exportiert. Das Resultat kann sowohl offline, auf dem lokalen Rechner, als auch online auf einem Webserver betrachtet werden.

Widmung

Wird verwendet, um Dankbarkeit gegenüber Dritten auszudrücken. In AsciiDoc ist die Widmung ein eigener Blocktyp, der vorzugsweise in Büchern verwendet wird.

X

Y

Z

Zeile

AsciiDoc ist eine zeilenorientierte Sprache, daher ist die Zeile ein wichtiges Konstrukt. Eine Zeile ist definiert als Text, der auf beiden Seiten entweder durch einen Zeilenumbruch oder durch die Begrenzung des Dokuments getrennt ist. Viele Aspekte der Syntax müssen eine ganze Zeile einnehmen. Bei arbeiten nach Docs as Code, ist die einzelne Zeile besonders wichtig, da auf ihr Änderungen in einem Git einfacher erkannt werden.

Zitat, zitierter Text

Text, der von einer speziellen Interpunktion umgeben ist, um andere Autoren zu zitieren, oder dem Text eine besondere Bedeutung zu verleihen.

Zusammenfassung

siehe Abstract