Documentation

La fonction 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électionnez une entrée dans le Volet de navigation, puis sélectionnez l'onglet Documentation dans le tableau de bord. Vous pouvez également cliquer avec le bouton droit sur une entrée dans le Volet de navigation, puis sélectionner Affichage - Documentation.

La documentation est écrite à l'aide de Markdown, une syntaxe de formatage de texte brut.

Cette fonctionnalité est disponible avec les sources de données Devolutions Server et SQL Server.

La fonctionnalité Documentation est chiffrée uniquement pour la source de données Devolutions Server. Si vous utilisez des sources de données telles que SQL Server ou Azure SQL, la fonctionnalité de 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.

Activer Synchroniser le document en mode hors ligne dans les Paramètres de sécurité. Cette propriété est définie pour être héritée par défaut.

RdmWin4057

Éditeur

L'éditeur de documentation est un simple éditeur de texte brut. Le texte est formaté à l'aide de la syntaxe de formatage de texte Markdown. Markdown est un langage de balisage conçu pour être aussi facile à lire et à écrire que possible.

RdmWin4071

Balises de mise en forme markdown

Paragraphes

Un paragraphe est constitué d'une ou plusieurs lignes consécutives. Les paragraphes normaux ne doivent pas être divisés avec des espaces ou des tabulations.

Accentuation

Deux méthodes d'accentuation du texte sont disponibles :

**Texte en gras**
*Texte en italique*

Affichage :

RdmWin4072

En-têtes

Il existe deux façons de créer des en-têtes avec Markdown.

Le premier et le deuxième niveau peuvent être créés en "soulignant" le texte avec des signes égaux (=) et des tirets (-).

En-tête de premier niveau
==================

En-tête de deuxième niveau
-------------------

Affichage :

RdmWin4073

Plus de niveaux d'en-têtes peuvent être créés en utilisant un à cinq symboles dièse (#) au début de la ligne.

# En-tête de premier niveau

## En-tête de deuxième niveau

### En-tête de troisième niveau

#### En-tête de quatrième niveau

##### En-tête de cinquième niveau

Affichage :

RdmWin4074

Listes

Utiliser des astérisques, des plus et des tirets pour créer une liste à puces non ordonnée. Ces trois marqueurs sont interchangeables.

* Objet 1
* Objet 2
* Objet 3
ou
+ Objet 1
+ Objet 2
+ Objet 3
ou
- Objet 1
- Objet 2
- Objet 3

Affichage :

RdmWin4075

Utiliser des nombres réguliers, suivis de points, pour créer une liste à puces ordonnée.

1. Objet 1
2. Objet 2
3. Objet 3

Affichage :

RdmWin4076

Barres horizontales

Utiliser trois barre de soulignement, astérisques ou tirets pour créer une barre horizontale.

___
ou
***
ou
---

Affichage :

RdmWin4077

Liens

Utiliser des crochets pour délimiter le texte que vous souhaitez transformer en lien.

Il existe deux manières de créer des liens : en ligne et de référence.

Utiliser des parenthèses immédiatement après le texte du lien pour les liens en ligne :

Naviguer sur le site internet [Devolutions](https://devolutions.net).

Affichage :

RdmWin4078

Optionnellement, un attribut de titre peut être inclus entre parenthèses.

Naviguer sur le site internet [Devolutions](https://devolutions.net "Devolutions").

Affichage :

RdmWin4079

Pour les liens de style référence, définir les liens ailleurs dans le document, puis faites référence à un lien par son nom dans un autre ensemble de crochets.

Naviguer sur le site internet [Devolutions][siteinternet] ou le [Forum][siteforum].

[siteinternet]: https://devolutions.net/ "Site internet Devolutions"
[siteforum]: https://forum.devolutions.net/ "Forum Devolutions"

Affichage :

RdmWin4080

L'attribut du titre est facultatif. Les noms de liens peuvent contenir des lettres, des chiffres et des espaces, mais ne sont pas sensibles à la casse.

Images

La syntaxe d'image est très similaire à la syntaxe de lien. Les images doivent être ajoutées dans le gestionnaire d'images avant de les référencer.

Pour ajouter des images dans le gestionnaire d'images, cliquer sur le bouton Gérer les images.

RdmWin4081

Cliquer sur Ajouter pour sélectionner une image sur l'ordinateur. Sélectionner l'image dans la liste et cliquez sur Insérer pour placer l'image dans le texte.

Citations en bloc

Citer un texte de citation en saisissant un symbole supérieur à (>) au début de la ligne de texte.

> Citation du texte

Affichage :

RdmWin4082

Les citations en bloc peuvent être imbriquées.

> Citation du texte
>> Imbrication du texte de la citation

Affichage :

RdmWin4083

Exemples de code

Le code en ligne est créé en entourant le texte d'un accent grave (`).

En ligne `code`.

Affichage :

RdmWin4084

Les blocs de code sont créés en indentant le texte avec quatre espaces au début de chaque ligne. Il doit y avoir une ligne vide avant.

    // Test de bloc de code indenté

    var markdownAwesomeness = 0;

    if (indentedCodeWorks) {
          markdownAwesomeness++;
    }

Affichage :

RdmWin4086

Une coloration syntaxique spécifique peut également être spécifiée.

var s = "JavaScript coloration syntaxique";
alerte(s);

Affichage :

RdmWin4085