Meistern Sie AsciiDoc mit adoc Coach
Mit adoc Coach erlernen Sie AsciiDoc und beschleunigen Ihren Schreibprozess. Dieser Artikel erklärt, wie Sie das Menü effizient nutzen können.
Lernen Sie AsciiDoc, direkt in Ihrem Text
AsciiDoc erfreut sich aufgrund seiner einfachen Syntax großer Beliebtheit. Sie benötigen nur wenige Zeichen, um Ihren Text zu formatieren, zu gestalten und zu strukturieren. Dennoch ist das Erlernen jeder neuen Sprache mit einer Lernkurve verbunden. Normalerweise müssen Sie sich durch Dokumentationen und Foren arbeiten, um eine neue Auszeichnungssprache zu erlernen. Mit adoc Studio werden Sie schnell produktiv arbeiten können. Das wird durch das Vervollständigungsmenü adoc Coach ermöglicht.
Es bietet Ihnen Syntaxhilfe und Vorschläge direkt in der Eingabezeile. Auf diese Weise können Sie Ihren Text schreiben und die Syntaxelemente einblenden. Zu jedem Element erhalten Sie im Menü eine kurze Erklärung, die den Einstieg weiter erleichtert. In diesem Blogartikel erfahren Sie alles, was Sie über den adoc Coach wissen müssen.
Wie verwendet man adoc Coach?
Das Menu zeigt Ihnen alle möglichen Syntaxelemente an, die an Ihrer aktuellen Cursorposition relevant sind. Sie können ihn entweder explizit oder implizit aufrufen. Beide Varianten stehen Ihnen jederzeit zur Verfügung:
adoc Coach aktivieren (Explizite Vervollständigung)
Sie können adoc Coach auf folgende Weise aufrufen:
Drücken Sie die esc-Taste
Klicken Sie mit der rechten Maustaste in den Editor und wählen Sie „adoc Coach einblenden“.
Gehen Sie in das Editor-Menü und wählen Sie „adoc Coach einblenden“.
Stellen Sie sicher, dass Sie in den Editor klicken, bevor Sie adoc Coach aktivieren. Dadurch erhalten Sie Vorschläge, die auf der aktuellen Cursor-Position basieren.
Automatische Vorschläge (Implizite Vervollständigung)
Schreiben Sie Ihren Text. adoc Coach erkennt sowohl Nicht-AsciiDoc-Ausdrücke wie "Bild" als auch den englischen AsciiDoc-Ausdruck "image::". Beide Ausdrücke sind im Menü sichtbar, mit Nicht-AsciiDoc-Begriffen auf der linken Seite und den entsprechenden AsciiDoc-Ausdrücken auf der rechten Seite. Geben Sie zwei oder mehr Zeichen ein und warten Sie einen Augenblick, dann öffnet sich automatisch das Menü und schlägt passende Elemente vor. Wenn Sie diese nicht verwenden möchten, schreiben Sie einfach weiter, und das Menü schließt sich von selbst.
Technisches Schreiben auf Mac, iPad & iPhone
adoc Coach in der Praxis
Zum Üben fügen Sie eine Bedingung in den Text ein. Bedingungen ermöglichen es, Inhalte in einem Export einzuschließen oder auszuschließen.
Für das Beispiel bearbeiten Sie ein Software-Handbuch für macOS und iPadOS. Das Dokument soll speziell für iPad-Nutzer exportiert werden. Daher passen Sie den Text an die iPad-Version an. Der unten stehende Text soll angezeigt werden, wenn (1) der iPad-Export ausgewählt wird oder (2) das Attribut ":iPad:" direkt im Text angegeben wird. Gegenwärtig wird der Text in allen Exporten angezeigt.
Es gibt drei Bedingungen, die in AsciiDoc verwendet werden können: ifdef, ifndef und ifeval. Für jedes dieser Elemente gibt es unterschiedliche Anwendungsfälle: mehrzeilig, einzeilig, unterschiedliche Anzahl von Attributen usw. Dies kann für AsciiDoc-Neulinge verwirrend sein. Deshalb hilft Ihnen der adoc Coach, die ideale Bedingung für Ihren Text zu wählen.
In diesem Fall wollen Sie den Text nur einbetten, wenn das Attribut "iPad" aktiv ist. adoc Coach führt Sie durch den Auswahlprozess. Am Ende entscheiden Sie sich für eine ifdef-Bedingung für mehrere Zeilen, da Sie (1) ein einziges, definiertes Attribut haben und dieses für Text verwenden, der sich über mehr als eine Zeile erstreckt.
Jetzt müssen Sie nur noch das richtige Attribut auswählen oder ein Neues erstellen, wenn Sie es noch nicht verwendet haben. Im zweiten Fall können Sie das Attribut einfach manuell schreiben. Dadurch wird es auch in zukünftigen Situationen in der Liste erscheinen.
Dann integrieren Sie den Text in die Bedingung. Um ihn im Export anzuzeigen, können Sie ihn (1) im Export definieren oder (2) manuell mit :ipad: in den Text setzen.
Mit nur wenigen Klicks haben Sie die richtige Syntax für Ihren Text ausgewählt. Übrigens: Wenn Sie bereits wissen, welche Syntax Sie verwenden möchten, brauchen Sie diesen Auswahlprozess nicht jedes Mal zu durchlaufen. Sie können jedes beliebige Element direkt aufrufen. adoc Coach kann Ihnen helfen, das Schreiben der Syntax zu beschleunigen.
Tipps und Tricks
Verwenden Sie die Pfeiltasten, um sich durch die Optionen zu bewegen.
Drücken Sie die Eingabetaste, um eine Option auszuwählen.
Nach der Auswahl nutzen Sie die Tabulatortaste, um sich durch die Parameter zu bewegen.
Entfernen Sie irrelevante Parameter mit der Eingabetaste oder klicken Sie mit der Maus auf das x. Dies ist besonders nützlich für Titel oder Bildoptionen..
Wenn Sie ein iPad benutzen und eine externe Tastatur ohne esc-Taste verwenden, finden Sie weiterführende Informationen im Blogbeitrag zu diesem Thema.
