So können technische Redakteure PHP-Code in ihren Online-Dokumentationen verwenden

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.

⚡ Vorteile der Verwendung von PHP-Code in Online-Hilferessourcen

Im Gegensatz zu statischen HTML-Inhalten bieten auf PHP basierende Dokumentationen eine sicherere, dynamischere und interaktivere Benutzererfahrung, mit der technische Redakteure die Bedürfnisse ihrer Benutzer besser erfüllen können.

Die Integration von PHP in Online-Benutzerdokumentationen bietet eine deutliche Verbesserung im Vergleich zu statischen HTML-Inhalten, die durch die meisten Hilfe-Entwicklungstools erstellt werden. Obgleich HTML eine grundlegende Struktur für die Darstellung von Informationen ist, bietet PHP insofern eine dynamische Funktionalität, als dass es eine Generierung dynamischer Inhalte ermöglicht, wodurch das Benutzererlebnis interaktiver und ansprechender wird. Im Gegensatz zu statischen HTML-Inhalten können auf PHP basierende Online-Benutzerdokumentationen Benutzerdaten erfassen, sichere serverseitige Zugriffsbeschränkungen bereitstellen und ein besseres Feedback ermöglichen, sodass eine Anpassung an die Anforderungen des Benutzers möglich ist.
Die Integration von PHP in Online-Benutzerdokumentationen ist in der Regel eine äußerst schwierige Aufgabe, wird jedoch mit dem richtigen Hilfe-Entwicklungstool deutlich einfacher: HelpNDoc zeichnet sich durch sein leistungsstarkes und vielseitiges Vorlagensystem aus, das es unglaublich einfach macht, PHP-Code in Online-Benutzerdokumentationen einzufügen.

So erstellen Sie eine benutzerdefinierte HTML-Vorlage zur Generierung von PHP-Dateien

Das Hilfe-Entwicklungstool HelpNDoc kann mehrere Dokumentationsformate aus einem einzigen Projekt erstellen, einschließlich rundum responsiver, statischer HTML-Webseiten. Benutzerdefinierte Vorlagen können die HTML-Ausgabe von HelpNDoc komplett anpassen, sodass auch PHP-Code enthalten ist.

Zum Erstellen einer neuen Vorlage sind die folgenden einfachen Schritte erforderlich:

1. Klicken Sie auf die Registerkarte Tools und dann in der Gruppe Vorlagen auf Vorlagen-Editor, um das Fenster Vorlage bearbeiten zu öffnen.
2. Klicken Sie auf die grüne Schaltfläche + und dann auf HTML-Vorlage erstellen, um eine neue HTML-Vorlage zu erstellen, die zunächst eine exakte Kopie der Standardvorlage ist.
3. Wählen Sie einen Vorlagennamen wie z. B. “PHP-Vorlage” aus.

Die neue Vorlage wird jetzt erstellt. Wir müssen nun lediglich ein paar Änderungen im Abschnitt Allgemeine Einstellungen der neu erstellten Vorlage vornehmen, damit der PHP-Code funktioniert:

1. Ändern Sie die Voreingestellte Dateierweiterung zu “php”.
2. Ändern Sie Format mit Themen verlinken zu “%helpid%.php”.
3. Ändern Sie Format mit Ankern verlinken zu “%helpid%.php#%anchorname%”.

Und das war’s! HelpNDoc kann diese Vorlage nun zur Erstellung einer voll funktionsfähigen PHP-Website verwenden. Erfahren Sie, wie Sie eine Vorlage für Ihre Builds in HelpNDoc auswählen können.

So verwenden Sie PHP-Code zur Erstellung besserer Online-Hilfen: Einige Beispiele

Jetzt, da wir eine dynamische PHP-Website mit Hilfe des Hilfe-Entwicklungstools HelpNDoc erstellen können, wollen wir diese leistungsstarke Skriptsprache zum Einfügen von benutzerdefinierten PHP-Skripten in unsere Online-Dokumentation nutzen.

Passwortgeschützte Dokumentationsthemen

Durch die Beschränkung des Zugriffs auf sensible oder vertrauliche Themen können technische Redakteure sicherstellen, dass diese Informationen nur autorisierten Benutzern angezeigt werden. Dies trägt dazu bei, den Datenschutz zu wahren und sensible Daten zu schützen.

Jetzt da wir eine voll funktionsfähige PHP-Website erstellen können, werden wir den Zugriff auf einige Dokumentationsseiten insofern beschränken, als dass zuerst ein Passwort angefordert wird. Dank des Bibliothekssystems von HelpNDoc können wir ein wiederverwendbares PHP-Skript erstellen und zur Zugriffsbeschränkung in ein beliebiges Thema einfügen. So geht‘s:

1. Klicken Sie auf HelpNDocs Registerkarte Start und dann in der Gruppe Bibliothek auf Element hinzufügen und dann auf HTML-Code hinzufügen.
2. Geben Sie einen Namen des Bibliothekselements an, wie z. B. “Eingeschränkter Zugriff”.
3. Geben Sie den folgenden HTML-/PHP-Code ein:

