diff --git a/mailsend/README.md b/mailsend/README.md deleted file mode 100755 index faff52858..000000000 --- a/mailsend/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# mailsend - -## Requirements - -This plugin has no requirements or dependencies. - -## Configuration - -### plugin.yaml - -```yaml -mail: - plugin_name: mailsend - host: mail.example.com - mail_from: mail@example.com - # tls: True - # username: False - # password: False - -``` - -#### Attributes - * `host`: specifies the hostname of your mail server. - * `port`: if you want to use a nonstandard port. - * `username`/`password`: login information - * `tls`: specifies if you want to use SSL/TLS. - * `mail_from`: for SMTP you have to specify an origin mail address. - -### items.yaml - -There is no item specific configuration. - - -## Functions - -The SMTP object provides one function (sending) and you access without specifing a method name. -`sh.mail(to, subject, message)` e.g. `sh.mail('admin@smart.home', 'Rain: Help me', 'You could send UTF-8 encoded subjects and messages')` diff --git a/mailsend/plugin.yaml b/mailsend/plugin.yaml index b14af5e64..c3c94a2a3 100755 --- a/mailsend/plugin.yaml +++ b/mailsend/plugin.yaml @@ -49,7 +49,7 @@ parameters: type: str default: '' description: - de: 'Absender-Adresse der eMails (mail@example.com)' + de: 'Absenderadresse der eMails (mail@example.com)' en: 'Sender address of the emails (mail@example.com)' username: @@ -83,7 +83,7 @@ plugin_functions: type: str description: de: "Empfänger der eMail (admin@smart.home)" - en: "Receipient of email (admin@smart.home)" + en: "Recipient of email (admin@smart.home)" subject: type: foo description: diff --git a/mailsend/user_doc.rst b/mailsend/user_doc.rst new file mode 100644 index 000000000..4a0b5a217 --- /dev/null +++ b/mailsend/user_doc.rst @@ -0,0 +1,98 @@ +.. index:: Plugins; sample +.. index:: sample + +====== +sample +====== + +Hier sollte eine allgemeine Beschreibung stehen, wozu das Plugin gut ist (was es tut). + +.. image:: webif/static/img/plugin_logo.png + :alt: plugin logo + :width: 300px + :height: 300px + :scale: 50 % + :align: left + + +Anforderungen +============= + +Anforderungen des Plugins auflisten. Werden spezielle Soft- oder Hardwarekomponenten benötigt? + + +Notwendige Software +------------------- + +* die +* benötigte +* Software +* auflisten + +Dies beinhaltet Python- und SmartHomeNG-Module + +Unterstützte Geräte +------------------- + +* die +* unterstütze +* Hardware +* auflisten + +| + +Konfiguration +============= + +Die Plugin Parameter und die Informationen zur Item-spezifischen Konfiguration des Plugins sind +unter :doc:`/plugins_doc/config/sample` beschrieben. + +plugin.yaml +----------- + +Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. + + +items.yaml +---------- + +Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. + + +logic.yaml +---------- + +Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. + + +Funktionen +---------- + +Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. + +| + +Beispiele +========= + +Hier können ausführlichere Beispiele und Anwendungsfälle beschrieben werden. (Sonst ist der Abschnitt zu löschen) + +| + +Web Interface +============= + +Die Datei ``dev/sample_plugin/webif/templates/index.html`` sollte als Grundlage für Webinterfaces genutzt werden. Um Tabelleninhalte nach Spalten filtern und sortieren zu können, muss der entsprechende Code Block mit Referenz auf die relevante Table ID eingefügt werden (siehe Doku). + +SmartHomeNG liefert eine Reihe Komponenten von Drittherstellern mit, die für die Gestaltung des Webinterfaces genutzt werden können. Erweiterungen dieser Komponenten usw. finden sich im Ordner ``/modules/http/webif/gstatic``. + +Wenn das Plugin darüber hinaus noch Komponenten benötigt, werden diese im Ordner ``webif/static`` des Plugins abgelegt. + +| + +Version History +=============== + +In diesem Abschnitt kann die Versionshistorie dokumentiert werden, falls der Plugin Autor dieses möchte. Diese Abschnitt +ist optional. +