Stud.IP-Plugins
- Alle Plugins ((:pitscount:))
- Admin-Plugins
- Core-Plugins
- Homepage-Plugins
- Portal-Plugins
- Standard-Plugins
- System-Plugins
- Auth-Plugins
- Plugins für Version:
1.4 | 1.5 | 1.6 | 1.7 | 1.8 | 1.9 | 1.10 | 1.11 | 2.0
Spezifikation-plugin-spec
< Plugin-Versionsschema | Plugin-Spezifikation 2.0 | Plugin-Server? >
Plugin-Spezifikation · "Plugin-Spec"-Referenz
Auf dieser Seite... (ausblenden)
Um ein Stud.IP-Plugin zu erzeugen, muss man eine eine Plugin-Spezifikation definieren, die "Plugin-Spec".
Eine Plugin-Spec besteht aus verschiedenen Attributen. Manche sind notwendig, einige optional. Es folgt eine Liste dieser Attribute jeweils mit Beschreibung, Beispielen, Anmerkungen...
§1. authors
Typ: String; erforderlich
Beschreibung
Die Namen der Autoren des Plugins.
Beispiel
Anmerkung
Hier sollten nur die Namen des/der Autor/en genannt werden. E-Mail-Adresse und Homepage können mit Hilfe von email und homepage angegeben werden.
§2. date
Typ: String; erforderlich; default = date('c')
Beschreibung
Das Datum der Herstellung des Plugins. Kann per Hand gesetzt werden, entspricht aber ansonsten der Ausgabe von date('c') falls es nicht angegeben wurde.
Beispiel
2004-02-12T15:19:21+00:00
Anmerkung
Das Datum muss ISO-8601 konform angegeben werden.
§3. dependencies
Typ: Array; optional; default = []
Beschreibung
Eine Liste von Stud.IP-Plugins, die installiert sein müssen, damit dieses Plugin funktioniert.
Beispiel
Anmerkung
Bei der Installation eines Plugins, muss die Installationsapplikation die vorherige Installation dieser anderen Plugins sicherstellen.
§4. email
Typ: String; optional
Beschreibung
Die E-Mail-Adresse/n des/der Autor/en.
Beispiel
Anmerkung
§5. files
Typ: Array; erforderlich
Beschreibung
Die Dateien, die das Plugin enthält.
Beispiel
Anmerkung
§6. homepage
Typ: String; optional
Beschreibung
Die Homepage des/der Autor/en.
Beispiel
Anmerkung
§7. license
Typ: String; erforderlich
Beschreibung
Die Lizenz des Plugins, unter der es verteilt wird. Kann entweder den Namen oder einen Link auf die verwendete Lizenz enthalten.
Beispiel
AGPL v3.0
Anmerkung
TODO (mlunzena) Kann man auch den Namen einer Datei im Plugin-Paket angeben? Sollte das Standard sein?
§8. name
Typ: String; erforderlich
Beschreibung
Der Name des Plugins.
Beispiel
Anmerkung
Der Name enthält nicht die Versionsnummer; siehe #version.
TODO (mlunzena) Wie muss so ein Name aufgebaut sein? Soll das ein lesbarer Name sein oder lieber eine Art ID?
§9. studip_version
Typ: String; erforderlich
Beschreibung
Die erforderliche Version von Stud.IP.
Beispiel
Anmerkung
TODO (mlunzena) Sollte es nicht eine Minimum- und Maximumversion geben?
§10. summary
Typ: String; erforderlich
Beschreibung
Eine kurze Beschreibung des Plugins.
Beispiel
Anmerkung
Wird für die Auflistung installierbarer Plugins verwendet. Für eine umfangreichere Beschreibung des Plugins siehe #description.
§11. version
Typ: String; erforderlich
Beschreibung Die Version des Plugins. Siehe Plugin-Versionsschema
Beispiel
Anmerkung
Der version-String darf nur aus Zahlen und Punkten bestehen.
§11.1 TODO
Vermutlich sollte ein Plugin eine UUID enthalten, damit auch nachträgliche Namensänderungen, Forks und lokale Anpassungen berücksichtigt werden können.
< Plugin-Versionsschema | Plugins.Spezifikation | Plugin-Server? >
