Generierungsmatrix, Rohcode-Bibliothekselemente und Unterstützung externer Snippets in HelpNDoc 10.7

Wir freuen uns, die Veröffentlichung von HelpNDoc 10.7 bekanntzugeben – einem neuen Update, das technischen Redakteur:innen bessere Einblicke, flexiblere Möglichkeiten zur Wiederverwendung von Inhalten und reibungslosere Arbeitsabläufe bei der täglichen Inhaltserstellung bietet. Diese Version führt eine leistungsstarke Generierungsmatrix im Themenanalysator ein, mit der sich leicht nachvollziehen lässt, warum ein Thema in den einzelnen Builds eines Projekts exportiert oder nicht exportiert wird. Außerdem verbessert sie die Verwaltung wiederverwendbarer Inhalte durch das neue Rohcode-Bibliothekselement und die Unterstützung externer Snippet-Dateien. Gleichzeitig bringt sie wichtige Optimierungen am Bild-, Themen- und Gleichungseditor sowie bei der Generierung bedingter Inhalte und der allgemeinen Zuverlässigkeit.

Wie immer ist HelpNDoc für die persönliche Nutzung und zu Bewertungszwecken kostenlos, sodass Sie HelpNDoc 10.7 noch heute herunterladen und alle Verbesserungen selbst ausprobieren können.

🧩 Generierungsmatrix: Verstehen Sie genau, warum Themen exportiert werden

Die neue Generierungsmatrix im Themenanalysator erklärt, warum das aktuell analysierte Thema für jeden Build im Projekt exportiert oder nicht exportiert wird.

Der Themenanalysator von HelpNDoc ist ein unverzichtbares Tool für ein besseres Verständnis einzelner Themen. Er liefert detaillierte Statistiken, etwa zur Anzahl der in einem Thema verwendeten Absätze, Wörter und Bibliothekselemente. Außerdem listet er Hyperlinks, Anker, eingehende Hyperlinks, Bedingungen, Stichwörter, Rechtschreibfehler und sogar die einzelnen im Thema vorkommenden Zeichen auf.

HelpNDoc 10.7 macht den Themenanalysator durch die neue Generierungsmatrix noch nützlicher. Für das aktuell analysierte Thema bietet diese Matrix für jeden Build eine Erklärung dazu, ob das Thema exportiert wird und warum. Dies ist besonders wertvoll bei Projekten, die mehrere Ausgaben erzeugen, etwa ein öffentliches Benutzerhandbuch, eine interne Wissensdatenbank, einen PDF-Leitfaden und einen Markdown-Export – jeweils mit eigenen Regeln für Sichtbarkeit, Status und Tags.

Die Generierungsmatrix überprüft für jeden Build das Thema und seine übergeordnete Hierarchie. Wenn das Thema selbst oder eines seiner übergeordneten Themen für einen Build ausgeblendet ist, zeigt die Matrix eindeutig an, dass das Thema nicht exportiert wird. Sie prüft auch die Statusregeln für Themen: Wenn ein Build beispielsweise Themen mit dem Status “In Bearbeitung” ausschließt, wird jedes Thema oder jedes übergeordnete Thema mit diesem Status von dieser Ausgabe ausgeschlossen. Schließlich analysiert sie die Übereinstimmung integrierter und benutzerdefinierter Tags zwischen Themen, übergeordneten Themen und Builds und macht deutlich, wenn ein Thema ausgeschlossen wird, weil es nicht zur Tag-Konfiguration des Builds passt.

So lässt sich eine der häufigsten Fragen bei der Veröffentlichung von Dokumentationen sofort beantworten: “Warum fehlt dieses Thema in meiner Ausgabe?” Statt die Build-Einstellungen, Sichtbarkeit von Themen und übergeordneten Themen, Statusfilter und Tag-Regeln einzeln manuell zu überprüfen, können Redakteur:innen nun die vollständige Erklärung an einer zentralen Stelle einsehen.

🧾 Rohcode-Bibliothekselement: Formatspezifischer benutzerdefinierter Code für jede Ausgabe

Das bisherige Bibliothekselement “HTML-Code” wurde in “Rohcode” umbenannt und zu einem erweiterten Element ausgebaut, das HTML, Markdown und textbasierte Ausweichinhalte unterstützt.

Das bisher als “HTML-Code” bekannte Bibliothekselement wurde in HelpNDoc 10.7 deutlich verbessert und heißt nun “Rohcode”. Dieser neue Name spiegelt die erweiterte Rolle besser wider: Statt auf Roh-HTML für HTML-basierte Dokumentationsformate beschränkt zu sein, kann das Element nun formatspezifische Inhalte für mehrere Ausgabetypen bereitstellen.

