Eine App-Anleitung schreiben
Ziel
Geben Sie Ihrer App eine eigene Hilfe. Diese Hilfeseite erklärt die Plattform: wie eine Ansicht funktioniert und wie ein Formular speichert. Sie kann Ihre App nicht erklären, etwa wie Ihr Verein eine Buchung aufnimmt. Eine App-Anleitung ist ein kurzes Markdown-Dokument, das Sie in der Lösung schreiben. Sie wird zusammen mit der App importiert, steht im Hilfe-Menü der App, und eine Schaltfläche auf einem Bildschirm kann sie öffnen.
Voraussetzungen
- Sie sind als Ersteller angemeldet und haben eine Lösung und eine Umgebung ausgewählt.
- Die App, für die die Anleitung ist, befindet sich in der Umgebung. Das kann eine modellgesteuerte App oder eine Studio-App sein.
Schritte
- Öffnen Sie Ihre Lösung und wählen Sie App-Anleitungen.
- Wählen Sie Neu. Der Designer öffnet sich mit einem kurzen Beispiel.
- Geben Sie einen Titel ein, zum Beispiel Eine Buchung aufnehmen. Der Name füllt sich beim Tippen aus. Bildschirme und Befehle öffnen die Anleitung über diesen Namen, deshalb lässt er sich nach dem Speichern nicht mehr ändern.
- Wählen Sie unter App die App, in deren Hilfe-Menü die Anleitung stehen soll. Lassen Sie das Feld leer für eine Anleitung, die nur über ihren Namen geöffnet wird.
- Reihenfolge legt den Platz der Anleitung in diesem Menü fest. Kleinere Zahlen stehen oben.
- Schreiben Sie die Anleitung im Editor. Die Vorschau daneben zeigt genau, was ein Leser sieht.
- Wählen Sie Speichern.
In Markdown schreiben
| Sie schreiben | Der Leser sieht |
|---|---|
## Section | Eine Überschrift |
**bold**, *italic* | fett, kursiv |
1. Step | Eine nummerierte Liste |
- Item | Eine Aufzählung |
`code` | code |
[text](https://example.com) | Einen Link, der in einem neuen Tab öffnet |
[text](guide:psl_guide_bookings) | Einen Link zu einer anderen Anleitung |
 | Ein Bild aus dem Web |
Tabellen, Zitate und Codeblöcke funktionieren ebenfalls.
HTML wird als Text angezeigt. Eine Anleitung kann niemals Skript ausführen, und ein Link öffnet
sich nur, wenn er mit http, https, mailto oder guide: beginnt.
Andere Sprachen
Englisch ist Pflicht. Jede weitere Sprache der Plattform hat daneben einen eigenen Tab, und jede ist optional. Eine Sprache, in der nichts geschrieben ist, zeigt einen Punkt hinter ihrem Namen. Leser dieser Sprache sehen die englische Anleitung mit einem Hinweis, dass sie nicht übersetzt wurde. Sie können einer Übersetzung einen eigenen Titel geben oder ihn leer lassen, dann gilt der englische.
Eine Anleitung von einem Bildschirm oder Befehl aus öffnen
-
Ein gezeichneter Studio-Bildschirm. Geben Sie einer Schaltfläche diesen Klick-Handler:
openGuide("psl_guide_bookings");Die Anleitung öffnet sich in einem Bereich neben dem Bildschirm, sodass der Leser ihr folgen und weiterarbeiten kann.
-
Ein Formular oder eine Ansicht. Fügen Sie einen Befehl hinzu. Wählen Sie unter Beim Drücken die Option Anleitung öffnen und dann die Anleitung.
-
Eine andere Anleitung. Verlinken Sie sie:
[how to cancel](guide:psl_guide_cancel).
Nennt ein Bildschirm eine Anleitung, die es nicht gibt, öffnet sich nichts. Die Problemliste des Bildschirms und die Meldung des Befehls nennen beide die gesuchte Anleitung.
Sie reist mit der Lösung
Eine Anleitung ist eine Lösungskomponente, genau wie eine Tabelle oder ein Skript. Beim Exportieren der Lösung wird die Anleitung in allen Sprachen exportiert. Beim Importieren erscheint sie im Hilfe-Menü der Zielumgebung, und beim Deinstallieren der Lösung wird sie entfernt.
Erwartetes Ergebnis
Im Shell wird Hilfe in der oberen Leiste beim Öffnen der App zu einem Menü. Zuerst kommen die Anleitungen der App, danach die Hilfe der Plattform. Eine gewählte Anleitung öffnet sich neben der Seite.