DSEDataSourceExplorer
DSE 1.0.1

README du Centre d’aide

Bienvenue dans le Centre d’aide DSE. Cette rubrique explique l’organisation du système d’aide Markdown intégré et la façon d’ajouter/mettre à jour les fichiers d’aide traduits.

À quoi sert ce système d’aide

DSE charge les rubriques d’aide depuis des fichiers Markdown stockés dans le dossier Help à côté de l’application. Chaque langue a son propre dossier, et chaque rubrique utilise le même nom de fichier dans toutes les langues.

Dossiers de langues pris en charge (projet actuel)

Comportement de repli (fallback)

Si la langue de l’interface n’a pas de fichier exact, DSE essaie :

  1. Le dossier de culture exact (ex. fr-CA, s’il existe)
  2. Le dossier de langue à deux lettres (fr)
  3. L’anglais (en)

Ajouter ou mettre à jour une rubrique

  1. Créez/modifiez d’abord le fichier anglais (ex. Help/en/help.readme.md)
  2. Ajoutez le même nom de fichier dans les autres dossiers de langue
  3. Traduisez le contenu en conservant la même structure Markdown
  4. Si c’est une nouvelle rubrique visible, ajoutez l’ID dans HelpCenterViewModel._topicIds
  5. Recompilez et testez le Centre d’aide

Conseils de rédaction

Astuce

Vous pouvez ouvrir le dossier d’aide directement depuis le Centre d’aide via le bouton Open Folder, modifier les fichiers Markdown puis recompiler.