2. adoc Studio

Dieses Kapitel bietet einen Überblick über die App und die Konzepte, die die Bedienung erleichtern.

2.1. Die Benutzeroberfläche

Nach dem Start von adoc Studio wird die abgebildete Ansicht angezeigt. Sie zeigt das mit adoc Studio erstellte Benutzerhandbuch, das über Hilfe  Benutzerhandbuch geöffnet wird.

100%

Das Fensterlayout von adoc Studio ist in drei Bereiche unterteilt:

Am oberen Fensterrand befindet sich die Symbolleiste mit diesen Funktionen:

  • Seitenleiste ein- und ausblenden (Tastaturkurzbefehl: ⌘+0)

  • Neue Komponente anlegen (Tastaturkurzbefehl: ⇧+⌘+N)

  • Zurück- und Vorwärts-Schaltfläche für die Navigation (Tastaturkurzbefehl: ⌃+⌘+< und ⌃+⌘+>)

  • Verzeichnisbaum als Auswahlmenü

  • Export der aktuellen Datei

  • Inhaltsstruktur als Auswahlmenü

  • Optional: Liste aller Produkte

  • Editor ein- und ausblenden (mit oder Tastaturkurzbefehl: ⇧+⌘+E)

  • Vorschau ein- und ausblenden (mit oder Tastaturkurzbefehl: ⇧+⌘+E) inklusive der Einstellungen

Jeder Bereich lässt sich individuell ein- und ausblenden, um die Darstellung an unterschiedliche Bildschirmgrößen anzupassen. Die entsprechenden Funktionen befinden sich in den Menüs Darstellung, Editor und Vorschau.

2.2. Der Projektnavigator

In adoc Studio arbeiten Sie projektorientiert. Ein Projekt enthält die Inhalte sowie gegebenenfalls zugehörige Bilder und andere Medien. Mit zunehmendem Umfang wird die Übersicht jedoch schwieriger. Um die Organisation zu erleichtern, sollten umfangreiche Inhalte in kleinere, thematisch abgegrenzte Dokumente unterteilt werden. Diese Dokumente werden gemeinsam mit den benötigten Medien innerhalb eines Projekts verwaltet.

Ein Dokument bezeichnet den inhaltlichen Gegenstand – also den AsciiDoc-Text mit seiner Struktur und semantischer Bedeutung. Eine Datei ist die technische Umsetzung dieses Dokuments im Dateisystem. In adoc Studio wird ein Dokument in einer oder mehreren Dateien gespeichert und und lässt sich in verschiedene Ausgabeformate exportieren.

In adoc Studio beschreibt ein Dokument in der Regel eine Datei innerhalb des Projekts. Diese liegt auf einem Datenträger (z. B. Festplatte, SSD oder Cloud) und enthält den AsciiDoc-Text.

Darüber hinaus enthält ein Dokument bei Bedarf weitere Inhalte, wie Begriffe für Wörterbücher, KI-Prompts oder andere projektspezifische Daten.

Die Dateiendung bestimmt dabei die Art des Dokuments:

  • Die Hauptendung .adoc kennzeichnet eine AsciiDoc-Datei.

  • Weitere unterstützte Dateiendungen werden in den entsprechenden Abschnitten erläutert.

Der Projektnavigator zeigt alle Dokumente des Projekts strukturiert und übersichtlich an.

Ein neues Projekt erstellen

Erstellen Sie ein neues Projekt mit dem Menüleistenbefehl Ablage  Neu  Projekt.

newproject1

In der Seitenleiste erscheinen zunächst zwei Objekte:

  • Ein Ordner für Medien.

  • Die Datei Dokument.adoc als erstes Dokument des Projekts.

Legen Sie fest, ob die Dateiendung .adoc angezeigt wird, in adoc Studio  Einstellungen. Die Einstellungen öffnen Sie auch mit dem Tastaturkurzbefehl ⌘+,.

Sortieren Sie im Projektnavigator Dateien und Ordner nach Bedarf. Sie können die Objekte beliebig verschachteln.

Die Sortierung für den Projekteintrag oder einzelne Ordner passen Sie im Informationsdialog an. Klicken Sie mit der rechten Maustaste auf einen Projekteintrag oder Ordner und wählen Sie im angezeigten Kontextmenü Information aus.

Speichern Sie Medien und Bilder idealerweise in Medienordnern, auch wenn Sie diese an jeder beliebigen Stelle im Projekt ablegen können. Erstellen Sie bei Bedarf einfach zusätzliche Ordner.

Im nächsten Schritt schreiben Sie den Text in ein vorhandenes Dokument.

Alleinstehende Dokumente verwenden

newproject2

Fügen Sie Ihrem Projekt weitere Dokumente hinzu über Ablage  Neu, den Kurzbehelf ⌘+N oder das in der Seitenleiste.

Jedes Dokument bildet eine inhaltliche Einheit und belegt eine eigene Datei.

So bearbeiten Sie ein Dokument:

  1. Klicken Sie im Projektnavigator auf das Dokument.

  2. Der Editor öffnet die Datei zur Bearbeitung.

  3. Die Vorschau zeigt den Inhalt sofort im gewählten Layout.

Wenn Sie ein anderes Dokument auswählen, öffnet es sich im Editor.

Die Inhalte von Weiteres_Dokument.adoc werden nicht automatisch in Dokument.adoc übernommen – und umgekehrt. AsciiDoc bietet Möglichkeiten, Inhalte aus anderen Dateien einzubinden, beispielsweise über das include-Makro..

