Écrire un guide d’application
Objectif
Donnez à votre application sa propre aide. Ce site d’aide explique la plateforme : comment fonctionne une vue et comment un formulaire enregistre. Il ne peut pas expliquer votre application, par exemple comment votre club prend une réservation. Un guide d’application est un court document markdown que vous écrivez dans la solution. Il est importé avec l’application, il figure dans le menu Aide de l’application, et un bouton d’un écran peut l’ouvrir.
Prérequis
- Vous êtes connecté en tant que créateur, avec une solution et un environnement sélectionnés.
- L’application concernée se trouve dans l’environnement. Il peut s’agir d’une application pilotée par modèle ou d’une application Studio.
Étapes
- Ouvrez votre solution et choisissez Guides de l’application.
- Sélectionnez Nouveau. Le concepteur s’ouvre avec un court exemple.
- Saisissez un Titre, par exemple Prendre une réservation. Le Nom se remplit pendant la saisie. Les écrans et les commandes ouvrent le guide par ce nom ; il ne peut donc plus être modifié après l’enregistrement.
- Dans Application, choisissez l’application dont le menu Aide doit lister le guide. Laissez vide pour un guide qui ne s’ouvre que par son nom.
- Ordre fixe la place du guide dans ce menu. Les petits nombres viennent en premier.
- Écrivez le guide dans l’éditeur. L’aperçu à côté montre exactement ce que verra le lecteur.
- Sélectionnez Enregistrer.
Écrire en markdown
| Vous écrivez | Le lecteur voit |
|---|---|
## Section | Un titre |
**bold**, *italic* | gras, italique |
1. Step | Une liste numérotée |
- Item | Une liste à puces |
`code` | code |
[text](https://example.com) | Un lien qui s’ouvre dans un nouvel onglet |
[text](guide:psl_guide_bookings) | Un lien vers un autre guide |
 | Une image du web |
Les tableaux, les citations et les blocs de code fonctionnent aussi.
Le HTML est affiché comme du texte. Un guide ne peut jamais exécuter de script, et un lien ne
s’ouvre que s’il commence par http, https, mailto ou guide:.
Autres langues
L’anglais est obligatoire. Chaque autre langue de la plateforme a un onglet à côté, et chacune est facultative. Une langue sans texte affiche un point après son nom. Ses lecteurs voient le guide en anglais, avec une note indiquant qu’il n’a pas été traduit. Vous pouvez donner un titre propre à une traduction, ou le laisser vide pour reprendre le titre anglais.
Ouvrir un guide depuis un écran ou une commande
-
Un écran Studio dessiné. Donnez à un bouton ce gestionnaire de clic :
openGuide("psl_guide_bookings");Le guide s’ouvre dans un panneau à côté de l’écran, pour que le lecteur le suive tout en continuant à travailler.
-
Un formulaire ou une vue. Ajoutez une commande. Sous Lorsqu’on appuie, choisissez Ouvrir un guide puis le guide.
-
Un autre guide. Faites-y un lien :
[how to cancel](guide:psl_guide_cancel).
Si un écran nomme un guide qui n’existe pas, rien ne s’ouvre. La liste des problèmes de l’écran et le message de la commande nomment tous deux le guide recherché.
Il voyage avec la solution
Un guide est un composant de solution, comme une table ou un script. Exporter la solution exporte le guide dans toutes ses langues. L’importer place le guide dans le menu Aide de l’environnement cible, et désinstaller la solution le supprime.
Résultat attendu
Dans le Shell, ouvrir l’application transforme Aide dans la barre supérieure en menu. Les guides de l’application viennent en premier, suivis de l’aide de la plateforme. Choisir un guide l’ouvre à côté de la page.