Documentation

La fonctionnalité Documentation permet de stocker des informations sur les ressources dans la source de données. Pour accéder à la documentation d'une entrée, sélectionner une entrée dans le Volet de navigation, puis sélectionner l'onglet Documentation dans le Tableau de bord. Alternativement, cliquer avec le bouton droit sur une entrée dans le Volet de navigation, puis sélectionner Voir – Documentation.

La documentation est rédigée en utilisant Markdown ou WYSIWYG. Texte brut et HTML sont également disponibles.

  • Cette fonctionnalité est également disponible avec Devolutions Server, Devolutions Hub Business, Devolutions Hub Personal et les sources de données SQL Server.
  • La fonctionnalité Documentation est chiffrée uniquement pour les sources de données Devolutions Server, Devolutions Hub Business, et Devolutions Hub Personal. Si vous utilisez des sources de données comme SQL Server ou Azure SQL, la fonctionnalité Documentation n'est pas chiffrée.
  • La fonctionnalité d'utilisation de la Documentation en mode hors ligne est disponible pour les documents stockés dans la base de données. Cette propriété est définie pour être héritée par défaut.

Créer une nouvelle page

  1. Choisir l'entrée dans le Volet de navigation.

  2. Aller à l'onglet Documentation et cliquer sur Nouvelle page.

    Onglet Documentation – Nouvelle page
    Onglet Documentation – Nouvelle page

  3. Entrer un nom et sélectionner un Type de documentation.

    Type de documentation
    Type de documentation
    Note : Vous pouvez basculer entre Markdown et WYSIWYG lorsque vous sélectionnez Markdown dans Type de documentation.
    Markdown et WYSIWYG
    Markdown et WYSIWYG

  4. Choisir un Modèle par défaut.

    Modèle par défaut
    Modèle par défaut

    Tutoriel crée un document contenant du texte généré et Vide un document vierge. La dernière option, Personnalisé, vous permet de sélectionner un modèle personnalisé de votre choix.

    Vous pouvez sélectionner Définir comme nouveau défaut pour sauvegarder vos préférences lors de la création d'un nouveau document et Ajouter comme dernière page pour insérer la nouvelle page en bas de la liste des fichiers.

  5. Cliquer sur OK pour fermer la fenêtre.

Synchroniser la documentation hors ligne

  1. Choisir l'entrée dans le Volet de navigation.
  2. Aller à Administration – Paramètres Coffre dans le ruban.
    Paramètres Coffre
    Paramètres Coffre
  3. Dans Paramètres de sécurité – Hors ligne – Synchroniser la documentation en mode hors ligne, sélectionner Oui.
    Synchroniser la documentation en mode hors ligne
    Synchroniser la documentation en mode hors ligne
  4. Cliquer sur OK et fermer la fenêtre.

L'onglet Documentation hors ligne est maintenant disponible dans le Tableau de bord.

Onglet Documentation
Onglet Documentation

Donnez-nous vos commentaires