Sammeldokumente verwenden

Sammeldokumente fassen, anders als alleinstehende Dokumente, mehrere Dateien automatisch zu einem Gesamtdokument zusammen.

Ein Sammeldokument erscheint im Projekt als spezieller Ordner mit dem Symbol. Auf dem Datenträger entspricht es einem Verzeichnis, das alle enthaltenen Dateien umfasst.

Innerhalb eines Sammeldokuments können Sie weitere Ordner zur Strukturierung verwenden und diese beliebig tief verschachteln.

Klicken Sie im Projektnavigator auf ein Sammeldokument, zeigt die Vorschau das vollständige Dokument einschließlich aller enthaltenen Dateien an.

Wählen Sie im Projektnavigator einen enthaltenen Ordner aus, zeigt die Vorschau alle darin enthaltenen Kapitel zusammenhängend.

In beiden Fällen bleibt der Editor leer, da die Vorschau mehrere Dateien zur Darstellung des Dokuments oder Teildokuments nutzt. Klicken Sie auf eine Datei im Projektnavigator um Sie zu bearbeiten.

Führen Sie einen Sekundärklick auf eine Textstelle im Projektnavigator aus und wählen Sie im Kontextmenü  Quelle zeigen, um die zugehörige Datei im Editor zu öffnen.

Neue Dateien werden in Sammeldokumenten standardmäßig als Kapitel.adoc angelegt, lassen sich jederzeit beliebig umbenennen.

Ordner zur Strukturierung verwenden

Nutzen Sie Ordner, um auch bei vielen Dateien die Übersicht zu behalten. Zusätzlich hilft Ihnen der Filter am unteren Ende des Projektnavigators beim schnellen Wiederfinden. Organisieren Sie in adoc Studio Ihre Projekte mit Hilfe von Ordnern genauso wie im Betriebssystem.

  • Verwenden Sie Ordner in einem alleinstehenden Dokument, und selektieren diesen, zeigt sowohl der Editor, als auch die Vorschau nichts an.

  • In einem Sammeldokument, zeigt die Vorschau alle enthaltenen Dateien des selektierten Ordners an.

Medienordner verwenden

Medien wie Bilder dürfen Sie grundsätzlich an jedem Ort in einem Projekt ablegen: Auf der obersten Ebene oder in einem beliebigen Unterordner. Um sie in einem Dokument zu verwenden, geben Sie einen absoluten oder relativen Dateipfad an.

Noch einfacher geht es jedoch, wenn Sie die Bilder in einen speziellen Medienordner legen. Dann genügt es anstatt des Pfads den Dateinamen des Bildes anzugeben.

In einem Projekt dürfen mehrere Medienordner existieren. adoc Studio durchsucht das Projekt in einer festgelegten Reihenfolge nach diesen Medien.

Suchreihenfolge für Bilder

Die Zeile image::bild.jpg[] weist adoc Studio an, das Bild in der folgenden Reihenfolge zu suchen:

  1. adoc Studio sucht die Datei „bild.jpg“ zunächst im selben Verzeichnis wie die .adoc-Datei.

  2. Findet adoc Studio die Datei dort nicht, durchsucht die App den übergeordneten Medienordner.

  3. Ist das Bild auch dort nicht vorhanden, prüft adoc Studio auf der jeweils nächsthöheren Ebene erneut den Medienordner.

  4. Diesen Vorgang wiederholt die App, bis sie das Wurzelverzeichnis des Projekts erreicht.

  5. Findet adoc Studio die Datei weiterhin nicht, markiert der Editor den Dateinamen rot und ergänzt einen entsprechenden Eintrag im Problemnavigator in der Seitenleiste.

Beispiel einer Fehlermeldung im Projekt
Bilder mit Pfadangaben

  • Die Zeile image::/bild.jpg[] sucht das Bild im Projektverzeichnis, in dem sich auch die .adocprojekt-Datei befindet.

  • Die Zeile image::/Ordner/bild.jpg[] sucht das Bild im Unterverzeichnis "Ordner", ausgehend vom Projektverzeichnis.

  • Die Zeile image::../bild.jpg[] sucht das Bild eine Ebene über der Textdatei, in der es referenziert wird.

Grundsätzlich werden alle Pfade wie im Betriebssystem angegeben. Geben Sie einen Pfad mit einem / an, ist das die Wurzel das Projektverzeichnis, also der Ordner, in dem sich Ihre .adocproject-Datei befindet.

Für die AsciiDoc-Profis:

In adoc Studio können Sie zusätzlich das Attribut imagesdir verwenden. Definieren Sie mit :imagesdir: einen Pfad, behandelt adoc Studio diesen Wert so, als stünde er als Präfix vor jeder Bildreferenz im Dokument. Weitere Details und spezifische Anwendungsfälle finden Sie auf der AsciiDoc-Webseite.

Bei referenzierenden Projekten gelten zusätzliche Besonderheiten. Die entsprechenden Details finden Sie im dortigen Abschnitt.

Neue Komponente einfügen

newcomponent

Um eine neue Komponente in Ihr Projekt einzufügen, klicken Sie in der Symbolleiste auf oder verwenden Sie den Tastaturkurzbefehl ⇧+⌘+N.