<hr>
<div style="margin:1em">
    <?php
        if(!isset($_GET["pass"]) || $_GET["pass"]!="secret") {
    ?>
        <p>Sie sind nicht dazu berechtigt, auf diese Seite zuzugreifen.</p>
        <form>
            <div class="form-group">
                <label for="pass">Passwort:</label>
                <input class="form-control" id='pass' name='pass'></input>
            </div>
            <button type="submit" class="btn btn-primary">Login</button>
        </form>
    <?php
            exit;
        }
    ?>
</div>

4. Klicken Sie auf OK: Das Bibliothekselement ist jetzt in der Bibliothek des Projekts verfügbar.
5. Fügen Sie das Bibliothekselement per Drag-and-Drop am Anfang jedes Themas ein, das geschützt werden soll.

Und das war’s! Generieren Sie Ihre Dokumentation erneut, und testen Sie sie auf einem PHP-Server: Besucher können ohne Eingabe des “geheimen” Passworts nicht auf gesicherte Seiten zugreifen.

Sammeln Sie Feedback von Benutzern, um die Dokumentation zu verbessern

Durch das Erfassen von Erfahrungen tatsächlicher Benutzer können technische Redakteure ein besseres Verständnis der Stärken und Schwächen ihrer Dokumentation sowie der Bereiche erlangen, in denen Verbesserungen erforderlich sind.

Obgleich es schön ist, nur bestimmten Seiten einen benutzerdefinierten PHP-Code hinzufügen zu können, wäre es noch besser, automatisch allen Seiten PHP-Code hinzufügen zu können. Wir werden nun unsere Vorlage aktualisieren, um genau das zu tun und am Ende jedes Themas ein Feedback-System einzufügen:

1. Klicken Sie auf die Registerkarte Tools und dann in der Gruppe Vorlagen auf Vorlagen-Editor, um das Fenster Vorlage bearbeiten zu öffnen.
2. Wählen Sie Ihre PHP-Vorlage in der Liste aus.
3. Navigieren Sie zum Abschnitt Skriptdateien.
4. Wählen Sie die Skriptdatei “topics.pas.html” aus, und klicken Sie dann auf Skript bearbeiten, um den integrierten Skripteditor von HelpNDoc zu öffnen.
5. Suchen Sie die Zeichenfolge <footer> in dieser Datei, und fügen Sie den folgenden Code direkt davor ein:

<hr>
<div style="margin:1em">
    <?php
        if(isset($_POST["feedback"])) {	
            $from = "support@example.com";
            $to = "support@example.com";
            $Headers = "Von: $from";
            $subject = "Neues Feedback";
            $message = "Neues Feedback für Thema: <% print(aTopicList[nCurTopic].caption); %>\n\n" . $_POST["feedback"];
            mail($to,$subject,$message,$headers);
            echo("<p>Vielen Dank für Ihr Feedback!</p>");
        }
        else {
    ?>
            <form method="POST">
                <div class="form-group">
                    <label for="feedback">Feedback:</label>	
                    <textarea class="form-control" id="feedback" name="feedback" rows="3"></textarea>
                    <small class="form-text text-muted">Lassen Sie es uns wissen, falls Sie Feedback zu diesem Thema haben</small>
                </div>
                <button type="submit" class="btn btn-primary">Feedback absenden</button>
            </form>
    <?php
        }
    ?>
</div>

Erstellen Sie Ihre Dokumentation und testen Sie sie: Sie enthält jetzt ein einfaches, jedoch voll funktionsfähiges Feedback-System!

Das Hinzufügen von PHP-Code in Online-Benutzerdokumentationen kann eine Reihe von Vorteilen mit sich bringen, einschließlich der Möglichkeit, dynamische Inhalte hinzuzufügen, vertrauliche Themen mit einem Passwort zu schützen und Benutzerfeedback zu sammeln. Mit dem leistungsstarken und vielseitigen Vorlagensystem von HelpNDoc können technische Redakteure diese Ziele ganz einfach erreichen und so hochwertige, ansprechende Dokumentationen erstellen, die den Anforderungen ihrer Benutzer entsprechen. Ganz gleich, ob Sie die Benutzererfahrung insgesamt verbessern, Prozesse optimieren oder vertrauliche Informationen schützen möchten, das Herunterladen der kostenlosen Einzelbenutzer-Lizenz von HelpNDoc ist der erste Schritt, um die vielen Vorteile von PHP für Ihre Dokumentation zu nutzen. Ergreifen Sie also diese Gelegenheit und optimieren Sie Ihre Online-Benutzerdokumentationen noch heute!

Das könnte Sie auch interessieren...

Inhaltsaktualisierungen mit HelpNDocs Such- und Ersetzungsfunktionen für technische Redakteure

Haben Sie es satt, Ihre Dokumentationen ständig mühevoll konsistent, aktuell und fehlerfrei zu halten? Für technische Redakteure und Content-Autoren kann die Bewältigung dieser Herausforderungen eine …

Mehr lesen →

Transformieren Sie Ihren Unterrichtsraum mit HelpNDoc: Das ultimative Tool zur Unterstützung von Lehrkräften und Lernenden zu Beginn des neuen Lehrjahres

Angesichts des Beginns des neuen Lehrjahres sind Lehrkräfte und Lernende auf der Suche nach Hilfsmitteln, die die Inhaltserstellung vereinfachen, die Zusammenarbeit verbessern und die Lernerfahrung …

Mehr lesen →

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 →