Anhang A: Support
Herzlichen Glückwunsch!
Bis hierhin wurden die Konzepte und Funktionen vorgestellt, jetzt sind Sie an der Reihe:
Schreiben Sie uns und berichten Sie von Ihren Erfahrungen!
A.1. Systemanforderungen
Für die Nutzung von adoc Studio werden mindestens folgende Systeme benötigt:
-
macOS 14 Sonoma
-
iOS 18
A.2. Erste Hilfe
- Forum
-
Ein kostenloses Forum steht zur Verfügung, in dem Sie Unterstützung von anderen Nutzer:innen und vom Team der ProjectWizards erhalten.
- AsciiDoc-Befehlsreferenz
-
Die stets aktuelle AsciiDoc-Befehlsreferenz finden Sie online. Derzeit nur auf Englisch; eine deutsche Übersetzung ist in Planung..
- Eigene Erfahrungen mit AsciiDoc
-
Im Blog der ProjectWizards-Webseite gibt es zahlreiche praktische Artikel und Tipps rund um AsciiDoc.
- Tipps zu AsciiDoc
-
Eine umfangreiche Sammlung von Tricks und Anleitungen bietet Awesome Asciidoc(tor).
A.3. Hilfe mit Vorlagen und Stilen
Zur Zeit entsteht ein Partnernetzwerk, das Ihnen gerne beim Aufbau Ihrer Vorlagen und der Gestaltung der Produktstile hilft. Die aktuelle Liste der Partner finden Sie auf unserer Webseite. Im Laufe der Zeit wird dort auch ein Verzeichnis aller Stile aufgebaut. Möchten Sie aktiv mitwirken, schreiben Sie an: office@projectwizards.net.
A.4. Attribute
Das Konzept und die Anwendung von Attributen wird im Kapitel Attribute erläutert. Im Folgenden finden Sie eine Übersicht aller in adoc Studio verfügbaren Attribute.
adoc Studio Attributes
- ads-compat-mode
-
Wenn gesetzt, wird die Kompatibilität mit Asciidoctor maximiert. Zum Beispiel werden Datums- und Zeitangaben nicht lokalisiert, Autorennamen werden anders aufgeteilt und Icon-Verzeichnisse zeigen an andere Orte. Auch andere AsciiDoc-Modernisierungen werden ebenfalls deaktiviert, wie source-highlighter oder stem.
- ads-device v3
-
Enthält Mac, iPhone oder iPad. Je nachdem, auf welchem Gerät Sie adoc Studio verwenden.
- ads-max-image-resolution v3
-
Legen Sie die maximale Auflösung für Bilder in HTML- und PDF-Exporten fest. Geben Sie die Auflösungswerte in dpi, dpcm oder dppx an. Für HTML wirkt sich diese Einstellung nur auf Bilder aus, für die Sie im Quelltext eine Breite oder Höhe explizit angegeben haben. Um die Größe von Bildern ohne vorgegebene Breite oder Höhe in HTML zu begrenzen, setzen Sie das Attribut ads-max-image-width.
- ads-max-image-width v3
-
Legen Sie für den HTML-Export die maximale Pixelbreite für diejenigen Bilder fest, für die Sie im Quelltext keine Breite oder Höhe angegeben haben.
- ads-pdf-ua v4
-
Wenn gesetzt, fügen PDF-Exporte Barrierefreiheitsinformationen gemäß dem PDF/UA-Standard hinzu. Dieses Attribut ist Standardmäßig nicht aktiv.
- ads-platform
-
Enthält macOS oder iOS. Je nachdem, auf welcher Plattform Sie adoc Studio verwenden.
- ads-static-stem
-
Standardmäßig werden STEM-Gleichungen in HTML-Exporten dynamisch per JavaScript erstellt, wenn Sie das exportierte Dokument in einem Webbrowser öffnen. Wenn diese Option aktiviert ist, werden die Gleichungen als statische SVG-Bilder exportiert, sodass kein JavaScript für die Anzeige erforderlich ist.
- ads-static-stem → external
-
Exportiert STEM-Gleichungen als externe SVG-Bilder.
- ads-static-stem → inline
-
Exportiert STEM-Gleichungen als Inline-SVG-Elemente
- ads-subtitle
-
Gibt den Subtitel aus.
Intrinsische Attribute
- backend
-
Immer auf html5 gesetzt, um die Kompatibilität mit Asciidoctor zu gewährleisten.
- backend-html5
-
Immer gesetzt für Kompatibilität mit Asciidoctor.
- basebackend
-
Immer auf html5 gesetzt, um die Kompatibilität mit Asciidoctor zu gewährleisten.
- basebackend-html
-
Immer gesetzt für Kompatibilität mit Asciidoctor.
- docdate
-
Datum der letzten Änderung des Quelldokuments ohne Zeitangabe. Lokalisiert entsprechend der Sprache und dem Sprachraum, die mit dem Attribut lang angegeben werden.
- docdatetime
-
Datum und Uhrzeit der letzten Änderung des Quelldokuments. Lokalisiert entsprechend der Sprache und dem Sprachraum, die mit dem Attribut lang angegeben werden.
- docdir
-
Pfad zu dem Verzeichnis, in dem sich das Quelldokument befindet. Der Pfad beginnt mit einem Schrägstrich und dem Wurzelverzeichnis des Projekts.
- docfile
-
Pfad zum Quelldokument. Der Pfad beginnt mit einem Schrägstrich und dem Wurzelverzeichnis des Projekts.
- docfilesuffix
-
Dateiendung des Quelldokuments einschließlich des führenden Punkts.
- docname
-
Name des Quelldokuments ohne Dateiendung.
- doctime
-
Letzter Änderungszeitpunkt des Quelldokuments. Lokalisiert entsprechend der Sprache und dem Sprachraum, die mit dem Attribut lang angegeben werden.
- docyear
-
Jahr, in dem das Quelldokument zuletzt geändert wurde. Lokalisiert entsprechend der Sprache und dem Sprachraum, die mit dem Attribut lang angegeben werden.
- embedded
-
Kann als Option für einen HTML-Export festgelegt werden. Das erzeugte HTML enthält dann keine Head- oder Body-Elemente und kann somit direkt in eine andere HTML-Seite eingebettet werden.
- filetype
-
Dateierweiterung der eigentlichen Ausgabedatei des Dokuments, ohne führenden Punkt. Der Wert is abhängig vom gewählten Ausgabeformat.
- filetype-html
-
Ein Hilfsattribut, mit dem Sie testen können, ob der Dateityp der Ausgabe html ist.
- filetype-pdf
-
Ein Hilfsattribut, mit dem Sie testen können, ob der Dateityp der Ausgabe pdf ist.
- filetype-rtfd
-
Ein Hilfsattribut, mit dem Sie testen können, ob der Dateityp der Ausgabe rtfd (Rich Text) ist.
- filetype-txt
-
Ein Hilfsattribut, mit dem Sie testen können, ob der Dateityp der Ausgabe txt (reiner Text) ist.
- filetype-website v4
-
Ein Hilfsattribut, mit dem Sie testen können, ob die Ausgabe eine Webseite ist.
- htmlsyntax
-
Derzeit immer html, da adoc Studio noch keine .xhtml-Ausgabe unterstützt.
- outfilesuffix
-
Dateierweiterung der eigentlichen Ausgabedatei des Dokuments, mit führendem Punkt. Der Wert ist abhängig vom gewählten Ausgabeformat.
- localdate
-
Datum, an dem das Dokument in das Ausgabeformat konvertiert wurde.
- localdatetime
-
Datum und Uhrzeit, zu der das Dokument in das Ausgabeformat konvertiert wurde.
- localtime
-
Uhrzeit, zu der das Dokument in das Ausgabeformat konvertiert wurde.
- localyear
-
Jahr, in dem das Dokument in das Ausgabeformat konvertiert wurde.
Compliance Attributes
- attribute-missing
-
Steuert, wie fehlende Attributreferenzen behandelt werden.
- attribute-missing → skip
-
Belässt den nicht aufgelösten Verweis an Ort und Stelle und erzeugt einen Fehler
- attribute-missing → drop
-
Entfernt den Verweis.
Lokalisierungs- und Nummerierungsattribute
- lang
-
Sprach-Tag wie de oder de-CH. Wird dem Wurzelelement der HTML-Ausgabe hinzugefügt. Steuert die Silbentrennung und Lokalisierung von Datumsangaben.
- appendix-caption
-
Text, der vor dem Titel eines Anhangs hinzugefügt wird.
- appendix-number
-
Setzt den Startwert für die Nummerierung von Anhängen.
- Callouts
-
Callout-Nummern (auch Callouts genannt) bieten die Möglichkeit, Anmerkungen zu Zeilen in einem Verbatim-Block hinzuzufügen.
- caution-caption
-
Text, mit dem CAUTION-Hinweise beschriftet werden, wenn Symbole nicht aktiviert sind.
- chapter-number
-
Setzt den Startwert für die Nummerierung der Kapitel (Abschnittsüberschriften der Ebene 1), wenn Sie den doctype book verwenden.
- chapter-signifier
-
Text, der dem Titel von Ebene 1-Abschnitten (Kapitel) hinzugefügt wird, wenn Sie den doctype book verwenden.
- example-caption
-
Text zur Beschriftung von Beispielblöcken.
- example-number
-
Legt den Startwert für die Nummerierung von Beispielen fest. Wird nur verwendet, wenn das Attribut example-caption gesetzt ist und das Beispiel einen Titel hat.
- figure-caption
-
Text, der zur Beschriftung von Bildern und Abbildungen verwendet wird.
- figure-number
-
Legt den Startwert für die Nummerierung von Abbildungen fest. Wird nur verwendet, wenn das Attribut figure-caption gesetzt ist und die Abbildung einen Titel hat.
- important-caption
-
Text, mit dem IMPORTANT-Hinweise beschriftet werden, wenn Symbole nicht aktiviert sind.
- last-update-label
-
Text, der vor dem letzten Änderungsdatum in der Fußzeile angezeigt wird.
- listing-caption
-
Text zur Beschriftung von Listing-Blöcken.
- listing-number
-
Legt den Startwert für die Nummerierung von Listings fest. Wird nur verwendet, wenn das Attribut listing-caption gesetzt ist und das Listing einen Titel hat.
- note-caption
-
Text, mit dem NOTE-Hinweise beschriftet werden, wenn Symbole nicht aktiviert sind.
- table-caption
-
Text, der Tabellentiteln vorangestellt ist.
- table-number
-
Legt den Startwert für die Nummerierung von Tabellen fest. Wird nur verwendet, wenn das Attribut table-caption gesetzt ist und die Tabelle einen Titel hat.
- tip-caption
-
Text, mit dem TIP-Hinweise beschriftet werden, wenn Symbole nicht aktiviert sind.
- toc-title
-
Titel für das Inhaltsverzeichnis.
- untitled-label
-
Standard-Dokumententitel, wenn das Dokument keinen Titel hat.
- version-label
-
Die Bezeichnung, die vor der Revisionsnummer in der Zusatzzeile des Dokumenttitels angezeigt wird.
- warning-caption
-
Text, mit dem WARNING-Hinweise beschriftet werden, wenn Symbole nicht aktiviert sind.
Attribute für Stile & Layout
- hyphens → none
-
Wörter werden nicht an Zeilenumbrüchen getrennt, auch wenn Zeichen innerhalb der Wörter Trennungen vorschlagen. Der Zeilenumbruch erfolgt nur an Leerzeichen.
- hyphens → manual
-
Wörter werden nur dann für den Zeilenumbruch getrennt, wenn Zeichen innerhalb des Wortes eine Trennung nahelegen.
- hyphens → auto
-
Wörter werden automatisch an den entsprechenden Punkten entsprechend der im Attribut lang gewählten Sprache getrennt. Vorgeschlagene Umbrüche haben jedoch Vorrang vor der automatischen Auswahl der Trennung.
- title-page
-
Stellt eine eigene Titelseite an den Anfang eines PDF-Dokuments. Die Titelseite enthält die Informationen doctitle, author, date und revision-Informationen.
- pagenums
-
Aktiviert die Anzeige von Seitenzahlen in PDF-Dokumenten.
- outline
-
Standardmäßig erzeugt adoc Studio eine PDF-Gliederung für PDF-Dokumente. Sie können dies ausschalten, indem Sie dieses Attribut löschen.
- outline-title
-
Standardmäßig wird der Dokumententitel als Titel der PDF-Gliederung angezeigt. Sie können dies mit diesem Attribut anpassen.
Dokument-Metadata Attribute
- app-name
-
Fügt das Meta-Element application-name für mobile Geräte in den Kopf der HTML-Dokumente ein.
-
Wird standardmäßig aus der Autoreninfozeile extrahiert. Kann ein beliebiges Inline-Makro sein, z. B. eine URL. Kann auch explizit gesetzt werden.
- firstname
-
Wird standardmäßig vom Attribut author abgeleitet. Kann auch explizit gesetzt werden.
- middlename
-
Wird standardmäßig vom Attribut author abgeleitet. Kann auch explizit gesetzt werden.
- lastname
-
Wird standardmäßig vom Attribut author abgeleitet. Kann auch explizit gesetzt werden.
- copyright
-
Wert für das Meta-Element copyright im Kopf des HTML-Dokuments.
- doctitle
-
Standardmäßig auf den Titel des Abschnitts der Ebene 0 eingestellt. Kann explizit eingestellt werden.
- description
-
Wert für das Meta-Element description im Kopf des HTML-Dokuments.
- keywords
-
Wert für das Meta-Element keywords im Kopf des HTML-Dokuments.
- publisher
-
Wird in das Meta-Datenfeld producer von PDF-Dokumenten eingetragen.
- subject
-
Wird in das Meta-Datenfeld subject von PDF-Dokumenten eingefügt.
- revnumber
-
Wird aus der Zeile der Revisionsinformationen entnommen.
- revdate
-
Wird aus der Zeile der Revisionsinformationen entnommen.
- revremark
-
Wird aus der Zeile der Revisionsinformationen entnommen.
- page-background-image
-
Setzen Sie dieses Attribut, um allen PDF-Inhaltsseiten ein Hintergrundbild hinzuzufügen. Als Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- page-background-image-recto
-
Setzen Sie dieses Attribut, um allen PDF-Recto-Seiten ein separates Hintergrundbild hinzuzufügen. Für den Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- page-background-image-verso
-
Setzen Sie dieses Attribut, um allen PDF-Verso-Seiten ein separates Hintergrundbild hinzuzufügen. Für den Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- title-page-background-image
-
Platziert ein Logo als Bild im Inhaltsbereich der Titelseite. Die Titelseite muss über das Attribut title-page aktiviert sein. Als Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- front-cover-image
-
Erzeugt eine separate PDF-Deckseite zu Beginn des Dokuments, die nur ein Bild enthält. Als Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- back-cover-image
-
Erzeugt eine separate PDF-Deckseite am Ende des Dokuments, die nur ein Bild enthält. Als Wert können Sie entweder einen einfachen Pfad zu einem Bild oder ein Inline-Bildmakro angeben. Letzteres erlaubt die Angabe weiterer Attribute zur Kontrolle der Bildgröße und -position.
- pdf-page-size
-
Das Setzen dieses Attributs überschreibt die in der Vorschau oder den Produktoptionen definierte PDF-Seitengröße.
- pdf-page-layout
-
Das Setzen dieses Attributs überschreibt die in der Vorschau oder den Produktoptionen festgelegte Ausrichtung der PDF-Seite im Hoch- oder Querformat.
- pdf-page-margin
-
Das Setzen dieses Attributs überschreibt die in den Vorschau- oder Produktoptionen definierten PDF-Seitenränder.
- pdf-page-margin-rotated
-
Legen Sie separate PDF-Seitenränder für das Querformat fest.
- text-align
-
Überschreibt die Standard-Textausrichtung des gewählten Stils.
Abschnittstitel und Inhaltsverzeichnisattribute
- idprefix
-
Standardmäßig beginnen die automatisch generierten Abschnitts-IDs mit einem Unterstrich. Sie können dies ändern, indem Sie dieses Attribut setzen. Der Wert muss mit einem gültigen ID-Anfangszeichen beginnen und kann eine beliebige Anzahl weiterer gültiger ID-Zeichen enthalten. Wenn Sie das Präfix entfernen möchten, setzen Sie das Attribut auf einen leeren Wert.
- idseparator
-
Das Standard-Worttrennzeichen für die Abschnitts-IDs ist ein Unterstrich. Sie können es mit diesem Attribut ändern. Wenn es nicht leer ist, muss der Wert genau ein gültiges ID-Zeichen sein.
- leveloffset
-
Ändert die Ebenentiefe aller Überschriften um die angegebene Anzahl von Schritten. Der Wert ist relativ und beginnt mit + oder -. So können Sie jedes Kapitel als eigenständiges Dokument veröffentlichen, komplett mit einem Dokumententitel.
- partnums
-
Um Buchteilnummern automatisch zu generieren, setzen Sie dieses Attribut im Buchkopf.
- sectanchors
-
Wenn diese Option aktiviert ist, wird ein Anker (leerer Link) vor den Abschnittsüberschriften eingefügt. Das Standard-Stylesheet zeigt ihn als ein §-Symbol, das links vom Titel des Abschnitts schwebt.
- sectids
-
Abschnitts- und Einzelüberschriften ohne explizit festgelegten Bezeichner erhalten eine automatisch generierte ID. Sie können dies verhindern, indem Sie dieses Attribut löschen. Auf Elemente ohne ID kann nicht querverwiesen werden.
- sectlinks
-
Wenn diese Option gesetzt ist, werden die Titel von Abschnitten in Links umgewandelt. Im Standard-Stylesheet haben sie denselben Stil wie unverknüpfte Abschnittsüberschriften. Verknüpfte Abschnittsüberschriften erleichtern das Erstellen von Lesezeichen in einem Webbrowser.
- sectnums
-
Abschnitte sind standardmäßig nicht nummeriert. Sie können dies jedoch aktivieren, indem Sie dieses Attribut setzen. Sie können die Nummerierung auch im Verlauf eines Dokuments ein- und ausschalten.
- sectnums → all
-
Abschnitte, denen ein eingebauter spezieller Stil zugewiesen ist, werden standardmäßig nicht nummeriert. Um sowohl reguläre als auch spezielle Abschnitte zu nummerieren, weisen Sie sectnums den Wert all zu.
- sectnumlevels
-
Wenn sectnums eingestellt ist, werden die Abschnittsüberschriften der Ebenen 1-3 standardmäßig nummeriert. Sie können die Ebenengrenze auf einen Wert von 0 bis 5 einstellen.
- toc
-
Schaltet das Inhaltsverzeichnis ein und legt seine Position fest. Standardmäßig wird es direkt unter dem Dokumententitel, dem Autor und den Revisionszeilen eingefügt.
- toc → auto
-
Das Inhaltsverzeichnis wird direkt unter dem Dokumententitel, dem Autor und der Revisionszeile eingefügt.
- toc → left
-
Das Inhaltsverzeichnis befindet sich links von der Hauptinhaltsspalte. Es ist feststehend und scrollbar.
- toc → right
-
Das Inhaltsverzeichnis befindet sich rechts von der Hauptinhaltsspalte. Es ist feststehend und scrollbar.
- toc → preamble
-
Das Inhaltsverzeichnis befindet sich unmittelbar unter der Präambel, der Inhalt zwischen dem Ende des Dokumentenkopfs und dem ersten Abschnittstitel.
- toc → macro
-
Platzieren Sie das Inhaltsverzeichnis an einer bestimmten Stelle. Weisen Sie den Wert macro zu, und geben Sie dann das Inhaltsverzeichnis-Blockmakro (toc::[]) in der Zeile in Ihrem Dokument ein, in der das Inhaltsverzeichnis erscheinen soll.
- toclevels
-
Standardmäßig zeigt das Inhaltsverzeichnis Abschnittsüberschriften der Ebenen 1 und 2 an. Verwenden Sie dieses Attribut, um die Tiefe auf einen Wert zwischen 1 und 5 einzustellen.
- toc-class
-
CSS-Klasse für das HTML-Element des Inhaltsverzeichnisses.
- media
-
Aktiviert ein für einen PDF-Medientyp spezifisches Verhalten.
- media → print
-
Zeigt die URLs für Links an, sofern der Linktext nicht mit der URL übereinstimmt.
- media → prepress
-
Zusätzlich zu print werden auch doppelseitige (gespiegelte) Seitenränder und automatisch gegenüberliegende Seiten verwendet.
Allgemeine Inhalts- und Formatierungsattribute
- data-uri
-
Bettet Bilder und andere Medien in HTML-Dateien als data-uri-Elemente ein. Dieses Attribut kommt nur zum Tragen, wenn Sie in den Export-Einstellungen für Ressourcen den Wert Aus Attributen auswählen.
- doctype → article
-
Der Standard-Dokumenttyp. Wenn Sie kein Buch erstellen, müssen Sie sich nicht um das Setzen des doctype kümmern.
- doctype → book
-
Baut auf dem Doctype article auf und bietet zusätzlich die Möglichkeit, einen Titel der obersten Ebene als Teiltitel zu verwenden. Es gibt auch das Konzept des mehrteiligen Buches, aber der Unterschied zu einem normalen Buch wird durch den Inhalt bestimmt. Ein Buch hat nur Kapitel und spezielle Abschnitte, während ein mehrteiliges Buch in Teile unterteilt ist, die jeweils ein oder mehrere Kapitel oder spezielle Abschnitte enthalten.
- hardbreaks-option
-
Behalten Sie die Zeilenumbrüche in allen Absätzen des gesamten Dokuments bei.
- notitle
-
Blendet den Dokumentitel in einem Dokument aus. Schließt sich gegenseitig aus mit dem Attribut showtitle.
- showtitle
-
Zeigt den Dokumenttitel in einem eingebetteten Dokument an. Schließt sich gegenseitig aus mit dem Attribut notitle.
- noheader
-
Schaltet den Dokumentenkopf aus.
- table-frame
-
Steuert den Standardwert für das Rahmenattribut in Tabellen.
- table-grid
-
Steuert den Standardwert für das Rasterattribut in Tabellen.
- table-stripes
-
Steuert den Standardwert für das Streifenattribut in Tabellen.
Bild- und Symbolattribute
- icons
-
Wählt Bilder oder Schriftsymbole anstelle von Text für Hinweise (Admonitions) und Callouts. Bei jedem anderen Wert wird davon ausgegangen, dass es sich um einen Icon-Typ handelt, und der Wert wird auf leer gesetzt (bildbasierte Icons).
- icons → image
-
Die Symbole werden zu Bilddateien aufgelöst, die sich in dem mit dem Attribut iconsdir angegebenen Verzeichnis befinden.
- icons → font
-
Die Icons werden aus einer Schriftart wie Font Awesome geladen.
- iconsdir
-
Speicherort der nicht-schriftbasierten Bildsymbole. Standardmäßig wird der Icon-Ordner unter imagesdir verwendet, wenn
imagesdirangegeben ist undiconsdirnicht angegeben ist. v3 verwendet jetzt den Medien-Ordner als Standard. Ist ads-compat.mode gesetzt ist das alte Verhalten wieder aktiv.
- icontype
-
Dateityp für Bildsymbole. Nur relevant bei der Verwendung von bildbasierten Icons.
- icon-set
-
Zur Verwendung mit icon Makros: Wählen Sie ein Set, aus dem die fontbasierten Icons genommen werden. Dieses Attribut wirkt sich nur aus, wenn Sie fontbasierte Icons über das Attribut icons aktiviert haben.
- icon-set → apple v3
-
Icon-Makros stellen Symbole aus den SF-Symbols dar. Es werden zusätzlich die unterschiedlichen Paletten (multicolor, hierachical, monochrome) unterstützt, wie auch die unterschiedlichen Font-Gewichte.
- icon-set → fa
-
Icon-Makros stellen Symbole aus dem veralteten Font Awesome 4-Set dar. In adoc Studio ist dies identisch mit dem Set Regular. Dies ist die Standardeinstellung.
- icon-set → fas
-
Icon-Makros stellen Symbole aus dem Font Awesome-Set Solid dar.
- icon-set → fab
-
Icon-Makros stellen Symbole aus dem Font Awesome-Set Brands dar.
- icon-set → far
-
Icon-Makros stellen Symbole aus dem Font Awesome-Set Regular dar.
- imagesdir
-
Standardmäßig werden Mediendateien für Bilder oder Filme anhand des Pfades ausgesucht, der im Ziel des Makros angegeben wird. Der in imagesdir gesetzte Text wird dabei automatisch am Anfang dieses Pfads hinzugefügt.
- source-highlighter v4
-
Um die Syntaxhervorhebung zu aktivieren, mussten Sie das Attribut im Dokumentkopf über einen Attributeintrag setzen. Ab der Version 4 ist es in jedem Dokument implizit gesetzt.
- stem v4
-
Um die Unterstützung von Gleichungen und Formeln zu aktivieren, setzen Sie dieses Attribut im Dokumentkopf. Ab der Version 4 ist das Attribut implizit auf
asciimathgesetzt.
HTML-Stilattribute
- linkcss
-
Fügt in HTML-Dateien einen Verweis auf das Stylesheet ein anstatt es komplett einzubetten. Dieses Attribut kommt nur zum Tragen, wenn Sie in den Export-Einstellungen für Ressourcen den Wert Aus Attributen auswählen.
- stylesheet
-
Normalerweise wählen Sie einen der installierten Stile, um Ihre Dokumente zu gestalten. Wenn Sie dieses Attribut auf den Namen einer CSS-Datei in ihrem Projekt setzen, wird stattdessen dieses Stylesheet für die Vorschau und den Export verwendet. Wenn sich die Stildatei nicht im gleichen Ordner wie das Dokument befindet, können Sie zusätzlich im Attribut stylesdir den Pfad zu dessen Ordner angeben.
- stylesdir
-
Der hier optional angegebene Dateipfad wird dem im Attribut stylesheet enthaltenen Dateiname vorangestellt, um die CSS-Stylesheet-Datei im Projekt zu lokalisieren.
A.5. Anmerkungen zur AsciiDoc-Kompatibilität in adoc Studio
adoc Studio folgt weitgehend dem AsciiDoc-Standard, setzt jedoch an einigen Stellen bewusst eigene Lösungen ein.
Bestehende Fehler im Standard werden nicht übernommen, sondern korrigiert. Zusätzlich wurden Funktionen erweitert, um die Arbeit zu erleichtern und eine umfassendere Nutzung zu ermöglichen. Dieser Abschnitt zeigt die Unterschiede und die zusätzlichen Möglichkeiten von adoc Studio.
Die App
-
Das Konzept der Sammeldokumente wird von AsciiDoc nicht unterstützt.
Möchten Sie zwischen verschiedenen Editoren oder Parsern wechseln, verwenden Sie stattdessen einen Ordner mit einer Index-Datei, in der alle zu nutzenden Dateien verlinkt oder inkludiert sind.
-
Für die Arbeit auf einem iPad ist adoc Studio erforderlich. Asciidoctor lässt sich auf iPadOS ohne spezielle Anpassungen nicht ausführen.
Wenn Sie bisher Asciidoctor.js für die Vorschau von .adoc-Dateien und Projekten genutzt haben, fällt Ihnen möglicherweise die neue Sicherheitsentwicklung in aktuellen Browsern auf: Die includes in AsciiDoc werden nun nicht mehr geladen. Dieses Problem tritt in adoc Studio nicht auf. |
Attribute
In adoc Studio wurde eine Reihe von benutzerdefinierten Attributen eingeführt, um die Funktionalität zu erweitern. Diese Attribute beginnt ausnahmslos mit „ads-“.
-
:ads-compat-mode:Wenn dieses Attribut gesetzt wird, ist die Kompatibilität mit Asciidoctor maximiert, alle anderen ads-Attribute werden dabei nicht mehr berücksichtigt. Beispielsweise werden Datums- und Zeitformate nicht mehr lokalisiert, Autorennamen werden anders geteilt, und icon directories verweisen auf andere Speicherorte. -
:ads-platform:Enthält macOS oder iOS, je nachdem, auf welcher Plattform Sie adoc Studio verwenden. -
:ads-device:Enthält Mac, iPhone oder iPad, je nachdem, auf welchem Gerät Sie adoc Studio verwenden. -
:ads-max-image-resolution:Legt die maximale Auflösung für Bilder in HTML- und PDF-Exporten fest. Geben Sie die Auflösungswerte in dpi, dpcm oder dppx an. Bei HTML wirkt sich diese Einstellung nur auf Bilder aus, für die Sie im Quellcode explizit eine Breite oder Höhe angegeben haben. Um die Größe von Bildern ohne vordefinierte Breite oder Höhe in HTML zu begrenzen, legen Sie das Attribut ads-max-image-width fest. -
:ads-max-image-width:Für den Export als HTML legt diese Option die maximale Pixelbreite für Bilder fest, für die im Quellcode keine Breite oder Höhe angegeben ist. -
:ads-rasterizing-resolution:Wenn ein Wert festgelegt ist, werden PDF- und SVG-Bilder sowie STEM-Gleichungen in HTML-Exporten in PNG-Bilder konvertiert. Sie geben die Auflösungswerte indpi,dpcmoderdppxan. -
:ads-static-stem:Standardmäßig werden STEM-Gleichungen in HTML-Exporten dynamisch über JavaScript generiert, wenn Sie das exportierte Dokument in einem Webbrowser öffnen. Wenn diese Option aktiviert ist, werden Gleichungen als statische SVG-Bilder exportiert, sodass JavaScript für ihre Anzeige nicht mehr erforderlich ist. -
:ads-static-stem: → inlineExportiert STEM-Gleichungen als Inline-SVG-Elemente. -
:ads-static-stem: → externalExportiert STEM-Gleichungen als externe SVG-Bilder.
Und noch drei Hinweise zu weiteren Attributen von AsciiDoc:
-
:experimental:Das Attribut wird in adoc Studio nicht mehr verwendet und hat keinen Effekt. -
:source-highlighter:Das Attribut ist in adoc Studio seit v3 implizit gesetzt. -
:stem:Das Attribut ist in adoc Studio seit v3 implizit gesetzt.
Stile
-
Alle Produkttypen greifen auf dasselbe Stylesheet zurück.
-
Die Stile sind zentral gesammelt, können direkt verwendet, für eigene Zwecke angepasst, erweitert und einfach geändert werden.
Icons
-
Im Gegensatz zu normalen Bildern unterstützt der AsciiDoc-Prozessor keine direkte Einbettung von SVG-Bildern im Icon-Makro. In adoc Studio lässt sich die Option
inlineverwenden. Dann wird das SVG direkt in die exportierte HTML-Datei eingebettet, ohne separate Datei.icon:tiger.svg[opts=inline] -
Das Attribut
:iconsdir:in adoc Studio verweist standardmäßig auf den Medienordner.
Makros
-
foonoteswerden in PDFs auf derselben Seite angezeigt, auf der sie gesetzt wurden.
A.6. Reguläre Ausdrücke
Mit zunehmendem Umfang eines Schreibprojekts wird die Suche nach Inhalten schnell komplex. Anstatt jede Datei Wort für Wort zu durchsuchen, können Sie nach bestimmten Mustern im Text suchen – sogenannte reguläre Ausdrücke.
Da der Begriff etwas sperrig ist, nutzen viele den englischen Ausdruck Regular Expressions oder die Abkürzung RegEx.
Ein kurzes Beispiel zeigt die Stärke dieser Methode:
Die Suche nach h*.us interpretiert das *. als „ein oder mehrere beliebige Zeichen“. Damit findet die Suche Wörter wie Haus, House oder Huus, aber nicht Hans, da nur Wörter erfasst werden, die mit „h“ beginnen und mit „us“ enden.
Reguläre Ausdrücke bestehen aus Zeichen, Operatoren oder speziellen Konstrukten, die sehr flexible Suchmuster ermöglichen. Im Folgenden erhalten Sie einen ersten Überblick über die wichtigsten Elemente.
Reguläre Ausdruck-Metazeichen
Die folgenden Tabellen erklären die Metazeichen, die reguläre Ausdrücke verwenden, um Muster in Texten zu erkennen:
-
Zeichenfolgen: Legen fest, welche Zeichen im Text abgeglichen werden.
-
Musteroperatoren: Bestimmen, wie oft ein Muster abgeglichen wird und unter welchen Bedingungen.
-
Flags: Können in den Ausdruck eingefügt werden, um das Suchverhalten zu steuern – zum Beispiel über mehrere Zeilen hinweg.
Die Tabelle Reguläre Ausdruck-Metazeichen beschreibt die Zeichenfolgen, die verwendet werden, um Zeichen innerhalb einer Zeichenkette abzugleichen.
|
Zeichenausdruck |
Beschreibung |
|
\a |
Entspricht einem GLOCKENZEICHEN, \u0007 |
|
\A |
Entspricht am Anfang der Eingabe. Unterscheidet sich von ^, da \A nicht nach einem neuen Zeilenzeichen innerhalb der Eingabe entspricht. |
|
\b, außerhalb eines [Sets] |
Entspricht, wenn die aktuelle Position eine Wortgrenze ist. Grenzen treten an den Übergängen zwischen Wort (\w) und Nicht-Wort (\W) Zeichen auf, wobei Kombinationszeichen ignoriert werden. |
|
\b, innerhalb eines [Sets] |
Entspricht einem RÜCKSPRUNGZEICHEN, \u0008. |
|
\B |
Entspricht, wenn die aktuelle Position keine Wortgrenze ist. |
|
\cX |
Entspricht einem Steuer-X Zeichen. |
|
\d |
Entspricht jedem Zeichen mit der Unicode Allgemeinen Kategorie Nd (Zahl, Dezimalziffer). |
|
\D |
Entspricht jedem Zeichen, das keine Dezimalziffer ist. |
|
\e |
Entspricht einem ESCAPE, \u001B. |
|
\E |
Beendet eine \Q … \E zitierte Sequenz. |
|
\f |
Entspricht einem SEITENWECHSEL, \u000C. |
|
\G |
Entspricht, wenn die aktuelle Position am Ende des vorherigen Abgleichs ist. |
|
\n |
Entspricht einem ZEILENVORSCHUB, \u000A. |
|
\N{UNICODE-ZEICHENNAME} |
Entspricht dem benannten Zeichen. |
|
\p{UNICODE-EIGENSCHAFTSNAME} |
Entspricht jedem Zeichen mit der angegebenen Unicode-Eigenschaft. |
|
\P{UNICODE-EIGENSCHAFTSNAME} |
Entspricht jedem Zeichen, das nicht die angegebene Unicode-Eigenschaft hat. |
|
\Q |
Zitiert alle folgenden Zeichen bis \E. |
|
\r |
Entspricht einem WAGENRÜCKLAUF, \u000D. |
|
\s |
Entspricht einem Leerzeichen. Leerzeichen sind definiert als [\t\n\f\r\p{Z}]. |
|
\S |
Entspricht einem Nicht-Leerzeichen. |
|
\t |
Entspricht einer HORIZONTALTABULATION, \u0009. |
|
\uhhhh |
Entspricht dem Zeichen mit dem Hex-Wert hhhh. |
|
\Uhhhhhhhh |
Entspricht dem Zeichen mit dem Hex-Wert hhhhhhhh. Genau acht Hex-Ziffern müssen angegeben werden, obwohl der größte Unicode-Codepunkt \U0010ffff ist. |
|
\w |
Entspricht einem Wortzeichen. Wortzeichen sind [\p{Ll}\p{Lu}\p{Lt}\p{Lo}\p{Nd}]. |
|
\W |
Entspricht einem Nicht-Wort-Zeichen. |
|
\x{hhhh} |
Entspricht dem Zeichen mit dem Hex-Wert hhhh. Von einer bis sechs Hex-Ziffern können angegeben werden. |
|
\xhh |
Entspricht dem Zeichen mit dem zweistelligen Hex-Wert hh. |
|
\X |
Entspricht einem Graphem-Cluster. |
|
\Z |
Entspricht, wenn die aktuelle Position am Ende der Eingabe ist, jedoch vor dem letzten Zeilenende, wenn eines vorhanden ist. |
|
\z |
Entspricht, wenn die aktuelle Position am Ende der Eingabe ist. |
|
\n |
Rückverweis. Entspricht dem, was die n-te Erfassungsgruppe abgeglichen hat. n muss eine Zahl ≥ 1 und ≤ Gesamtanzahl der Erfassungsgruppen im Muster sein. |
|
\0ooo |
Entspricht einem Oktal-Zeichen. ooo ist von ein bis drei Oktal-Ziffern. 0377 ist das größte erlaubte Oktal-Zeichen. Die führende Null ist erforderlich; sie unterscheidet Oktalkonstanten von Rückverweisen. |
|
[Muster] |
Entspricht jedem einzelnen Zeichen aus dem Muster. |
|
. |
Entspricht jedem Zeichen. Siehe dotMatchesLineSeparators und den s Zeichenausdruck in Tabelle 4. |
|
^ |
Entspricht am Anfang einer Zeile. Siehe anchorsMatchLines und den \m Zeichenausdruck in Tabelle 4. |
|
$ |
Entspricht am Ende einer Zeile. Siehe anchorsMatchLines und den m Zeichenausdruck in Tabelle 4. |
|
\ |
Zitiert das folgende Zeichen. Zeichen, die zitiert werden müssen, um als Literale behandelt zu werden, sind * ? + [ ( ) { } ^ $ | \ . / |
Reguläre Ausdruck-Operatoren
Die Tabelle Reguläre Ausdruck-Operatoren zeigt die wichtigsten Operatoren regulärer Ausdrücke und erklärt ihre Funktionsweise.
|
Operator |
Beschreibung |
|
Alternation. A |
B entspricht entweder A oder B. |
|
* |
Entspricht 0 oder mehrmals. Entspricht so oft wie möglich. |
|
+ |
Entspricht 1 oder mehrmals. Entspricht so oft wie möglich. |
|
? |
Entspricht null oder einmal. Bevorzuge einmal. |
|
{n} |
Entspricht genau n-mal. |
|
{n,} |
Entspricht mindestens n-mal. Entspricht so oft wie möglich. |
|
{n,m} |
Entspricht zwischen n und m-mal. Entspricht so oft wie möglich, aber nicht mehr als m. |
|
*? |
Entspricht 0 oder mehrmals. Entspricht so selten wie möglich. |
|
+? |
Entspricht 1 oder mehrmals. Entspricht so selten wie möglich. |
|
?? |
Entspricht null oder einmal. Bevorzuge null. |
|
{n}? |
Entspricht genau n-mal. |
|
{n,}? |
Entspricht mindestens n-mal, aber nicht mehr als für einen Gesamtmusterabgleich erforderlich. |
|
{n,m}? |
Entspricht zwischen n und m-mal. Entspricht so selten wie möglich, aber nicht weniger als n. |
|
*+ |
Entspricht 0 oder mehrmals. Entspricht so oft wie möglich, wenn zuerst aufgetreten. Versuche nicht erneut mit weniger, selbst wenn der Gesamtabgleich fehlschlägt (besitzergreifender Abgleich). |
|
++ |
Entspricht 1 oder mehrmals (besitzergreifender Abgleich). |
|
?+ |
Entspricht null oder einmal (besitzergreifender Abgleich). |
|
{n}+ |
Entspricht genau n-mal. |
|
{n,}+ |
Entspricht mindestens n-mal (besitzergreifender Abgleich). |
|
{n,m}+ |
Entspricht zwischen n und m-mal (besitzergreifender Abgleich). |
|
(…) |
Erfassende Klammern. Bereich der Eingabe, der der eingeklammerten Unterexpression entspricht, ist nach dem Abgleich verfügbar. |
|
(?:…) |
Nicht-erfassende Klammern. Gruppiert das eingeschlossene Muster, bietet jedoch kein Erfassen des abgeglichenen Textes. Etwas effizienter als erfassende Klammern. |
|
(?>…) |
Atomare Abgleich-Klammern. Der erste Abgleich der eingeklammerten Unterexpression ist der einzige versuchte; wenn er nicht zu einem Gesamtmusterabgleich führt, wird die Suche nach einem Abgleich auf eine Position vor dem "(?>" zurückgesetzt. |
|
(?# … ) |
Freiformkommentar (?# Kommentar). |
|
(?= … ) |
Vorausschau-Assertion. Wahr, wenn das eingeklammerte Muster an der aktuellen Eingabeposition entspricht, jedoch die Eingabeposition nicht voranschreitet. |
|
(?! … ) |
Negative Vorausschau-Assertion. Wahr, wenn das eingeklammerte Muster nicht an der aktuellen Eingabeposition entspricht. Schreitet die Eingabeposition nicht voran. |
|
(?⇐ … ) |
Rückschau-Assertion. Wahr, wenn das eingeklammerte Muster dem Text vor der aktuellen Eingabeposition entspricht, wobei das letzte Zeichen des Abgleichs das Eingabezeichen unmittelbar vor der aktuellen Position ist. Ändert die Eingabeposition nicht. Die Länge möglicher durch das Rückschaumuster abgeglichener Zeichenketten darf nicht ungebunden sein (keine * oder + Operatoren). |
|
(?<! … ) |
Negative Rückschau-Assertion. Wahr, wenn das eingeklammerte Muster dem Text vor der aktuellen Eingabeposition nicht entspricht, wobei das letzte Zeichen des Abgleichs das Eingabezeichen unmittelbar vor der aktuellen Position ist. Ändert die Eingabeposition nicht. Die Länge möglicher durch das Rückschaumuster abgeglichener Zeichenketten darf nicht ungebunden sein (keine * oder + Operatoren). |
|
(?ismwx-ismwx: … ) |
Flag-Einstellungen. Bewertet den eingeklammerten Ausdruck mit den aktivierten oder -deaktivierten angegebenen Flags. Die Flags sind in den Flag-Optionen definiert. |
|
(?ismwx-ismwx) |
Flag-Einstellungen. Ändert die Flag-Einstellungen. Änderungen gelten für den Teil des Musters nach der Einstellung. Zum Beispiel ändert (?i) zu einem Groß-/Kleinschreibung-unempfindlichen Abgleich. Die Flags sind in den Flag-Optionen definiert. |
Vorlagenabgleichsformat
Mit regulären Ausdrücken können Sie Suchen-und-Ersetzen-Operationen auf unveränderliche wie auch veränderliche Zeichenketten mithilfe der Technik des Vorlagenabgleichs anwenden.
Tabelle Vorlagenabgleichsformat erklärt die Syntax.
|
Zeichen |
Beschreibung |
|
$n |
Der Text der Erfassungsgruppe n wird durch $n ersetzt. n muss >= 0 und nicht größer als die Anzahl der Erfassungsgruppen sein. Ein $, dem keine Ziffer folgt, hat keine besondere Bedeutung und erscheint im Ersetzungstext als es selbst, ein $. |
|
\ |
Behandelt das folgende Zeichen als Literal, unterdrückt jegliche besondere Bedeutung. Backslash-Escaping im Ersetzungstext ist nur für '$' und '' erforderlich, kann jedoch bei jedem anderen Zeichen ohne negative Auswirkungen verwendet werden. |
Flag-Optionen
Mit Flags können Sie verschiedene Aspekte des Abgleichs regulärer Ausdrücke steuern. Diese Flag-Werte können innerhalb des Musters mit den (?ismx-ismx) Musteroptionen angegeben werden. Alternativ lassen sich diese Optionen auch für den gesamten Ausdruck festlegen, wenn Sie einen regulären Ausdruck initialisieren.
|
Flag (Muster) |
Beschreibung |
|
i |
Wenn gesetzt, findet der Abgleich groß-/kleinschreibungsunabhängig statt. |
|
x |
Wenn gesetzt, erlaubt die Verwendung von Leerzeichen und #Kommentaren in Mustern. |
|
s |
Wenn gesetzt, wird ein "." in einem Muster einen Zeilenabschluss im Eingabetext abgleichen. Standardmäßig wird das nicht der Fall sein. Beachten Sie, dass eine Wagenrücklauf-/Zeilenvorschub-Kombination im Text als ein einzelner Zeilenabschluss fungiert und einen einzelnen "." in einem regulären Ausdrucksmuster abgleichen wird. |
|
m |
Steuert das Verhalten von "^" und "$" in einem Muster. Standardmäßig entsprechen diese nur am Anfang bzw. am Ende des Eingabetextes. Wenn dieses Flag gesetzt ist, werden "^" und "$" auch am Anfang und Ende jeder Zeile innerhalb des Eingabetextes entsprechen. |
|
w |
Steuert das Verhalten von \b in einem Muster. Wenn gesetzt, werden Wortgrenzen gemäß den Definitionen von Wort in Unicode UAX 29, Textgrenzen, gefunden. Standardmäßig werden Wortgrenzen durch eine einfache Klassifizierung von Zeichen als entweder „Wort“ oder „Nicht-Wort“ identifiziert, was das traditionelle Verhalten regulärer Ausdrücke annähernd nachahmt. Die Ergebnisse, die mit den beiden Optionen erzielt werden, können bei Läufen von Leerzeichen und anderen Nicht-Wort-Zeichen sehr unterschiedlich sein. |
A.7. Fehlt Ihnen noch etwas?
adoc Studio befindet sich noch am Anfang einer langen Entwicklungsreise. Den aktuellen Stand finden Sie jederzeit auf der Webseite.
Der Fokus liegt zunächst auf Funktionen, die die meisten Benutzer:innen benötigen. Vielleicht fehlt Ihnen aber genau die eine Funktion.
Melden Sie sich kostenlos im adoc Studio-Forum an und teilen Sie uns Ihre Idee mit.
Wenn andere Anwender:innen Ihre Vorschläge unterstützen, steigt deren Priorität – so sorgen wir dafür, dass die wichtigsten Funktionen zuerst in adoc Studio umgesetzt werden.
Freuen Sie sich auf die spannenden Entwicklungen, die noch kommen, und gestalten Sie adoc Studio aktiv mit!
A.8. Tipps für externe Werkzeuge
Da adoc Studio alle erstellten Texte im UTF-8-Standard speichert, können Sie besonders gut UNIX-basierte Werkzeuge einsetzen. Im Folgenden haben wir einige Tools zusammengestellt, die uns bei der täglichen Arbeit helfen:
-
Git mit Tower: Git ist eine freie Software zur verteilten Versionsverwaltung, initiiert von Linus Torvalds. Tower bietet die grafische Benutzeroberfläche für Git auf macOS.
-
Make und Makefiles:sind Build-Management-Tools, die Kommandos abhängig von definierten Bedingungen ausführen.
-
Vale: Vale ist ein Open-Source-Tool für die Befehlszeile, das Ihren redaktionellen Stil-Leitfaden automatisch überprüft und umsetzt.
Haben Sie ein weiteres externes Werkzeug, das Sie empfehlen möchten? Teilen Sie Ihre Idee im adoc Studio-Forum – wir freuen uns auf Ihren Beitrag!