Een app-handleiding schrijven
Doel
Geef uw app een eigen hulp. Deze helpsite legt het platform uit: hoe een weergave werkt en hoe een formulier opslaat. Ze kan uw app niet uitleggen, bijvoorbeeld hoe uw club een boeking aanneemt. Een app-handleiding is een kort markdown-document dat u in de oplossing schrijft. Ze wordt samen met de app geïmporteerd, staat in het Help-menu van de app, en een knop op een scherm kan haar openen.
Vereisten
- U bent aangemeld als maker, met een oplossing en een omgeving geselecteerd.
- De app waarvoor de handleiding is, staat in de omgeving. Dat kan een modelgestuurde app of een Studio-app zijn.
Stappen
- Open uw oplossing en kies App-handleidingen.
- Kies Nieuw. De ontwerper opent met een kort voorbeeld.
- Typ een Titel, bijvoorbeeld Een boeking aannemen. De Naam vult zich tijdens het typen. Schermen en opdrachten openen de handleiding met deze naam, dus na het opslaan kan hij niet meer veranderen.
- Kies bij App de app in wiens Help-menu de handleiding moet staan. Laat het leeg voor een handleiding die alleen op naam wordt geopend.
- Volgorde bepaalt de plaats van de handleiding in dat menu. Lagere getallen staan bovenaan.
- Schrijf de handleiding in de editor. Het voorbeeld ernaast is precies wat een lezer ziet.
- Kies Opslaan.
Schrijven in markdown
| U schrijft | De lezer ziet |
|---|---|
## Section | Een kop |
**bold**, *italic* | vet, cursief |
1. Step | Een genummerde lijst |
- Item | Een opsomming |
`code` | code |
[text](https://example.com) | Een link die in een nieuw tabblad opent |
[text](guide:psl_guide_bookings) | Een link naar een andere handleiding |
 | Een afbeelding van het web |
Tabellen, citaten en codeblokken werken ook.
HTML wordt als tekst getoond. Een handleiding kan nooit script uitvoeren, en een link opent alleen
als hij begint met http, https, mailto of guide:.
Andere talen
Engels is verplicht. Elke andere taal van het platform heeft ernaast een eigen tabblad, en elke taal is optioneel. Een taal waarin niets staat, toont een punt achter haar naam. Lezers van die taal zien de Engelse handleiding, met een melding dat ze niet is vertaald. U kunt een vertaling een eigen titel geven, of de titel leeg laten om de Engelse te gebruiken.
Een handleiding openen vanuit een scherm of een opdracht
-
Een getekend Studio-scherm. Geef een knop deze klikhandler:
openGuide("psl_guide_bookings");De handleiding opent in een paneel naast het scherm, zodat de lezer haar kan volgen en kan doorwerken.
-
Een formulier of een weergave. Voeg een opdracht toe. Kies bij Bij indrukken de optie Een handleiding openen en kies de handleiding.
-
Een andere handleiding. Link ernaar:
[how to cancel](guide:psl_guide_cancel).
Noemt een scherm een handleiding die er niet is, dan opent er niets. De probleemlijst van het scherm en de melding van de opdracht noemen allebei de handleiding die werd gezocht.
Ze reist mee met de oplossing
Een handleiding is een onderdeel van de oplossing, net als een tabel of een script. Bij het exporteren van de oplossing gaat de handleiding in al haar talen mee. Bij het importeren komt ze in het Help-menu van de doelomgeving, en bij het verwijderen van de oplossing verdwijnt ze.
Verwacht resultaat
In de Shell wordt Help in de bovenste balk een menu zodra u de app opent. Eerst komen de handleidingen van de app, daarna de hulp van het platform. Een gekozen handleiding opent naast de pagina.