Der Dialog passt sich automatisch an die aktuelle Auswahl in der Dateiliste an:

  • Wählen Sie ein eigenständiges Dokument aus, können Sie ein weiteres eigenständiges Dokument oder ein Sammeldokument erstellen.

  • Wählen Sie ein Sammeldokument oder ein Kapitel aus, können Sie neue Kapitel hinzufügen.

Unabhängig von der Auswahl können Sie außerdem neue Ordner, Medienordner oder bestehende Dateien in das Projekt einfügen.

Ziehen Sie Dateien alternativ direkt aus dem Finder in die Dateiliste, um sie ins Projekt hinzuzufügen.

Bestehende Dateien einfügen

Doppelter Mausklick im Finder

Öffnen Sie im Finder eine .adoc-Datei mit einem Doppelklick in adoc Studio, sofern keine andere Anwendung die Dateiendung .adoc` übernommen hat. Daraufhin zeigt adoc Studio eine Dialogfenster an. Wählen Sie darin das Zielprojekt aus oder erstellen Sie ein neues Projekt. Die Datei wird in das ausgewählte Projekt kopiert, ohne sie am ursprünglichen Speicherort zu bewegen.

newdocument
Drag & Drop aus dem Finder

Alternativ bewegen Sie eine Datei per Drag & Drop aus dem Finder an die gewünschte Position in adoc Studio.

Legen Sie die Datei auf einem Sammeldokument ab, fügt adoc Studio sie automatisch als Kapitel in dieses Sammeldokument ein.

Dateien im Finder kopieren oder bewegen

Sie können Dateien auch direkt im Finder in das Projektverzeichnis kopieren oder bewegen.

adoc Studio erkennt neue oder geänderte Dateien automatisch und zeigt sie nach kurzer Zeit in der Dateiliste des Projekts an.

Menüleistenfunktion

Über die Menüleiste können Sie ebenfalls Dateien in ein Projekt einfügen.

Wählen Sie dazu Ablage  Neu  Dateien hinzufügen … oder verwenden Sie den Tastaturkurzbefehl ⌥+⌘+A.

adoc Studio fügt die ausgewählte(n) Datei(en) unterhalb der aktuellen Auswahl in der Dateiliste ein. Anschließend können Sie die Dateien mithilfe der Maus an die gewünschte Position bewegen.

Bewegen Sie eine Datei in ein Sammeldokument, fügt adoc Studio sie automatisch als Kapitel in dieses Sammeldokument ein.

Dateiinformationen

Befindet sich eine Datei in einem Sammeldokument, die weder in der Vorschau noch im Export angezeigt werden soll, können Sie ihre Einbindung gezielt deaktivieren:

Klicken Sie mit der rechten Maustaste auf die Datei im Dateiverzeichnis, um das Kontextmenü zu öffnen.

fileinspector

Wählen Sie anschließend Informationen … aus, und adoc Studio öffnet direkt den rechts dargestellten Dialog.

Deaktivieren Sie die Option „Teil des Sammeldokuments“, um die Datei aus der Einbindung zu entfernen.

Auf diese Weise können Sie beispielsweise To-do-Listen erstellen, die niemals Teil Ihres Dokuments werden.

Weitere Informationen

Die meisten Dateien und alle Ordner in der Seitenleiste bearbeiten Sie über das Menü Informationen …. Neben dem Umbenennen von Dateien oder Ordnern stehen dort weitere Optionen zur Verfügung.

Diese Einstellungen wirken sich ausschließlich auf die Arbeit in adoc Studio aus. Im macOS- Finder (wie auch in anderen Betriebssystemen) erscheinen alle Objekte weiterhin als reguläre Dateien und Ordner.

2.3. Ein Projekt sichern

saveproject

Sie können Ihr Projekt an einem beliebigen Speicherort sichern. Entweder über die Menüleiste Ablage  Sichern… oder mit dem Tastaturkurzbefehl ⌘+S.

Sichern Sie die Dateien von adoc Studio auf Ihrem Gerät, einem Server oder in einer Cloud.

Alternativ können Sie auch ein Versionskontrollsystem wie Git oder GitHub verwenden.

Schließen Sie das letzte Projektfenster, ohne das Projekt vorher zu sichern, weist adoc Studio Sie darauf hin.

adoc Studio sichert die .adoc-Dateien automatisch in kurzen Abständen. Lösen Sie jederzeit mit dem Tastaturkurzbefehl ⌘+S eine manuelle Sicherung aus.

2.4. Weitere Fenster für ein Projekt

Öffnen Sie über die Menüleiste Fenster  Neues Fenster ein Projekt in mehreren Fenstern. Das ist besonders praktisch, wenn Sie mehrere Monitore verwenden. Organisieren Sie Vorschau, Übersetzung und Überarbeitung eines Dokuments in separaten Fenstern, um effizienter zu arbeiten.

Klicken Sie auf dem Mac bei gedrückter ⌘-Taste auf den Fenstertitel, um ein Menü mit dem Pfad des aktuellen Projekts im Finder zu öffnen.

2.5. Referenzierendes Projekt

Referenzierende Projekte unterscheiden sich von normalen Projekten, in denen alle Dateien innerhalb eines eigenen Ordners verwaltet werden.

Normale adoc Studio-Projekte liegen in einem Projektordner, der die Projektdatei sowie alle Dokumente, Ordner und Medien enthält.

Mit adoc Studio können Sie jedoch auch referenzierende Projekte erstellen. Diese beziehen bestehende Dateien direkt von ihrem aktuellen Speicherort im System, ohne sie in den Projektordner zu kopieren.

Erstellen Sie ein externes referenzierendes Projekt über die Menüzeile mit gedrückter ⌥-Taste an und klicken auf Ablage  Neu  Referenzierendes Projekt.

  • adoc Studio öffnet ein leeres Projektfenster.

  • Speichern Sie das Projekt als .adocproject-Datei an einem beliebigen Ort.

  • Bewegen Sie nun Dateien oder Ordner von beliebigen Orten in den Projektnavigator.

  • adoc Studio erstellt dadurch eine Referenz zu den Originaldateien im Projekt.

  • Bearbeiten Sie die .adoc-Dokumente wie gewohnt, die Änderungen werden direkt im ursprünglichen Quellordner gesichert.

Der zweite Reiter in der Seitenleiste zeigt die Struktur der Überschriften als Gliederung an.

Bei Sammeldokumenten zeigt der Abschnitt-Navigator das gesamte Inhaltsverzeichnis, unabhängig davon, in welchem Kapitel Sie gerade arbeiten. Bei einzelnen Dokumenten wird nur das Inhaltsverzeichnis dieses Dokuments angezeigt.

Um ein Inhaltsverzeichnis im Text in der Vorschau oder im Export auszugeben, verwenden Sie das Attribut :toc:, das hier beschrieben wird.
search context menu

Der Reiter mit der Lupe ist der Such-Navigator. Verwenden Sie ihn, um Texte im gesamten Projekt zu durchsuchen.

Im Kontextmenü hinter der Lupe aktivieren Sie die Ersetzen-Funktion.

Darüber hinaus können Sie folgende Einstellungen vornehmen:

  • Groß-/Kleinschreibung ignorieren.

  • Akzente und Umlaute ignorieren.

  • In mehrsprachigen Projekten die Suche auf bestimmte Sprachen beschränken.

In diesem Menü aktivieren Sie außerdem die regulären Ausdrücke für die Suche.

Nach der Suche gruppiert adoc Studio die Treffer nach Dateien. Ein Klick auf eine Datei öffnet diese im Editor und springt direkt zur gewünschten Position.

Besonderheiten

Ersetzen Sie gefundene Texte mit den praktischen Optionen von adoc Studio:

  • Selektieren Sie einzelne Treffer in der Liste (Mehrfachauswahl mit gedrückter ⇧-Taste) und führen Sie die Ersetzungen nur an diesen Stellen durch.

  • Wählen Sie eine Datei in der Trefferliste aus, um die Ersetzungen ausschließlich in dieser Datei vorzunehmen.

Der Problem-Navigator erkennt AsciiDoc-Probleme im Text. Er prüft nicht auf grammatikalische oder orthografische Fehler, sondern erkennt Probleme mit AsciiDoc-Befehlen.

Bei einem Fehler zeigt adoc Studio das Symbol der Fehlerliste in roter Farbe an errorlist. Kleinere Probleme werden als Warnungen in Gelb dargestellt.

problem nav

Die Liste ist nach dem Auftreten der Probleme sortiert. Ein Klick auf eine Meldung öffnet den Editor direkt an der entsprechenden Stelle, damit Sie den Fehler beheben können.

2.9. Schreiben und im Text navigieren

Wählen Sie in der Dateiliste eine Textdatei aus. Blinkt die Einfügemarke noch nicht im Editor-Fenster, setzen Sie sie mit einem Mausklick in den mittleren Bereich des Fensters oder drücken Sie ⌃+TAB.

Danach ist adoc Studio bereit, Ihren Text aufzunehmen. Hinweise zu AsciiDoc finden Sie im nächsten Kapitel.

Der eingegebene Text erscheint sofort in der Vorschau. Bei längeren Texten synchronisiert adoc Studio automatisch die Position der beiden Fenster, sodass Sie den gerade geschriebenen Abschnitt auf gleicher Höhe in der Vorschau sehen.

Die vertikale Position der Schreibmarke bleibt dabei mit der Scroll-Position der Vorschau synchron.

Beachten Sie, dass der Wechsel zur PDF-Vorschau bei längeren Texten mehr Zeit in Anspruch nehmen kann. Verwenden Sie daher bevorzugt die HTML-Vorschau, da diese schneller aktualisiert wird.

Passen Sie den Editor nach Ihren persönlichen Vorlieben an, etwa hinsichtlich Farbeinstellungen oder Dioptrienstärke. Der Reiter Editorstile in den Programmeinstellungen bietet Ihnen zahlreiche Gestaltungsmöglichkeiten.

Zusatznavigation

Oberhalb des Editors befindet sich die Zusatznavigation.

Sie beginnt mit den Navigationspfeilen links und rechts die ähnlich wie einem Webbrowser funktionieren. Damit navigieren Sie vorwärts und rückwärts und springen zu den zuvor bearbeiteten Dateien.

Recht daneben befindet sich ein grafischer Block, der zeigt die aktuelle Datei und deren Struktur an.

zusatz navigation

Von links nach rechts erkennen Sie, in welcher Datei Sie gerade arbeiten.

Am äußersten rechten Rand finden Sie ein kleines Inhaltsverzeichnis, das den Gesamtzusammenhang der Datei und ihrer Struktur darstellt. Werden hier Struktureinträge in grauer Farbe dargestellt, kommen diese aus anderen Dateien innerhalb eines Sammeldokuments.

Zeilennummern

Am rechten Rand des Editors erscheint eine einzelne Zeilennummer zur Orientierung. Für die meisten Zwecke reicht dies für die Kommunikation über Zeilennummern aus. Möchten Sie alle Zeilennummern anzeigen, passen Sie die Einstellung in den Einstellungen an.

Klicken Sie auf eine Zeilennummer oder verwenden Sie den Tastaturkurzbefehl ⌘+L, um direkt zu einer bestimmten Zeile zu springen.
Auch Texte werden sofort gesichert

Änderungen an den Texten sichert adoc Studio sofort, genau wie die Projektdateien. Damit sind Ihre Daten jederzeit vor Verlust geschützt.

Einfügemarke

Beim Schreiben bewegen Sie die Einfügemarke bequem mithilfe der Tastatur, ohne die Hand von der Tastatur zu nehmen. adoc Studio integriert dafür alle wichtigen Tastaturkurzbefehle zur Textbearbeitung direkt für Sie.

Tabelle 1. Verwendete Modifikatortasten

⌘

Command- oder Befehlstaste

⌥

Option- oder Wahltaste

⌃

Control- oder Ctrl-Taste

⇧

Shift- oder Umschalttaste

⌤

Eingabetaste

⏎

Zeilenschalter oder Return

⌫

Backspace- oder Rückschritttaste

⌦

Entf.-Taste (Erweiterte Tastatur)
Tabelle 2. Bewegung im Dokument

←

Ein Zeichen nach links

→

Ein Zeichen nach rechts

↑

Eine Zeile nach oben

↓

Eine Zeile nach unten

⌥+←

Ein Wort nach links

⌥+→

Ein Wort nach rechts

⌘+←

Zum Anfang der Zeile

⌘+→

Zum Ende der Zeile

⌘+↑

Zum Anfang des Dokument

⌘+↓

Zum Ende des Dokuments
Tabelle 3. Selektionen im Dokument

⇧+←

Selektion nach links erweitern

⇧+→

Selektion nach rechts erweitern

⇧+↑

Selektion nach links erweitern

⇧+↓

Selektion nach rechts erweitern

⇧+⌥+←

Selektion zum Wort nach links erweitern

⇧+⌥+→

Selektion zum Wort nach rechts erweitern

⇧+⌘+↑

Selektion zum Anfang des Dokuments erweitern

⇧+⌘+↓

Selektion zum Ende des Dokuments erweitern

⌃+↑

Zeile mit Schreibmarke oder Selektion nach oben verschieben

⌃+↓

Zeile mit Schreibmarke oder Selektion nach unten verschieben
Tabelle 4. Im Dokument löschen

⌘+⌫

Löscht die aktuelle Zeile links vom Cursor

⌥+⌫

Löscht das Wort links vom Cursor

⌥+⌦

Löscht das Wort rechts vom Cursor
Tabelle 5. Alternative Tastenkürzel im Dokument

⌃+a

Geht zum Anfang der Zeile

⌃+b

Geht ein Zeichen nach links

⌃+d

Löscht das Zeichen rechts vom Cursor

⌃+e

Geht zum Ende der Zeile

⌃+f

Geht ein Zeichen nach rechts

⌃+h

Löscht das Zeichen links vom Cursor

⌃+k

Löscht die den Rest der Zeile ab dem Cursor

⌃+n

Eine Zeile nach unten

⌃+o

Neue Zeile hinter der Einfügemarke einfügen

⌃+t

Zeichen an der Einfügemarke oder in einer Selektion tauschen

Ein weiterer Tastaturkurzbefehl, den Sie in adoc Studio häufig nutzen werden, ist die ESC-Taste. Damit öffnen Sie den umfangreichen Bereich der Eingabehilfen.

2.10. Eingabehilfe: Der adoc Coach

Der Funktionsumfang von AsciiDoc ist sehr groß. Deshalb kann selbst Profis passieren, dass einzelne Befehle oder Makros vergessen werden. Aus diesem Grund bietet adoc Studio eine intelligente Eingabehilfe.

Während Sie schreiben, sucht adoc Studio kontinuierlich nach Möglichkeiten, Sie zu unterstützen. Oft erscheint bereits nach dem zweiten oder dritten Zeichen ein Menü mit Vervollständigungsvorschlägen. Dabei achtet adoc Studio darauf, Ihren Schreibfluss so wenig wie möglich zu unterbrechen – die Vorschläge werden daher nur angezeigt, wenn Sie eine kurze Schreibpause machen. Bei Bedarf öffnen Sie das Menü der Eingabehilfen mit der ESC-Taste.

completion images

Beispiel: Ein Bild im Text einbinden

  1. Beginnen Sie am Zeilenanfang mit der Eingabe von bil oder ima.

  2. Ein kurzes Menü erscheint:

    completion image

  3. Navigieren Sie in der Liste mit den Tasten ↓ oder ↑.

  4. Wählen Sie den gewünschten Eintrag mit der ⏎-Taste aus.

  5. Nach der Auswahl erscheint ein weiteres Menü:

    completion image adoc

    Die Bilder werden dabei direkt als kleine Vorschau angezeigt.

  6. Wählen Sie das passende Bild aus und bestätigen Sie erneut mit der ⏎-Taste. Das Bild erscheint anschließend in voller Breite in der Vorschau.

  7. Setzen Sie den Einfügemarke zwischen die beiden eckigen Klammern nach dem Bildnamen ([]), um die Optionen für das Bild einzugeben.

  8. Geben Sie zuerst die Breite des Bildes ein, indem Sie wi tippen. Ein Menü zeigt alle verfügbaren Optionen, die wi enthalten.

  9. Navigieren Sie mit den Pfeiltasten zu width= und betätigen Sie mit ⏎.

  10. Nun sehen Sie folgendes: completion image placeholder

  11. Überschreiben Sie den Platzhaltertext mit einer Zahl (z. B. 200), um die Skalierung des Bildes in der Vorschau sofort zu sehen.

  12. Setzen Sie die Einfügemarke erneut zwischen die beiden eckigen Klammern nach dem Bildnamen ([]). Es spielt keine Rolle, ob Sie die Option width davor oder danach einfügen. Wichtig ist, dass alle Optionen durch ein Komma getrennt werden.

  13. Drücken Sie die ESC-Taste, damit das Vervollständigungsmenü mit den weiteren Bildoptionen erscheint.

  14. Möchten Sie das Bild rechts neben einem Text platzieren, benötigen Sie die Option float. Geben Sie flo ein, und das Vervollständigungsmenü zeigt alle Optionen, die flo enthalten:

    completion image float

  15. Wählen Sie float=right aus.

Fertig. Sie haben ein Bild eingefügt, skaliert und rechts neben dem Text positioniert.

Im Quelltext auf der linken Seite sieht das wie folgt aus:
image::adocstudio.png[width=200, float=right]

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 
Duis aute irure dolor in reprehenderit in voluptate, velit esse cillum dolore eu fugiat nulla pariatur. 
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
completion image example
Abbildung 1. Das Ergebnis sehen Sie rechts in der Vorschau:
Für jeden AsciiDoc-Befehl und jedes Attribut steht Ihnen adoc Coach zur Verfügung. Wenn Sie unsicher sind, drücken Sie einfach ESC. So sehen Sie alle Makros, die an der aktuellen Position möglich sind.

2.11. Rechtschreibprüfung

Unter macOS ist die Rechtschreibprüfung in vielen Anwendungen standardmäßig aktiviert. Das ist auch in adoc Studio der Fall. Falsch geschriebene Wörter erkennen Sie sofort an der roten Unterstreichung.

Sie können die Prüfung automatisch im Hintergrund nutzen oder manuell starten. Wählen Sie dazu Bearbeiten  Rechtschreibung und Grammatik  Dokument jetzt prüfen oder den Tastaturkurzbefehl ⌘+Ü. adoc Studio springt anschließend direkt zum nächsten erkannten Fehler. Mit einem Rechtsklick auf ein markiertes Wort lassen Sie sich passende Korrekturvorschläge anzeigen und übernehmen die gewünschte Schreibweise mit einem Klick.

Ein vermeintlich falsch geschriebenes Wort können Sie außerdem zum systemweiten Wörterbuch hinzufügen. Es steht Ihnen dann in allen Apps auf Ihrem Mac zur Verfügung.

dictionary

In technischen oder fachlich spezialisierten Dokumentationen verwenden Sie häufig Begriffe, die nicht in das systemweite Wörterbuch passen. Dafür bietet Ihnen adoc Studio projektbezogene Wörterbücher.

Diese werden direkt im Projekt als .adict-Datei gesichert. Dabei handelt es sich um alphabetisch sortierte Textdateien, die Sie bei Bedarf manuell bearbeiten können.

Legen Sie in jedem Projekt beliebig viele eigene Wörterbücher an. Verwalten Sie diese direkt im Text über das Kontextmenü mit einem Rechtsklick.

2.12. Dokumente übersetzen

Veröffentlichen Sie Dokumente in mehreren Sprachen. adoc Studio unterstützt Sie in der Pro-Version bei Übersetzung und Sprachmanagement.

Vorbereitung

languages

Definieren Sie zunächst die benötigten Sprachen im Projekt.

Öffnen Sie in der Menüzeile Anlage  Projekteinstellungen … (⌘+;) oder klicken im Projektnavigator mit der rechten Maustaste auf eine Datei und wählen Sprache hinzufügen  Dokumentsprachen ….

Fügen Sie im Dialogfenster die gewünschten Dokumentsprachen mit hinzu.

Bedienung

Weisen Sie einer Datei eine Sprache zu, indem Sie im Kontextmenü Sprache hinzufügen  eine Sprache wählen.

Der Projektnavigator zeigt die Sprachversion anschließend als Untereintrag im Dateibaum an. Klappen Sie den Pfeil auf, um die zugewiesene Sprache anzuzeigen. Über Sprache Hinzufügen  eine andere Sprache fügen Sie weitere Sprachen hinzu. Das Kontextmenü bietet ausschließlich Sprachen an, die im Projekt definiert und der Datei noch nicht zugewiesen sind.

Sie können Sprachen auch direkt über die Symbolleiste auswählen.

toolbar

Die Symbolleiste zeigt von links nach rechts:

  1. Projekt- und Ordnerstruktur (z.B. Manual und Publish)

  2. Aktive Datei im Editor (zB. products).

  3. Aktive Sprache (z.B. Deutsch).

  4. Aktuelle Position der Einfügemarke im Dokument (z.B. Produkte).

Technischer Hintergrund

Weisen Sie einer Datei die erste Sprache zu, übernimmt adoc Studio den bestehenden Inhalt in diese Sprachversion. Wählen Sie als erste Sprache die Ausgangssprache Ihres Dokuments. Fügen Sie weitere Sprachen hinzu, legt adoc Studio neue Sprachversionen ohne Inhalt an.

Im Finder erhalten alle Sprachversionen eine erweiterte Namensgebung. adoc Studio ergänzt vor der Dateiendung einen Sprachcode:

  • Handbuch.adoc - Originaldokument

    • Handbuch.de.adoc - Deutsche Version

    • Handbuch.en.adoc - Englische Version

In adoc Studio werden die Sprachversionen immer als Dateibaum dargestellt.

Die Sprachzuordnung gilt für alle Projektinhalte, nicht nur für .adoc-Dateien. Je Sprache sollten Sie auch unterschiedliche Medien verwenden.

Liegt keine Übersetzung vor, nutzt adoc Studio die vorhandene Datei in allen Sprachen.

adoc Studio verwendet standardisierte Ländercodes (Locale Codes). Kennzeichnen Sie regionale Varianten mit einem Bindestrich, z. B. en-HK. Alle Sprachkürzel erscheinen in der Liste der Dokumentsprachen.

Ausgabe

Wählen Sie bei Exporten und Produkten die Sprache aus, in der adoc Studio die Ausgabe erzeugen soll.

Praktischer Ablauf einer Übersetzung

Führen Sie die Übersetzung in drei Schritten durch:

  • Sie starten Ablage  Export  Zur Übersetzung ….

  • Wählen Sie im Dialogfenster die Sprachen aus, die an den Übersetzer oder die Agentur weitergegeben werden.

  • Importieren Sie die fertigen Übersetzungen über Ablage  Übersetzung importieren …

Binden Sie Ihr Übersetzungsteam direkt ein. Seit Version 4 unterstützt die Community-Version bereits zwei Sprachen.

2.13. Schreibwerkzeuge mit Künstliche Intelligenz

Der Einsatz künstlicher Intelligenz liefert unterschiedliche Ergebnisse. Prüfen und bewerten Sie alle Inhalte sorgfältig. Verlassen Sie sich nicht ungeprüft auf KI-Ergebnisse. adoc Studio hat keinen Einfluss auf die erzeugten Resultate.

Im Editor-Kontextmenü von adoc Studio unterstützt Sie die Pro-Version mit integrierten KI-Funktionen.

Die Funktionen nutzen wahlweise:

  • ChatGPT von OpenAI

  • Claude von Anthropic

  • Gemini von Google

Die Apple Intelligence Schreibwerkzeuge von Apple werden nicht verwendet.

Kontext für die KI

Nicht in jedem Fall erschließt sich für eine KI der Kontext eines Projekts. Oft müssen auch besondere Informationen und Einleitungen mitgegeben werden, die dann von den einzelnen Funktionen beachten werden.

So eine Kontextdatei wird im Menü Ablage  Neu  Komponente … erstellt. Im Dialog wählen Sie den letzten Eintrag KI-Schreibtools-Kontext. Dadurch wird eine Textdatei mit der Endung `.adocai im Projekt angelegt. In dieser Datei speichern Sie alle Informationen, die Sie der KI als Basis für die folgenden KI-Funktionen übergeben möchten.