Rohcode-Bibliothekselemente können weiterhin HTML-Code für HTML-basierte Dokumentationsformate wie CHM, HTML und kompatible E-Reader-Ausgaben enthalten. Sie können nun aber auch Markdown-Inhalte im Rohformat für Markdown-Builds enthalten, wobei der Code direkt als Markdown exportiert wird. Für alle anderen Dokumentationsformate können Rohcode-Bibliothekselemente einfachen Text bereitstellen, der unverändert exportiert wird.

Dadurch wird eine deutlich präzisere Anpassung der Ausgabe möglich. Technische Redakteur:innen sowie Entwickler:innen können nun ein einzelnes wiederverwendbares Bibliothekselement definieren, das sich an die jeweils generierte Ausgabe anpasst. Zum Beispiel könnte derselbe konzeptionelle Block in einem Webhandbuch ein benutzerdefiniertes HTML-Widget ausgeben, in einem Markdown-Export Markdown-Syntax im Rohformat und in berichtsbasierten Dokumentationen einen lesbaren Ausweichtext.

HelpNDoc 10.7 macht formatspezifische Anpassungen über die Bibliothek wiederverwendbar und hilft fortgeschrittenen Anwender:innen dadurch, Nachbearbeitungen zu vermeiden, doppelte Inhalte zu reduzieren und Projekte übersichtlicher zu halten, wenn mehrere Dokumentationsformate aus einer einzigen Quelle erstellt werden.

📚 Unterstützung externer Snippets: Nutzen Sie Rich-Text-Inhalte projektübergreifend

Snippets können nun während der Generierung aus externen Dateien geladen werden. Dadurch lassen sich wiederverwendbare Rich-Text-Inhalte einfacher projektübergreifend nutzen und pflegen.

Snippet-Bibliothekselemente bieten eine leistungsstarke Möglichkeit zur Wiederverwendung von Rich-Text-Inhalten in HelpNDoc-Projekten. Sie können formatierten Text und Absätze, Hyperlinks, Bilder, Tabellen und andere Rich-Text-Themeninhalte enthalten. Bisher wurden Snippets ausschließlich in der HelpNDoc-Projektdatei gespeichert. Dadurch waren sie innerhalb eines einzelnen Projekts praktisch, ließen sich aber schwieriger projektübergreifend nutzen.

HelpNDoc 10.7 unterstützt nun externe Snippet-Dateien. Snippets können nun bearbeitet und von der Festplatte geladen werden, sodass sie außerhalb des Projekts gespeichert werden können. Beim Generieren der Dokumentation lädt HelpNDoc die externen Snippet-Inhalte bei Bedarf und verwendet dabei den zum Zeitpunkt der Generierung aktuellen Dateiinhalt.

Dadurch wird die Wiederverwendung gemeinsam genutzter Rich-Text-Inhalte über mehrere Projekte hinweg deutlich vereinfacht. Teams können nun gemeinsame Warnhinweise, rechtliche Hinweise, Support-Anweisungen, Produktbeschreibungen, Verfahren, Haftungsausschlüsse oder wiederverwendbare Dokumentationsblöcke in externen Dateien pflegen und in mehreren HelpNDoc-Projekten darauf verweisen. Wenn die gemeinsame Datei aktualisiert wird, kann jedes Projekt, das sie verwendet, bei der nächsten Generierung der Dokumentation von der neuesten Version profitieren.

🖼️ Verbesserungen im Bild-, Themen- und Gleichungseditor

HelpNDoc 10.7 verbessert mehrere alltägliche Bearbeitungsabläufe – mit besserem Verhalten beim Einfügen von Bildern, zuverlässigeren Kopiervorgängen für Markdown und schnellerer Bearbeitung von Gleichungen.

Der integrierte Bildeditor von HelpNDoc erleichtert das Ergänzen von Bildern mit visuellen Anmerkungen wie Stempeln, Text, Linien, Formen und anderen Elementen. In HelpNDoc 10.7 ist das Einfügen eines Bildes bei ausgewählter Hintergrundebene nun flexibler: Sie können wählen, ob Sie das Hintergrundbild ersetzen oder eine neue Bildebene erstellen möchten.

Dadurch wird der Bildeditor vielseitiger und benutzerfreundlicher. Das Ersetzen des Hintergrunds ist ideal, wenn der ursprüngliche Screenshot oder die ursprüngliche Illustration aktualisiert werden soll. Das Erstellen einer neuen Ebene eignet sich hingegen besser, wenn ein eingefügtes Bild als Überlagerung oder Kompositionselement hinzugefügt werden soll. HelpNDoc ermöglicht es nun, direkt beim Einfügen das gewünschte Verhalten auszuwählen, wodurch Fehler reduziert werden und die Bildbearbeitung vorhersehbarer wird. Die neue Version behebt außerdem ein Problem, bei dem ein als Hintergrundebene eingefügtes Bild verzerrt werden konnte: Die Ebene wird nun korrekt an das neu eingefügte Bild angepasst.

