Das Hilfesystem für Erweiterungen #

Teil 8, Referenz 32. Das Hilfezentrum der Administration zeigt die Dokumentation des Kernels und jeder aktiven Erweiterung. Diese Seite fasst die Einstellungen und Dateikonventionen an einer Stelle zusammen. Die Erklärung steht in Ihre Erweiterung dokumentieren, das Tutorial in Hilfeseiten für Ihre Erweiterung, von Hand und die vollständige Beschreibung in Das Hilfesystem und seiner Spezifikation.

Ihren doc-Ordner ausliefern #

Solange die Erweiterung aktiv ist ([IndexSettings] ActiveExtensionDocs=enabled, die Vorgabe), liefert die Hilfe die von Git verfolgten Dateien beider Orte aus, mit den Seiten-IDs ext/myext/<path below doc>. Nicht verfolgte Dateien werden nicht angezeigt. Klartextseiten (.txt, .rst, eine README ohne Endung) älterer Erweiterungen erscheinen weiterhin, als Klartext. Um die Seiten einer nicht aktiven Erweiterung zu zeigen, nennen Sie sie in settings/exphelp.ini.append.php der Installation:

[IndexSettings]
ExtensionDocDirs[]=myext

Die Konvention, mit einem Baum und einem umgewandelten Beispiel: Eine Extension dokumentieren.

Front Matter #

---
title: My extension: settings
audience: developer, admin
category: development
order: 10
summary: One sentence, at most 220 characters.
keywords: myext, settings
type: help
---
# My extension: settings

Zielgruppen-IDs (exphelp.ini [AudienceSettings] Audiences[]): editor, admin, developer, user, project-manager, sales-marketing, partner, advocate, designer, hosting, app-creator, website-creator, supporter, sponsor.

Ordner #

Die README.md eines Ordners ist seine Indexseite: Ihr Titel und ihre Reihenfolge sind die des Ordners in der Navigation. Verlinken Sie jede Seite aus der README ihres Ordners, damit keine verwaist.

Kontexthilfe #

Die Hilfe-Schaltfläche in der Kopfzeile öffnet die Hilfe zur aktuellen Seite:

[ContextHelp]
Map[myext]=ext/myext/README.md
Map[myext/settings]=ext/myext/settings.md#clearing-the-cache
Providers[]=myExtHelpContextProvider

Schlüssel sind module, module/view oder solche mit einem Design-Präfix (admin4l:myext/settings). Ein Provider implementiert expHelpContextProviderInterface (kernel/classes/help/exphelpcontextproviderinterface.php): helpContext( $module, $view, $design ) gibt "path[#anchor]" oder null zurück.

Schreibregeln, die die Hilfe durchsetzt #

• Nur Markdown: Rohes HTML wird maskiert.
• Relative Links müssen auf existierende Dateien zeigen, Anker auf existierende Überschriften.
• Bilder im selben Ordnerbaum.

Prüfen #

./console exp:exphelp check

meldet defekte Links, fehlende Anker und Probleme im Front Matter, mit Fehlern und Warnungen. Führen Sie es vor jedem Release Ihrer Dokumentation aus.

Verwandte Seiten #

• Zurück: admin4-Komponenten und -Tokens
• Weiter: expservices: entfernte Dienste für Erweiterungen
• Das Hilfesystem
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.