KI-Funktionen

Wählen Sie Ihren bevorzugten Anbieter und das Modell in adoc Studio  Einstellungen … Den benötigten API-Schlüssel hinterlegen Sie einmalig. Falls er noch fehlt, fragt adoc Studio ihn beim ersten Einsatz automatisch ab.

Anschließend stehen Ihnen folgende Werkzeuge zur Verfügung:

ai menu
Freundlich

Die KI formuliert Ihren markierten Text in einem positiven, zugewandten Ton.

Sachlich

Die KI gibt Ihren Text klar, neutral und professionell wieder.

Kompakt

Die Ki bringt Ihren Text auf den Punkt und entfernt Überflüssiges.

Korrekturlesen

Die Ki prüft ausgewählten Text auf Fehler und markiert erkannte Stellen blau. Übernehmen oder verwerfen Sie Vorschläge wie bei der Rechtschreibprüfung per Kontextmenü.

Tabelle

Die KI strukturiert geeignete Inhalte automatisch als Tabelle.

Liste

Die KI wandelt geeignete Inhalte in eine übersichtliche Liste um.

Hauptpunkte

Die KI reduziert längere Texte auf die zentralen Aussagen.

Zusammenfassung

Die KI erstellt eine kurze und verständliche Zusammenfassung.

Übersetzen

