adoc Studio Version 3 ist live

Willkommen zu adoc Studio 3: Ihr nächster Schritt in der Dokumentation!

In diesem Blogartikel stellen wir Ihnen die wichtigsten Neuerungen vor und zeigen, wie sie Ihren Arbeitsalltag erleichtern.

Bibliographie

Die Bibliographie ist eine besondere Sektion, die in keinem wissenschaftlichen Projekt fehlen darf. Das Literaturverzeichnis ist ein eigener Bereich, der eine Liste unterschiedlichster Bücher, Paper und Artikel aufnimmt. Als Referenz darauf setzen Sie im Text die klassische Syntax für Verweise <<...>>.

// Der Verweis im Text wird über <<...>> angegeben.

Hier eine zitierte Aussage <<pp>>

// Der Verweis sieht in der Ausgabe so aus: "[pp]".
// Optional vergeben Sie nach einem Komma einen eigenen Text:

Hier eine zitierte Aussage <<pp, neuer Text>>

// Für die Bibliographie erstellen Sie eine neue Sektion, in der Sie Ihre Quellen auflisten

[bibliography]
== Bibliography
* [[[pp]]] Informationen zur Quelle

SF Symbols für Icon-Makros

Seit der zweiten Version kann adoc Studio das icon Makro nutzen, um aus der Font Awesome-Bibliothek kleine Symbole im Text zu platzieren. Ab sofort freuen sich nicht nur die Entwickler von macOS und iOS-Software über die SF Symbols. Dies ist die Sammlung aller Symbole, die in den verschiedenen Apple Betriebssystemen verwendet werden. In adoc Studio 3 greifen Sie auf über 6.000 Bilder für die Beschreibung Ihrer App-Interfaces zu.

1️⃣ Aktivieren Sie die Apple-Symbole, indem Sie folgende Attribute setzen:

:icons: font
:icon-set: apple

2️⃣ Fügen Sie die Icons mit dem Makro icon:Name[Parameter] ein. Während Sie tippen, schlägt Ihnen der adoc Coach automatisch passende Icons vor.

3️⃣ Personalisieren Sie die Icon anhand verschiedene Parameter:

• flip=horizontal oder flip=vertical

• link=... für Hyperlinks

• palette mit Varianten (Monochrome, Hierarchical, Multicolor)

• role=blue für eine farbliche Anpassung des Icons

• rotate=90|180|270

• set=apple|far|fab|fas für die Icon-Sets von Apple und Font Awesome

• size=1x|...|7x oder kurz [2x]

• title=... für einen Titel

• weight=ultralight|...|black für unterschiedliche Strichstärken

• window=blank|parent|_top für Link-Ziele

Hier ein paar Beispiele, um zu zeigen, was alles mit dem Icons Makro möglich ist:

icon:rainbow[palette=multicolor]

icon:arrow.right.circle.fill[palette=hierarchical, role=green]

icon:cloud.drizzle.fill[flip=vertical]

icon:view.2d[rotate=90, role=red]

icon:01.circle[weight=ultralight] 

icon:01.circle[weight=black]

Auflösung regeln, Dateigrößen senken

Ein wichtiges Thema für den Export sind Bilder. Die Herausforderung dabei ist oft die Größe. Vom Produkt-Team kommen meist Bilder in der maximalen Auflösung. Und das ist auch gut so. Aber der Leser einer Dokumentation, z. B. auf dem iPhone, kann keine Bilder mit hunderten von Megabytes gebrauchen.

In adoc Studio Version 3 gibt es neue Attribute, um die Auflösung Ihrer Bilder in der Ausgabe anzupassen. So lässt sich mit den folgenden Attributen nun die Dateigröße ihrer Dokumente verringern:

1. ads-max-image-resolution -> Legt die maximale Ausgabeauflösung von Bildern fest (in dpi, dpcm oder dppx), wenn Höhe oder Breite im Quellcode definiert sind.

2. ads-max-image-width -> Begrenzt die Bildbreite in der HTML-Ausgabe, wenn keine feste Höhe oder Breite angegeben ist.

3. ads-rasterizing-resolution -> PDF, SVG Bilder und STEM Formeln werden als PNG konvertiert und auf eine vorgegebene Resolution (in dpi, dpcm, dppx) festgelegt.

4. ads-static-stem -> Normalerweise werden STEM Formeln mit JavaScript exportiert. Mit dieser Option liegen sie dem Dokument als SVG bei (kein JavaScript mehr notwendig).

