Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r62  >  r61  >  r60  >  r59  >  r58  >  r57  ...
TWikiVariables 62 - 27 Jan 2003 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 246 to 246
 [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):


TWikiVariables 61 - 19 Jan 2003 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 218 to 218
 
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
Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Changed:
<
<		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)
HELP 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: 376 to 377
 
    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed:
<
<		-- PeterThoeny - 13 Sep 2001
>
>		-- PeterThoeny - 19 Jan 2003
 -- MikeMannix? - 12 May 2002

TWikiVariables 60 - 11 Dec 2002 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 173 to 173
 
REMOTE_USER environment variable, is
%INCLUDE{"page" ...}%
Changed:
<
<		 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.SiteMap"}%
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
>
>		 Server side include to IncludeTopicsAndWebPages:
Parameter: Description: Default:
"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.SiteMap"}%  
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%  
pattern="..." A RegularExpression pattern to include a subset of a topic or page none
rev="1.2" Include a previous topic revision; N/A for URLs top revision
 
%STARTINCLUDE%
Line: 213 to 216
 
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:
<
<
header="..."
format="..." 		Custom format results: see FormattedSearch for usage, variables & examples Results in table
>
>
header="..."
format="..." 		Custom format results: see FormattedSearch for usage, variables & examples Results in table
 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)

TWikiVariables 59 - 23 Nov 2002 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 199 to 199
  %SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
Parameter: Description: Default:
Changed:
<
<
"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
>
>
"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 Topic text (body)
order="topic"
order="modified"
order="editby"
order=
 "formfield(name)" 		Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms Sort by topic name
limit="all"
limit="16" 		Limit the number of results returned All results
Changed:
<
<
regex="on" RegularExpression search Literal search
>
>
regex="on" RegularExpression search; also enables ";" as and Literal search
 
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

TWikiVariables 58 - 06 Oct 2002 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 45 to 45
 
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 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:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value
 

Creating Custom Variables


Revision 62r62 - 27 Jan 2003 - 08:22:18 - PeterThoeny?
Revision 61r61 - 19 Jan 2003 - 08:21:09 - PeterThoeny?
Revision 60r60 - 11 Dec 2002 - 08:10:00 - PeterThoeny?
Revision 59r59 - 23 Nov 2002 - 04:42:00 - PeterThoeny?
Revision 58r58 - 06 Oct 2002 - 01:21:00 - PeterThoeny?
Revision 57r57 - 25 Aug 2002 - 07:18:17 - PeterThoeny?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM