Schnelles Hinzufügen eines Logos und benutzerdefinierten CSS- und JavaScript-Codes in Ihre HTML-Dokumentationsdateien

Das Schreiben einer Online-Hilfedatei, eines Benutzerhandbuchs, eines E-Books oder eines anderen durch HelpNDoc bearbeiteten Formats ist in der Regel ein langwieriger und nicht geradliniger Prozess. Mit zunehmender Entwicklung des Inhalts ist die übergreifende Themenhierarchie oft nicht mehr optimal, sodass eine Neugliederung erforderlich ist, um die Dokumentation einfacher lesbar und navigierbar zu machen. Obwohl HelpNDoc einige Tools zur einfachen Neugliederung des Inhaltsverzeichnisses bietet, kann dieser Vorgang mitunter langwierig und fehleranfällig sein, beispielsweise wenn eine alphabetische Themensortierung erforderlich ist. Zum Glück enthält HelpNDoc Scripts zum automatischen Umsortieren der Themen nach Titeln. Im Folgenden erfahren Sie, wie Ihnen das einfach und schnell gelingt.

Ausführen des Scripts zur Themensortierung

HelpNDoc bietet nicht nur leistungsstarke Scripting-Fähigkeiten, sondern es enthält zudem nützliche Script-Quellen wie etwa die Scripts “SortAllTopics” und “SortChildTopics”, die die Themen automatisch nach Titeln ordnen können.

Nachdem Sie Ihrer Dokumentation einige Themen hinzugefügt und die Themen vielleicht gegliedert haben, sind HelpNDocs Scripting-Fähigkeiten sehr hilfreich, um die Themensortierung zu automatisieren:

1. Klicken Sie auf “Script-Editor” in dem Tab “Tools” der HelpNDoc-Multifunktionsleiste.
2. Klicken Sie in dem Script-Editor-Fenster auf den Pfeil neben der Schaltfläche “Script laden”.
3. Klicken Sie auf “SortAllTopics.hnd.pas”, um das Script zur Themensortierung zu laden.
4. Klicken Sie auf “Script ausführen” … und fertig! Das gesamte Inhaltsverzeichnis wird nach Titeln geordnet.

Das war doch einfach. Was ist jedoch, wenn Sie nur einige und nicht alle Themen sortieren wollen?
Wählen Sie einfach ein Thema im Inhaltsverzeichnis aus, laden Sie das Script “SortChildTopics.hnd.pas” und führen Sie es wie oben beschrieben aus, und schon werden alle Unterthemen alphabetisch sortiert.

Benutzerdefiniertes Sortieren und spezielle Anforderungen

Das Sortieren der Themen nach Titeln ist nicht immer sinnvoll, und einige Projekte erfordern eventuell ein automatisiertes Sortieren der Themen anhand anderer Attribute wie beispielsweise anhand der Hilfe-Identifikatoren der Themen. Für solche besonderen Anforderungen können die enthaltenen Scripts als Ausgangspunkt dienen und leicht mithilfe HelpNDocs leistungsstarker und umfangreicher API angepasst werden.

Von der intuitiven Benutzeroberfläche bis hin zu den erweiterten Scripting-Fähigkeiten bietet HelpNDoc alle Tools, die für ein möglichst schnelles und einfaches Erstellen beeindruckender Hilfedateien, Produkthandbücher, E-Books etc. notwendig sind. Und das Beste daran: HelpNDoc ist komplett kostenfrei für den persönlichen Gebrauch und zu Bewertungszwecken. Probieren Sie es jetzt aus, und haben Sie Freude am Dokumentieren!

Das könnte Sie auch interessieren...

Anpassen der Ausgangsposition und -größe von CHM-Hilfedateien

Die Erstellung von CHM-Dateien (kompilierten HTML-Hilfedateien) mit HelpNDoc ist dank der benutzerfreundlichen Oberfläche und leistungsstarken Funktionen ein Kinderspiel. In diesem Artikel erfahren …

Mehr lesen →

Balance zwischen Sicherheit und Benutzerfreundlichkeit: Die besten Dokumentationsformate für die interne Freigabe

Die effektive und sichere Freigabe von Dokumenten ist in modernen Arbeitsumgebungen von entscheidender Bedeutung. Egal, ob Sie Handbücher, Projektdokumentationen oder Unternehmensrichtlinien intern …

Mehr lesen →

Die Geheimwaffe technischer Redakteure: Die einzigartigen Vorteile des Zeichen-Analysators von HelpNDoc

HelpNDoc hat sich als eine Lösung für Fachleute etabliert, die hochwertige, ansprechende und benutzerfreundliche Dokumentationen erstellen möchten. Es sind nicht nur die benutzerfreundliche Oberfläche …

Mehr lesen →

Optimale Anwendung von HelpNDoc: Wie die Funktion "Temporäre Dateien behalten" technischen Redakteuren helfen kann

Bei der Arbeit an technischen Dokumentationen können die uns zur Verfügung stehenden Werkzeuge und Funktionen einen großen Unterschied hinsichtlich unserer Produktivität und Effizienz ausmachen. Eine …

Mehr lesen →