Comment les rédacteurs techniques peuvent inclure du code PHP dans leur documentation en ligne

PHP est un puissant langage de script côté serveur qui constitue un outil essentiel du développement Web depuis des décennies. Grâce à sa capacité à générer du contenu de manière dynamique, à améliorer l’expérience utilisateur, à gérer les restrictions de sécurité, à augmenter l’interactivité ou à collecter des données utilisateur, il constitue un excellent complément à la documentation utilisateur en ligne. Grâce au système de modèles puissant et polyvalent de l’outil de création d’aide HelpNDoc, ces avantages sont maintenant facilement réalisables : explorons comment l’incorporation de PHP dans la documentation utilisateur en ligne peut aider à améliorer l’expérience utilisateur et à fournir un meilleur engagement et un meilleur retour d’information. Que vous soyez un développeur web, un rédacteur technique ou quelqu’un qui cherche à améliorer sa documentation en ligne, cet article vous fournira des informations et des conseils précieux sur la façon d’utiliser HelpNDoc pour tirer le meilleur parti de PHP dans votre documentation en ligne.

⚡ Avantages de l’ajout de code PHP aux ressources d’aide en ligne

Contrairement au contenu HTML statique, la documentation alimentée par PHP peut offrir une expérience utilisateur plus sûre, dynamique et interactive, permettant aux rédacteurs techniques de mieux répondre aux besoins de leurs utilisateurs.

L'éditeur de modèles de HelpNDoc avec du code PHP

L’incorporation de PHP dans la documentation utilisateur en ligne offre une nette amélioration par rapport au contenu HTML statique produit par la plupart des logiciels de création d’aide. Alors que le code HTML fournit une structure de base pour l’affichage des informations, PHP apporte une fonctionnalité dynamique car il permet la génération de contenu dynamique, rendant l’expérience de l’utilisateur plus interactive et engageante. Contrairement au HTML statique, la documentation utilisateur en ligne alimentée par PHP peut collecter des données sur l’utilisateur, fournir des restrictions d’accès sécurisées côté serveur et faciliter un meilleur retour d’information, permettant la personnalisation et l’adaptation aux besoins de l’utilisateur.
L’intégration de PHP dans la documentation utilisateur en ligne est généralement une tâche très difficile, mais avec le bon logiciel de création d’aide, cela devient beaucoup plus facile : HelpNDoc se distingue par son système de modèles puissant et polyvalent qui rend incroyablement simple l’ajout de code PHP à la documentation utilisateur en ligne.

🤔 Comment créer un modèle HTML personnalisé pour produire des fichiers PHP

Le logiciel de création d’aide HelpNDoc peut produire plusieurs formats de documentation à partir d’un seul projet, notamment des sites web HTML statiques entièrement adaptatifs. Les modèles personnalisés peuvent complètement personnaliser la sortie HTML de HelpNDoc pour inclure également du code PHP.

L'éditeur de modèles de HelpNDoc avec du code PHP

Voici les étapes simples nécessaires à la création d’un nouveau modèle :

  1. Dans l’onglet Outils du ruban de HelpNDoc, dans le groupe Modèles, cliquez sur Editeur de modèles pour ouvrir la fenêtre de l’éditeur de modèles
  2. Cliquez sur le bouton vert + puis cliquez sur Créer un modèle HTML pour créer un nouveau modèle HTML, qui est initialement une copie exacte du modèle par défaut
  3. Choisissez un nom de modèle tel que “Modèle PHP”

Le nouveau modèle est maintenant créé. Nous devons juste effectuer quelques modifications pour le faire fonctionner avec du code PHP, dans la section Paramètres généraux du modèle nouvellement créé :

  1. Changez l’extension de fichier par défaut en “php”.
  2. Changez le Format du lien vers les chapitres en “%helpid%.php”.
  3. Changez le Format du lien vers les ancres en “%helpid%.php#%anchorname%”.

Et c’est tout ! HelpNDoc peut maintenant utiliser ce modèle pour produire un site Web PHP entièrement fonctionnel. Voyez comment choisir un modèle pour vos constructions dans HelpNDoc.

😍 Comment exploiter le code PHP pour créer une meilleure aide en ligne : quelques exemples

Maintenant que nous pouvons créer un site web PHP dynamique à l’aide de l’outil de création d’aide HelpNDoc, tirons parti de ce puissant langage de script en ajoutant des scripts PHP personnalisés à notre documentation en ligne.

L'éditeur de modèles de HelpNDoc avec du code PHP

🔑 Password-protected documentation topics

En limitant l’accès aux sujets sensibles ou confidentiels, les rédacteurs techniques peuvent s’assurer que ces informations ne sont vues que par les utilisateurs autorisés. Cela permet de maintenir la confidentialité et de protéger les données sensibles.

Formulaire de mot de passe sécurisé en PHP

Maintenant que nous pouvons produire un site web PHP entièrement fonctionnel, limitons l’accès à certaines pages de documentation en demandant d’abord un mot de passe. Grâce au système de bibliothèque de HelpNDoc, nous pouvons créer un script PHP réutilisable et le placer dans n’importe quelle rubrique pour en restreindre l’accès. Voici comment procéder :

  1. Depuis l’onglet Accueil du ruban de HelpNDoc, dans le groupe Bibliothèque, cliquez sur Ajouter un élément puis Ajouter du code HTML.
  2. Spécifiez un Nom de l'élément de bibliothèque tel que “Accès restreint”.
  3. Entrez le code HTML/PHP suivant :
<hr>
<div style="margin:1em">
    <?php
        if(!isset($_GET["pass"]) || $_GET["pass"]!="secret") {
    ?>
        <p>Vous n'êtes pas autorisé à accéder à cette page.</p>
        <form>
            <div class="form-group">
                <label for="pass">Mot de passe:</label>
                <input class="form-control" id='pass' name='pass'></input>
            </div>
            <button type="submit" class="btn btn-primary">Connexion</button>
        </form>
    <?php
            exit;
        }
    ?>
