Home Credits Impressum more

Einblick in das Redaktionssystem Help&Manual

21.12.2024

Help&Manual ist ein kleines Redaktionssystem, mit dem man modularisierte, mehrsprachige und cross-mediale Dokumente erstellen kann. Auf dieser Seite finden Sie eine kurze Einführung in das Tool.

Im Vergleich zu einem Textverarbeitungsprogramm ergibt sich der Nutzen eines Redaktionsystem aus drei Eigenschaften:

Ein Redaktionssystem kann über weitere Funktionen verfügen (z.B. Terminologiefunktion oder Versionsverwaltung). Meiner Meinung nach sind die drei genannten die wichtigsten. Daher konzentriere ich mich in dieser Erführung auf diese drei.

Mit ca. 700 Euro pro Lizenz ist Help&Manual ein günstiges System. Falls sich 700 Euro teuer anhören - Alternative Systeme können das Hundertfache und mehr kosten.

Ein kurzer Sprint

Nach dem ersten Start der Software sehen Sie folgendes Menü:

Neues Projekt

  1. Klicken Sie auf „Neues Projekt“ und anschließend auf „Neues Projekt erzeugen“.
  2. Geben Sie den Speicherort Ihres Projekts an.

Speicherort

  1. Klicken Sie auf die Schaltfläche „Erzeugen“.

Projekt erzeugen

Es wurde nun eine Art Dummy-Dokument erstellt. Mit diesem Dokument können wir im nächsten Schritt die wichtigsten Funktionen ausprobieren.

Im oberen Bereich sehen Sie einige Bearbeitungsfunktionen, die von Microsoft Word bekannt zu sein scheinen.

Bearbeitungsfunktionen

Es gibt folgende Registerkarten:

90% der im Alltag benötigten Funktionen befinden sich in der Registerkarte „Einfügen“.

Im linken Bereich sehen Sie den sog. Projekt-Explorer. Der Projekt-Explorer stellt sozusage das Inhaltsverzeichnis des Dokuments dar (Map).

Projektexplorer

Im Projekt-Explorer wird besonders häufig gearbeitet. Je besser Sie den Projekt-Explorer verstehen, umso leichter wird Ihnen der Einstieg in das Programm Help&Manual fallen.

Unten im Projekt-Explorer finden Sie die beiden Aufklappmenüs „Projektdateien“ und „Konfiguration“.

Projektexplorer

Im mittleren Bereich sehen Sie den Inhalt des aktuellen Kapitels:

Inhaltsbereich

Nehmen Sie die 3 Registerkarten „Editor“, „XML-Code“ und „Eigenschaften“ zur Kenntnis. Diese befinden sich vertikal neben dem Eingabefeld.

Standardmäßig ist die Registerkarte „Editor“ geöffnet. Wechseln Sie zur Registerkarte „XML-Code“, sehen Sie, dass es sich bei jedem Topic eigentlich um eine XML-Datei handelt:

XML-Editor

Eine große Stärke des Programms Help&Manual ist es, dass die direkte Bearbeitung von XML-Dateien möglich ist. Im XML-Editor werden Sie aber in der Regel nicht arbeiten.

Schauen wir uns einmal an, wie ein Dokument als PDF-Datei exportiert wird:

  1. Klicken Sie auf die Schaltfläche „Datei“.

Datei-Menü

  1. Klicken Sie auf „Exportieren“.

Export-Menü

  1. Wählen Sie „PDF“ als Ausgabeformat.

PDF-Auswahl

  1. Geben Sie einen Speicherpfad an.

Speicherpfad

  1. Klicken Sie auf „Jetzt exportieren“.

Jetzt exportieren

Im PDF-Programm Ihrer Wahl können Sie das Ergebnis anschauen:

Exportfertig

Sie werden feststellen, dass es zwischen dem Aussehen der PDF und den Inhalten in Help&Manual Unterschiede gibt. Das ist kein Bug, sondern ein Feature. Grundsätzlich sind die Inhalte, die Sie in Help&Manual eingeben, unabhängig von einem Endformat wie z.B. PDF und HTML. Das finale Aussehen ergibt sich aus das der Vorlage, die beim Export verwendet wird.

Falls Sie weiter einsteigen möchten, finden Sie auf den folgenden Seiten weitere Informationen zu den 3 erwähnten Features des Programms:

Modularisierte Dokumente mit Help&Manual
Mehrsprachige Dokumente mit Help&Manual
Cross-mediale Dokumente mit Help&Manual