develop:plugin.xml
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende ÜberarbeitungLetzte ÜberarbeitungBeide Seiten der Revision | ||
develop:plugin.xml [d.m.Y H:i] – angelegt willuhn | develop:plugin.xml [d.m.Y H:i] – [Die Sektionen im Einzelnen] willuhn | ||
---|---|---|---|
Zeile 4: | Zeile 4: | ||
Der Aufbau dieser Datei ist stark an das Format der " | Der Aufbau dieser Datei ist stark an das Format der " | ||
+ | Unter [[http:// | ||
Beispiel Hibiscus: | Beispiel Hibiscus: | ||
Zeile 10: | Zeile 11: | ||
<?xml version=" | <?xml version=" | ||
- | <plugin name=" | + | <plugin name=" |
+ | xmlns: | ||
+ | xsi: | ||
< | < | ||
< | < | ||
< | < | ||
+ | |||
+ | < | ||
+ | <import plugin=" | ||
+ | <import plugin=" | ||
+ | <import plugin=" | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
< | < | ||
<item id=" | <item id=" | ||
- | <item id=" | + | <item id=" |
+ | | ||
<item name=" | <item name=" | ||
[...] | [...] | ||
Zeile 24: | Zeile 42: | ||
</ | </ | ||
| | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
< | < | ||
<item id=" | <item id=" | ||
Zeile 61: | Zeile 73: | ||
</ | </ | ||
+ | < | ||
+ | < | ||
+ | <message queue=" | ||
+ | < | ||
+ | ${manifest.pluginDir}/ | ||
+ | ]]> | ||
+ | </ | ||
+ | </ | ||
</ | </ | ||
</ | </ | ||
- | |||
==== Die Sektionen im Einzelnen ==== | ==== Die Sektionen im Einzelnen ==== | ||
Zeile 74: | Zeile 93: | ||
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | ||
| name | Legt den Namen des Plugins fest. Dieser muss in Jameica eindeutig sein. Er sollte keine Leerzeichen enthalten | | | name | Legt den Namen des Plugins fest. Dieser muss in Jameica eindeutig sein. Er sollte keine Leerzeichen enthalten | | ||
| version | Versionsnummer bestehend aus Major- und Minor-Number. | | | version | Versionsnummer bestehend aus Major- und Minor-Number. | | ||
| class | " | | class | " | ||
+ | | shared | Legt fest, ob die Klassen dieses Plugins auch für andere Plugins sichtbar sein sollen (Default=true). Wert kann auf " | ||
Zeile 88: | Zeile 107: | ||
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | ||
| description | Optionale Beschreibung des Plugins. Wird z.Bsp. unter Datei-> | | description | Optionale Beschreibung des Plugins. Wird z.Bsp. unter Datei-> | ||
| homepage | Homepage des Plugins/ | | homepage | Homepage des Plugins/ | ||
| license | Bezeichnung der Lizenz des Plugins | | | license | Bezeichnung der Lizenz des Plugins | | ||
- | + | === Dependencies | |
- | === Menu === | + | Der Pluginloader löst Abhängigkeiten zwischen Plugins selbst auf und lädt die Plugins |
- | + | ||
- | Definiert | + | |
<code xml> | <code xml> | ||
- | <menu> | + | <requires jameica=" |
- | <item id="hibiscus.menu" | + | <import plugin="Name des benoetigten Plugins"/> |
- | <item id="hibiscus.menu.settings" | + | <import plugin="Name des benoetigten Plugins2" |
- | <item name="-" /> | + | <import plugin="Name des benoetigten Plugins3" |
- | [...] | + | ... |
- | </ | + | </requires> |
- | </menu> | + | |
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | + | | requires |
- | | menu | Container für die Menuelemente | + | | jameica |
- | | item | Ein einzelnes Menuelement. Können beliebige verschachtelt werden, um Untermenus zu erzeugen | + | | import |
- | | id | Eindeutige ID für diesen Menupunkt für eventuelle Erweiterung mittels [[develop:: | + | | plugin |
- | | name | Bezeichnung | + | | version |
- | | action | + | | required | Legt fest, ob die Abhängigkeit erfüllt sein muss oder nicht (default=" |
+ | |||
+ | Versionsnummern können in den folgenden Formaten angegeben werden: | ||
+ | |||
+ | ^ Beispiel | ||
+ | | 2.0 | Plugin/ | ||
+ | | 1.2- | Plugin/ | ||
+ | | 1.7+ | Plugin/ | ||
Zeile 128: | Zeile 150: | ||
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | ||
| include | Regulärer Ausdruck für einen Dateinamen/ | | include | Regulärer Ausdruck für einen Dateinamen/ | ||
+ | |||
+ | |||
+ | === Menu === | ||
+ | |||
+ | Definiert die im Jameica-Menu (unterhalb des Menupunktes " | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | <item id=" | ||
+ | <item id=" | ||
+ | <item name=" | ||
+ | [...] | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | | menu | Container für die Menuelemente | | ||
+ | | item | Ein einzelnes Menuelement. Können beliebige verschachtelt werden, um Untermenus zu erzeugen | | ||
+ | | id | Eindeutige ID für diesen Menupunkt für eventuelle Erweiterung mittels [[develop:: | ||
+ | | name | Bezeichnung des Menuelementes | | ||
+ | | action | Name der Java-Klasse, | ||
+ | | enabled | Legt fest, ob das Menuelement aktiv oder inaktiv (grau) sein soll. Default: true | | ||
Zeile 142: | Zeile 185: | ||
icon-close=" | icon-close=" | ||
icon-open=" | icon-open=" | ||
- | action=" | + | action=" |
+ | expanded=" | ||
+ | enabled=" | ||
</ | </ | ||
</ | </ | ||
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | ||
| navigation | Container für die Navigations-Elemente | | | navigation | Container für die Navigations-Elemente | | ||
| item | Ein einzelnes Menuelement. Können beliebige verschachtelt werden, um Untermenus zu erzeugen | | | item | Ein einzelnes Menuelement. Können beliebige verschachtelt werden, um Untermenus zu erzeugen | | ||
Zeile 155: | Zeile 199: | ||
| icon-open | Optionale Angabe eines Icons, welches angezeigt wird, wenn der Knoten geöffnet ist | | | icon-open | Optionale Angabe eines Icons, welches angezeigt wird, wenn der Knoten geöffnet ist | | ||
| action | Name der Java-Klasse, | | action | Name der Java-Klasse, | ||
+ | | expanded | Optionales Attribut, welches festlegt, ob das Element auf- oder zugeklappt sein soll. Standardmäßig ist es aufgeklappt. | | ||
+ | | enabled | Legt fest, ob das Navigations-Element aktiv oder inaktiv (grau) sein soll. Default: true | | ||
Zeile 174: | Zeile 220: | ||
</ | </ | ||
- | ^ Name des Elements / Attributes ^ Bedeutung ^ | ||
| services | Container für die Liste der Dienste | | | services | Container für die Liste der Dienste | | ||
| service | Ein einzelner Service | | | service | Ein einzelner Service | | ||
Zeile 184: | Zeile 229: | ||
+ | === Messaging === | ||
+ | |||
+ | Das Messaging ist eine elegante Möglichkeit, | ||
+ | Außerdem können in diesem Abschnitt des Manifests auch direkt Messages versendet werden. Das ist z.Bsp. für Plugins sinnvoll, die keinen eigenen Java-Code mitbringen aber dennoch eine Message versenden wollen. Die Message wird immer beim Start von Jameica versendet. Der Content des XML-Elements " | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | <message queue=" | ||
+ | < | ||
+ | ${manifest.pluginDir}/ | ||
+ | ]]> | ||
+ | </ | ||
+ | </ | ||
+ | </ |
Impressum | Datenschutz
develop/plugin.xml.txt · Zuletzt geändert: d.m.Y H:i von willuhn