</div>
  1. Cliquez sur OK : l’élément de bibliothèque est maintenant disponible dans la bibliothèque du projet
  2. Glissez et déposez cet élément de bibliothèque en haut de chaque rubrique à protéger.

Et voilà, c’est fait ! Générez à nouveau votre documentation et testez-la sur un serveur PHP : les visiteurs ne pourront pas accéder aux pages restreintes sans entrer le mot de passe “secret”.

💬 Recueillir les commentaires des utilisateurs pour améliorer la documentation

En recueillant les avis d’utilisateurs réels, les rédacteurs techniques peuvent acquérir une meilleure compréhension des forces et des faiblesses de leur documentation, ainsi que des domaines à améliorer.

Formulaire de commentaires PHP

C’est bien de pouvoir ajouter du code PHP personnalisé à certaines pages seulement, mais ce serait encore mieux de pouvoir ajouter automatiquement du code PHP à toutes les pages. Mettons à jour notre modèle pour qu’il le fasse, et incluons un système de feedback au bas de chaque sujet :

  1. Depuis l’onglet Outils du ruban de HelpNDoc, dans le groupe Modèles, cliquez sur Editeur de modèles pour ouvrir la fenêtre de l’éditeur de modèle
  2. Sélectionnez votre modèle PHP dans la liste
  3. Naviguez jusqu’à la section Fichiers script
  4. Sélectionnez le fichier script “topics.pas.html” et cliquez sur Editer le script pour ouvrir l’éditeur de script intégré de HelpNDoc
  5. Localisez la chaîne <footer> dans ce fichier, et ajoutez le code suivant juste avant :
<hr>
<div style="margin:1em">
    <?php
        if(isset($_POST["feedback"])) {	
            $from = "support@example.com";
            $to = "support@example.com";
            $headers = "From: $from";
            $subject = "Nouveau commentaire";
            $message = "Nouveau feedback pour le chapitre: <% print(aTopicList[nCurTopic].caption); %>\n\n" . $_POST["feedback"];
            mail($to,$subject,$message,$headers);
            echo("<p>Merci pour vos commentaires!</p>");
        }
        else {
    ?>
            <form method="POST">
                <div class="form-group">
                    <label for="feedback">Commentaire:</label>	
                    <textarea class="form-control" id="feedback" name="feedback" rows="3"></textarea>
                    <small class="form-text text-muted">Faites-nous savoir si vous avez des commentaires sur ce sujet.</small>
                </div>
                <button type="submit" class="btn btn-primary">Soumettre un commentaire</button>
            </form>
    <?php
        }
    ?>
</div>

Générez votre documentation et testez-la : elle inclut maintenant un système de commentaires basique mais fonctionnel! 🤯

Vous voulez créer de superbes documentations ?

HelpNDoc est gratuit, entièrement fonctionnel et facile à utiliser.
Produisez votre première documentation multi-format dans la minute qui suit.

Télécharger HelpNDoc ›

L’ajout de code PHP à la documentation utilisateur en ligne peut apporter une foule d’avantages, notamment la possibilité d’ajouter du contenu dynamique, de protéger par mot de passe des chapitres sensibles et de recueillir les commentaires des utilisateurs. Le système de modèles puissant et polyvalent de l’outil de création d’aide HelpNDoc permet d’atteindre facilement ces objectifs, permettant aux rédacteurs techniques de créer une documentation de haute qualité et attrayante qui répond aux besoins de leurs utilisateurs. Que vous cherchiez à améliorer l’expérience globale de l’utilisateur, à rationaliser les processus ou à protéger les informations sensibles, télécharger l’édition personnelle gratuite de HelpNDoc est la première étape vers la réalisation des nombreux avantages que PHP peut apporter à votre documentation. Alors profitez de cette opportunité et commencez dès aujourd’hui à tirer le meilleur parti de votre documentation utilisateur en ligne !

HelpNDoc peut générer plusieurs formats de documentation

Voir aussi...

images/replace-text-by-logo.jpeg
Maîtriser les mises à jour de contenu avec les outils de recherche et de remplacement de HelpNDoc pour les rédacteurs techniques

Êtes-vous fatigué de la lutte constante pour maintenir la documentation cohérente, à jour et sans erreur ? Pour les rédacteurs techniques et les auteurs de contenu, relever ces défis peut être une …

Lire la suite →
images/woman-student-back-to-school-helpndoc.jpg
Transformez votre salle de classe avec HelpNDoc : l'outil ultime de la rentrée pour les enseignants et les étudiants

À l’approche de la rentrée scolaire, les enseignants et les étudiants sont à la recherche d’outils susceptibles de simplifier la création de contenu, d’améliorer la collaboration et d’enrichir …

Lire la suite →
images/chm-help-file-size-and-position.png
Comment Personnaliser la Position et la Taille Initiales des Fichiers d'Aide CHM

Créer des fichiers CHM (Compiled HTML Help) avec HelpNDoc est un jeu d’enfant, grâce à son interface conviviale et à ses puissantes fonctionnalités. Dans cet article, nous examinerons comment vous …

Lire la suite →
images/produce-markdown-with-helpndoc-help-authoring-tool.png
Équilibrer la sécurité et la facilité d'utilisation : Les meilleurs formats de documentation pour le partage interne

Le partage efficace et sécurisé de la documentation est essentiel sur le lieu de travail moderne. Que vous distribuiez des manuels internes, de la documentation sur des projets ou des directives …

Lire la suite →
Catégories: articles
Tags: modèles sécurité trucs et astuces