Wiki username: Is your name in WikiNotation, e.g. PeterThoeny. When you create your own home page topic, you should use your WikiName for the topic name. Like that, your name will be linked automatically where ever it is used. Please create your home page in TWiki.Main, not any other TWiki web.
Note: When you write a WikiName of a user (your own or somebody else's) be sure to specify the Main web in front of the Wiki user name, e.g. write it as Main.wikiUsername. This assures that the name will be linked automatically to the TWiki.Main web, even if the text is written in a different Wiki web.
TWiki can map the Intranet username to the Wiki username automatically, provided that the Login username and Wiki username pair has been entered in the TWikiUsers topic.
(2) Wiki Variables
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.
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.
TWiki expands the following variables (enclosed in % percent signs):
Variable:
Expanded to:
%WIKIHOMEURL%
The base script URL of TWiki, is the link of the Home icon in the upper left corner, is http://freenetproject.org/twiki
%SCRIPTURL%
The script URL of TWiki, is http://freenetproject.org/cgi-bin/twiki
%SCRIPTURLPATH%
The path of the script URL of TWiki, is /cgi-bin/twiki
%SCRIPTSUFFIX%
The script suffix, ex: .pl, .cgi is
%PUBURL%
The public URL of TWiki, is http://freenetproject.org/twiki
%PUBURLPATH%
The path of the public URL of TWiki, is /twiki
%ATTACHURL%
The attachment URL of the current topic, is http://freenetproject.org/twiki/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/TWiki/TWikiVariables
%URLPARAM{"name"}%
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 TWiki
%WIKIVERSION%
Wiki tool version is 01 Dec 2001
%USERNAME%
Your login username is guest
%WIKINAME%
Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME%
Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
The index topic of all registered users. Is TWikiUsers
%WIKIPREFSTOPIC%
The web preferences topic. Is TWikiPreferences
%WEBPREFSTOPIC%
The web preferences topic. Is WebPreferences
%STATISTICSTOPIC%
The web statistics topic. Is WebStatistics
%TOPIC%
The current topic name, is TWikiVariables
%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
%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:
Parameter:
Description:
Default:
"format"
Format of one line, may include $name and $web variables
"$name"
format="format"
(Alternative to above)
"$name"
separator=", "
line separator
"\n" (new line)
web="Name"
Name of web
Current web
Examples:
%TOPICLIST{" * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable 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:
Parameter:
Description:
Default:
"format"
Format of one line, may include $name variable
"$name"
format="format"
(Alternative to above)
"$name"
separator=", "
line separator
"\n" (new line)
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="%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.
%GMTIME%
GM time, is Fri Apr 19 00:56:48 2002
%GMTIME{"format"}%
Formatted GM time based on time variables.
Variable:
Unit:
Example
$seconds
seconds
59
$minutes
minutes
59
$hours
hours
23
$day
day of month
31
$month
month in ISO format
Dec
$mo
2 digit month
12
$year
4 digit year
1999
$ye
2 digit year
99
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 19 Apr, 2002 - 00:56:48
%SERVERTIME%
Server time, is Thu Apr 18 17:56:48 2002
%SERVERTIME{"format"}%
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 17:56
%HTTP_HOST%
HTTP_HOST environment variable, is freenetproject.org
%REMOTE_ADDR%
REMOTE_ADDR environment variable, is 195.110.99.218
%REMOTE_PORT%
REMOTE_PORT environment variable, is 36107
%REMOTE_USER%
REMOTE_USER environment variable, is
%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"}%
"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.
%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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
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
[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.
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 ian@freenetproject.org
%WIKIWEBLIST%
SL
List of TWiki webs (in upper right corner of topics)
%WEBTOPICLIST%
WL
Common links of web (second line of topics)
%WEBCOPYRIGHT%
SL , WL
Copyright notice (bottom right corner of topics)
%WEBBGCOLOR%
WL
Background color of web
%NOSEARCHALL%
WL
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%
SL , UL
Horizontal size of edit box, is 70
%EDITBOXHEIGHT%
SL , UL
Vertical size of edit box, is 17
%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.
%HTTP_EQUIV_ON_EDIT%
SL , UL
http-equiv meta tags for edit script.
%HTTP_EQUIV_ON_PREVIEW%
SL , UL
http-equiv meta tags for preview script.
%DENYWEBCHANGE%
WL
List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE%
WL
List of users and groups who are allowed to change topics in the TWiki 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%
WL
List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
WL
List of users and groups who are allowed to rename topics in the TWiki 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 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
Above template files will result in the following table when editing a topic:
Note: It is possible to force the values of a category table when creating a new topic. This is useful to create new topics using a form for the topic name. The default values of the category table can be specified as hidden fields if needed, i.e. <input type="hidden" name="someCategory" value="someValue">
Example (edit this page to see the source) :
Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki/pub to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
Now add Alias for /twiki/pub and ScriptAlias for /twiki/bin to /etc/httpd/conf/srm-conf .
Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
Test if the twiki/bin directory is cgi-enabled: Enter the URL of that directory into your browser (http://your.domain.com/twiki/bin). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server." .
Make sure PERL and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rw-r-xr-x .
Set the file permission of all files below twiki/data to 666 ( -rw-rw-rw- ).
Set the file permission of the twiki/data directory and all its subdirectories to 777 ( drwxrwxrwx ).
Set the file permission of the twiki/pub directory to 777 ( drwxrwxrwx ).
Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
Make sure RCS is installed. In case RCS is not in the path environment variable, add it to path . Alternatively, add the full path name to the rcs, ci, co, rlog, rcsdiff commands in the variables of twiki/bin/wikicfg.pm .
Note in case cgi user is notnobody : The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data , or simply delete all the repository files.
Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
Optional: You can add new rendering rules or new %variables%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Optional: If you are on a public server and you would like to authenticate users you need to rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. Consult the HTTP server documentation for details.
To create a new web:
Use a topic name consisting of characters A..Z , a..z but not in WikiNotation.
Create a new template directory under twiki/templates .
Create a new data directory under twiki/data and check the file permission of the directory.
Copy the files TWikiUsers?.txt, WebHome.txt, WebNotify.txt, WebSearch.txt, webcolor.inc, and weblist.inc from the twiki/data/Main directory to the new data directory.
Make changes to webcolor.inc (unique color for web), and possibly also weblist.inc (web specific links on top).
In case you need a web specific copyright notice (at the bottom), copy file webcopyright.inc from the twiki/data directory to the new data directory, and customize it.
If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
If you want to use a category table, copy the three files twikicatitems.tmpl, twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. The TWiki Category Table section has more.
Here are contents of directories with file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
directory twiki/bin :
drwxr-xr-x 5 twiki t5 512 Nov 11 02:52 .
drwxr-xr-x 5 twiki t5 512 Nov 6 02:57 ..
-rw-r--r-- 1 twiki t5 430 Oct 21 18:51 .htaccess
-rw-r-xr-x 1 twiki t5 3752 Mar 27 02:21 attach
-rw-r-xr-x 1 twiki t5 2810 Oct 21 18:51 changes
-rw-r-xr-x 1 twiki t5 1244 Mar 27 02:21 delete
-rw-r-xr-x 1 twiki t5 2589 Nov 6 03:05 edit
-rwxr-xr-x 1 twiki t5 4614 Oct 21 18:52 mailnotify
-rw-r-xr-x 1 twiki t5 1353 Oct 23 20:19 oops
-rw-r-xr-x 1 twiki t5 2043 Nov 6 03:05 preview
-rw-r-xr-x 1 twiki t5 6249 Aug 3 04:34 register
-rw-r-xr-x 1 twiki t5 6890 Nov 11 03:06 rdiff
-rw-r-xr-x 1 twiki t5 1819 Nov 6 03:06 save
-rw-r-xr-x 1 twiki t5 3174 Oct 21 18:51 search
-rw-r-xr-x 1 twiki t5 6696 Mar 27 02:22 upload
-rw-r-xr-x 1 twiki t5 3878 Nov 11 03:06 view
-rw-r-xr-x 1 twiki t5 1538 Mar 27 02:22 viewfile
-rw-r-xr-x 1 twiki t5 16169 Nov 7 01:43 wiki.pm
-rw-r-xr-x 1 twiki t5 3945 Jun 23 01:24 wikicfg.pm
directory twiki/templates/ :
drwxr-xr-x 6 twiki t5 512 Nov 4 20:34 .
drwxr-xr-x 5 twiki t5 512 Nov 11 02:52 ..
drwxr-xr-x 2 twiki t5 512 Oct 23 20:57 Know
drwxr-xr-x 2 twiki t5 512 Nov 4 20:35 Main
-rw-r--r-- 1 twiki t5 2232 Mar 27 02:03 attach.tmpl
-rw-r--r-- 1 twiki t5 1200 Mar 27 02:03 attachtable.tmpl
-rw-r--r-- 1 twiki t5 1751 Nov 11 02:41 changes.tmpl
-rw-r--r-- 1 twiki t5 1711 Nov 6 03:01 edit.tmpl
-rw-r--r-- 1 twiki t5 896 Oct 21 18:51 mailnotify.tmpl
-rw-r--r-- 1 twiki t5 25 Oct 21 18:51 notedited.tmpl
-rw-r--r-- 1 twiki t5 21 Oct 21 18:51 notext.tmpl
-rw-r--r-- 1 twiki t5 157 Oct 23 21:05 notwiki.tmpl
-rw-r--r-- 1 twiki t5 218 Oct 23 20:06 noweb.tmpl
-rw-r--r-- 1 twiki t5 279 Oct 23 20:29 oops.tmpl
-rw-r--r-- 1 twiki t5 833 Mar 27 02:03 oopsdel.tmpl
-rw-r--r-- 1 twiki t5 1331 Oct 23 20:29 oopslocked.tmpl
-rw-r--r-- 1 twiki t5 1026 Aug 03 08:21 oopsregexist.tmpl
-rw-r--r-- 1 twiki t5 935 Aug 03 08:23 oopsregpasswd.tmpl
-rw-r--r-- 1 twiki t5 924 Aug 03 08:26 oopsregrequ.tmpl
-rw-r--r-- 1 twiki t5 931 Aug 03 08:29 oopsregwiki.tmpl
-rw-r--r-- 1 twiki t5 868 Mar 27 02:03 oopsupload.tmpl
-rw-r--r-- 1 twiki t5 2010 Nov 6 03:01 preview.tmpl
-rw-r--r-- 1 twiki t5 1501 Nov 12 22:56 rdiff.tmpl
-rw-r--r-- 1 twiki t5 263 Aug 3 02:44 register.tmpl
-rw-r--r-- 1 twiki t5 1548 Oct 23 21:10 search.tmpl
-rw-r--r-- 1 twiki t5 1541 Oct 26 21:07 view.tmpl
directory twiki/templates/Main :
drwxr-xr-x 2 twiki t5 512 Nov 4 20:35 .
drwxr-xr-x 6 twiki t5 512 Nov 4 20:34 ..
-rw-r--r-- 1 twiki t5 2328 Nov 6 03:03 edit.tmpl
directory twiki/templates/Know (has a TWiki Category Table) :
drwxr-xr-x 2 twiki t5 512 Nov 4 20:35 .
drwxr-xr-x 6 twiki t5 512 Nov 4 20:34 ..
-rw-r--r-- 1 twiki t5 611 Dec 7 20:59 notedited.tmpl
-rw-r--r-- 1 twiki t5 210 Dec 24 23:22 twikicatedit.tmpl
-rw-r--r-- 1 twiki t5 1887 Jan 6 20:54 twikicatitems.tmpl
-rw-r--r-- 1 twiki t5 245 Dec 24 23:27 twikicatview.tmpl
directory twiki/data/ :
drwxrwxrwx 6 twiki t5 512 Nov 19 01:01 .
drwxr-xr-x 5 twiki t5 512 Nov 11 02:52 ..
drwxrwxrwx 2 twiki t5 9216 Nov 13 13:55 Know
drwxrwxrwx 2 twiki t5 4608 Nov 15 21:42 Main
-rw-r--r-- 1 nobody 65535 53 Aug 03 08:31 .htpasswd
-rw-rw-rw- 1 twiki t5 1091 Nov 6 04:15 debug.txt
-rw-r--r-- 1 nobody 65535 4153 Nov 19 01:01 log199810.txt
-rw-r--r-- 1 nobody 65535 7189 Nov 19 01:01 log199811.txt
-rw-r--r-- 1 twiki t5 2356 Oct 22 00:56 webcopyright.inc
-rw-r--r-- 1 twiki t5 276 Oct 22 00:28 wikiwebs.inc
-rw-r--r-- 1 twiki t5 1484 Oct 22 01:11 wikiwebtable.inc