Die KI übersetzt Ihren markierten Text in die Sprachen, die Sie im Projekt unter Sprachen eingestellt haben. Diese Zielsprachen stehen direkt im Kontextmenü zur Auswahl zur Verfügung.

Eigene Abfrage

Stellen Sie der KI eine individuelle Anfrage über die Eingabe. Legen Sie anschließend fest, wie adoc Studio das Ergebnis verwendet:

  • ersetzt die markierte Textstelle,

  • fügt es hinter der Auswahl ein,

  • kopiert es in die Zwischenablage,

  • hebt Unterschiede hervor oder

  • erstellt eine neue Datei.

Während die KI Ihre Anfrage verarbeitet und Text einfügt, sperrt adoc Studio die aktuelle Datei kurzzeitig für manuelle Eingaben.

2.14. Programmeinstellungen

Mit Einstellungen passen Sie adoc Studio an Ihre Arbeitsweise an.

Allgemein

Öffnen Sie die Einstellungen über adoc Studio  Einstellungen … oder mit dem Tastaturkurzbefehl ⌘+,.

Im Reiter Allgemein konfigurieren Sie zentrale Editorfunktionen.

settingsgeneral
Zeilennummern

Legen Sie fest, ob der Editor alle Zeilennummern oder nur die aktuelle Zeile anzeigt.

