Changeset 8298 for trunk/core/data/System/VarRENDERZONE.txt

Timestamp:

07/25/10 13:30:18 (3 years ago)

Author:

PaulHarvey

Message:

Item9317: 3-line ADDTOZONE fix ended up being a lot bigger than intended

• body zone is now an alias to head zone when not {OptimizePageLayout}
• Renamed some vars and methods, because they seemed a little opaque.
• Rename tag parameter to id (tag is still supported, undocumented)
• Added a new parameter, missingtoken, which dictates the output of a new format token: $missing. This adds information in the <!-- $id --> decoration that's appended after each ADDTOZONE's content if there were required ids that could not be found.
• Adjusted docs, probably too much.
• Added some tests.

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=.
+   * =format="..."= optional, format string for each item added to the zone, defaults to =$item=. 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.
+      * =$zone= - the ="zone"= currently being rendered.
+      * =$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"=
    * =chomp="on"= remove leading and trailing whitespace from formatted items, can be useful for pretty-printing and compression.
    * =footer="..."= optional, suffix format string
@@ -23 +29 @@
 
 =head= and =body= are _built-in_ zones - there is no corresponding =RENDERZONE=
-required in the templates.
+required in the templates, they will be rendered automatically.
+
+%ICON{"info"}% Zones are flushed when rendered; they may only be rendered once
 
 See also [[VarADDTOZONE][ADDTOZONE]] for more information on zones.