You are here: Foswiki>System Web>Category>UserDocumentationCategory>Macros>VarRENDERZONE (2024-12-23, UnknownUser)Edit Attach

RENDERZONE - render the content of a zone

Rendersa zone. See ADDTOZONE for an explanation of zones.

Parameters

Parameter Description Default
"zone" name of the zone   (reguired)
format format string for each item added to the zone 
$item <!--<literal> $id $missing</literal>-->
missingtoken string assigned to the $missing format token for use in the format parameter. 
$id: requires= missing ids: $missingids
chomp remove leading and trailing whitespace from formatted items, can be useful for pretty-printing and compression. off
header prepended to the output  
footer appended to the output  
separator put between each item of a zone  

The following tokens are expanded in the format string:

  • $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.

Supports the standard format tokens in all parameters.

HELP

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).

HELP

Zones are cleared after being rendered; they are only ever rendered once.

HELP

head, script and body are default zones. The corresponding RENDERZONE is already included in the base foswiki.tmpl. head and script are automatically inserted before the </head> tag in the output HTML page. body is automatically inserted before the </body> tag in the output HTML page.

HELP

Macros will be expanded in all zones. TML markup will not be expanded in the head and scripts zones. Any formatting in head and scripts zones including [[TML links]] must be done directly using HTML. TML pseudo-tags like nop. verbatim, literal. and noautolink are removed from head and script zones and have no influence on the markup. All other zones will be rendered as normal topic text.

HELP

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.

ADDTOZONE Using ADDTOZONE, Updating applications to use script zone

Edit  | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions

Topic revision: r1 - 2024-12-23, UnknownUser

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 Foswiki? Send feedback