Zuklappen von Abschnitten

Blenden Sie Dreiecke zum Ein- und Ausklappen von Abschnitten ein oder aus.

Zeige Dateiendungen

Bestimmen Sie, ob der Projektnavigator alle Dateiendungen anzeigt. Ist die Option deaktiviert, sehen Sie die Endung nur bei der ausgewählten Datei.

Zeilenbreite

Bestimmen Sie die maximale Zeichenanzahl pro Zeile. Ist das Editorfenster schmaler, bricht adoc Studio die Zeile automatisch um.

Abschnitts-Einrückung

Bestimmen Sie den linken Abstand von Überschriften. Wählen Sie einen Wert zwischen 0 und 6. Der Fließtext bleibt linksbündig, die =-Zeichen ragen entsprechend nach links.

Tabulatorbreite

Legen Sie fest, wie viele Zeichen ein Tabulator umfasst (1 bis 100). Bewährt haben sich Werte zwischen 3 und 5.

Einrücken mit

Bestimmen Sie, ob adoc Studio beim Einrücken Tabulatoren oder Leerzeichen verwendet.

Dateizugriff

settingsfileaccess

macOS und iOS schützen Dateien durch das Sandbox-Prinzip. Jede App arbeitet in einem eigenen, abgeschotteten Bereich.

