Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r52  >  r51  >  r50  >  r49  >  r48  >  r47  ...
TWikiVariables 52 - 12 May 2002 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 172 to 172
  %INCLUDE{"page" ...}% 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"}%
Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiSiteMap"}%
 
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
Line: 196 to 196
  %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) 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:
    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
 

-- PeterThoeny - 13 Sep 2001

Changed:
<
<		-- MikeMannix? - 07 Mar 2002
>
>		-- MikeMannix? - 12 May 2002

TWikiVariables 51 - 07 Apr 2002 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 172 to 172
  %INCLUDE{"page" ...}% 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"}%
Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
 
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%

TWikiVariables 50 - 08 Mar 2002 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 186 to 186
 
Table of Contents of current topic.
%TOC{"SomeTopic" ...}%
Changed:
<
<
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:
 
Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
Line: 366 to 366
 

-- PeterThoeny - 13 Sep 2001

Changed:
<
<		-- MikeMannix? - 23 Jan 2002
>
>		-- MikeMannix? - 07 Mar 2002

TWikiVariables 49 - 16 Feb 2002 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 200 to 200
 
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)
Changed:
<
<
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
>
>
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
regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search

TWikiVariables 48 - 23 Jan 2002 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

TWiki Variables

Changed:
<
<		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 Results in table
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
>
>
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)
 
%METASEARCH{...}%
Line: 221 to 221
 
Parameter: Description: Default:
| 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: "}%
Line: 366 to 366
 

-- PeterThoeny - 13 Sep 2001

Changed:
<
<		-- MikeMannix? - 05 Jan 2002
>
>		-- MikeMannix? - 23 Jan 2002

Revision 52r52 - 12 May 2002 - 11:07:14 - MikeMannix?
Revision 51r51 - 07 Apr 2002 - 10:30:00 - PeterThoeny?
Revision 50r50 - 08 Mar 2002 - 03:52:00 - MikeMannix?
Revision 49r49 - 16 Feb 2002 - 10:37:10 - PeterThoeny?
Revision 48r48 - 23 Jan 2002 - 10:22:00 - MikeMannix?
Revision 47r47 - 06 Jan 2002 - 03:45:00 - MikeMannix?
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