Projektwörterbücher für Ihr Team

Bisher wurde in adoc Studio das System-Wörterbuch verwendet. Jede Korrektur floss hier hinein. Das war bei professionellen Autoren mit vielen unterschiedlichen Projekten nicht optimal gelöst. Deshalb gibt es in adoc Studio 3 jetzt projektinterne Wörterbücher.

Bei aktivierter Rechtschreibprüfung (Bearbeiten → Rechtschreibung & Grammatik → Haken bei „Rechtschreib- & Grammatikprüfung" setzen) können Sie unbekannte Wörter direkt einem neuen Wörterbuch hinzufügen. Das Video zeigt, wie es funktioniert.

Das neue Wörterbuch (.adict-Datei) erscheint in der Seitenleiste. Es lässt sich natürlich versionieren, in andere Projekte übernehmen und im Team gemeinsam nutzen.

Automatisierung mit adoc Studio

Dokumentationsprodukte werden oft – insbesondere wenn es sich um laufende Projekte handelt – automatisiert erstellt. Ab dieser Version binden Sie adoc Studio nun in Ihre Prozesse ein. Das Kommandozeilen-Tool adocstudio wird einmalig auf dem System installiert und kann danach in allen Shell-Skripten eingebunden werden.

Dokument-Export:

adocstudio export documents --project Projektname.adocproject --document Dokumentname.adoc (Speicherort)

Produkt-Export:

adocstudio export products --project Projektname.adocproject --product Produktname (Speicherort)

Geben Sie einfach adocstudio help export products oder adocstudio help export documents im Terminal ein, um sich alle verfügbaren Befehle anzeigen zu lassen.

Neue Drag & Drop-Funktionen

1. Text aus dem Quelltext-Editor ziehen

Arbeiten Sie nun mit Textbausteinen. Sie können Text aus dem Editor herausziehen. Ziehen Sie ihn zum Beispiel auf Ihren Schreibtisch, um automatisch ein neues Textsnippet zu erstellen. Selbstverständlich kann ein Textsnippet auch wieder in den Editor gezogen werden.

2. Drag & Drop in den Quelltext

Ziehen Sie eine Datei wie file.adoc aus dem Projektnavigator in den Editor, wird deren Inhalt in das Ziel-Dokument kopiert. Hierbei gibt es 2 Varianten:

• Ziehen Sie eine externe Datei direkt in den Editor, wird ein Include-Statement eingefügt.

• Halten Sie während des Ziehens die Option-Taste gedrückt, wird immer deren Inhalt eingefügt.

Verbesserte Benutzerfreundlichkeit

• Kontextmenü für Bilder: „Im Projektnavigator zeigen“: Per Rechtsklick auf ein Bild in der Vorschau können Sie nun „Im Projektnavigator zeigen“ wählen. Dadurch wird die betreffende Datei direkt im Medienordner hervorgehoben, was das Auffinden und Bearbeiten erheblich beschleunigt.

• Sortieren von Projektdateien: Im Projektnavigator haben Sie ab sofort die Möglichkeit, Dateien nach Name, Änderungsdatum, Erstellungsdatum oder Größe zu sortieren – wahlweise aufsteigend oder absteigend. Wenn Sie eine manuelle Sortierung bevorzugen, können Sie die automatische Sortierung einfrieren und Ihre Dateien anschließend per Drag & Drop verschieben.

• Standardstil festlegen: Wechseln Sie in den Einstellungen (Befehl + Komma) zum Tab „Produktstile“. Dort können Sie per Rechtsklick auf einen Stil „Make Default“ auswählen. Dieser Stil wird automatisch für alle neuen Projekte genutzt und ist entsprechend fett markiert.

• Einbindung in bestehende HMTL Seiten: Über das neue :embedded: Attribut werden HTML Ausgaben ohne <head> oder <body> Tags ausgegeben und lassen sich auf HTML Seiten einbetten.

Jetzt 14 Tage kostenlos testen!

All diese neuen Funktionen sind ab sofort auf Mac, iPad und iPhone verfügbar. Wenn Sie adoc Studio 3 ausprobieren möchten, können Sie noch heute mit einer kostenlosen 14-Tage-Testphase starten. Holen Sie sich jetzt die neueste Version und erleben Sie, wie einfach professionelle Dokumentation sein kann!

Viel Erfolg und Freude mit adoc Studio Version 3!