Möchte adoc Studio auf Projektdateien außerhalb dieser Sandbox zugreifen, benötigen Sie eine Freigabe.

Alle freigegebenen Ordner erscheinen in der Liste dieses Tabs. Verwalten Sie Einträge mit + und -.

Öffnen Sie ein neues Projekt, fordert adoc Studio automatisch die erforderliche Berechtigung an.

Geben Sie einen übergeordneten Ordner frei, um wiederholte Nachfragen zu vermeiden.

Editorstile

settingseditorstyles

Gestalten Sie hier das Erscheinungsbild des Editors.

  • Wählen Sie links einen Stil.

  • Viele Stile unterstützen den Hellmodus ○ und den Dunkel-Modus ●.

  • Passen Sie in der mittleren Liste Schriftart, Größe und weitere Attribute an. Beginnen Sie mit „Allgemein“.

Wechselt Ihr System automatisch zwischen Hell- und Dunkelmodus, merkt sich adoc Studio den zuletzt gewählten Stil je Modus.

Produktstile

Öffnen Sie adoc Studio  Einstellungen … oder mit dem Tastaturkurzbefehl ⌘+, und wechseln Sie in den Reiter Produktstile.

In adoc Studio sind Inhalt und Gestaltung getrennt. Die Gestaltung erfolgt über Produktstile auf Basis von CSS. Damit gestalten Sie HTML, PDF-Dateien und Webseiten.

