Changeset 8299

Timestamp:

07/25/10 13:30:51 (22 months ago)

Author:

PaulHarvey

Message:

Item9317: Update RENDERZONE documentation, re: defaults

File:

• trunk/core/data/System/VarRENDERZONE.txt (modified) (2 diffs)

trunk/core/data/System/VarRENDERZONE.txt

@@ -12 +12 @@
    * ="zone"= required, name of the zone
    * =header="..."= optional, prefix format string
-   * =format="..."= optional, format string for each item added to the zone, defaults to =$item=. Tokens:
+   * =format="..."= optional, format string for each item added to the zone, default:
+   <pre>$item &lt;!-- $id $missing--&gt;</pre>Tokens:
       * =$id= - =id= of the [[VarADDTOZONE][ADDTOZONE]] call within the =zone= currently being rendered.
       * =$item= - text of the [[VarADDTOZONE][ADDTOZONE]] call within the =zone= currently being rendered.
@@ -18 +19 @@
       * =$missing= - if the [[VarADDTOZONE][ADDTOZONE]] call being rendered required any =id= which was not found, then =$missing= is the =missingtoken= parameter; empty string otherwise.
       * =$missingids= - comma separated list of ids that were required by the [[VarADDTOZONE][ADDTOZONE]] call currently being rendered but weren't found within this =zone=.
-   * =missingtoken="..."= optional, this will be the string assigned to the =$missing= format token for use in the =format= parameter. Defaults to ="$missingids"=
+   * =missingtoken="..."= optional, this will be the string assigned to the =$missing= format token for use in the =format= parameter. Default:
+   <pre>required id(s) that were missing from $zone zone: $missingids</pre>
    * =chomp="on"= remove leading and trailing whitespace from formatted items, can be useful for pretty-printing and compression.
    * =footer="..."= optional, suffix format string