You are here: Foswiki>System Web>Category>UserDocumentationCategory>Macros>VarSTARTSECTION (18 Jun 2015, ProjectContributor)Edit Attach

STARTSECTION -- marks the start of a section within a topic

Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. Sections may be given a name to help identify them, and/or a type, which changes how they are used.
    • type="section" - the default, used for a generic section, such as a named section used by INCLUDE.
    • type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want which are all merged into one when included (%STARTINCLUDE% is restricted to only one). Sections of type include may not be given a name.
    • type="expandvariables" - all macros inside an "expandvariables" type section gets expanded when a new topic based on the template topic is created. See Template Topics for more information.
    • 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 Template Topics for more information.

Parameters

Parameter Description Default
"name" Name of the section. Must be unique inside a topic. Generated name
=type=" Type of the section; type "section", "expandvariables", "include" or "templateonly" "section"
Any other parameter will be defined as a default value for a macro within the scope of the section. The example parameters on the left will result in %PARONE% and %PARTWO% being defined if they are not defined parameters to the INCLUDE, or nested INCLUDEs surrounding it, or previsouly defined Preferences.

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

HELP You can define nested sections. It is not recommended to overlap sections, although it is valid in Foswiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.

Examples

  • %STARTSECTION{"name"}% ................... %ENDSECTION{"name"}%
  • %STARTSECTION{"name" type="section"}% .... %ENDSECTION{"name" type="section"}% (type="section" is the default)
  • %STARTSECTION{type="include"}% ........... %ENDSECTION{type="include"}%
  • %STARTSECTION{type="expandvariables"}% ... %ENDSECTION{type="expandvariables"}%
  • %STARTSECTION{type="templateonly"}% ...... %ENDSECTION{type="templateonly"}%

ENDSECTION, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE
Edit  | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 18 Jun 2015, ProjectContributor
 

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