From ba906061d7318bbc2a3245ceb682c42107ae8feb Mon Sep 17 00:00:00 2001 From: Peter Thoeny Date: Sun, 15 Jul 2001 02:04:44 +0000 Subject: none --- TWiki/TWikiVariables.mdwn | 91 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 79 insertions(+), 12 deletions(-) diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn index 062898fe..bc7aa01c 100644 --- a/TWiki/TWikiVariables.mdwn +++ b/TWiki/TWikiVariables.mdwn @@ -95,11 +95,58 @@ %TOPICLIST{"format"}% - Topic index of a web. Parameter is composed of the format, followed by an optional web="Name". The "format" defines the format of one topic item; use it to create any formatting you need. The $name variable is expanded to the topic name; the $web variable is expanded to the name of the web. Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus). + Topic index of a web. The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web. Parameters are format, separator and web: + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter:Description:Default:
"format" Format of one line, may include $name and $web variables "$name"
format="format" (Alternative to above) "$name"
separator=", " line separator "\n" (new line)
web="Name" Name of web Current web
Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus). %WEBLIST{"format"}% - Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable is expanded to the name of the web. Example:
%WEBLIST{"   * [[$name.%HOMETOPIC%]]"}% creates a bullet list of all webs. + Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web. Parameters are format, separator and web: + + + + + + + + + + + + + + + + + + + + +
Parameter:Description:Default:
"format" Format of one line, may include $name variable "$name"
format="format" (Alternative to above) "$name"
separator=", " line separator "\n" (new line)
Example:
%WEBLIST{"   * [[$name.%HOMETOPIC%]]"}% creates a bullet list of all webs. %GMTIME% @@ -181,7 +228,7 @@ %INCLUDE{"page" ...}% - Server side include to Include Topics And Web Pages?. The parameter is composed of the page name, followed by an optional pattern="(reg-exp)" pair. The page name is: +
Server side include to Include Topics And Web Pages?. Parameters are page name, and an optional pattern="(reg-exp)". The page name is: @@ -211,12 +258,17 @@ -
"SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
%TOC{"SomeTopic" ...}% Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in Wiki Syntax? ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameter is composed of the topic name, followed by optional name="value" pairs: + - -
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in Wiki Syntax? ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameters are topic name, web and depth: - + + + + + + @@ -230,17 +282,22 @@
Pair:Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="%TWIKIWEB%"}%
%SEARCH{"str" ...}% Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional name="value" pairs: [1] + +
%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] - + - - - + + + + + + + + @@ -378,6 +435,16 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in + + + + + + + + + + @@ -432,4 +499,4 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in * Additional preferences variables can be defined on all three level as needed. Example: * Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif --- [[PeterThoeny]] - 25 Jun 2001
+-- [[PeterThoeny]] - 14 Jul 2001
-- cgit v1.2.3
Pair:Parameter: Description: Default:
search="food" Search term, (either regex or literal, depending on the regex parameter) (used if initial search term is missing) "text" Search term. (Is a regular expression or literal, depending on the regex parameter) required
search="text" (Alternative to above) N/A
web="Name"
web="%MAINWEB% Know"
web="all"		SL , UL Vertical size of edit box, is %EDITBOXHEIGHT%
%RELEASEEDITLOCKCHECKBOX%SL , UL Default state of the "Release edit lock" (Unlock Topic?) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: %RELEASEEDITLOCKCHECKBOX%
%DONTNOTIFYCHECKBOX%SL , UL Default state of the "Minor Changes, Don't Notify" (Dont Notify?) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is: %DONTNOTIFYCHECKBOX%
%ATTACHLINKBOX% SL , UL