HelpNDoc enthält einen sehr leistungsfähigen Vorlagenprozessor, mit dem Sie jeden Teil der generierten Dokumentation anpassen können. Er bietet technischen Redakteuren eine breite Palette von Anpassungsoptionen, einschließlich der Möglichkeit, das Aussehen von Überschriften, Text, Tabellen, Bildern und anderen Elementen ihrer Dokumentation zu verändern. Designer können auch benutzerdefinierte Logos hinzufügen, die Hintergrundfarbe ändern und die Schriftgröße und den Stil anpassen, um einen einzigartigen und personalisierten Dokumentationsstil zu schaffen.
Technische Autoren können in ihrer HTML-Dokumentation eine spezielle robots.txt-Datei verwenden oder Robots-Meta-Tags definieren, um festzulegen, wie populäre Suchmaschinen wie Google oder Bing einzelne Seiten in den Suchergebnissen indizieren und ausliefern sollen. In diesem Artikel werden Sie erfahren, wie Sie die durch das Hilfe-Entwicklungstool HelpNDoc bereitgestellte Standard-HTML-Vorlage aktualisieren können, um eine robots.txt-Datei zu generieren, einen projektweiten Standardwert für das Robots-Meta-Tag anzugeben und dessen Inhalt auf bestimmten Dokumentationsseiten zu überschreiben. Der Artikel wurde durch einen Code des HelpNDoc-Benutzers Keith Phillips angeregt, dem wir für seinen Beitrag an dieser Stelle danken möchten.
Klicken Sie auf den Vorlagen-Editor, unter der Registerkarte Tools. Das “Berichtsvorlage bearbeiten”-Fenster wird geöffnet.
Klicken Sie nun auf den nach unten zeigenden Pfeil im Vorlage-Feld, um eine bestehende Vorlage auszuwählen. Klicken Sie auf die Vorlage umbenennen-Taste (Bleistift).
Das “Name der neuen Vorlage”-Fenster wird geöffnet.
Geben Sie den neuen Namen für die Vorlage ein und klicken Sie auf OK.
Das “Berichtsvorlage bearbeiten”-Fenster wird wieder angezeigt werden und der neue Name der Vorlage wird im Vorlage-Feld erscheinen.
Die vor Kurzem veröffentlichte neue Version von HelpNDoc (HelpNDoc 6.4) bietet eine verbesserte einseitige HTML-Vorlage, mit der Sie Ihrer generierten einseitigen HTML-Dokumentation ein Inhaltsverzeichnis hinzufügen können. Wir haben diese einseitige Vorlage mit HelpNDocs leistungsfähigem Vorlagen-Editor modifiziert und denken, dass es eine gute Idee ist, diesen Vorgang zu Lernzwecken zu dokumentieren. Befolgen Sie die in diesem Artikel beschriebenen Schritte, um zu erfahren, wie Sie Ihre HTML-basierten Dokumentationsvorlagen mit den in HelpNDoc integrierten Tools erstellen und ändern können.
Klicken Sie auf den Vorlagen-Editor, unter der Registerkarte Tools. Das ?Berichtsvorlage bearbeiten?-Fenster wird geöffnet.
Klicken Sie nun auf den nach unten zeigenden Pfeil im Vorlage-Feld, um eine bestehende Vorlage auszuwählen. Klicken Sie auf die Vorlage kopieren-Taste (Zwei Ordner), um die ausgewählte Vorlage zu duplizieren.
Das ?Vorlage kopieren?-Fenster wird geöffnet.
Wählen Sie die Art der neuen Vorlage aus (z.B. PDF oder Word).
Geben Sie den Namen der neuen Vorlage ein und klicken Sie auf Kopieren.
Klicken Sie auf den Vorlagen-Editor, unter der Registerkarte Tools. Das “Berichtsvorlage bearbeiten”-Fenster wird geöffnet. Klicken Sie nun auf das grüne Pluszeichen, um die gewünschte Art der Vorlage zu bestimmen. Das “Name der neuen Vorlage”-Fenster wird geöffnet. Geben Sie einen einmaligen Namen für die neue Vorlage ein und klicken Sie auf OK. Sie befinden sich nun wieder im “Berichtsvorlage bearbeiten”-Fenster. Der Name der neuen Vorlage wurde ausgewählt.
Benutzen Sie das Menü auf der linken Seite, um die Einstellungen und Eigenschaften Ihrer neuen Vorlage festzulegen.
Die Erstellung möglichst vollständiger, umfassender und aktueller Dokumentationen hat bei technischen Redakteuren oberste Priorität. Die Leser erwarten zudem ein sauberes und modernes Design, und die Unternehmen müssen häufig Dokumentationswebsites in ihr bestehendes Material integrieren und so ein vorgegebenes Look-and-Feel nachahmen. Glücklicherweise können Sie Ihre Inhalte mit dem HelpNDoc-Hilfe-Entwicklungstool schnell durch ein hinzugefügtes Logo oder einen CSS-Code oder vollständig durch das Erstellen einer komplett neuen Vorlage anpassen. In diesem Artikel erklären wir Ihnen, wie Sie benutzerdefinierte Symbole im Inhaltsverzeichnis der generierten HTML-Dokumentation verwenden können.
HelpNDoc ist ein leistungsfähiges Hilfe-Entwicklungstool, das mehrere Dokumentationsformate (einschließlich CHM, HTML, Word, PDF, ePub, Kindle, Qt Help) aus einer Hand generieren kann. Es verfügt über ein äußerst leistungsfähiges Vorlagensystem, mit dem Sie das Look-and-Feel der generierten Dokumentation in nahezu allen Einzelheiten anpassen können. Nachdem Sie eine benutzerdefinierte Vorlage erstellt haben, können Sie diese ganz einfach für mehrere Mitarbeiter freigeben oder sichern. Im Folgenden erfahren Sie, wie Ihnen das gelingt
PHP ist eine leistungsstarke serverseitige Skriptsprache, die seit Jahrzehnten ein wichtiges Tool für die Webentwicklung ist. Mit der Fähigkeit zur dynamischen Erstellung von Inhalten, Verbesserung der Benutzererfahrung, Handhabung von Sicherheitseinschränkungen, Erhöhung der Interaktivität und Erfassung von Benutzerdaten ist PHP eine ausgezeichnete Ergänzung für Online-Benutzerdokumentationen. Dank des leistungsstarken und vielseitigen Vorlagensystems von HelpNDoc sind diese Vorteile jetzt leicht zu erreichen: In diesem Artikel werden wir besprechen, wie die Integration von PHP in Online-Benutzerdokumentationen die Benutzererfahrung verbessern und eine bessere Interaktion und ein besseres Feedback bieten kann. Egal, ob Sie ein Webentwickler, ein technischer Redakteur oder einfach jemand sind, der eine Online-Dokumentation mit HelpNDoc verbessern möchte, dieser Artikel bietet wertvolle Informationen und Tipps zur optimalen Nutzung von PHP in Ihrer Online-Dokumentation.
HelpNDoc verfügt über einen äußerst leistungsfähigen Vorlagenprozessor, mit dem Sie beliebige Abschnitte Ihrer erstellten Dokumentation anpassen können. Meistens werden Sie die Standardvorlage des Dokumentationsformats, das Sie anpassen möchten, als Ausgangspunkt verwenden. Wenn jedoch eine neue Version von HelpNDoc veröffentlicht wird, kann die Standardvorlage durch neue Funktionen und Fehlerbehebungen weiterentwickelt worden sein, sodass Sie diese Änderungen eventuell in Ihre benutzerdefinierten Vorlagen übernehmen möchten. Dies ist möglich, indem Sie die aktualisierte Standardvorlage mit Ihrer eigenen Vorlage vergleichen und zusammenführen. Hier erklären wir Ihnen eine Methode, mit der Ihnen diese Aufgabe problemlos und zuverlässig gelingt
Klicken Sie auf die Vorlagen-Editor-Taste in der Registerkarte Tools. Das “Berichtsvorlage bearbeiten”-Fenster wird angezeigt werden.
Klicken Sie nun auf den nach unten zeigenden, schwarzen Pfeil, um die zu aktualisierende Vorlage auszuwählen.
Benutzen Sie das Menü auf der linken Seite, um die Eigenschaften zu bestimmen:
Seiteneinstellungen Wählen Sie die Papiergröße, die Orientierung der Seite, die Ränder und die Lage der Kopf- und Fußzeile aus.
Deckblatt Klicken Sie auf Deckblatt bearbeiten, um zum “Inhaltseditor”-Fenster zu gelangen.
