Benutzer-Werkzeuge

Webseiten-Werkzeuge


develop:plugin.xml

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
Nächste ÜberarbeitungBeide Seiten der Revision
develop:plugin.xml [d.m.Y H:i] willuhndevelop:plugin.xml [d.m.Y H:i] willuhn
Zeile 4: Zeile 4:
  
 Der Aufbau dieser Datei ist stark an das Format der "plugin.xml" von Eclipse-Plugins angelehnt. Der Aufbau dieser Datei ist stark an das Format der "plugin.xml" von Eclipse-Plugins angelehnt.
 +Unter [[http://www.willuhn.de/schema/jameica-plugin-1.0.xsd]] befindet eine [[http://de.wikipedia.org/wiki/XML-Schema|XML-Schema-Datei]], welche eine technische Beschreibung des XML-Formats liefert. Wird diese Schema-Datei wie im folgenden Beispiel mittels "xsi:noNamespaceSchemaLocation" referenziert, kann die Syntax der plugin.xml (abhängig vom verwendeten XML-Editor) sofort geprüft werden. Ggf. steht dann auch eine Text-Vervollständigung zur Verfügung.
  
 Beispiel Hibiscus: Beispiel Hibiscus:
Zeile 10: Zeile 11:
 <?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
  
-<plugin name="hibiscus" version="1.7" class="de.willuhn.jameica.hbci.HBCI">+<plugin name="hibiscus" version="1.7" class="de.willuhn.jameica.hbci.HBCI
 +  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 +  xsi:noNamespaceSchemaLocation="http://www.willuhn.de/schema/jameica-plugin-1.0.xsd"> 
  
   <description>HBCI-Onlinebanking-Plugin für Jameica</description>   <description>HBCI-Onlinebanking-Plugin für Jameica</description>
   <homepage>http://www.willuhn.de/projects/hibiscus</homepage>   <homepage>http://www.willuhn.de/projects/hibiscus</homepage>
   <license>GPL - http://www.gnu.org/copyleft/gpl.html</license>   <license>GPL - http://www.gnu.org/copyleft/gpl.html</license>
 +
 +  <requires jameica="1.7+">
 +    <import plugin="Name des benoetigten Plugins"/>
 +    <import plugin="Name des benoetigten Plugins2" version="1.2-"/>
 +    <import plugin="Name des benoetigten Plugins3" version="2.0" required="false"/>
 +    ...
 +  </requires>
 +
 +  <classfinder>
 +    <include>hibiscus\.jar</include>
 +    <include>hbci_passport_.*\.jar</include>
 +    <include>.*\.class</include>
 +  </classfinder>
  
   <menu>   <menu>
     <item id="hibiscus.menu" name="Hibiscus">     <item id="hibiscus.menu" name="Hibiscus">
-      <item id="hibiscus.menu.settings" name="Einstellungen" action="de.willuhn.jameica.hbci.gui.action.Settings" />+      <item id="hibiscus.menu.settings" name="Einstellungen" 
 +            action="de.willuhn.jameica.hbci.gui.action.Settings" />
       <item name="-" />       <item name="-" />
       [...]       [...]
Zeile 24: Zeile 42:
   </menu>   </menu>
      
-  <classfinder> 
-    <include>hibiscus\.jar</include> 
-    <include>hbci_passport_.*\.jar</include> 
-    <include>.*\.class</include> 
-  </classfinder> 
- 
   <navigation>   <navigation>
     <item id="hibiscus.navi" name="Hibiscus"     <item id="hibiscus.navi" name="Hibiscus"
Zeile 90: Zeile 102:
 | 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 in der gewünschten Reihenfolge. Existiert eine der Abhängigkeiten nicht oder kam es dort bei der Initialisierung zu einem Fehler, wird auch das betreffende Plugin nicht geladen um Folgefehler zu vermeiden.
- +
-Definiert die im Jameica-Menu (unterhalb des Menupunktes "Plugins") anzuzeigenden Elemente.+
  
 <code xml> <code xml>
-  <menu+  <requires jameica="1.7+"
-    <item id="hibiscus.menu" name="Hibiscus"> +    <import plugin="Name des benoetigten Plugins"/
-      <item id="hibiscus.menu.settingsname="Einstellungen" action="de.willuhn.jameica.hbci.gui.action.Settings" /> +    <import plugin="Name des benoetigten Plugins2version="1.2-"/> 
-      <item name="-" /> +    <import plugin="Name des benoetigten Plugins3" version="2.0" required="false"/> 
-      [...+    ... 
-    </item> +  </requires>
-  </menu>+
 </code> </code>
  
-menu | Container für die Menuelemente +requires | Container für die Liste der Abhängigkeiten 
-item Ein einzelnes Menuelement. Können beliebige verschachtelt werden, um Untermenus zu erzeugen +jameica  Versionsnummer der benötigten Jameica-Version (optional) 
-id Eindeutige ID für diesen Menupunkt für eventuelle Erweiterung mittels [[develop::extensions|Extension-System]] +import   Ein benötigtes Plugin 
-name Bezeichnung des Menuelementes +plugin   Name des benötigten Plugins. Das ist der Wert des Attributes *<plugin name=..."* des benötigten Plugins 
-action Name der Java-Klasse, die beim Klick auf das Menuelement ausgelöst wirdMuss das Interface "*de.willuhn.jameica.gui.Actionimplementieren |+version  Versionsnummer der benötigten Plugin-Version (optional) | 
 +| required | Legt festob die Abhängigkeit erfüllt sein muss oder nicht (default="true")Ist eine Abhängigkeit mit "required=false" als optional markiert, kann das Plugin auch dann gestartet werden, wenn die Abhängigkeit **nicht*erfüllt istIst das abhängige Plugin jedoch installiert, dann stellt Jameica sicher, dass es **vor** dem Plugin geladen wird. |
  
 +Versionsnummern können in den folgenden Formaten angegeben werden:
  
-=== Dependencies === +^ Beispiel   ^ Bemerkung             ^ 
-Der Pluginloader löst Abhängigkeiten zwischen Plugins nun (seit 05.04.2007) selbst auf und lädt die Plugins in der gewünschten ReihenfolgeExistiert eine der Abhängigkeiten nicht oder kam es dort bei der Initialisierung zu einem Fehler, wird auch das betreffende Plugin nicht geladen um Folgefehler zu vermeiden.+| 2.0        | Plugin/Jameica wird **exakt** in dieser Version benötigt | 
 +| 1.2-       | Plugin/Jameica wird in einer Version benötigt, die **älter** als 1.2 ist | 
 +| 1.7+       Plugin/Jameica wird in einer Version benötigt, die **neuer** als 1.7 ist |
  
-<code xml> 
-  <requires> 
-    <import plugin="Name des benoetigten Plugins"/> 
-    <import plugin="Name des benoetigten Plugins2"/> 
-    ... 
-  </requires> 
-</code> 
- 
-| requires | Container für die Liste der Abhängigkeiten | 
-| import | Ein benötigtes Plugin | 
-| plugin | Name des benötigten Plugins. Das ist der Wert des Attributes *<plugin name=..."* des benötigten Plugins | 
  
 === Classfinder === === Classfinder ===
Zeile 140: Zeile 142:
  
 | include | Regulärer Ausdruck für einen Dateinamen/Pfad. Alle dort gefundenen Klassen werden automatisch im Classfinder registriert und können anschliessend durchsucht werden | | include | Regulärer Ausdruck für einen Dateinamen/Pfad. Alle dort gefundenen Klassen werden automatisch im Classfinder registriert und können anschliessend durchsucht werden |
 +
 +
 +=== Menu ===
 +
 +Definiert die im Jameica-Menu (unterhalb des Menupunktes "Plugins") anzuzeigenden Elemente.
 +
 +<code xml>
 +  <menu>
 +    <item id="hibiscus.menu" name="Hibiscus">
 +      <item id="hibiscus.menu.settings" name="Einstellungen" action="de.willuhn.jameica.hbci.gui.action.Settings" enabled="true" />
 +      <item name="-" />
 +      [...]
 +    </item>
 +  </menu>
 +</code>
 +
 +| 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::extensions|Extension-System]] |
 +| name | Bezeichnung des Menuelementes |
 +| action | Name der Java-Klasse, die beim Klick auf das Menuelement ausgelöst wird. Muss das Interface "*de.willuhn.jameica.gui.Action* implementieren |
 +| enabled | Legt fest, ob das Menuelement aktiv oder inaktiv (grau) sein soll. Default: true |
  
  
Zeile 152: Zeile 176:
             icon-close="page.gif"             icon-close="page.gif"
             icon-open="page.gif"             icon-open="page.gif"
-            action="de.willuhn.jameica.hbci.gui.action.KontoList" />+            action="de.willuhn.jameica.hbci.gui.action.KontoList
 +            expanded="true" 
 +            enabled="true" />
     </item>     </item>
   </navigation>   </navigation>
Zeile 164: Zeile 190:
 | 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, die beim Klick auf das Element ausgelöst wird. Muss das Interface "*de.willuhn.jameica.gui.Action* implementieren | | action | Name der Java-Klasse, die beim Klick auf das Element ausgelöst wird. Muss das Interface "*de.willuhn.jameica.gui.Action* implementieren |
 +| 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 |
  
  


Impressum | Datenschutz
develop/plugin.xml.txt · Zuletzt geändert: d.m.Y H:i von willuhn