Auch der Themeneditor erhält eine wichtige Verbesserung für Markdown-Workflows. Beim Kopieren ausgewählter Themeninhalte als Markdown werden eingebettete Bilder nun als inline eingebettete Base64-Daten übernommen. Das bedeutet: Wenn der Inhalt in ein Tool oder eine Plattform eines Drittanbieters eingefügt wird – etwa in einen Markdown-Editor oder -Viewer, ein Issue-Tracking-System, ein Notiztool oder eine Dokumentationsplattform –, bleiben die Bilder zusammen mit dem Text verfügbar, statt verloren zu gehen.

Dies sorgt für einen deutlich zuverlässigeren Workflow beim Extrahieren von Inhalten aus HelpNDoc als Markdown. Das ist besonders nützlich für Überprüfungen, die Zusammenarbeit, schnelle Veröffentlichungsentwürfe, Support-Antworten, Entwicklerdokumentation und alle Situationen, in denen kopiertes Markdown eigenständig bleiben muss, ohne separate Bilddateien zu benötigen.

Der Gleichungseditor wurde ebenfalls optimiert. Seine Ladezeit wurde deutlich verkürzt, insbesondere beim ersten Öffnen nach dem Start der Anwendung, sodass sich Gleichungen nun zügiger bearbeiten lassen. Die Bearbeitung von Gleichungen ist außerdem einfacher, da die Eingabe über die virtuelle Tastatur zuverlässiger funktioniert, die Cursor-Navigation verbessert wurde und akzentuierte Ausdrücke, Klammern und Relationsoperatoren präziser formatiert werden.

Mehrere Zuverlässigkeitskorrekturen runden diese Verbesserungen ab. Große bearbeitete Gleichungen werden nun im Themeneditor korrekt angezeigt, ohne unerwünschtes Abschneiden oder horizontale Bildlaufleisten. Außerdem besteht nicht mehr das Risiko, dass HelpNDoc die standardmäßige Gleichung E=mc2 statt der gerade bearbeiteten Gleichung anzeigt. Insgesamt sorgen diese Verbesserungen dafür, dass sich mathematische und wissenschaftliche Inhalte schneller, klarer und zuverlässiger erstellen lassen.

🛠️ Weitere neue Funktionen, Fehlerbehebungen und Verbesserungen

HelpNDoc 10.7 enthält außerdem zusätzliche Korrekturen für sauberere Generierungsausgaben, zuverlässigere Kopiervorgänge und ein verbessertes Editorverhalten.

Die Generierung bedingter Inhalte wurde verbessert, sodass eigenständige Markerzeilen mit IF, ELSE und END nun sauber entfernt werden, ohne zusätzliche Leerzeilen zu hinterlassen. Dadurch wird die generierte Dokumentation sauberer und der Bedarf an manuellen Formatierungsanpassungen bei der intensiven Nutzung von bedingten Inhalten reduziert.

Diese Version behebt außerdem einen “Zugriff verweigert”-Fehler, der beim Kopieren von Themeneditor-Inhalten mit Bildern auftreten konnte. Das Kopieren von Rich-Text-Inhalten aus HelpNDoc ist nun zuverlässiger, insbesondere bei bildlastigen Themen oder beim Verschieben von Inhalten zwischen HelpNDoc und externen Anwendungen.

Wie immer finden Sie die vollständige Liste der Änderungen in den ausführlichen Versionshinweisen unten.

🚀 Laden Sie HelpNDoc 10.7 noch heute herunter

HelpNDoc 10.7 ist für den persönlichen Gebrauch und zu Bewertungszwecken kostenlos. Laden Sie HelpNDoc 10.7 jetzt herunter und überzeugen Sie sich selbst von den Verbesserungen.

Ganz gleich, ob Sie mit der neuen Generierungsmatrix komplexe Veröffentlichungsregeln prüfen, mit Rohcode-Bibliothekselementen Ausgaben für mehrere Formate anpassen, wiederverwendbare Rich-Text-Inhalte über externe Snippets projektübergreifend nutzen oder von reibungsloseren Bearbeitungs- und Generierungsabläufen profitieren: HelpNDoc 10.7 bietet praktische Verbesserungen für technische Redakteur:innen, die an Projekten jeder Größe arbeiten.

👉 Laden Sie HelpNDoc 10.7 noch heute herunter und erfahren Sie, wie diese Verbesserungen Ihren Dokumentationsablauf übersichtlicher, schneller und zuverlässiger machen können.