TWiki Variables » Search » Category: Workflow & Automation

COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.

• A %COMMENT% without parameters shows a simple text box.
• A %COMMENT{}% can handle the following parameters:

  Parameter <-- -->	Description	Default
  button	Button label text	"Add comment"
  default	Default text to put into the textarea of the prompt.
  emailto	Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;".
  location	Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!
  mode	For compatibility with older versions only, synonymous with type
  noform	Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example.	"off"
  nonotify	Set to "on" to disable change notification for target topics	"off"
  nopost	Set to "on" to disable insertion of the posted text into the topic.	"off"
  remove	Set to "on" to remove the comment prompt after the first time it is clicked.	"off"
  target	Name of the topic to add the comment to	the current topic
  type	This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.	"below"

• See CommentPlugin for more information
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, WorkflowAndAutomationVariables
• Related: HIDE, TWikiForms (this topic)

ENDSECTION{"name"} -- marks the end of a named section within a topic

• Syntax: %ENDSECTION{"name"}%
• Syntax: %ENDSECTION{type="include"}%
• Syntax: %ENDSECTION{type="templateonly"}%
• Syntax: %ENDSECTION{type="expandvariables"}%
• Supported parameter:

  Parameter:	Description:
  "name"	Name of the section.
  type="..."	Type of the section being terminated; supported types "section", "include", "templateonly", "expandvariables"

• If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If the STARTSECTION specifies a type, then the corresponding ENDSECTION must also specify the same type. If the section is unnamed, ENDSECTION will match with the nearest unnamed %STARTSECTION% of the same type above it.
• Category: DevelopmentVariables, WorkflowAndAutomationVariables
• Related: ENDSECTION, INCLUDE, STARTINCLUDE, STARTSECTION, STOPINCLUDE (this topic)

IF{"condition" ...} -- simple conditionals

• Evaluate a condition and show one text or another based on the result. See details in IfStatements
• Syntax: %IF{"CONDITION" then="THEN" else="ELSE"}% shows "THEN" if "CONDITION" evaluates to TRUE, otherwise "ELSE" will be shown
• Example: %IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else="FUNFACTOR is not defined"}% renders as FUNFACTOR is not defined
• Category: DevelopmentVariables, WorkflowAndAutomationVariables
• Related: GET, SET, IfStatements, $IF() of SpreadSheetPlugin, QuerySearch (this topic)

STARTINCLUDE -- start position of topic text if included

• If present in included topic, start to include text from this location up to the end, or up to the location of the %STOPINCLUDE% variable. A normal view of the topic shows everything exept the %STARTINCLUDE% variable itself.
• Note: If you want more than one part of the topic included, use %STARTSECTION{type="include"}% instead
• Syntax: %STARTINCLUDE%
• Category: DevelopmentVariables, WorkflowAndAutomationVariables
• Related: ENDSECTION, INCLUDE, STARTSECTION, STOPINCLUDE (this topic)

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 (%STARTINCLUDE% is restricted to only one).
  • type="templateonly" - start position of text to be removed when a template topic is used. Use this to embed text that you do not want expanded when a new topic based on the template topic is created. TWikiTemplates has more.
  • type="expandvariables" - start position where TWikiVariables get expanded when a new topic is created. As documented in TWikiTemplates#VariableExpansion, only certain variables get expanded when a new topic based on the template topic is created. All variables get expanded within a "expandvariables" section.
• Syntax: %STARTSECTION{"name"}% ................... %ENDSECTION{"name"}%
• Syntax: %STARTSECTION{type="include"}% ........... %ENDSECTION{type="include"}%
• Syntax: %STARTSECTION{type="templateonly"}% ...... %ENDSECTION{type="templateonly"}%
• Syntax: %STARTSECTION{type="expandvariables"}% ... %ENDSECTION{type="expandvariables"}%
• Supported parameters:

  Parameter:	Description:	Default
  "name"	Name of the section. Must be unique inside a topic.	Generated name
  type="..."	Type of the section; type "section", "include", "templateonly", or "expandvariables"	"section"
  disablefixlinks="on"	Only for named sections: Bypass fixing WikiWord links if section is included from a topic in another web. Fixing links in included text such as from SomeLink to Thisweb.SomeLink is usually desirable so that links in included text still point to the same target.	fix links

• 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..
• Note: You can define nested sections. Do not overlap sections. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.
• Category: DevelopmentVariables, WorkflowAndAutomationVariables
• Related: ENDSECTION, HIDE, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE (this topic)

Total: 5 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart