release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Search | Go
Wiki > System > Macros > VarRENDERZONE

RENDERZONE

%RENDERZONE{"zone" ...}%
See ADDTOZONE for an explanation of zones.

Parameters:
  • "zone" required, name of the zone.
  • format="..." optional, format string for each item added to the zone, default:
    $item <!--<literal> $id $missing</literal>-->
    Tokens:
    • $id - id of the ADDTOZONE call within the zone currently being rendered.
    • $item - text of the ADDTOZONE call within the zone currently being rendered.
    • $zone - the "zone" currently being rendered.
    • $missing - if the 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 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. Default:
    $id: requires= missing ids: $missingids
  • chomp="on" remove leading and trailing whitespace from formatted items, can be useful for pretty-printing and compression.
  • header="..." optional, prepended to the output
  • footer="..." optional, appended to the output
  • separator="..." optional, put between each item of a zone
Supports the standard format tokens in all parameters.

Notes:
  • header and footer are not output if there is no content in the zone (nothing has been ADDTOZONEd ). However they are output if the output is the empty string (at least one ADDTOZONE has been processed).
  • Zones are cleared after being rendered; they are only ever rendered once.
  • head and script are automatic zones. They don't require a corresponding RENDERZONE anywhere in the templates - they are automatically inserted before the </head> tag in the output HTML page.
  • Normally, dependencies between individual ADDTOZONE statements are resolved within each zone. However, if {MergeHeadAndScriptZones} is enabled in configure, then head content which requires an id that only exists in script will be re-ordered to satisfy this dependency.
    ALERT! {MergeHeadAndScriptZones} will be removed from a future version of Foswiki.

See also ADDTOZONE for more information on zones.
r1 - 22 Sep 2010 - 19:00:46 - ProjectContributor

Parents: WebHome > Macros
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Wiki? Send feedback