Stud.IP Dokumentation
Stud.IP-Plugins
InstallationFAQFür EntwicklerNeues Plugin eintragenZum Trac |
< Plugin-Versionsschema | Plugin-Spezifikation 2.0 | Plugin-Server? > Plugin-Spezifikation · "Plugin-Spec"-ReferenzAuf 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. authorsTyp: 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. dateTyp: String; erforderlich; default = 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. dependenciesTyp: 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. emailTyp: String; optional Beschreibung Die E-Mail-Adresse/n des/der Autor/en. Beispiel Anmerkung –– §5. filesTyp: Array; erforderlich Beschreibung Die Dateien, die das Plugin enthält. Beispiel Anmerkung –– §6. homepageTyp: String; optional Beschreibung Die Homepage des/der Autor/en. Beispiel Anmerkung –– §7. licenseTyp: 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. nameTyp: 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_versionTyp: String; erforderlich Beschreibung Die erforderliche Version von Stud.IP. Beispiel Anmerkung TODO (mlunzena) Sollte es nicht eine Minimum- und Maximumversion geben? –– §10. summaryTyp: 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. versionTyp: String; erforderlich Beschreibung Die Version des Plugins. Siehe Plugin-Versionsschema Beispiel Anmerkung Der version-String darf nur aus Zahlen und Punkten bestehen. –– §11.1 TODOVermutlich 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? >
| ||
|