settingsproductstyles

  • Links: Liste aller verfügbaren Stile.

  • Rechts: Vorschau des ausgewählten Stils.

  • Unterhalb: Auswahl von Beispielinhalten (links) und Ausgabeformat (rechts).

Eigene Produktstile installieren

Produktstile besitzen die Endung .adocstyle. Installieren Sie einen Stil durch:

  • Doppelklick im Finder.

  • Bewegen der Datei in die Stileliste.

  • Klick auf + unterhalb der Liste.

Installierte Produktstile gehören nicht automatisch zum Projekt. Übertragen Sie bei einem Rechnerwechsel auch die verwendeten Stil-Dateien.

Produktstil als Standard festlegen

Klicken Sie mit der rechten Maustaste auf einen Stil und wählen Sie ihn als Standard.

adoc Studio verwendet diesen Stil automatisch für:

Produktstile entfernen

Klicken Sie mit der rechten Maustaste auf einen Stil und wählen Sie Löschen aus.

Eigene Produktstile erstellen

Um einen eigenen Produktstil zu erstellen oder zu bearbeiten, benötigen Sie CSS-Kenntnisse.

So erstellen Sie einen neuen Stil auf Basis eines vorhandenen:

  • Wählen Sie den Produktstil aus, der als Grundlage dienen soll.

  • Öffnen Sie über oder per Rechtsklick auf den Stil das Kontextmenü und wählen Sie Duplizieren.

  • adoc Studio legt den neuen Stil als eigenen Eintrag oben in der Liste an.

  • Doppelklicken Sie auf den Namen des neuen Stils und passen Sie ihn an.

Einen Stil bearbeiten

Bearbeiten Sie einen Produktstil mit einem Texteditor.

Geeignet als Texteditor ist z. B. Apple TextEdit im Modus „Reiner Text“ oder BBEdit. Sie können jeden Editor verwenden, der Ihre CSS-Inhalte im Unicode-Format (UTF-8) speichert.

Gehen Sie so vor:

  • Wählen Sie den gewünschten Produktstil aus.

  • Öffnen Sie über oder mit Rechtsklick das Kontextmenü und wählen Sie Bearbeiten in.

  • Wählen Sie Ihren bevorzugten Editor.

  • adoc Studio öffnet den Produktstil in der gewählten Anwendung.

  • Nehmen Sie die gewünschten Anpassungen vor. (siehe Details.

Lassen Sie adoc Studio geöffnet und aktivieren Sie den bearbeiteten Stil in der Vorschau. Ihre Änderungen im externen Editor werden sofort übernommen und gespeichert.