Zeilen 151-152 bearbeitet:
Der Name enthält nicht die Versionsnummer; siehe #version.
geändert in:
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?
Zeilen 213-216 hinzugefügt:
TODO
Vermutlich sollte ein Plugin eine UUID enthalten, damit auch nachträgliche Namensänderungen, Forks und lokale Anpassungen berücksichtigt werden können.
Zeilen 12-15 bearbeitet:
dependencies
Typ: Array; optional; default = []
geändert in:
authors
Typ: String; erforderlich
Zeilen 18-19 bearbeitet:
Eine Liste von Stud.IP-Plugins, die installiert sein müssen, damit dieses Plugin funktioniert.
geändert in:
Die Namen der Autoren des Plugins.
Zeilen 24-25 bearbeitet:
Bei der Installation eines Plugins, muss die Installationsapplikation die vorherige Installation dieser anderen Plugins sicherstellen.
geändert in:
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.
Zeilen 30-33 bearbeitet:
files
Typ: Array; erforderlich
geändert in:
date
Typ: String; erforderlich; default = date('c')
Zeilen 36-37 bearbeitet:
Die Dateien, die das Plugin enthält.
geändert in:
Das Datum der Herstellung des Plugins. Kann per Hand gesetzt werden, entspricht aber ansonsten der Ausgabe von date('c') falls es nicht angegeben wurde.
Zeilen 40-41 hinzugefügt:
2004-02-12T15:19:21+00:00
Zeilen 44-45 hinzugefügt:
Das Datum muss ISO-8601 konform angegeben werden.
Zeilen 50-53 bearbeitet:
name
Typ: String; erforderlich
geändert in:
dependencies
Typ: Array; optional; default = []
Zeilen 56-57 bearbeitet:
geändert in:
Eine Liste von Stud.IP-Plugins, die installiert sein müssen, damit dieses Plugin funktioniert.
Zeilen 62-63 bearbeitet:
Der Name enthält nicht die Versionsnummer; siehe #version.
geändert in:
Bei der Installation eines Plugins, muss die Installationsapplikation die vorherige Installation dieser anderen Plugins sicherstellen.
Zeilen 65-173 hinzugefügt:
––
email
Typ: String; optional
Beschreibung
Die E-Mail-Adresse/n des/der Autor/en.
Beispiel
Anmerkung
(:toc-back:)
––
files
Typ: Array; erforderlich
Beschreibung
Die Dateien, die das Plugin enthält.
Beispiel
Anmerkung
(:toc-back:)
––
homepage
Typ: String; optional
Beschreibung
Die Homepage des/der Autor/en.
Beispiel
Anmerkung
(:toc-back:)
––
––
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?
(:toc-back:)
––
name
Typ: String; erforderlich
Beschreibung
Der Name des Plugins.
Beispiel
Anmerkung
Der Name enthält nicht die Versionsnummer; siehe #version.
(:toc-back:)
––
studip_version
Typ: String; erforderlich
Beschreibung
Die erforderliche Version von Stud.IP.
Beispiel
Anmerkung
TODO (mlunzena) Sollte es nicht eine Minimum- und Maximumversion geben?
(:toc-back:)
Zeilen 1-2 bearbeitet:
Plugin-Spec-Referenz
geändert in:
Plugin-Spezifikation · "Plugin-Spec"-Referenz
Zeilen 5-6 bearbeitet:
Um ein Stud.IP-Plugin zu erzeugen, muss man eine eine Plugin-Spezifikation definieren, die Plugin-Spec.
geändert in:
Um ein Stud.IP-Plugin zu erzeugen, muss man eine eine Plugin-Spezifikation definieren, die "Plugin-Spec".
Zeile 57 bearbeitet:
Der Name enthält nicht die Versionsnummer; siehe version.
geändert in:
Der Name enthält nicht die Versionsnummer; siehe #version.
Zeilen 3-4 hinzugefügt:
Zeilen 9-10 hinzugefügt:
Zeilen 27-28 hinzugefügt:
Zeilen 43-44 hinzugefügt:
Zeilen 61-62 hinzugefügt:
Zeilen 79-80 hinzugefügt:
Zeilen 95-97 bearbeitet:
geändert in:
Zeilen 1-83 hinzugefügt:
Plugin-Spec-Referenz
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…
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.
(:toc-back:)
files
Typ: Array; erforderlich
Beschreibung
Die Dateien, die das Plugin enthält.
Beispiel
Anmerkung
(:toc-back:)
name
Typ: String; erforderlich
Beschreibung
Der Name des Plugins.
Beispiel
Anmerkung
Der Name enthält nicht die Versionsnummer; siehe version.
(:toc-back:)
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.
(:toc-back:)
version
Typ: String; erforderlich
Beschreibung
Der Name des Plugins.
Beispiel
Anmerkung
Der Name enthält nicht die Versionsnummer; siehe #version.
(:toc-back:)
