Modularisierte Dokumente mit Help&Manual 9

21.12.2024

Mit Help&Manual 9 werden Inhalte einmalig erstellt und in verschiedenen Dokumenten wiederverwendet. Voraussetzung dafür ist ein gutes Ablagekonzept.

Wenn Sie die Kategorie „Projektdateien“ im Projektexplorer aufklappen, könnte Ihnen etwas doppeltgemoppelt vorkommen. Sie sehen dort die Kapitel, die bereits im Inhaltsverzeichnis Ihres Dokuments enthalten sind.

Alle Kapitel, die Sie mit Help&Manual erstellen, werden als XML-Dateien (auch Topics genannt) in einer Ordnerstruktur auf Ihrem PC gespeichert. Es gibt zwei Besonderheiten:

• Es können mehrere Ablageordner existieren.
• Mehrere Dokumente können sich dieselben Ablageordner teilen.

Der zweite Punkt erlaubt es, dass Inhalte, die in mehreren Dokumenten vorkommen, nur ein einziges Mal erstellt, gepflegt und übersetzt werden.

Hier erfahren Sie, wie Sie eine eigene Ablage (Repository) erstellen:

1. Klappen Sie das Menü „Projektdateien“ auf.

1. Klicken Sie mit der rechten Maustaste auf „Topic-Dateien“ und wählen Sie die Option „Neuer Ordner“.

1. Geben Sie einen Namen für den Ordner ein.

1. Klicken Sie auf den soeben angelegten Eintrag und wählen Sie im Kontextmenü „Neue Datei anlegen“.

1. Geben Sie einen Dateinamen an.

Anschließend können Sie das neue Topic per Drag&Drop ins Inhaltsverzeichnis des Dokuments ziehen.

Modularisierung auf Abschnittsebene

Für Topics gibt es zwei verschiedene Verwendungsmöglichkeiten:

• als Kapitel in einem Dokument (s.o.)
• als Teil eines Kapitels (Schnipsel)

Schnipsel eignen sich für Hinweistexte, die in vielen Dokumenten als Bestandteile von Kapiteln auftauchen können.

Technisch gesehen gibt es zwischen Kapitel-Topics und Schnipseln keinen Unterschied. In beiden Fällen handelt es sich um eine XML-Datei, die beide Verwendungen zulässt.

Um ein Topic als Schnipsel in ein anderes Kapitel einzufügen, gehen Sie wie folgt vor:

1. Klicken Sie in der Registerkarte „Einfügen“ auf die Schaltfläche „Schnipsel“.

1. Fügen Sie den Schnipsel über den Dateiexplorer ins Dokument ein.

Sie erkennen den Schnipsel daran, dass der Inhalt grau unterlegt ist.

Bilder

Um ein Bild einzufügen, klicken Sie in der Registerkarte „Einfügen“ auf die Schaltfläche „Bild“.

Es erscheint die folgende Meldung.

Wenn Sie die zweite Option wählen, speichert Help&Manual nicht nur den Dateinamen, sondern auch den Ordnerpfad, in welchem sich das Bild befindet. Das ist besonders refiniert. Denn wenn Sie ihr Dokument in eine andere Sprache übersetzen, brauchen Sie später nur den Ordnerpfad auszutauschen. (Konfiguration -> Projekt-Suchpfad)

Da Help&Manual alle Topics als XML-Dateien speichert, besteht auch die Möglichkeit, diese Dateien mit diversen Zusatztools zu bearbeiten. Dateiübergreifendes Suchen&Ersetzen, Übersetzungsprogramme und KI-Tools wären Beispiele. Auch kleine und mittelständische Unternehmen können mit Help&Manual eine Technische Redaktion aufbauen, die sich in die IT-Landschaft des Unternehmens prima einfügt.