Swapped out a large number of parameters to an XML construct. The previous commit...

[mailer.git] / templates / xml / admin_data_template.xml

diff --git a/templates/xml/admin_data_template.xml b/templates/xml/admin_data_template.xml
index a1639cb5807f3c766c9c99fa25f018f8c269d377..632b23c2889736c03c9dc64a2419482b52a8f752 100644 (file)
--- a/templates/xml/admin_data_template.xml
+++ b/templates/xml/admin_data_template.xml
@@ -73,31 +73,37 @@ MA  02110-1301  USA
        <extra-parameter-list>
                <!--
                A list entry for a single extra parameter. 'type' can now be: string,
-               int, float, bool, array. If the type 'array' is provided, the parser searches
-               for a tag called "extra-parameter-<value>-list(-entry)", by <value>
-               is the value from the 'value' attribute. Please check out the examples below.
+               int, float, bool, array. If the type 'array' is provided, the parser
+               searches for a tag called "extra-parameter-<value>-list(-entry)", by
+               <value> is the value from the 'value' attribute. Please check out the
+               examples below.
+               Keep 'name' empty for numerical array indexes (array keys).
                //-->
                <!--
-               A simple string example, int and float are similar.
+               A simple string example with a numerical index, int and float are similar.
                //-->
-               <extra-parameter-list-entry type="string" value="foo" />
+               <extra-parameter-list-entry name="" type="string" value="foo" />
                <!--
-               A simple bool example, value can only be 'false' or 'true'
+               A simple bool example with a numerical index, value can only be 'false' or 'true'
                //-->
-               <extra-parameter-list-entry type="bool" value="false" />
+               <extra-parameter-list-entry name="" type="bool" value="false" />
                <!--
-               A one-dimensional array with some entries
+               A one-dimensional array with a numerical index and with some entries
                //-->
-               <extra-parameter-list-entry type="array" value="bar">
+               <extra-parameter-list-entry name="" type="array" value="bar">
                        <!--
                        Our 'bar' array
                        //-->
                        <extra-parameter-bar-list>
                                <!--
-                               A bool entry in the 'bar' array, all other types are added in a
-                               similar way.
+                               A bool entry with a numerical index in the 'bar' array, all
+                               other types are added in a similar way.
                                //-->
-                               <extra-parameter-bar-list-entry type="bool" value="true" />
+                               <extra-parameter-bar-list-entry name="" type="bool" value="true" />
+                               <!--
+                               A float entry with a alpha-numerical index in the 'bar' array.
+                               //-->
+                               <extra-parameter-bar-list-entry name="my_key" type="float" value="1.2345" />
                        </extra-parameter-bar-list>
                </extra-parameter-list-entry>
        </extra-parameter-list>