Dokumentation des Plugins
Die Dokumentation für Plugins wird in der Datei user_doc.rst abgelegt. Früher wurde die Dokumentation in der
Datei README.md abgelegt. Falls ein Plugin noch eine Datei README.md hat, ist Information hieraus in
die user_doc zu überführen und anschließend ist die README.md zu löschen.
Die Konfigurationsparameter selbst müssen in der user_doc.rst nicht beschrieben werden. Die Dokumentation der Konfigurationsparameter und der Item Attribute wird automatisch aus den Metadaten (aus der plugin.yaml) generiert. Falls gewünscht kann jeweils auf die (automatisch generierte) Seite mit der Konfigurationsdokumentation verwiesen werden.
Die Dokumentation beginnt mit dem Titel, der dem Namen des Plugins entspricht. (in Lower Case - Plugin Namen sind Case sensitive!)
Wichtig
Im folgenden Template sind die Einträge in sptzen Klammern jeweils durch den gewünschten Inhalt zu ersetzen oder zu entfernen.
Die erste Überschrift der Dokumentationsdatei user_doc MUSS dem Kurznamen des Plugins in Kleinbuchstaben entsprechen.
Dieser Eintrag wird als Einstiegspunkt für die Navigation in der Dokumentation genutzt. Ein anderer Eintrag als Überschrift sorgt für Inkonsistenzen in den Navigationselementen.
Die user_doc.rst sollte folgendes Format haben:
.. index:: Plugins; Pluginname (in Kleinbuchstaben)
.. index:: Pluginname (in Kleinbuchstaben)
===============================
Pluginname (in Kleinbuchstaben)
===============================
.. comment set image name and extension according to the image file you use for the plugin-logo
.. image:: webif/static/img/plugin_logo.png
:alt: plugin logo
:width: 300px
:height: 300px
:scale: 50 %
:align: left
<Hier erfolgt die allgemeine Beschreibung des Zwecks des Plugins>
Anforderungen
=============
...
Notwendige Software
-------------------
<Hier wird weitere benötigte Software beschrieben. Falls keine weitere Software benötigt wird, kann dieser
Abschnitt entfallen.>
Unterstützte Geräte
-------------------
<Hier werden unterstützte Geräte beschrieben. Falls keine keine speziell zu beschreibenden Geräte unterstützt
werden, kann dieser Abschnitt entfallen.>
Konfiguration
=============
.. comment Den Text **Pluginname (in Kleinbuchstaben)** durch :doc:`/plugins_doc/config/pluginname` ersetzen
Die Plugin Parameter, die Informationen zur Item-spezifischen Konfiguration des Plugins und zur Logik-spezifischen
Konfiguration sind unter **Pluginname (in Kleinbuchstaben)** beschrieben.
Dort findet sich auch die Dokumentation zu Funktionen, die das Plugin evtl. bereit stellt.
Funktionen
----------
<Hier können bei Bedarf ausführliche Beschreibungen zu den Funktionen dokumentiert werden.>
<Sonst diesen Abschnitt löschen>
|
Beispiele
=========
Hier können bei Bedarf Konfigurationsbeispiele dokumentiert werden.
|
Web Interface
=============
<Hier erfolgt die Beschreibung des Web Interfaces>
Tab 1: <Name des Tabs>
----------------------
<Hier wird der Inhalt und die Funktionalität des Tabs beschrieben.>
.. image:: assets/webif_tab1.jpg
:class: screenshot
<Zu dem Tab ist ein Screenshot im Unterverzeichnis ``assets`` des Plugins abzulegen.
|
Version History
===============
<In diesem Abschnitt kann die Versionshistorie dokumentiert werden, falls der Plugin Autor dieses möchte.
Diese Abschnitt ist optional.>