Utilisation de l'aide - docwiki

De RAD Studio
Aller à : navigation, rechercher

Remonter à Utilisation de l'aide


L'aide en ligne de RAD Studio est disponible dans trois wikis distincts :

Tous les utilisateurs de RAD Studio sont invités à participer au docwiki. Vous pouvez créer votre propre compte utilisateur en cliquant sur Créer un compte ou se connecter depuis n'importe quelle page du docwiki.

Introduction

Vous devez vous connecter pour modifier la page Discussion. Pour obtenir la permission de modifier les pages principales, contactez documentation@embarcadero.com.

  • Cliquez sur l'onglet Discussion pour poser une question, ou répondre à une question, à propos de la rubrique.
  • Cliquez sur l'onglet Modifier pour afficher le balisage wiki et modifier facultativement la rubrique affichée.

Balises wiki de base lors de l'édition ou de l'écriture

Puces

Pour créer un paragraphe à puces, entrez une étoile ou un astérisque (*) dans la première colonne. Utilisez plusieurs étoiles pour les niveaux imbriqués, comme suit :

  • * Une étoile indique une puce de niveau supérieur, comme celle-ci.
    • ** Deux étoiles indiquent une puce de deuxième niveau, comme celle-ci.
      • *** Trois étoiles indiquent une puce de troisième niveau, comme celle-ci.

Liaison

Pour créer un hyperlien vers une autre rubrique sur le docwiki, placez le nom de la rubrique entre crochets doubles, comme suit :

 [[Object Inspector]] = Inspecteur d'objets

Liaison entre les wikis

Il existe en fait trois docwikis : Rubriques, Bibliothèques et Exemples de code, et vous pouvez créer facilement des liens d'un docwiki à un autre.

  • Pour créer un hyperlien vers la référence des bibliothèques, ajoutez le préfixe 'lib_fr:'. Pour les autres langues, utilisez lib_de, lib_en et lib_ja. Spécifiez le titre en utilisant un "|" pour éliminer le préfixe du lien :
    [[lib_fr:FMX.Forms.TForm|FMX.Forms.TForm]] = FMX.Forms.TForm
  • Pour effectuer un lien d'un autre docwiki vers le docwiki Rubriques, utilisez le préfixe 'rad_fr:' :
    [[rad_fr:Inspecteur d'objets|Inspecteur d'objets]] = Inspecteur d'objets
  • Pour effectuer un lien vers le docwiki Exemples de code, utilisez le préfixe samp: :
    [[samp:TrySystemTimeToDateTime ({{Delphi}})|TrySystemTimeToDateTime ({{Delphi}})]] = TrySystemTimeToDateTime (Delphi)

En-têtes

Pour créer des en-têtes de divers niveaux, commencez et terminez la ligne par un ou plusieurs signes égal (=). Un en-tête de niveau supérieur a un signe égal, et les en-têtes de niveau inférieur ont plusieurs signes égal, comme illustré ci-dessous :

== Sample Heading 2 ==

crée un en-tête de niveau 2, comme suit :

Exemple d'en-tête 2

=== Sample Heading 3 ===

crée un en-tête de niveau 3, comme suit :

Exemple d'en-tête 3

Ajout d'une page au docwiki

  1. Dans une rubrique associée (une rubrique qui nécessite un lien vers la rubrique que vous voulez créer), ajoutez un lien vers la nouvelle rubrique :
    [[nouvelle rubrique]]
  2. Enregistrez la page.
  3. Cliquez sur le lien (rouge) vers votre nouvelle rubrique.
  4. Vous pouvez maintenant commencer à écrire la nouvelle rubrique.
    • Au début, ajoutez une balise parent (pour fournir le lien "Remonter à") :
    {{Parent|rubrique de niveau supérieur}}
    qui pointe sur la rubrique située au-dessus de votre rubrique dans l'organisation de l'aide (le sommaire).
    Remarque: Si vous êtes incertain de la rubrique parent, contactez khouser@embarcadero.com.
    • En bas de la rubrique, ajoutez une liste facultative Voir aussi :
    ==Voir aussi==

Ajout de balises Category au wiki

Les balises Category vous permettent de grouper des rubriques associées. Pour examiner la liste des catégories qui existent actuellement sur le docwiki, voir Liste des catégories.

Chaque page doit comporter au moins l'une des balises suivantes :

  • balise de langage, Delphi ou C++, ou les deux
  • balise de version
  • balise de technologie facultative
  • balise d'organisation (telle que Guide du langage Delphi ou Référence RAD Studio)

Voici quelques exemples :

Delphi seulement :

[[Category:{{Delphi}}]]

C++ seulement :

[[Category:C++]]

Les deux :

[[Category:C++]]
[[Category:{{Delphi}}]]

Chaque page doit être marquée pour la version dans laquelle elle est apparue pour la première fois, ou pour la dernière version dans laquelle il y a eu des modifications majeures :

[[Category:XE2]]

Des catégories supplémentaires se rapportent à la technologie. Voici quelques suggestions :

Bibliothèque FireMonkey :

[[Category:FMX]]

Bibliothèque RTTI :

[[Category:RTTI]]

Rubriques

Voir aussi