|
|
# settings.xml
|
|
|
|
|
|
Mit der settings.xml können Sie eigene Einstellungen für Ihr Plugin / Package definieren. Zusätzlich ist es möglich den Aufbau des Einstellungs Panels zu bestimmen.
|
|
|
|
|
|
Das Anlegen geht denkbar einfach, legen Sie in das root Verzeichnis Ihres Plugin / Package eine settings.xml an und definieren Sie hier Ihre Einstellungen.Die Einstellungen werden automatisch vom QUIQQER System eingelesen.
|
|
|
|
|
|
## Aufbau
|
|
|
|
|
|
```xml
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
<settings>
|
|
|
|
|
|
<config name="my_conf_name">
|
|
|
<section name="first_section">
|
|
|
<conf name="var_1">
|
|
|
<type><![CDATA[string]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_2">
|
|
|
<type><![CDATA[integer]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_3">
|
|
|
<type><![CDATA[bool]]></type>
|
|
|
</conf>
|
|
|
</section>
|
|
|
|
|
|
<section name="second_section">
|
|
|
<conf name="var_1">
|
|
|
<type><![CDATA[string]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_2">
|
|
|
<type><![CDATA[integer]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_3">
|
|
|
<type><![CDATA[bool]]></type>
|
|
|
</conf>
|
|
|
</section>
|
|
|
</config>
|
|
|
|
|
|
<window>
|
|
|
<title>My Settings</title>
|
|
|
<params>
|
|
|
<icon>URL_BIN_DIR/16x16/settings.png</icon>
|
|
|
</params>
|
|
|
|
|
|
<categories>
|
|
|
<category name="first_settings">
|
|
|
<text>Allgemein</text>
|
|
|
<icon>URL_BIN_DIR/22x22/quiqqer.png</icon>
|
|
|
|
|
|
<settings title="first_setting_section" name="first_setting_section">
|
|
|
<title>My First Settings</title>
|
|
|
<input conf="first_section.var1" type="checkbox">
|
|
|
<text>Here is a title text</text>
|
|
|
<description>
|
|
|
Here is a description
|
|
|
</description>
|
|
|
</input>
|
|
|
</settings>
|
|
|
|
|
|
<settings title="second_setting_section" name="second_setting_section">
|
|
|
<title>My second Settings</title>
|
|
|
<input conf="first_section.var2" type="text">
|
|
|
<text>Verwendete Template Engine</text>
|
|
|
</input>
|
|
|
<input conf="first_section.var3" type="checkbox">
|
|
|
<text>Smarty Compile Prüfung</text>
|
|
|
</input>
|
|
|
</settings>
|
|
|
</category>
|
|
|
|
|
|
<category name="second_settings">
|
|
|
<text>More Settings</text>
|
|
|
<icon>URL_BIN_DIR/22x22/database.png</icon>
|
|
|
|
|
|
<settings title="database" name="database">
|
|
|
<title>Some Settings</title>
|
|
|
<input conf="second_section.var1" type="text">
|
|
|
<text>Datenbank Typ</text>
|
|
|
</input>
|
|
|
<input conf="second_section.var2" type="text">
|
|
|
<text>Host</text>
|
|
|
</input>
|
|
|
<input conf="second_section.var3" type="text">
|
|
|
<text>Datenbank Name</text>
|
|
|
</input>
|
|
|
</settings>
|
|
|
</category>
|
|
|
</categories>
|
|
|
</window>
|
|
|
|
|
|
</settings>
|
|
|
```
|
|
|
|
|
|
### \<settings\>
|
|
|
|
|
|
|
|
|
Mit \<settings\> fangen Sie die Definition der Einstellungen an. Das \<settings\> Node kann \<config\> und oder \<window\> enthalten. Diese bestimmen welche Einstellungen es gibt und wie diese im Administrationsbereich dargestellt werden.
|
|
|
|
|
|
|
|
|
#### \<config\>
|
|
|
|
|
|
In dem \<config\> Node legen Sie fest welche Einstellungen das Plugin / Package mitbringt.
|
|
|
Das Attribute **name=""** definiert den Namen der Konfigurationsdatei. Verwenden Sie zum Beispiel **attribute="my_plugin"**, legt QUIQQER eine Konfigurations Datei mit dem Namen **my_plugin.ini** an. Hier werden die definierten Konfigurationen gespeichert und wieder ausgelesen.
|
|
|
|
|
|
Die angelegte Konfigurationen können auch direkt auf dem Filesystem editiert werden.
|
|
|
|
|
|
|
|
|
##### \<section\> und \<conf\>
|
|
|
|
|
|
Damit Sie in ini Dateien auch Sektionen anlegen können, können Sie Konfigurationsparameter wie folgt angeben, entweder in einer \<section\> oder den Parameter direkt \<conf\>.
|
|
|
|
|
|
Die folgende ini Datei:
|
|
|
|
|
|
```ini
|
|
|
[section]
|
|
|
var1="text"
|
|
|
var2="text"
|
|
|
var3="text"
|
|
|
```
|
|
|
|
|
|
Wäre die folgende XML Defnition
|
|
|
|
|
|
```xml
|
|
|
<section name="section">
|
|
|
<conf name="var_1">
|
|
|
<type><![CDATA[string]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_2">
|
|
|
<type><![CDATA[string]]></type>
|
|
|
</conf>
|
|
|
<conf name="var_3">
|
|
|
<type><![CDATA[string]]></type>
|
|
|
</conf>
|
|
|
</section>
|
|
|
```
|
|
|
|
|
|
##### \<conf name="conf_name"\> #####
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### \<window\> ####
|
|
|
|