data/TWiki/VarSTARTSECTION.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="2"}%
     2 %META:TOPICPARENT{name="TWikiVariables"}%
     3 #VarSTARTSECTION
     4 ---+++ STARTSECTION -- marks the start of a section within a topic
     5    * Section boundaries are defined with =%<nop>STARTSECTION{}%= and =%<nop>ENDSECTION{}%=.
     6    * Sections may be given a name to help identify them, and/or a type, which changes how they are used.
     7       * =type="section"= - the default, used for a generic section, such as a named section used by [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarINCLUDE][INCLUDE]].
     8       * =type="include"= - like =%<nop>STARTINCLUDE%= ... =%<nop>STOPINCLUDE%= except that you can have as many include blocks as you want (=%<nop>STARTINCLUDE%= is restricted to only one).
     9       * =type="templateonly"= - start position of text to be removed when a template topic is used. This is used to embed text that you _do not_ want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
    10    * Syntax: =%<nop>STARTSECTION{"name"}% ................ %<nop>ENDSECTION{"name"}%=
    11    * Syntax: =%<nop>STARTSECTION{type="include"}% ........ %<nop>ENDSECTION{type="include"}%=
    12    * Syntax: =%<nop>STARTSECTION{type="templateonly"}% ... %<nop>ENDSECTION{type="templateonly"}%=
    13    * Supported parameters:
    14      | *Parameter:* | *Description:* | *Default* |
    15      | ="name"= | Name of the section. Must be unique inside a topic. | Generated name |
    16      | =type="..."= | Type of the section; type ="section"=, ="include"= or ="templateonly"= | ="section"= |
    17    * __%X% Note:__ If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with =_SECTION0= for the first unnamed section in the topic, =_SECTION1= for the second, etc..
    18    * __%X% Note:__ You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are *not* displayed when a topic is viewed.
    19    * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENDSECTION][ENDSECTION]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarINCLUDE][INCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarNOP][NOP]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSTARTINCLUDE][STARTINCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSTOPINCLUDE][STOPINCLUDE]]
    20