This version of TWiki - Alpha 30 Jul 2004 $Rev: 1701 $ - expands the following variables (enclosed in % percent signs):
Changed:
< <
Variable:
Expanded to:
%WIKIHOMEURL%
The base script URL of JCuckoo, is the link of the Home icon in the upper left corner, is http://your.domain.com/twiki
%SCRIPTURL%
The script URL of JCuckoo, is http://jcuckoo.sourceforge.net/cgi-bin
%SCRIPTURLPATH%
The path of the script URL of JCuckoo, is /cgi-bin
%SCRIPTSUFFIX%
The script suffix, ex: .pl, .cgi is
%PUBURL%
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub Example: You can refer to a file attached to another topic as %PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH%
The path of the public URL of JCuckoo, is /twiki/pub
%ATTACHURL%
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH%
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%ICON{"type"}%
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:
Default value in case parameter is empty or missing
empty string
newline="<br />"
Convert newlines in textarea to other delimiters
no conversion
encode="entity"
Encode special characters into HTML entities, like a double quote into ". This is needed if text is put into an HTML form field
no encoding
encode="url"
Encode special characters for URL parameter use, like a double quote into %22
no encoding
multiple="on" multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item"
first element
separator=", "
Separator between multiple selections. Only relevant if multiple is specified
"\n" (new line)
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%ENCODE{"string"}%
Encodes a string. Supported parameters:
> >
ATTACHURL -- attachment URL of the current topic
Syntax: %ATTACHURL%
Expands to: http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
The index topic of all registered users - TWikiUsers
%WIKIPREFSTOPIC%
The site-wide preferences topic - TWikiPreferences
%WEBPREFSTOPIC%
The local web preferences topic in each web - WebPreferences
%STATISTICSTOPIC%
The web statistics topic WebStatistics
%TOPIC%
The current topic name - TWikiVariables
%BASETOPIC%
The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE.
%INCLUDINGTOPIC%
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
%SPACEDTOPIC%
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%TOPICLIST{"format"}%
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:
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, ex: 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, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Parameters are format, separator and web:
comma sep list of Web, public expands to all non-hidden
"public"
marker="selected"
Text for $marker where item matches selection, otherwise equals ""
"selected"
selection="%WEB%"
Current value to be selected in list
section="%WEB%"
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME%
GM time, is 28 Mar 2024 - 12:41
%GMTIME{"format"}%
Formatted GM time based on time variables.
> >
Example: %ENCODE{"spaced name"}% expands to spaced%20name
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 28 Mar, 2024 - 12:41:21
%SERVERTIME%
Server time, is 28 Mar 2024 - 12:41
%SERVERTIME{"format"}%
Formatted server time. Same format qualifiers as %GMTIME% Example: %SERVERTIME{"$hou:$min"}% is 12:41
%DISPLAYTIME%
Display time, is 28 Mar 2024 - 12:41
%DISPLAYTIME{"format"}%
Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME% Example: %DISPLAYTIME{"$hou:$min"}% is 12:41
%HTTP_HOST%
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
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 everyting exept the %STARTINCLUDE% variable itself.
%STOPINCLUDE%
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
%TOC%
Table of Contents of current topic.
%TOC{"SomeTopic" ...}%
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Supported parameters:
Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
> >
type="topicmoved"
What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children
required
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
title="Title"
Text that is prepended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
Expands to: http://jcuckoo.sourceforge.net/cgi-bin
Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://jcuckoo.sourceforge.net/cgi-bin/viewauth/TWiki/TWikiVariables
Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort
Sort by topic name
limit="all" limit="16"
Limit the number of results returned. This is done after sorting in case order is specified
All results
Line: 255 to 244
expandvariables="on"
Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin%CALC{}% instead of the formula
Raw text
multiple="on"
Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search
Only one hit per topic
separator=", "
Line separator between hits
Newline "$n"
Changed:
< <
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
Example with format: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
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 everyting exept the %STARTINCLUDE% variable itself.
STOPINCLUDE -- end position of topic text if included
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children
required
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
title="Title"
Text that is prepended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%VAR{"NAME" web="Web"}%
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
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.
Default value in case parameter is empty or missing
empty string
newline="<br />"
Convert newlines in textarea to other delimiters
no conversion
encode="entity"
Encode special characters into HTML entities, like a double quote into ". This is needed if text is put into an HTML form field
no encoding
encode="url"
Encode special characters for URL parameter use, like a double quote into %22
no encoding
multiple="on" multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item"
first element
separator=", "
Separator between multiple selections. Only relevant if multiple is specified
"\n" (new line)
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Test this:
[1] Note: The search form uses identical names for input fields.
> >
USERNAME -- your login username
TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like Main.JohnSmith. A user is a TWikiGuest in case the topic is not authenticated
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, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
comma sep list of Web, public expands to all non-hidden
"public"
marker="selected"
Text for $marker where item matches selection, otherwise equals ""
"selected"
selection="%WEB%"
Current value to be selected in list
section="%WEB%"
Example: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Preferences Variables
Line: 292 to 448
Variable:
Level:
What:
Changed:
< <
%WIKIWEBMASTER%
SL
Webmaster email address (sender of email notifications) , is rumcajs_78@users.sourceforge.net
%WIKIWEBLIST%
SL
List of JCuckoo webs (in upper right corner of topics)
%WEBTOPICLIST%
> >
%ALLOWTOPICCHANGE%
(any topic)
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME%
(any topic)
List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWWEBCHANGE%
WL
Changed:
< <
Common links of web (second line of topics)
%WEBCOPYRIGHT%
SL , WL
Copyright notice (bottom right corner of topics)
%WEBBGCOLOR%
> >
List of users and groups who are allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
WL
Changed:
< <
Background color of web
%NOSEARCHALL%
> >
List of users and groups who are allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%ATTACHLINKBOX%
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%DENYTOPICCHANGE%
(any topic)
List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%DENYTOPICRENAME%
(any topic)
List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%DENYWEBCHANGE%
WL
Changed:
< <
Exclude web from a web="all" search (set variable to on for hidden webs)
%NEWTOPICBGCOLOR%
SL , UL
Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR%
SL , UL
Font color of non existing topic. ( UL needs authentication for topic views )
%EDITBOXWIDTH%
> >
List of users and groups who are not allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%DENYWEBRENAME%
WL
List of users and groups who are not allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%DONTNOTIFYCHECKBOX%
SL , UL
Changed:
< <
Horizontal size of edit box, is 70
> >
Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%EDITBOXHEIGHT%
SL , UL
Vertical size of edit box, is 50
Changed:
< <
> >
%EDITBOXWIDTH%
SL , UL
Horizontal size of edit box, is 70
%EDITBOXSTYLE%
SL , UL
Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
Changed:
< <
%RELEASEEDITLOCKCHECKBOX%
SL , UL
Default state of the "Release edit lock" (UnlockTopic) 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:
%DONTNOTIFYCHECKBOX%
SL , UL
Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%ATTACHLINKBOX%
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%HTTP_EQUIV_ON_VIEW%
SL
http-equiv meta tags for view, rdiff, attach, search* scripts.
> >
%FINALPREFERENCES%
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
%HTTP_EQUIV_ON_EDIT%
SL , UL
http-equiv meta tags for edit script.
Changed:
< <
> >
%HTTP_EQUIV_ON_PREVIEW%
SL , UL
http-equiv meta tags for preview script.
Changed:
< <
%DENYWEBCHANGE%
WL
List of users and groups who are not allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE%
WL
List of users and groups who are allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%DENYTOPICCHANGE%
(any topic)
List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE%
(any topic)
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%DENYWEBRENAME%
> >
%HTTP_EQUIV_ON_VIEW%
SL
http-equiv meta tags for view, rdiff, attach, search* scripts.
%NEWTOPICBGCOLOR%
SL , UL
Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR%
SL , UL
Font color of non existing topic. ( UL needs authentication for topic views )
%NOSEARCHALL%
WL
Changed:
< <
List of users and groups who are not allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
> >
Exclude web from a web="all" search (set variable to on for hidden webs)
%RELEASEEDITLOCKCHECKBOX%
SL , UL
Default state of the "Release edit lock" (UnlockTopic) 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:
%WEBBGCOLOR%
WL
Changed:
< <
List of users and groups who are allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%DENYTOPICRENAME%
(any topic)
List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME%
(any topic)
List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%FINALPREFERENCES%
> >
Background color of web
%WEBCOPYRIGHT%
SL , WL
Changed:
< <
List of preferences that are not allowed to be overridden by next level preferences
> >
Copyright notice (bottom right corner of topics)
%WEBTOPICLIST%
WL
Common links of web (second line of topics)
%WIKIWEBLIST%
SL
List of JCuckoo webs (in upper right corner of topics)
%WIKIWEBMASTER%
SL
Webmaster email address (sender of email notifications) , is rumcajs_78@users.sourceforge.net
Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon.
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. When a topic is rendered for viewing, VARIABLES are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.
Added:
> >
Note: To leave a variable unexpanded, preceed it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%.
Predefined Variables
Most predefined variables return values that were either set in the lib/twiki.cfg file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.
Default value in case parameter is empty or missing
empty string
Changed:
< <
newline="<br />"
Convert newlines to other delimiters
no conversion
> >
newline="<br />"
Convert newlines in textarea to other delimiters
no conversion
encode="entity"
Encode special characters into HTML entities, like a double quote into ". This is needed if text is put into an HTML form field
no encoding
encode="url"
Encode special characters for URL parameter use, like a double quote into %22
no encoding
Added:
> >
multiple="on" multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item"
first element
separator=", "
Separator between multiple selections. Only relevant if multiple is specified
"\n" (new line)
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat)
Thu
$month
month in ISO format
Dec
$mo
2 digit month
12
$year
4 digit year
1999
$ye
2 digit year
99
$tz
either "GMT" (if set to gmtime), or "Local" (if set to servertime)
GMT
$iso
ISO format timestamp
2024-03-28T12:41Z
$rcs
RCS format timestamp
2024/03/28 12:41:22
$http
E-mail & http format timestamp
Thu, 28 Mar 2024 12:41:22 GMT
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 28 Mar, 2024 - 12:41:22
%SERVERTIME%
Server time, is 28 Mar 2024 - 12:41
%SERVERTIME{"format"}%
Changed:
< <
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 12:41
> >
Formatted server time. Same format qualifiers as %GMTIME% Example: %SERVERTIME{"$hou:$min"}% is 12:41
%DISPLAYTIME%
Display time, is 28 Mar 2024 - 12:41
%DISPLAYTIME{"format"}%
Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME% Example: %DISPLAYTIME{"$hou:$min"}% is 12:41
%HTTP_HOST%
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort
Sort by topic name
limit="all" limit="16"
Limit the number of results returned. This is done after sorting in case order is specified
All results
reverse="on"
Reverse the direction of the search
Ascending search
casesensitive="on"
Case sensitive search
Ignore case
nosummary="on"
Show topic title only
Show topic summary
Line: 237 to 250
noheader="on"
Suppress search header Topics: Changed: By:
Show search header
nototal="on"
Do not show number of topics found
Show number
header="..." format="..."
Custom format results: see FormattedSearch for usage, variables & examples
Results in table
Added:
> >
expandvariables="on"
Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin%CALC{}% instead of the formula
Raw text
multiple="on"
Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
Changed:
< <
%PARAM{"name"}%
> >
%URLPARAM{"name"}%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:
Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep.
required
> >
"text"
Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more
required
search="text"
(Alternative to above)
N/A
web="Name" web="Main, Know" web="all"
Wiki web to search: A web, a list of webs separated by comma, or all webs. [2]
Current web
topic="WebPreferences" topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
Line: 273 to 273
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Changed:
< <
> >
Variable:
Level:
What:
Line: 383 to 382
List of preferences that are not allowed to be overridden by next level preferences
Deleted:
< <
Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon.
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
Changed:
< <
%URLPARAM{"name"}%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline:
> >
%PARAM{"name"}%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Parameters are topic name, web and depth:
> >
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Supported parameters:
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%ICON{"type"}%
Changed:
< <
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
> >
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline:
Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep.
required
search="text"
(Alternative to above)
N/A
Changed:
< <
web="Name" web="Main Know" web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2]
Current web
> >
web="Name" web="Main, Know" web="all"
Wiki web to search: A web, a list of webs separated by comma, or all webs. [2]
Current web
topic="WebPreferences" topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Changed:
< <
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name and newline:
> >
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline:
Default value in case parameter is empty or missing
empty string
Line: 227 to 227
noheader="on"
Suppress search header Topics: Changed: By:
Show search header
nototal="on"
Do not show number of topics found
Show number
header="..." format="..."
Custom format results: see FormattedSearch for usage, variables & examples
Results in table
Added:
> >
multiple="on"
Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search
Only one hit per topic
separator=", "
Line separator between hits
Newline "$n"
Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name and newline:
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Changed:
< <
Returns the value of a URL parameter. Note that there is a low risk that this variable could be misused for cross-scripting. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
> >
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name and newline:
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
Added:
> >
%ICON{"type"}%
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Returns the value of a URL parameter. Note that there is a low risk that this variable could be misused for cross-scripting. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
You can add your own Preference Variables for us across an entire site or a single web, using the standard Preferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.
Changed:
< <
Example: Create a custom logo variable the TWiki web
> >
Example: Create a custom logo variable the TWiki web
To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences page, and upload a logo file, ex: mylogo.gif. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: LogoTopic:
Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
%RELEASEEDITLOCKCHECKBOX%
SL , UL
Default state of the "Release edit lock" (UnlockTopic) 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:
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Added:
> >
Preferences Variables
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
> >
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
Search term. (Is a regular expression or literal, depending on the regex parameter) [TWikiAlphaRelease - for regular expressions ";" can be used to mean and e.g. "search;agrep" will find all topic containing search and agrep ]
required
> >
"text"
Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep.
required
search="text"
(Alternative to above)
N/A
web="Name" web="Main Know" web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2]
Current web
scope="topic" scope="text"
Search topic name (title) or in the text (body) of the topic
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}%
Changed:
< <
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
> >
Returns the value of a URL parameter. Note that there is a low risk that this variable could be misused for cross-scripting. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%URLENCODE{"string"}%
Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name
Line: 351 to 351
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
Added:
> >
Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon.
Setting Preferences
Changed:
< <
The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
Set VARIABLENAME = =value=
Set VARIABLENAME = =value=
> >
The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [multiple of 3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
Changed:
< <
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
> >
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
> >
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Parameters are topic name, web and depth:
The syntax for Preferences Bariables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
> >
The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
> >
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub Example: You can refer to a file attached to another topic as %PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH%
The path of the public URL of JCuckoo, is /twiki/pub
Line: 47 to 47
%URLPARAM{"name"}%
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
Added:
> >
%URLENCODE{"string"}%
Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name
Search term. (Is a regular expression or literal, depending on the regex parameter)
required
> >
"text"
Search term. (Is a regular expression or literal, depending on the regex parameter) [TWikiAlphaRelease - for regular expressions ";" can be used to mean and e.g. "search;agrep" will find all topic containing search and agrep ]
required
search="text"
(Alternative to above)
N/A
web="Name" web="Main Know" web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2]
Current web
scope="topic" scope="text"
Search topic name (title) or in the text (body) of the topic
Topic text (body)
Line: 225 to 225
children | required |
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
Changed:
< <
title="Title"
Text the is prepended to any search results
required
> >
title="Title"
Text that is prepended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
Line: 348 to 348
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
Changed:
< <
> >
Setting Preferences
Changed:
< <
The syntax for Preferences variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
> >
The syntax for Preferences Bariables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
Set VARIABLENAME = =value=
Set VARIABLENAME = =value=
Creating Custom Variables
Changed:
< <
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
> >
You can add your own Preference Variables for us across an entire site or a single web, using the standard Preferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.
Changed:
< <
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
> >
Example: Create a custom logo variable the TWiki web
To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences page, and upload a logo file, ex: mylogo.gif. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: LogoTopic:
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
> >
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
Text strings expanded on the fly to display data or system info
Overview
> >
Special text strings expand on the fly to display user data or system info
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. When a topic is rendered for viewing, VARIABLES are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.
Line: 212 to 210
nosearch="on"
Suppress search string
Show search string
noheader="on"
Suppress search header Topics: Changed: By:
Show search header
nototal="on"
Do not show number of topics found
Show number
Changed:
< <
format="..."
Flexible custom result formatting: see FormattedSearch for usage
| type="topicmoved" | What sort of search is required? "topicmoved" if search for a topic that may have been moved
Changed:
< <
"parent" if searcing for topics that have a specific parent i.e. its
> >
"parent" if searching for topics that have a specific parent i.e. its
children | required |
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
Changed:
< <
title="Title"
Text the is pre-pended to any search results
required
> >
title="Title"
Text the is prepended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.
> >
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. When a topic is rendered for viewing, VARIABLES are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.
Predefined Variables
Changed:
< <
Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.
> >
Most predefined variables return values that were either set in the lib/twiki.cfg file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.
Changed:
< <
JCuckoo expands the following variables (enclosed in % percent signs):
> >
Take the time to thoroughly read through ALL preference variables. If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see %INCLUDINGTOPIC%, %INCLUDE%, and the mighty %SEARCH%.
This version of TWiki - Alpha 30 Jul 2004 $Rev: 1701 $ - expands the following variables (enclosed in % percent signs):
Line: 48 to 50
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME%
Changed:
< <
Name of wiki tool, is JCuckoo
> >
The name of your TWiki site - JCuckoo
%WIKIVERSION%
Changed:
< <
Wiki tool version is Alpha 30 Jul 2004 $Rev: 1701 $
> >
Your current TWiki version - Alpha 30 Jul 2004 $Rev: 1701 $
%USERNAME%
Changed:
< <
Your login username is guest
> >
Your login username - guest
%WIKINAME%
Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME%
Changed:
< <
Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
> >
Your %WIKINAME% including the Main web name - always use full signatures - Main.TWikiGuest
The index topic of all registered users. Is TWikiUsers
> >
The index topic of all registered users - TWikiUsers
%WIKIPREFSTOPIC%
Changed:
< <
The web preferences topic. Is TWikiPreferences
> >
The site-wide preferences topic - TWikiPreferences
%WEBPREFSTOPIC%
Changed:
< <
The web preferences topic. Is WebPreferences
> >
The local web preferences topic in each web - WebPreferences
%STATISTICSTOPIC%
Changed:
< <
The web statistics topic. Is WebStatistics
> >
The web statistics topic WebStatistics
%TOPIC%
Changed:
< <
The current topic name, is TWikiVariables
> >
The current topic name - TWikiVariables
%BASETOPIC%
Changed:
< <
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
> >
The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE.
%INCLUDINGTOPIC%
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
Line: 121 to 123
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Changed:
< <
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, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
> >
Web index, ex: 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, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
[1] Note: The search form uses identical names for input fields.
Changed:
< <
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
> >
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Preferences Variables
Line: 349 to 351
Setting Preferences
Changed:
< <
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
> >
The syntax for Preferences variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [3 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Examples:
Control the formatting of an embedded search. By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the format="..." parameter to specify a custom format, typically, a bullet list or table row containing variables
Ex: %SEARCH{ "food" format="| $topic | $summary |" }%) Two paramters can be used to specify a customized search result: 1.header="..." parameter
Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. Ex: header="| *Topic:* | *Summary:* |" 2.format="..." parameter Use the format paramter to specify the format of one search hit.
Ex: format="| $topic | $summary |" Variables that can be used in the format string:
Wiki user name of last topic update, i.e. Main.JohnSmith
$summary
Topic summary
$formfield(name)
The field value of a form field, i.e. $formfield(TopicClassification?) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$pattern(reg-exp)
A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....
Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, ex: $pattern(.*?(from here.*?to here).*). You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag. NOTE: Sorting is nicely covered by the TablePlugin. For how-to tips and tricks, see: TWikiVariablesExamples?
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Changed:
< <
> >
Variable:
Level:
What:
Line: 377 to 352
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
With a couple of notable exceptions, predefined variables return set values that are defined on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
> >
Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.
JCuckoo expands the following variables (enclosed in % percent signs):
Control the formatting of an embedded search. By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the format="..." parameter to specify a custom format, typically, a bullet list or table row containing variables
Ex: %SEARCH{ "food" format="| $topic | $summary |" }%) Two paramters can be used to specify a customized search result: 1.header="..." parameter
Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. Ex: header="| *Topic:* | *Summary:* |" 2.format="..." parameter Use the format paramter to specify the format of one search hit.
Ex: format="| $topic | $summary |" Variables that can be used in the format string:
Wiki user name of last topic update, i.e. Main.JohnSmith
$summary
Topic summary
$formfield(name)
The field value of a form field, i.e. $formfield(TopicClassification?) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$pattern(reg-exp)
A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....
Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, ex: $pattern(.*?(from here.*?to here).*). You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag. NOTE: Sorting is nicely covered by the TablePlugin. For how-to tips and tricks, see: TWikiVariablesExamples?
[1] Note: The search form uses identical names for input fields.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
Changed:
< <
Creating Custom Variables
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
> >
Customizing Variables
Changed:
< <
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
BookView search, e.g. show complete topic text. [3]
Show topic summary.
format="..."
Define a FormattedSearch, i.e. " * [[$topic]]: $summary". [3]
Show regular search result with topic summary
header="..."
Specify header of FormattedSearch, i.e. " * *Topic: Summary:*".
Show regular header
nosearch="on"
Suppress search string
Show search string
noheader="on"
Suppress search header Topics: Changed: By:
Show search header
nototal="on"
Do not show number of topics found
Show number
Line: 233 to 235
[1] Note: The search form uses identical names for input fields.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Text strings expanded on the fly include predefined, preference-driven and custom-defined data
> >
Text strings expanded on the fly to display data or system info
Overview
Changed:
< <
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!
> >
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.
Predefined Variables
Changed:
< <
With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
> >
With a couple of notable exceptions, predefined variables return set values that are defined on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
Changed:
< <
JCuckoo expands the following variables enclosed in % percent signs:
> >
JCuckoo expands the following variables (enclosed in % percent signs):
Changed:
< <
> >
Variable:
Expanded to:
Line: 88 to 86
%WIKIUSERSTOPIC%
The index topic of all registered users. Is TWikiUsers
Added:
> >
%WIKIPREFSTOPIC%
The web preferences topic. Is TWikiPreferences
%WEBPREFSTOPIC%
The web preferences topic. Is WebPreferences
Line: 238 to 239
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Changed:
< <
> >
Variable:
Level:
What:
Line: 353 to 354
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
Changed:
< <
> >
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
Note: Included topic UtilTempDocNote? does not exist yet
Line: 356 to 356
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Changed:
< <
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
> >
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
Note: Included topic UtilTempDocNote? does not exist yet
TOC: No TOC in "TWiki.TWikiVariables"
Line: 40 to 41
The path of the public URL of JCuckoo, is /twiki/pub
%ATTACHURL%
Changed:
< <
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
> >
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH%
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
Line: 114 to 115
separator=", "
line separator
"\n" (new line)
web="Name"
Name of web
Current web
Examples:
Changed:
< <
%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).
> >
%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 gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Line: 127 to 128
separator=", "
line separator
"\n" (new line)
webs="public"
comma sep list of Web, public expands to all non-hidden
"public"
marker="selected"
Text for $marker where item matches selection, otherwise equals ""
"selected"
Changed:
< <
selection
Current value e.g. current for current Web, =section="%WEB%"
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
> >
selection="%WEB%"
Current value to be selected in list
section="%WEB%"
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
Line: 147 to 148
$mo
2 digit month
12
$year
4 digit year
1999
$ye
2 digit year
99
Changed:
< <
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 28 Mar, 2024 - 12:41:25
> >
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 28 Mar, 2024 - 12:41:25
%SERVERTIME%
Server time, is 28 Mar 2024 - 12:41
%SERVERTIME{"format"}%
Changed:
< <
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 12:41
> >
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 12:41
%HTTP_HOST%
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searcing for topics that have a specific parent i.e. its children
required
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
title="Title"
Text the is pre-pended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%VAR{"NAME" web="Web"}%
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
Line: 332 to 346
Setting Preferences
Changed:
< <
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
> >
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
Creating Custom Variables
Line: 340 to 354
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
Changed:
< <
Example: Create a custom logo variable
> >
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Text strings expanded on the fly include predefined, preference-driven and custom-defined data
Overview
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!
Changed:
< <
Predefined Variables
> >
Predefined Variables
With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
Line: 214 to 218
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Changed:
< <
Preferences Variables
> >
Preferences Variables
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Line: 324 to 328
List of preferences that are not allowed to be overridden by next level preferences
Changed:
< <
Setting Preferences
> >
Setting Preferences
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
Changed:
< <
Creating Custom Variables
> >
Creating Custom Variables
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
Changed:
< <
HOW-TO: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. In this case, you also have to upload logo.gif to the same directory.:
> >
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
> >
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!
Predefined Variables
Added:
> >
With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
JCuckoo expands the following variables enclosed in % percent signs:
Changed:
< <
Variable:
Expanded to:
> >
Variable:
Expanded to:
%WIKIHOMEURL%
The base script URL of JCuckoo, is the link of the Home icon in the upper left corner, is http://your.domain.com/twiki
Line: 203 to 206
%VAR{"NAME" web="Web"}%
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
Deleted:
< <
Added:
> >
[1] Note: The search form uses identical names for input fields.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Added:
> >
Preferences Variables
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Changed:
< <
Variable:
Level:
What:
> >
Variable:
Level:
What:
%WIKIWEBMASTER%
SL
Line: 318 to 323
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
Changed:
< <
Setting Variable Preferences
> >
Setting Preferences
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
Creating Custom Variables
Changed:
< <
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths. Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
> >
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
HOW-TO: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. In this case, you also have to upload logo.gif to the same directory.:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
Predefined Variables
Line: 24 to 24
The path of the script URL of JCuckoo, is /cgi-bin
%SCRIPTSUFFIX%
Changed:
< <
The script suffix, i.e. .pl, is
> >
The script suffix, ex: .pl, .cgi is
%PUBURL%
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
Line: 39 to 39
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}%
Changed:
< <
Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
> >
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME%
Name of wiki tool, is JCuckoo
%WIKIVERSION%
Changed:
< <
Wiki tool version, is Alpha 30 Jul 2004 $Rev: 1701 $
> >
Wiki tool version is Alpha 30 Jul 2004 $Rev: 1701 $
%USERNAME%
Changed:
< <
Your login username, is guest
> >
Your login username is guest
%WIKINAME%
Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
The web containing all documentation and configuration of JCuckoo. Is TWiki
> >
The web containing all documentation and configuration of JCuckoo is TWiki
%WEB%
Changed:
< <
The current web, is TWiki
> >
The current web is TWiki
%BASEWEB%
The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include.
Line: 320 to 320
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
Changed:
< <
Setting and Creating New Preferences
> >
Setting Variable Preferences
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
Changed:
< <
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, images. Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
> >
Creating Custom Variables
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths. Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
JCuckoo expands the following variables enclosed in % percent signs:
Line: 317 to 321
List of preferences that are not allowed to be overridden by next level preferences
Changed:
< <
Notes:
> >
Setting and Creating New Preferences
Changed:
< <
Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
Set VARIABLENAME = value
Additional preferences variables can be defined on all three level as needed. Example:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
> >
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
Set VARIABLENAME = value
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, images. Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
%TOC%
Changed:
< <
Table of Content of current topic.
> >
Table of Contents of current topic.
%TOC{"SomeTopic" ...}%
Changed:
< <
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. (But not "<H2>text<H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
> >
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameters are topic name, web and depth:
> >
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. (But not "<H2>text<H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Changed:
< <
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.
> >
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, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Example: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
> >
webs="public"
comma sep list of Web, public expands to all non-hidden
"public"
marker="selected"
Text for $marker where item matches selection, otherwise equals ""
"selected"
selection
Current value e.g. current for current Web, =section="%WEB%"
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME%
GM time, is 28 Mar 2024 - 12:41
Line: 287 to 293
(any topic)
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
Added:
> >
%DENYWEBRENAME%
WL
List of users and groups who are not allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
WL
List of users and groups who are allowed to rename topics in the JCuckoo web. (More in TWikiAccessControl)
%DENYTOPICRENAME%
(any topic)
List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME%
(any topic)
List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%FINALPREFERENCES%
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%TOPICLIST{"format"}%
Changed:
< <
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.
> >
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:
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.
Added:
> >
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Changed:
< <
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.
> >
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:
Example: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
%GMTIME%
Line: 116 to 128
REMOTE_USER environment variable, is
%INCLUDE{"page" ...}%
Changed:
< <
Server side include to IncludeTopicsAndWebPages. The parameter is composed of the page name, followed by an optional pattern="(reg-exp)" pair. The page name is:
> >
Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
"SomeTopic"
The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
"Web.Topic"
A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
"http://..."
A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
Line: 132 to 144
Table of Content of current topic.
%TOC{"SomeTopic" ...}%
Changed:
< <
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ 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 WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameters are topic name, web and depth:
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 term. (Is a regular expression or literal, depending on the regex parameter)
required
search="text"
(Alternative to above)
N/A
web="Name" web="Main Know" web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2]
Current web
scope="topic" scope="text"
Search topic name (title) or in the text (body) of the topic
Topic text (body)
order="topic" order="modified" order="editby"
Sort the results of search by the topic names, last modified time, or last editor
Sort by topic name
Line: 212 to 226
SL , UL
Vertical size of edit box, is 50
Added:
> >
%RELEASEEDITLOCKCHECKBOX%
SL , UL
Default state of the "Release edit lock" (UnlockTopic) 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:
%DONTNOTIFYCHECKBOX%
SL , UL
Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%ATTACHLINKBOX%
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
Line: 256 to 278
Additional preferences variables can be defined on all three level as needed. Example:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
> >
%INCLUDE{"page" ...}%
Server side include to IncludeTopicsAndWebPages. The parameter is composed of the page name, followed by an optional pattern="(reg-exp)" pair. The page name is:
"SomeTopic"
The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
"Web.Topic"
A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
"http://..."
A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
%STARTINCLUDE%
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 everyting exept the %STARTINCLUDE% variable itself.
Line: 134 to 138
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]
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
Added:
> >
%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).
%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.WebHome]]"}% creates a bullet list of all webs.
Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
> >
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]
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1]
Current web
> >
search="food"
Search term, (either regex or literal, depending on the regex parameter)
(used if initial search term is missing)
web="Name" web="Main Know" web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [2]
Current web
scope="topic" scope="text"
Search topic name (title) or in the text (body) of the topic
Topic text (body)
order="topic" order="modified" order="editby"
Sort the results of search by the topic names, last modified time, or last editor
Sort by topic name
limit="all" limit="16"
Limit the number of results returned
All results
Line: 139 to 140
Changed:
< <
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
> >
[1] Note: The search form uses identical names for input fields.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Preferences Variables
Line: 232 to 235
Additional preferences variables can be defined on all three level as needed. Example:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
> >
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Added:
> >
Preferences Variables
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Line: 226 to 232
Additional preferences variables can be defined on all three level as needed. Example:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
Added:
> >
%TOC%
Table of Content of current topic.
%TOC{"SomeTopic" ...}%
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameter is composed of the topic name, followed by optional name="value" pairs:
The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include.
%INCLUDINGWEB%
The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
%TOPIC%
The current topic name, is TWikiVariables
Added:
> >
%BASETOPIC%
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
%INCLUDINGTOPIC%
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
%SPACEDTOPIC%
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
Line: 52 to 64
GM time, is 28 Mar 2024 - 12:41
%GMTIME{"format"}%
Changed:
< <
Formatted GM time based on keywords (first three characters needed.) Example: %GMTIME{"day month, year - hour:min:sec"}% is day month, year - hour:min:sec
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
Added:
> >
%STARTINCLUDE%
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 everyting exept the %STARTINCLUDE% variable itself.
%STOPINCLUDE%
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
%SEARCH{"str" ...}%
Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
> >
Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
%WEB%
The current web, is TWiki
Line: 93 to 93
Changed:
< <
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
> >
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
TWiki expands the following variables enclosed in % percent signs:
> >
JCuckoo expands the following variables enclosed in % percent signs:
Variable:
Expanded to:
%WIKIHOMEURL%
Changed:
< <
The base script URL of TWiki, link of Home icon in upper left corner, is http://your.domain.com/twiki
> >
The base script URL of JCuckoo, is the link of the Home icon in the upper left corner, is http://your.domain.com/twiki
%SCRIPTURL%
Changed:
< <
The script URL of TWiki, is http://jcuckoo.sourceforge.net/cgi-bin
> >
The script URL of JCuckoo, is http://jcuckoo.sourceforge.net/cgi-bin
%SCRIPTURLPATH%
Changed:
< <
The path of the script URL of TWiki, is /cgi-bin
> >
The path of the script URL of JCuckoo, is /cgi-bin
%PUBURL%
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
%PUBURLPATH%
Changed:
< <
The path of the public URL of TWiki, is /twiki/pub
> >
The path of the public URL of JCuckoo, is /twiki/pub
%ATTACHURL%
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Line: 70 to 70
REMOTE_USER environment variable, is
%INCLUDE{"SomeTopic"}%
Changed:
< <
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
> >
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
%SEARCH{"str" ...}%
Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
> >
Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
Line: 155 to 155
%HTTP_EQUIV_ON_PREVIEW%
SL , UL
http-equiv meta tags for preview script.
Added:
> >
%DENYWEBCHANGE%
WL
List of users and groups who are not allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE%
WL
List of users and groups who are allowed to change topics in the JCuckoo web. (More in TWikiAccessControl)
%DENYTOPICCHANGE%
(any topic)
List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE%
(any topic)
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%FINALPREFERENCES%
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
Notes:
Line: 164 to 184
Additional preferences variables can be defined on all three level as needed. Example:
Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Line: 107 to 113
WL
Background color of web
Added:
> >
%NOSEARCHALL%
WL
Exclude web from a web="all" search (set variable to on for hidden webs)
%EDITBOXWIDTH%
SL , UL
Horizontal size of edit box, is 70
Line: 118 to 128
%ATTACHLINKBOX%
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
Added:
> >
%HTTP_EQUIV_ON_VIEW%
SL
http-equiv meta tags for view, rdiff, attach, search* scripts.
Your Wiki username, if defined in TWikiUsers?. Same as %USERNAME% if not defined. Is Main.TWikiGuest
> >
Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
%WEB%
The current web, is TWiki
Line: 42 to 42
%TOPIC%
The current topic name, is TWikiVariables
Deleted:
< <
%DATE%
Todays date (local server time), is 28 Mar 2024
%GMTIME%
Changed:
< <
Todays date (GM time), is 28 Mar 2024 - 12:41
> >
GM time, is 28 Mar 2024 - 12:41
%GMTIME{"format"}%
Formatted GM time based on keywords (first three characters needed.) Example: %GMTIME{"day month, year - hour:min:sec"}% is day month, year - hour:min:sec
%SERVERTIME%
Server time, is 28 Mar 2024 - 12:41
%SERVERTIME{"format"}%
Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
%HTTP_HOST%
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
> >
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
Line: 111 to 114
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
The base script URL of TWiki, link of Home icon in upper left corner is http://your.domain.com/twiki
> >
The base script URL of TWiki, link of Home icon in upper left corner, is http://your.domain.com/twiki
%SCRIPTURL%
The script URL of TWiki, is http://jcuckoo.sourceforge.net/cgi-bin
Line: 45 to 45
%DATE%
Todays date, is 28 Mar 2024
Added:
> >
%HTTP_HOST%
HTTP_HOST environment variable, is jcuckoo.sourceforge.net
%REMOTE_ADDR%
REMOTE_ADDR environment variable, is 127.0.0.1
%REMOTE_PORT%
REMOTE_PORT environment variable, is 43098
%REMOTE_USER%
REMOTE_USER environment variable, is
%INCLUDE{"file.ext"}%
Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"../Know/TopicName.txt"}%
Line: 98 to 110
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
The base script URL of TWiki, link of Home icon in upper left corner is http://your.domain.com/twiki
%SCRIPTURL%
Changed:
< <
The base script URL of TWiki, is http://jcuckoo.sourceforge.net/cgi-bin
> >
The script URL of TWiki, is http://jcuckoo.sourceforge.net/cgi-bin
%SCRIPTURLPATH%
The path of the script URL of TWiki, is /cgi-bin
%PUBURL%
Changed:
< <
The base public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
> >
The public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
%PUBURLPATH%
The path of the public URL of TWiki, is /twiki/pub
%ATTACHURL%
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Added:
> >
%ATTACHURLPATH%
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Deleted:
< <
%WIKIWEBMASTER%
The email address of the Wiki webmaster, is rumcajs_78@users.sourceforge.net
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Variable:
Level:
What:
%WIKIWEBMASTER%
SL
Webmaster email address (sender of email notifications) , is rumcajs_78@users.sourceforge.net
%WIKIWEBLIST%
SL
List of JCuckoo webs (in upper right corner of topics)
TWiki expands the following variables enclosed in % percent signs:
Variable:
Expanded to:
%WIKIHOMEURL%
The base script URL of TWiki, link of Home icon in upper left corner is http://your.domain.com/twiki
%SCRIPTURL%
The base script URL of TWiki, is http://jcuckoo.sourceforge.net/cgi-bin
%PUBURL%
The base public URL of TWiki, is http://jcuckoo.sourceforge.net/twiki/pub
%ATTACHURL%
The attachment URL of the current topic, is http://jcuckoo.sourceforge.net/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%WIKIWEBMASTER%
The email address of the Wiki webmaster, is rumcajs_78@users.sourceforge.net
%WIKITOOLNAME%
Name of wiki tool, is JCuckoo
%WIKIVERSION%
Wiki tool version, is Alpha 30 Jul 2004 $Rev: 1701 $
%USERNAME%
Your login username, is guest
%WIKIUSERNAME%
Your Wiki username, if defined in TWikiUsers?. Same as %USERNAME% if not defined. Is Main.TWikiGuest
%WEB%
The current web, is TWiki
%TOPIC%
The current topic name, is TWikiVariables
%DATE%
Todays date, is 28 Mar 2024
%INCLUDE:"file.ext"%
Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE:"../Know/TopicName.txt"%