TWiki Reference Manual (Foswiki-1.0.7, Sun, 20 Sep 2009, build 5061)

This page contains all documentation topics as one long, complete reference sheet.
Doubleclick anywhere to return to the top of the page.

Note - if you are reading this at twiki.org, then you are reading about the code running on that site.
If you want to read about the features on your local TWiki, then you should read the documentation there!

Note: Read the most up to date version of this document at http://TWiki.org/cgi-bin/view/TWiki/TWikiDocumentation

Related Topics: TWikiSite, TWikiHistory, TWikiPlannedFeatures, TWikiEnhancementRequests, UserDocumentationCategory, AdminDocumentationCategory

---

TWiki System Requirements

Server and client requirements

Low client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions. Many Plugins and contrib modules exist which enhance and expand TWiki's capabilities; they may have additional requirements.

Server Requirements

TWiki is written in Perl 5, uses a number of shell commands, and requires RCS (Revision Control System), a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements.

Resource	Required Server Environment *
Perl	5.005_03 or higher (5.8.4 or higher is recommended)
RCS	5.7 or higher (including GNU diff) Optional, TWiki includes a pure perl implementation of RCS that can be used instead (although it's slower)
GNU diff	GNU diff 2.7 or higher is required when not using the all-Perl RcsLite. Install on PATH if not included with RCS (check version with diff -v) Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to diff
Other external programs	fgrep, egrep
Cron/scheduler	• Unix: cron • Windows: cron equivalents
Web server	Apache is well supported; for other servers, see the TWiki:Codev.CategoryCookbook lists

Required CPAN Modules

The following Perl modules are used by TWiki:

Module	Preferred version
Algorithm::Diff (included)
CGI::Carp	>=1.26
Config	>=0
Cwd	>=3.05
Data::Dumper	>=2.121
Error (included)
File::Copy	>=2.06
File::Find	>=1.05
File::Spec	>=3.05
FileHandle	>=2.01
IO::File	>=1.10
Text::Diff (included)
Time::Local	>=1.11

Optional CPAN Modules

The following Perl modules may be used by TWiki:

Module	Preferred version	Description
CGI::Cookie	>=1.24	Used for session support
CGI::Session	>=3.95	Used for session support
Digest::base
Digest::SHA1
Jcode		Used for I18N? support with perl 5.6
Locale::Maketext::Lexicon	>=0	Used for I18N? support
Net::SMTP	>=2.29	Used for sending mail
Unicode::Map		Used for I18N? support with perl 5.6
Unicode::Map8		Used for I18N? support with perl 5.6
Unicode::MapUTF8		Used for I18N? support with perl 5.6
Unicode::String		Used for I18N? support with perl 5.6
URI		Used for configure

Most of them will probably already be available in your installation. You can check version numbers with the configure script, or if you're still trying to get to that point, check from the command line like this:

perl -e 'use FileHandle; print $FileHandle::VERSION."\n"'

Client Requirements

The TWiki standard installation has relatively low browser requirements:

• HTML 3.2 compliant
• Cookies, if persistent sessions are required

CSS and Javascript are used in most skins, although there is a low-fat skin (Classic skin) available that minimises these requirements. Some skins will require more recent releases of browsers. The default skin (Pattern) is tested on IE 6, Safari, and Mozilla 5.0 based browsers (such as Firefox).

You can easily select a balance of browser capability versus look and feel. Try the installed skins at TWikiSkinBrowser? and more at TWiki:Plugins.SkinPackage.

Important note about TWiki Plugins

• Plugins can require just about anything - browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
  • Note: Plugins included in the TWiki distribution do not add requirements, except for the CommentPlugin? which requires Perl 5.6.1.

Related Topics: AdminDocumentationCategory

---

TWiki Installation Guide

Please review the AdminSkillsAssumptions before you install TWiki.

TWiki should be fine with any web server and OS that meet the system requirements. See the cookbooks list at TWiki:Codev.CategoryCookbook for guidance for your particular platform.

If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)

Basic Installation

1. Download the TWiki distribution from http://TWiki.org/download.html.
2. Make a directory for the installation and unpack the distribution in it.
3. Make sure the user that runs CGI scripts on your system can read and write all files in the distribution.
   Detailed instructions on file permissions are beyond the scope of this guide, but in general:
   • During installation and configuration, the CGI user needs to be able to read and write everything in the distribution,
   • Once installation and configuration is complete, the CGI user needs write access to everything under the data and pub directories and to lib/LocalSite.cfg. Everything else should be read-only.
   • Everybody else should be denied access to everything, always.
4. Make sure Perl 5 and the Perl CGI library are installed on your system.
   The default location of Perl is /usr/bin/perl. If it's somewhere else, change the path to Perl in the first line of each script in the twiki/bin directory.
   Some systems require a special extension on perl scripts (e.g. .cgi or .pl). If necessary, rename all files in twiki/bin (i.e. rename view to view.pl etc). If you do this, make sure you set the ScriptSuffix option in configure (Step 6).
5. Create the file /twiki/bin/LocalLib.cfg.
   There is a template for this file in /twiki/bin/LocalLib.cfg.txt.
   The file must contain a setting for $twikiLibPath, which must point to the absolute file path of your twiki/lib e.g. /home/httpd/twiki/lib.
   If you need to install additional CPAN modules, but can't update the main Perl installation files on the server, you can set $CPANBASE to point to your personal CPAN install. Don't forget that the webserver user has to be able to read those files as well.
6. Configure the webserver so you can execute the bin/configure script from your browser.
   • Explicit instructions for doing this are beyond the scope of this document, though there is a lot of advice on TWiki.org covering different configurations of webserver. To help you out, there's an example Apache httpd.conf file in twiki_httpd_conf.txt at the root of the package. This file also contains advice on securing your installation. There's also a script called tools/rewriteshebang.pl to help you in fixing up the shebang lines in your CGI scripts.
7. Run the configure script from your browser, and resolve any errors or warnings it tells you about.

You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!

Next Steps (optional)

Once you have your TWiki running, you can move on to customise it for your users.

• Edit the TWikiPreferences topic in the TWiki web. Read through it and set any additional settings you think you might need (you can click the 'Edit' button near the top to edit the settings in place)
  • Alternately, you can copy any settings or variables that you want to customize from TWiki.TWikiPreferences? and paste them into Main.TWikiPreferences. This will protect your local customizations from being overwritten in later upgrades. See notes at top of TWiki.TWikiPreferences? for more information.
• Enable authentication, if required. Read TWikiUserAuthentication..
• Enable email notification (WebChangesAlerts). Read TWikiSiteTools.
• Install Plugins. TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few plugins are pre-installed in the TWiki distribution. Installation instructions for the other plugins can be found in the plugin topics on TWiki.org.

Ongoing maintenance

TWiki ships with two cron scripts that you may want to enable:

• tools/tick_twiki.pl - removes expired sessions and lease files.
  • Read the top of the script for more information.
• bin/mailnotify - generates change notification mails.
  • See MailerContrib? for more details.

Troubleshooting

The first step is to re-run the configure script and make sure you have resolved all errors, and are happy that you understand any warnings.

Failing that, please check the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.

• For Unix or Linux, check TWiki:Codev/TWikiOnUnix and TWiki:Codev/TWikiOnLinux.
• For Windows, check the TWiki:Codev/WindowsInstallCookbook.
• For MacOS X, check TWiki:Codev/TWikiOnMacOSX.
• To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge
• For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes.

If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)

---

TWiki Upgrade Guide

Upgrade from the previous TWiki Sep-2004 "Cairo" production release to TWiki "Dakar"

Overview

Dakar is a major new release. You can chose between an automated upgrade using a script or a manual update.

Upgrade Requirements

• Please review the AdminSkillsAssumptions before you upgrade TWiki
• To upgrade from a Cairo standard installation to the latest Dakar Production Release, follow the instructions below
• NOTE: To upgrade from a pre-Cairo TWiki, start with TWikiUpgradeToCairo?
• To upgrade from a Beta of the new release, or if you made custom modifications, read through all new reference documentation, then use the procedure below as a guideline
• Once the upgrade has been applied, an existing earlier installation will still be able to read all the topics, but will not be able to write. Make sure you take a backup!
• Not all Cairo plugins are supported with Dakar. Make sure the plugins you use can be upgraded as well!

Major Changes Compared to TWiki Cairo

SEE TWiki:Codev.DakarReleaseNotes FOR NOW

Automated Upgrade Procedure

If you would prefer to do things manually, skip to the manual upgrade procedure below.

The upgrade script is called "UpgradeTwiki", and is found in the root of the distribution. It can be run by any user, though you will need to make sure you correct permissions so the webserver user can write all files in the new installation when you have finished. The upgrade script does not write to your existing installation.

The upgrade script will upgrade the TWiki core only. Plugins will need to be upgraded separately.

It will:

• Create a new TWiki installation, placing the files from the distribution there as appropriate
• Where possible, merge the changes you've made in your existing topics and attachments into the new twiki
• Where not possible, it will tell you, and you can inspect those differences manually
• Create new configuration files for the new TWiki based on your existing configuation information
• Set the permissions in the new TWiki so that it should work straight away
• Attempt to setup authentication for your new TWiki, if you are using .htaccess in the old one
• Tell you what else you need to do

To perform the upgrade, you need to:

• Check first if there is a newer UpgradeTwiki script available, see TWiki:Codev.UpgradeTWiki
• Create a new directory for your new installation: Let's call this distro/
• Put the distribution zip file in distro/
• Unzip it
• Choose a directory for the new installation. I will call this new_twiki. This directory must not already exist.
• Change directory to distro/ and run:
  ./UpgradeTwiki <full path to existing_twiki's setlib.cfg> <full path to new_twiki>
• confirm your system settings by pointing your browser to cgi-bin/configure

Assuming all goes well, UpgradeTwiki will give you the final instructions.

There are a few points worth noting:

• UpgradeTwiki may not be able to merge all the changes you made in your existing TWiki into the new installation, but it will tell you which ones it couldn't deal with
• UpgradeTwiki creates the new installation in a new directory tree. It makes a complete copy of all your existing data, so:
  • Clearly you need to point it to a location where there is enough space
  • If you have symlinks under your data/ directory in your existing installation, these are reproduced as actual directories in the new structure. It is up to you to pull these sub-directories out again and re-symlink as needed
• UpgradeTwiki doesn't deal with custom templates or Plugins, you will have to reinstall these in the new installation.

If you use it, and would be kind enough to add your experiences to TWiki:Codev.UpgradeTWiki, it would be much appreciated. The report of your experience will help to make UpgradeTwiki more robust.

Manual Upgrade Procedure

The following steps are a rough guide to upgrading only. It is impossible to give detailed instructions, as what you have to do may depend on whether you can configure the webserver or not, and how much you have changed distributed files in your current TWiki release.

1. Follow the installation instructions, and install the new release in a new directory.
2. Copy your local webs over to the data and pub directories of the new install
   • You could also use softlinks to link the web directories in data and pub to the old installation area
3. Examine your old TWiki.cfg, and for each local setting, set the corresponding value in the configure interface for the new install.

• If you can't use configure, then copy the new TWiki.cfg to LocalSite.cfg, and edit LocalSite?.cfg. Remove all the settings that you didn't change in your previous install, and change the remaining settings to the values from your old TWiki.cfg.

1. Transfer any local settings from TWiki.TWikiPreferences? to the topic pointed at by {LocalSitePreferences} (Main.SitePreferences). This avoids having to write over files in the distribution.
2. If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though the following procedure may help:
   1. Install a copy of the original TWiki release you were using in a temporary directory
   2. Use 'diff' to find changed files, and transfer the changes into the new Dakar install.
   3. Install updated plugins into your new area.
3. Point your webserver at the new install.

You are highly recommended not to change any distributed files if you can avoid it, to simplify future upgrades!

---

TWiki User Authentication

TWiki site access control and user activity tracking options

Authentication, or "login", is the process by which a user lets TWiki know who they are.

Authentication isn't just to do with access control. TWiki uses authentication to identify users, so it can keep track of who made changes, and manage a wide range of personal settings. With authentication enabled, users can personalise TWiki and contribute as recognised individuals, instead of shadows.

TWiki authentication is very flexible, and can either stand alone or integrate with existing authentication schemes. You can set up TWiki to require authentication for every access, or only for changes. Authentication is also essential for access control.

Quick Authentication Test - Use the %WIKIUSERNAME% variable to return your current identity:

• You are WikiGuest

TWiki user authentication is split into three sections; password management, user registration, and login management. Password management deals with how users are recognised (authenticated). Registration deals with how new users are added to the wiki. Login management deals with how users log in.

Once a user is logged on, they are remembered using a "session id" stored in a cookie in the browser (or by other less elegant means if the user has disabled cookies). This avoids them having to log on again and again.

Please note FileAttachments are not protected by TWiki User Authentication.

Password Management

As shipped, TWiki supports the Apache 'htpasswd' password manager. This manager supports the use of .htpasswd files on the server. These files can be unique to TWiki, or can be shared with other applications (such as an Apache webserver). A variety of password encodings are supported for flexibility when re-using existing files. See the descriptive comments in the Security Settings section of the configure interface for more details.

New User Registration

New user registration uses the password manager to set and change passwords. It is also responsible for the new user verification process. the registration process supports single user registration via the TWikiRegistration page, and bulk user registration via the BulkRegistration page (for admins only).

The registration process is responsible for creating user topics.

Login Management

Login management controls the way users have to log in. There are three basic options; no login, login via a TWiki login page, and login using the webserver authentication support.

You can select your chosen login through the Security Settings pane in the configure interface.

No Login

Does exactly what it says on the tin. Forget about authentication to make your site completely public - anyone can browse and edit freely, in classic Wiki style. All visitors are given the TWikiGuest? default identity, so you can't track individual user activity.

Template Login

Template Login asks for a username and password in a web page, and processes them using whatever Password Manager you choose. Users can log in and log out.

Enabling Template Login

1. Use the configure interface to
   1. enable the TemplateLogin login manager (on the Security Settings pane).
   2. select the appropriate password manager for your system, or provide your own.
2. Register yourself in the TWikiRegistration topic.
   Check that the password manager recongises the new user. If you are using .htpasswd files, check that a new line with the username and encrypted password is added to the .htpasswd file. If not, you probably got a path wrong, or the permissions may not allow the webserver user to write to that file.
3. Create a new topic to check if authentication works.
4. Edit the TWikiAdminGroup topic in the TWiki:Main web to include users with system administrator status.
   This is a very important step, as users in this group can access all topics, independent of TWiki access controls.

TWikiAccessControl has more information on setting up access controls.

At this time TWikiAccessControls cannot control access to files in the pub area, unless they are only accessed through the viewfile script. If your pub directory is set up in the webserver to allow open access you may want to add .htaccess files in there to restrict access.

You can create a custom version of the TWikiRegistration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.

You can customize the default user home page in NewUserTemplate. The same variables get expanded as in the template topics

Apache Login

Using this method TWiki does not authenticate users internally. Instead it depends on the REMOTE_USER environment variable, which is set when you enable authentication in the webserver.

The advantage of this scheme is that if you have an existing website authentication scheme using Apache modules such as mod_auth_ldap or mod_auth_mysql you can just plug in directly to them.

The disadvantage is that because the user identity is cached in the browser, you can log in, but you can't log out again.

TWiki maps the REMOTE_USER that was used to log in to the webserver to a WikiName using the table in TWikiUsers?. This table is updated whenever a user registers, so users can choose not to register (in which case their webserver login name is used for their signature) or register (in which case that login name is mapped to their WikiName).

The same private .htpasswd file used in TWiki Template Login can be used to authenticate Apache users, using the Apache Basic Authentication support. This allows the TWiki registration support to maintain usernames and passwords.

Enabling Apache Login using mod_auth

You can use any other Apache authentication module that sets REMOTE_USER.

1. Use configure to select the ApacheLogin login manager.
2. Use configure to set up TWiki to create the right kind of .htpasswd entries.
3. Create a .htaccess file in the twiki/bin directory.
   There is an template for this file in twiki/bin/.htaccess.txt that you can copy and change. The comments in the file explain what need to be done.
   If you got it right, the browser should now ask for login name and password when you click on the Edit. If .htaccess does not have the desired effect, you may need to "AllowOverride All" for the directory in httpd.conf (if you have root access; otherwise, email web server support)
   At this time TWikiAccessControls do not control access to files in the pub area, unless they are only accessed through the viewfile script. If your pub directory is set up to allow open access you may want to add .htaccess files in there as well to restrict access
4. You can create a custom version of TWikiRegistration by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
   You can customize the default user home page in NewUserTemplate. The same variables get expanded as in the template topics
5. Register yourself in the TWikiRegistration topic.
   Check that a new line with the username and encrypted password is added to the .htpasswd file. If not, you may have got a path wrong, or the permissions may not allow the webserver user to write to that file.
6. Create a new topic to check if authentication works.
7. Edit the TWikiAdminGroup topic in the TWiki:Main web to include users with system administrator status.
   This is a very important step, as users in this group can access all topics, independent of TWiki access controls.

TWikiAccessControl has more information on setting up access controls.

Logons via bin/logon

Any time a user enters a page that needs authentication, they will be forced to log on. It may be convenient to have a "logon" as well, to give the system a chance to identify the user and retrieve their personal settings. It may be convenient to force them to log on.

The bin/logon script accomplishes this. The bin/logon script must be setup in the bin/.htaccess file to be a script which requires a valid user. However, once authenticated, it will simply redirect the user to the view URL for the page from which the logon script was linked.

Sessions

TWiki uses the CPAN:CGI::Session and CPAN:CGI::Cookie modules to track sessions using cookies. These modules are de facto standards for session management among Perl programmers. If you can't use Cookies for any reason, CPAN:CGI::Session also supports session tracking using the client IP address. See How to choose an authentication method for a discussion of the pros and cons of the various authentication methods.

There are a number of TWikiVariables available that you can use to interrogate your current session. You can even add your own session variables to the TWiki cookie. Session variables are referred to as "sticky" variables.

Getting, Setting, and Clearing Session Variables

You can get, set, and clear session variables from within TWiki web pages or by using script parameters. This allows you to use the session as a personal "persistent memory space" that is not lost until the web browser is closed. Also note that if a session variable has the same name as a TWiki preference, the session variables value takes precedence over the TWiki preference. This allows for per-session preferences.

To make use of these features, use the tags:

%SESSION_VARIABLE{ "varName" }%
%SESSION_VARIABLE{ "varName" set="varValue" }%
%SESSION_VARIABLE{ "varName" clear="" }%

Cookies and Transparent Session IDs

TWiki normally uses cookies to store session information on a client computer. Cookies are a common way to pass session information from client to server. TWiki cookies simply hold a unique session identifier that is used to look up a database of session information on the TWiki server.

For a number of reasons, it may not be possible to use cookies. In this case, TWiki has a fallback mechanism; it will automatically rewrite every internal URL it sees on pages being generated to one that also passes session information.

TWiki Username vs. Login Username

This section applies only if you are using authentication with existing login names (i.e. mapping from login names to WikiNames).

Wiki-SL internally manages two usernames: Login Username and TWiki Username.

• Login Username: When you login to the intranet, you use your existing login username, ex: pthoeny. This name is normally passed to TWiki by the REMOTE_USER environment variable, and used internally. Login Usernames are maintained by your system administrator.

• TWiki Username: Your name in WikiNotation, ex: PeterThoeny, is recorded when you register using TWikiRegistration; doing so also generates a personal home page in the Main web.

TWiki can automatically map an Intranet (Login) Username to a TWiki Username if the {AllowLoginName} is enabled in configure. The default is to use your WikiName as a login name.

NOTE: To correctly enter a WikiName - your own or someone else's - be sure to include the Main web name in front of the Wiki username, followed by a period, and no spaces. Ex:

Main.WikiUsername or %MAINWEB%.WikiUsername

This points WikiUser to the Main web, where user registration pages are stored, no matter which web it's entered in. Without the web prefix, the name appears as a NewTopic? everywhere but in the Main web.

Changing Passwords

If your {PasswordManager} supports password changing, you can change and reset passwords using forms on regular pages.

• The ChangePassword form ( TWiki/ChangePassword ):
• The ResetPassword form ( TWiki/ResetPassword ):

Controlling access to individual scripts

You may want to add or remove scripts from the list of scripts that require authentication. The method for doing this is different for each of Template Login and Apache Login.

• For Template Login, update the {AuthScripts} list using configure
• For Apache Login, add/remove the script from =

.htaccess=

How to choose an authentication method

One of the key features of TWiki is that it is possible to add HTML to topics. No authentication method is 100% secure on a website where end users can add HTML, as there is always a risk that a malicious user can add code to a topic that gathers user information, such as session IDs. The TWiki developers have been forced to make certain tradeoffs, in the pursuit of efficiency, that may be exploited by a hacker.

This section discusses some of the known risks. You can be sure that any potential hackers have read this section as well!

Firstly, the most secure method is without doubt to use the webserver authentication support, with Sessions turned off.

The second most secure method is to use TWiki's internal authentication with Sessions turned off. This method is less secure than using the webserver because passwords are sent in plain text and can therefore be intercepted in transit.

As soon as you allow the server to maintain information about a logged-in user, you open a door to potential attacks. There are a variety of ways a malicious user can pervert TWiki to obtain another users session ID, the most common of which is known as a cross-site scripting attack. Once a hacker has an SID they can pretend to be that user.

To help prevent these sorts of attacks, TWiki supports IP matching, which ensures that the IP address of the user requesting a specific session is the same as the IP address of the user who created the session. This works well as long as IP addresses are unique to each client, and as long as the IP address of the client can't be faked.

The third most secure method is to use sessions with IP matching ({UseIPMatching} switched on). Shorter session expiry times are more secure ({Sessions}{ExpireAfter}). The default session lifetime is 6 hours, which is quite a long lifetime for a session.

Session IDs are usually stored by TWiki in cookies, which are stored in the client browser. Cookies work well, but not all environments or users permit cookies to be stored in browsers. So TWiki also supports two other methods of determining the session ID. The first method uses the client IP address to determine the session ID. The second uses a rewriting method that rewrites local URLs in TWiki pages to include the session ID in the URL.

The first method works well as long as IP addresses are unique to each individual client, and client IP addresses can't be faked by a hacker. If IP addresses are unique and can't be faked, it is almost as secure as cookies + IP matching, so it ranks as the fourth most secure method.

If you have to turn IP matching off, and cookies can't be relied on, then you may have to rely on the second method, URL rewriting. This method exposes the session IDs very publicly, so should be regarded as the least secure method.

See TWiki:Codev.SecuringYourTWiki for more information

---

TWiki Access Control

Restricting read and write access to topics and webs, by Users and groups

TWikiAccessControl allows you restrict access to single topics and entire webs, by individual user and by user Groups. Access control, combined with TWikiUserAuthentication, lets you easily create and manage an extremely flexible, fine-grained privilege system.

Permissions settings of the webs on this TWiki site

Web	Sitemap	VIEW		CHANGE		RENAME
	Listed	DENY	ALLOW	DENY	ALLOW	DENY	ALLOW
Main ...	on
Amadeu ...	on
Anapolivre ...	on
ArquivoLivre ...	on
Arte ...	on
BahiaSocial ...
BeaBa ...	on
BibliotecaLivre ...	on
Blogs ...	on
BrasilDigital ...	on
BrasilELivre ...	on
BSM ...	on
Ccsa ...
CESL ...	on
CoberturaWiki ...
Cooperativas ...
Curriculo ...	on
DarvinMarosin ...	on
DiaD ...	on
Dinamicoop ...
Economia ...	on
EducacaoLivre ...	on
Ekaaty ...	on
Emacsbr ...	on
ENSL ...	on
Fatos ...	on
Festival3 ...
Festival4 ...					FestivalBahiaGroup
Flisol ...	on
Fmpb ...	on
Formatos ...	on
Foswikibr ...	on
FSM2005 ...	on
GNOMEBR ...	on
GTTemario2004 ...	on
GTWeb ...	on
Guialivre ...	on
HDC ...	on
Incubus ...	on				IncubusGroup		EricJardim
InkscapeBrasil ...	on
Jogos ...
KdeBR ...	on				KdebrGroup		KdebrGroup
KSP ...	on				PabloLorenzzoni, FelipeMobus, MarceloTerres, MarcioOliveira		PabloLorenzzoni
LGM ...	on
LinuxStokDoc ...
Livros ...	on
Mentores ...	on
MHHOB ...	on
MinuanoDigital ...	on
MoradiaECidadania ...	on
OlhosDagua ...	on
Olimpo ...	on
OLPC ...	on
OOPTQ ...
Papers ...	on
PCLivre ...	on
PentahoBrasil ...	on
Pessoas ...	on
Portal ...	on
Prefeituras ...	on				PesquisaSoftexGroup
PSLAL ...	on
PSLBA ...	on
PSLBancarios ...	on
PSLBrasil ...	on
PSLGO ...	on
PSLMA ...	on
PSLMG ...	on
PSLMIP ...	on
PSLMT ...	on
PSLMulheres ...	on
PSLPI ...	on
PubFisl10 ...	on
PubFisl7 ...
PubFisl8 ...	on
PubFisl9 ...	on
QuilomboDoSopapo ...	on
RadioSL ...	on
RedeMesh ...	on
RedePopular ...
RobotWars ...	on
Sandbox ...	on
Saudelivre ...	on
Scribus ...	on
Sementes ...	on
Shakya ...	on
SLRJ ...	on
SoftwareLivreIrece ...	on
SoftwareLivreVS ...	on
SoLiSC ...	on				SoLiSCGroup
SuporteLivre ...
System ...	on				AdminGroup		AdminGroup
Telecentros ...	on
TeseSA ...	on				TeseSAGroup
TextoLivre ...	on
TV ...	on
TWikiBar ...	on
TWikiPtbr ...	on						TWikiAdminGroup
UNELivre ...	on
UNIMIX ...
VilaTorres ...
WebNordeste ...
WTRD2004 ...	on

See TWikiAccessControl for details

Please Note:

• A blank in the the above table may mean either the corresponding control is absent or commented out or that it has been set to a null value. The two conditions have dramatically different and possibly opposed semantics.
• TWikiGuest? is the guest account - used by unauthenticated users.
• The TWiki web must not deny view to TWikiGuest?; otherwise, people will not be able to register.

Related Topics: SiteMap, UserDocumentationCategory, AdminDocumentationCategory, AdminToolsCategory

This table comes from SitePermissions

An Important Control Consideration

Open, freeform editing is the essence of WikiCulture - what makes TWiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with great care - the more restrictions, the less Wiki in the mix. Experience shows that unrestricted write access works very well because:

• Peer influence is enough to ensure that only relevant content is posted.
• Peer editing - the ability for anyone to rearrange all content on a page - keeps topics focussed.
• In TWiki, content is transparently preserved under revision control:
  • Edits can be undone by the TWikiAdminGroup (the default administrators group; see #ManagingGroups).
  • Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.

As a collaboration guideline:

• Create broad-based Groups (for more and varied input), and...
• Avoid creating view-only Users (if you can read it, you should be able to contribute to it).

Authentication vs. Access Control

Authentication: Identifies who a user is based on a login procedure. See TWikiUserAuthentication.

Access control: Restrict access to content based on users and groups once a user is identified.

Users and Groups

Access control is based on the familiar concept of Users and Groups. Users are defined by their WikiNames. They can then be organized in unlimited combinations by inclusion in one or more user Groups. For convenience, Groups can also be included in other Groups.

Managing Users

A user can create an account in TWikiRegistration. The following actions are performed:

• WikiName and encrypted password are recorded using the password manager if authentication is enabled.
• A confirmation e-mail is sent to the user.
• A user home page with the WikiName of the user is created in the Main web.
• The user is added to the WikiUsers topic.

The default visitor name is TWikiGuest?. This is the non-authenticated user.

Managing Groups

Groups are defined by group topics created in the Main web, like the TWikiAdminGroup. To create a new group:

1. Edit TWikiGroups? by entering a new topic with a name that ends in Group. Example:
   • SomeGroup
2. Define two TWikiVariables in the new group topic:
   • Set GROUP = < list of Users and/or Groups >
   • Set ALLOWTOPICCHANGE = < list of Users and/or Groups >
   • The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
     • Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup
   • ALLOWTOPICCHANGE defines who is allowed to change the group topic; it is a comma delimited list of Users and Groups. You typically want to restrict that to the members of the group itself, so it should contain the name of the topic. This prevents Users not in the Group from editing the topic to give themselves or others access. For example, for the TWikiAdminGroup topic write:
   • Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
3. These are summarised on SitePermissions

Note: TWiki has strict formatting rules. Make sure you have three spaces, an asterisk, and an extra space in front of any access control rule.

The SuperAdminGroup

By mistyping a user or group name in the settings, it's possible to lock a topic so that no-one can edit it from a browser. To avoid this, you can create superusers:

• Edit the SuperAdminGroup as described above and add the wikinames of a group of Users who are always allowed to edit/view topics e.g.
  • Set GROUP= ElizabethWindsor?,Main.TonyBlair

Restricting Access

You can define who is allowed to read or write to a web or a topic. Note that some plugins may not respect access permissions.

• Restricting VIEW blocks viewing and searching of content.
• Restricting CHANGE blocks creating new topics, changing topics or attaching files.
• Restricting RENAME controls who is allowed to rename, move or delete a topic.
  • To rename, move or delete a topic, the user also also needs VIEW and CHANGE permission. They also need CHANGE access to change references in any referring topics (though the rename can proceed without this access), and CHANGE access to the target topic.
• Restricting MANAGE controls access to certain management functions, such as 'create web'. It must be set in the TWiki web.

Controlling access to a Web

You can define restrictions of who is allowed to view a Wiki-SL web. You can restrict access to certain webs to selected Users and Groups, by:

• authenticating all webs and restricting selected webs: Topic access in all webs is authenticated, and selected webs have restricted access.
• authenticating and restricting selected webs only: Provide unrestricted viewing access to open webs, with authentication and restriction only on selected webs.

• You can define these settings in the WebPreferences topic, preferable towards the end of the topic:
  • Set DENYWEBVIEW = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBVIEW = < comma-delimited list of Users and Groups >
  • Set DENYWEBCHANGE = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBCHANGE = < comma-delimited list of Users and Groups >
  • Set DENYWEBRENAME = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBRENAME = < comma-delimited list of Users and Groups >

Be careful with empty values for any of these. In older versions of TWiki,

• Set ALLOWWEBVIEW =

meant the same as not setting it at all. However since TWiki Dakar release, it means allow no-one access i.e. prevent anyone from viewing the web. Similarly

• Set DENYWEBVIEW =

now means do not deny anyone the right to view this web. See "How TWiki evaluates ALLOW/DENY settings" below for more on this.

Controlling access to a Topic

• You can define these settings in the WebPreferences topic, preferable towards the end of the topic:
  • Set DENYTOPICVIEW = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICVIEW = < comma-delimited list of Users and Groups >
  • Set DENYTOPICCHANGE = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICCHANGE = < comma-delimited list of Users and Groups >
  • Set DENYTOPICRENAME = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICRENAME = < comma-delimited list of Users and Groups >

Remember when opening up access to specific topics within a restricted web that other topics in the web - for example, the WebLeftBar - may also be accessed when viewing the topics. The message you get when you are denied access should tell you what topic you were not permitted to access.

Be careful with empty values for any of these. In older versions of TWiki,

• Set ALLOWTOPICVIEW =

meant the same as not setting it at all. However since TWiki Dakar release, it means allow no-one access i.e. prevent anyone from viewing the topic. Similarly

• Set DENYTOPICVIEW =

now means do not deny anyone the right to view this topic. See "How TWiki evaluates ALLOW/DENY settings" below for more on this.

Controlling access to Attachments

Attachments are referred to directly, and are not normally indirected via TWiki scripts. This means that the above instructions for access control will not apply to attachments. It is possible that someone may inadvertently publicise a URL that they expected to be access-controlled.

The easiest way to apply the same access control rules for attachments as apply to topics is to use the Apache mod_rewrite module, and configure your webserver to redirect accesses to attachments to the TWiki viewfile script. For example,

  ScriptAlias /twiki/bin/ /filesystem/path/to/twiki/bin/
  Alias /twiki/pub/       /filesystem/path/to/twiki/pub/

  RewriteEngine on
  RewriteRule ^/twiki/pub/TWiki/(.*)$ /twiki/pub/TWiki/$1 [L,PT]
  RewriteRule ^/twiki/pub/([^\/]+)/([^\/]+)/([^\/]+)$ /twiki/bin/viewfile/$1/$2?filename=$3 [L,PT]

That way all the controls that apply to the topic also apply to attachments to the topic. Other types of webserver have similar support.

Note: Images embedded in topics will load much slower since each image will be delivered by the viewfile script.

How TWiki evaluates ALLOW/DENY settings

When deciding whether to grant access, TWiki evaluates the following rules in order (read from the top of the list; if the logic arrives at PERMITTED or DENIED that applies immediately and no more rules are applied). You need to read the rules bearing in mind that VIEW, CHANGE and RENAME access may be granted/denied separately.

1. If the user is a super-user
   • access is PERMITTED.
2. If DENYTOPIC is set to a list of wikinames
   • people in the list will be DENIED.
3. If DENYTOPIC is set to empty ( i.e. Set DENYTOPIC = )
   • access is PERMITTED i.e no-one is denied access to this topic
4. If ALLOWTOPIC is set
   1. people in the list are PERMITTED
   2. everyone else is DENIED
      • Note that this means that setting ALLOWTOPIC to empty denies access to everyone except admins (unless DENYTOPIC is also set to empty, as described above)
5. If DENYWEB is set to a list of wikiname
   • people in the list are DENIED access
6. If ALLOWWEB is set to a list of wikinames
   • people in the list will be PERMITTED
   • everyone else will be DENIED
     • Note that setting ALLOWWEB to empty denies access to everyone except admins
7. If you got this far, access is PERMITTED

Access Control quick recipes

Obfuscating Webs

Another way of hiding webs is to keep them hidden by not publishing the URL and by preventing the all webs search option from accessing obfuscated webs. Do so by enabling the NOSEARCHALL variable in WebPreferences:

• Set NOSEARCHALL = on

This setup can be useful to hide a new web until content its ready for deployment, or to hide view access restricted webs.

Note: Obfuscating a web without view access control is very insecure, as anyone who knows the URL can access the web.

Authenticate all Webs and Restrict Selected Webs

Use the following setup to authenticate users for topic viewing in all webs and to restrict access to selected webs. Requires TWikiUserAuthentication to be enabled.

1. Restrict view access to selected Users and Groups. Set one or both of these variables in its WebPreferences topic:
   • Set DENYWEBVIEW = < list of Users and Groups >
   • Set ALLOWWEBVIEW = < list of Users and Groups >
   • Note: DENYWEBVIEW is evaluated before ALLOWWEBVIEW. Access is denied if the authenticated person is in the DENYWEBVIEW list, or not in the ALLOWWEBVIEW list. Access is granted in case DENYWEBVIEW and ALLOWWEBVIEW is not defined.
2. Hide the web from an "all webs" search. Enable this restriction with the NOSEARCHALL variable in its WebPreferences topic:
   • Set NOSEARCHALL = on

Authenticate and Restrict Selected Webs Only

Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs. Requires TWikiUserAuthentication to be enabled.

1. Restrict view access to selected Users and Groups. Set one or both of these variables in its WebPreferences topic:
   • Set DENYWEBVIEW = < list of Users and Groups >
   • Set ALLOWWEBVIEW = < list of Users and Groups >
   • Note: DENYWEBVIEW is evaluated before ALLOWWEBVIEW. Access is denied if the authenticated person is in the DENYWEBVIEW list, or not in the ALLOWWEBVIEW list. Access is granted in case DENYWEBVIEW and ALLOWWEBVIEW is not defined.
2. Hide the web from an "all webs" search. Enable this restriction with the NOSEARCHALL variable in its WebPreferences topic:
   • Set NOSEARCHALL = on

Hide Control Settings

Tip: To hide access control settings from normal browser viewing, place them in HTML comment markers.

<!--
   * Set DENYTOPICCHANGE = Main.SomeGroup
-->

---

TWiki Text Formatting

Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below.

TWiki Editing Shorthand

Formatting Command:	You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
Headings: Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. You can create a table of contents with the %TOC% variable. If you want to exclude a heading from the TOC, put !! after the ---+. Empty headings are allowed, but won't appear in the table of contents.	---++ Sushi ---+++ Maguro ---+++!! Not in TOC	Sushi Maguro Not in TOC
Bold Text: Words get shown in bold by enclosing them in * asterisks.	*Bold*	Bold
Italic Text: Words get shown in italic by enclosing them in _ underscores.	_Italic_	Italic
Bold Italic: Words get shown in bold italic by enclosing them in __ double-underscores.	__Bold italic__	Bold italic
Fixed Font: Words get shown in fixed font by enclosing them in = equal signs.	=Fixed font=	Fixed font
Bold Fixed Font: Words get shown in bold fixed font by enclosing them in double equal signs.	==Bold fixed==	Bold fixed
You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops. Make sure there is no space between the text and the indicators.	_This works_, _this does not _	This works, _this does not _
Verbatim (Literal) Text: Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted. NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.	<verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>	class CatAnimal { void purr() { <code here> } }
Separator (Horizontal Rule): Three or more three dashes at the beginning of a line..	-------
Bulleted List: Multiple of three spaces, an asterisk, and another space. For all the list types, you can break a list item over several lines by indenting lines after the first one by at least 3 spaces.	* level 1 * level 2 * back on 1 * A bullet broken over three lines * last bullet	level 1 level 2 back on 1 A bullet broken over three lines last bullet
Numbered List: Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number: Type Generated Style Sample Sequence 1. Arabic numerals 1, 2, 3, 4... A. Uppercase letters A, B, C, D... a. Lowercase letters a, b, c, d... I. Uppercase Roman Numerals I, II, III, IV... i. Lowercase Roman Numerals i, ii, iii, iv...	1. Sushi 1. Dim Sum 1. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue	Sushi Dim Sum Fondue Sushi Dim Sum Fondue Sushi Dim Sum Fondue
Definition List: Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.	$ Sushi: Japan $ Dim Sum: S.F.	Sushi Japan Dim Sum S.F.
Table: Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored. | *bold* | header cell with text in asterisks |   center-aligned   | cell with at least two, and equal number of spaces on either side |      right-aligned | cell with more spaces on the left | 2 colspan || and multi-span columns with multiple |'s right next to each other |^| cell with caret indicating follow-up row of multi-span rows You can split rows over multiple lines by putting a backslash '\' at the end of each line Contents of table cells wrap automatically as determined by the browser The TablePlugin provides the |^| multiple-span row functionality and additional rendering features	| *L* | *C* | *R* | | A2 | B2 | C2 | | A3 | B3 | C3 | | multi span ||| | A5-7 | 5 | 5 | |^| six | six | |^| seven | seven | | split\ | over\ | 3 lines | | A9 | B9 | C9 |	L C R A2 B2 C2 A3 B3 C3 multi span A5-7 5 5 six six seven seven split over 3 lines A9 B9 C9
WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. If you want to link to a topic in a different web write Otherweb.TopicName. The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic.	WebStatistics Sandbox.WebNotify Sandbox.WebHome	WebStatistics WebNotify Sandbox
Anchors: You can define a reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.	[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WikiWord#NotThere Jump To here
Forced Links: You can create a forced internal link by enclosing words in double square brackets. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.	[[wiki syntax]] [[Main.TWiki users]] escaped: ![[wiki syntax]]	wiki syntax Main.TWiki users? escaped: [[wiki syntax]]
Specific Links: You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]]. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported. The rules described under Forced Links apply for internal link references. Anchor names can be added as well, to create a link to a specific place in a topic.	[[WikiSyntax][wiki syntax]] [[http://gnu.org][GNU]]	wiki syntax GNU
Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point.	!SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags. It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto Links: E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain][descriptive text]].	a@b.com [[mailto:a@b.com]\ [Mail]] [[mailto:?subject=\ Hi][Hi]]	a@b.com Mail Hi

Using HTML

You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <strike>deleted text</strike> to get deleted text.

There are a few usability and technical considerations to keep in mind:

• On collaboration pages, it's better not to use HTML, but to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
• If you use HTML use XHTML 1.0 Transitional syntax.
• Script tags may be filtered out, at the discretion of your TWiki administrator.

Recommendations when pasting HTML from other sources:

• Copy only text between <body> and </body> tags.
• Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags.
• Remove leading spaces. TWiki might interpret some text as lists.
• Do not span a tag over more than one line. TWiki requires that the opening and closing angle brackets - <...> - of an HTML tag are on the same line, or the tag will be broken.
• In your HTML editing program, save without hard line breaks on text wrap.

TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn.

Script tags

You can use HTML <script> tags for your TWiki applications. However note that your TWiki administrator can disable <script> in topics, and may have chosen to do so for security considerations. TWiki markup and TWikiVariables are not expanded inside script tags.

Hyperlinks

Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs.

Internal Links

• GoodStyle is a WikiWord that links to the GoodStyle topic located in the current web.

• NotExistingYet? is a topic waiting to be written. Create the topic by clicking on the ?. (Try clicking, but then, Cancel - creating the topic would wreck this example!)

External Links

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

• Email addresses like name@domain.com are linked automatically.

• [[Square bracket rules]] let you easily create non-WikiWord links.
  • You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

TWiki Variables

TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly.

• %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

• %WEB% : The current web, is TWikiPtbr.

• %TOPIC% : The current topic name, is TextFormattingRules.

• %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

• %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

• %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications.

• TWikiPreferences defines some site-wide variables. Among others:
  • Line break: Write %BR% to start a new line.
  • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
  • Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

• There are many more variables, see TWikiVariables.

• To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the Plugins web on TWiki.org.

Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

• TWikiCompatibilityPlugin (Foswiki-1.0, $Rev: 1776 (2009-01-06) $): add TWiki personality to Foswiki
• SpreadSheetPlugin (20 Sep 2009, $Rev: 5049 (2009-09-20) $): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
• AttachmentListPlugin (1.3.3, $Rev: 4282 (2009-06-22) $):
• CommentPlugin (12 Sep 2009, $Rev: 4843 (2009-09-11) $): Quickly post comments to a page without an edit/preview/save cycle
• EditTablePlugin (4.33, $Rev: 4950 (2009-09-16) $): Edit tables using edit fields, date pickers and drop down boxes
• ImageGalleryPlugin (5.01, $Rev: 4425 (2009-07-03) $): Displays image gallery with auto-generated thumbnails from attachments
• InterwikiPlugin (20 Sep 2009, $Rev: 5022 (2009-09-20) $): Link ExternalSite?:Page text to external sites based on aliases defined in a rules topic
• LinkOptionsPlugin (1.0.0, 4643): Extends the "Forced Specific Links" syntax [[URL or TopicName][Link Text][Options]]
• PreferencesPlugin (20 Sep 2009, $Rev: 5037 (2009-09-20) $): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (02 Aug 2008, $Rev: 2742 (2009-02-26) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (20 Sep 2009, $Rev: 5046 (2009-09-20) $): Render smilies like as icons
• TablePlugin (1.042, $Rev: 4847 (2009-09-12) $): Control attributes of tables and sorting of table columns
• TagMePlugin (11 Jun 2009, $Rev: 4104 (2009-06-11) $): Tag wiki content collectively to find content by keywords
• TopicDataHelperPlugin (1.1.1, $Rev: 4253 (2009-06-20) $):
• TopicTranslationsPlugin (Dakar, $Rev: 4525 (2009-07-21) $): Manages a topic's translations into several languages.
• TwistyPlugin (1.5.3, $Rev: 4751 (2009-09-02) $): Twisty section Javascript library to open/close content dynamically

Check on current Plugin status and settings for this site in TWikiPreferences.

Common Editing Errors

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:

• Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
  • A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
    Example: Type 'prog <filename>' to get 'prog <filename>'.

• Q: Why is the '&' character sometimes not displayed?
  • A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
    Example: Type 'This & that' to get 'This & that'.

---

TWiki Variables

Special text strings expand on the fly to display user data or system info

TWikiVariables are text strings - %VARIABLE% or %VARIABLE{ parameter="value" }% - that expand into content whenever a topic is rendered for viewing. There are two types of variables:

1. Preferences variables: Can be defined and changed by the user
2. Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin? introduces a %CALC{}% variable)

Using Variables

To use a variable type its name. For example,

• type %T% to get (a preferences variable)
• type %TOPIC% to get TWikiVariables (a predefined variable)
• type %CALC{ "$UPPER(Text)" }% to get TEXT (a variable defined by Plugin)

Note:

• To leave a variable unexpanded, precede it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%
• Variables are expanded relative to the topic they are used in, not the topic they are defined in
• Type %ALLVARIABLES% to get a full listing of all variables defined for a particular topic

Preferences Variables

Unlike predefined variables, preferences variables can be defined by the user in various places.

Setting Preferences Variables

You can set variables in all the following places:

1. local site level in SitePreferences
2. user level in individual user topics in Main web
3. web level in WebPreferences of each web
4. topic level in topics in webs
5. plugin topics (see TWikiPlugins)
6. session variables (if sessions are enabled)

Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.

The syntax for setting 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] = [space] value

Examples:

• Set VARIABLENAME = value
  • Set VARIABLENAME = value

Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example:

   * Set VARIABLENAME = value starts here
     and continues here

Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.

Example: Create a custom logo variable

• To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences topic, 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, e.g. LogoTopic. Sample variable setting in WebPreferences:
  • Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

You can also set preferences variables on a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are not visible in the topic text, but take effect nevertheless.

Access Control Variables

These are special types of preferences variables to control access to content. TWikiAccessControl explains these security settings in detail.

Local values for variables

Certain topics (a users home topic, web site and default preferences topics) have a problem; variables defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the variable definition. For example, if the user sets the following in their home topic:

   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20

Then when they are editing any other topic, they will get a 10 high edit box. However when they are editing their home topic, they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all variables in their evaluation order, so you can see variable scope if you get confused.

Frequently Used Preferences Variables

The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings:

• %BR% - line break
• %BULLET% - bullet sign
• %BB% - line break and bullet combined
• %BB2% - indented line break and bullet
• %RED% text %ENDCOLOR% - colored text (also %YELLOW%, %ORANGE%, %PINK%, %PURPLE%, %TEAL%, %NAVY%, %BLUE%, %AQUA%, %LIME%, %GREEN%, %OLIVE%, %MAROON%, %BROWN%, %BLACK%, %GRAY%, %SILVER%, %WHITE%)
• %H% - Help icon
• %I% - Idea icon
• %M% - Moved to icon
• %N% - New icon
• %P% - Refactor icon
• %Q% - Question icon
• %S% - Pick icon
• %T% - Tip icon
• %U% - Updated icon
• %X% - Alert icon
• %Y% - Done icon

There are additional useful preferences variables defined in TWikiPreferences, in Main.SitePreferences, and in WebPreferences of every web.

Predefined Variables

Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH%, are powerful and general tools.

• Predefined variables can be overridden by preferences variables
• Plugins may extend the set of predefined variables (see individual Plugins topics for details)
• 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 - Foswiki-1.0.7, Sun, 20 Sep 2009, build 5061 - predefines the following variables:

ACTIVATEDPLUGINS -- list of currently activated plugins

• Syntax: %ACTIVATEDPLUGINS%
• Expands to: TWikiCompatibilityPlugin, SpreadSheetPlugin, AttachmentListPlugin, CommentPlugin, EditTablePlugin, ImageGalleryPlugin, InterwikiPlugin, LinkOptionsPlugin, PreferencesPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TagMePlugin, TopicDataHelperPlugin, TopicTranslationsPlugin, TwistyPlugin
• Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION

ALLVARIABLES -- list of currently defined TWikiVariables

• Syntax: %ALLVARIABLES%
• Expands to: a table showing all defined TWikiVariables in the current context

ATTACHURL -- full URL for attachments in the current topic

• Syntax: %ATTACHURL%
• Expands to: http://wiki.softwarelivre.org/pub/TWikiPtbr/TWikiVariablesAtoM
• Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
• Related: ATTACHURLPATH, PUBURLPATH, SCRIPTURL, FileAttachments

ATTACHURLPATH -- path of the attachment URL of the current topic

• Syntax: %ATTACHURLPATH%
• Expands to: /pub/TWikiPtbr/TWikiVariablesAtoM
• Related: ATTACHURL, PUBURL, FileAttachments

AUTHREALM -- authentication realm

• String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login templates as part of the login prompt.
• Syntax: %AUTHREALM%
• Expands to: Enter your LoginName. (Typically First name and last name, no space, no dots, capitalized, e.g. JohnSmith, unless you chose otherwise). Visit UserRegistration if you do not have one.
• Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE

BASETOPIC -- base topic where an INCLUDE started

• The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE
• Syntax: %BASETOPIC%
• Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC

BASEWEB -- base web where an INCLUDE started

• 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.
• Syntax: %BASEWEB%
• Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB

DATE -- signature format date

• Syntax: %DATE%
• Expands to: 21 Nov 2009
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: DISPLAYTIME, GMTIME{"format"}, SERVERTIME

DISPLAYTIME -- display time

• Syntax: %DISPLAYTIME%
• Expands to: 21 Nov 2009 - 11:33
• Related: DISPLAYTIME{"format"}, GMTIME, SERVERTIME

DISPLAYTIME{"format"} -- formatted display time

• Formatted time - either GMT or Local server time, depending on setting in configure. Same format qualifiers as %GMTIME%
• Syntax: %DISPLAYTIME{"format"}%
• Example: %DISPLAYTIME{"$hou:$min"}% expands to 11:33
• Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string to HTML entities

Encode "special" characters to HTML numeric entities. Encoded characters are:

• all non-printable ascii chars (< \x1f), except \n (\xa) and \r (\xd)
• HTML special characters '>', '<', '&', ''' and '"'.
• TWiki special characters '%', '[', ']', '@', '_', '*' and '='
• Syntax: %ENCODE{"string"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "string"	String to encode	required (can be empty)
  type="entity"	Encode special characters into HTML entities, like a double quote into "	URL encoding
  type="url"	Encode special characters for URL parameter use, like a double quote into %22	(this is the default)

• Example: %ENCODE{"spaced name"}% expands to spaced%20name
• Related: URLPARAM

ENDSECTION{"name"} -- marks the end of a named section

• Syntax: %ENDSECTION{"name"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "name"	Name of the section. Must be unique inside a topic, and must match with a previous %SECTION% variable.	Mandatory parameter without a default

• Related: INCLUDE, SECTION, STARTINCLUDE, STOPINCLUDE

FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list

• Syntax: %FAILEDPLUGINS%
• Expands to: See TWikiPlugins#FAILEDPLUGINS
• Related: PLUGINDESCRIPTIONS, ACTIVATEDPLUGINS, PLUGINVERSION

FORMFIELD{"format"} -- renders a field in the form attached to some topic

• Syntax: %FORMFIELD{"fieldname"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "fieldname"	The name of a TWiki form field	required
  topic="..."	Topic where form data is located. May be of the form Web.TopicName	Current topic
  format="..."	Format string. $value expands to the field value, and $title expands to the field title	"$value"
  default="..."	Text shown when no value is defined for the field	""
  alttext="..."	Text shown when field is not found in the form	""

• Example: %FORMFIELD{"ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field found"}%
• Related: SEARCH

GMTIME -- GM time

• Syntax: %GMTIME%
• Expands to: 21 Nov 2009 - 11:33
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: DISPLAYTIME, GMTIME{"format"}, SERVERTIME

GMTIME{"format"} -- formatted GM time

• Syntax: %GMTIME{"format"}%
• Supported variables:

  Variable:	Unit:	Example
  $seconds	seconds	59
  $minutes	minutes	59
  $hours	hours	23
  $day	day of month	31
  $wday	day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat)	Thu
  $dow	day of the week (Sun = 0)	2
  $week	number of week in year (ISO 8601)	34
  $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	2009-11-21T11:33:11Z
  $rcs	RCS format timestamp	2009/11/21 11:33:11
  $http	E-mail & http format timestamp	Sat, 21 Nov 2009 11:33:11 GMT
  $epoch	Number of seconds since 00:00 on 1st January, 1970	1258803191

• Variables can be shortened to 3 characters
• Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 21 Nov, 2009 - 11:33:11
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

• Syntax: %HOMETOPIC%
• Expands to: WebHome, renders as WebHome
• Related: NOTIFYTOPIC, STATISTICSTOPIC, TOPIC

HTTP -- get HTTP headers

• Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant.
• Syntax: %HTTP%
• Syntax: %HTTP{'Header-name'}%
• Examples:

  %HTTP%
  %HTTP{"Accept-language"}%	en-us,en;q=0.5
  %HTTP{"User-Agent"}%	CCBot/1.0 (+http://www.commoncrawl.org/bot.html)

• Note: You can see the HTTP headers your browser sends to the server on a number of sites e.g. http://www.ericgiguere.com/tools/http-header-viewer.html
• Related: HTTPS, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

HTTPS -- get HTTPS headers

• The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
• Syntax: %HTTPS%
• Syntax: %HTTPS{'Header-name'}%
• Related: HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

HTTP_HOST -- environment variable

• Syntax: %HTTP_HOST%
• Expands to: wiki.softwarelivre.org
• Related: REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

ICON{"name"} -- small documentation graphic or icon of common attachment types

• Small graphic images stored in TWikiDocGraphics, used to enhance topics. Also a collection of common file type icons. Specify file type only, file name, or full path name of file. Graphics typically have 16x16 pixels.
• Syntax: %ICON{"name"}%
• Graphic samples: arrowbright, bubble, choice-yes, hand
• File type samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
• Example: %ICON{"info"}% expands to HTML img tag
• Related: ICONURL, ICONURLPATH, DefaultPreferences?, FileAttachments, TWikiDocGraphics

ICONURL{"name"} -- URL of small documentation graphic or icon

• Generates the URL of an image, typically used in an HTML img tag (contrast with %ICON{"name"}%, which generates the full img tag)
• Syntax: %ICONURL{"name"}%
• Example: %ICONURL{"info"}% expands to URL http://wiki.softwarelivre.org/pub/System/DocumentGraphics/info.gif, which renders as
• Related: ICONURLPATH, ICON, DefaultPreferences?, FileAttachments, TWikiDocGraphics

ICONURLPATH{"name"} -- URL path of small documentation graphic or icon

• Generates the URL path of an image, typically used in an HTML img tag
• Syntax: %ICONURLPATH{"name"}%
• Example: %ICONURLPATH{"info"}% expands to /pub/System/DocumentGraphics/info.gif
• Related: ICONURL, ICON, DefaultPreferences?, FileAttachments, TWikiDocGraphics

IF{"condition" ...} -- simple conditionals

• Evaluate a condition and show one text or another based on the result. See details in IfStatements
• Syntax: %IF{"CONDITION" then="THEN" else="ELSE"}% shows "THEN" if "CONDITION" evaluates to TRUE, otherwise "ELSE" will be shown
• Example: %IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else=" is not defined"}% renders as ==
• Related: $IF()? of SpreadSheetPlugin?

INCLUDE{"page"} -- include other topic or web page

• Syntax: %INCLUDE{"page" ...}%
• Supported parameters:

  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:80/index.html"}%. Supported content types are text/html and text/plain. if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.
  pattern="..."	A RegularExpression pattern to include a subset of a topic or page	none
  rev="2"	Include a previous topic revision; N/A for URLs	top revision
  warn="off"	Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name)	%INCLUDEWARNING% preferences setting
  section="name"	Includes only the specified section, as defined in the included topic by the SECTION and ENDSECTION variables
  PARONE="val 1"   PARTWO="val 2"	Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic.

• Examples: See IncludeTopicsAndWebPages
• Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, SECTION, ENDSECTION

INCLUDINGTOPIC -- name of topic that includes current topic

• The name of the topic that includes the current topic - same as %TOPIC% in case there is no include
• Syntax: %INCLUDINGTOPIC%
• Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

INCLUDINGWEB -- web that includes current topic

• The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
• Syntax: %INCLUDINGWEB%
• Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

LANGUAGES -- list available TWiki languages

• List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's user interface is available.
• Syntax: %LANGUAGES{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  format	format for each item. See below for variables available in the format string.	"   * $langname"
  separator	separator between items.	"\n" (newline)

• format variables:

  Variable	Meaning
  $langname	language's name, as informed by the translators
  $langtag	language's tag. Ex: en, pt-br, etc.

LOCALSITEPREFS -- web.topicname of site preferences topic

• The full name of the local site preferences topic. This topic is read for preferences before TWiki.%TWIKIPREFSTOPIC% is read.
• Syntax: %LOCALSITEPREFS%
• Expands to: Main.SitePreferences, renders as SitePreferences

LOGIN -- present a full login link

• Syntax: %LOGIN%
• Expand to: Log In
• Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION_VARIABLE

LOGOUT -- present a full logout link

• Syntax: %LOGOUT%
• Expand to:
• Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSION_VARIABLE

MAKETEXT -- creates text using TWiki's I18N? infrastructure

• Syntax: %MAKETEXT{"string" args="..."}
• Supported parameters:

  Parameter	Description	Default
  "text" or string="text"	The text to be displayed.	none
  args="param1, param2"	a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it.	none

• Examples:
  • %MAKETEXT{string="Notes:"}%
    expands to
    Notes:
  • %MAKETEXT{"Contact [_1] if you have any questions." args="%WIKIWEBMASTER%"}%
    expands to
    Contact wikiwebmaster@softwarelivre.org if you have any questions.
  • %MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="TWiki.ResetPassword,%WIKIUSERNAME%"}%
    expands to
    Did you want to reset Main.WikiGuest's password?
• Notes:
  • TWiki will translate the string to the current user's language only if it has such string in its translation table for that language.
  • Amperstands (&) followed by one letter (one of a...z, A...Z) (say, X) in the translatable string will be translated to <span class='twikiAccessKey'>X</span>. This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&&): they will be transformed in just one.
  • translatable string starting with underscores (_) are reserved. You should not use translatable phrases starting with an underscore.
  • Make sure that the translatable string is constant. Specially, do not include %VARIABLES% inside the translatable strings (since they will get expanded before the %MAKETEXT{...}% itself is handled).

MAINWEB -- name of Main web

• The web containing WikiUsers, individual user topics and TWikiGroups?
• Syntax: %MAINWEB%
• Expands to: Main
• Related: TWIKIWEB

META -- displays meta-data

• Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The formfield item is the most likely to be useful to casual users.
• Syntax: %META{ "item" ...}%
• Parameters:

  Item	Options	Description
  "formfield"	name="..." - name of the field. The field value can be shortened as described in FormattedSearch for $formfield	Show a single form field
  "form"	none	Generates the table showing the form fields. See Form Templates
  "attachments"	all="on" to show hidden attachments	Generates the table showing the attachments
  "moved"	none	Details of any topic moves
  "parent"	dontrecurse="on": By default recurses up tree, this has some cost. nowebhome="on": Suppress WebHome. prefix="...": Prefix that goes before parents, but only if there are parents, default "". suffix="...": Suffix, only appears if there are parents, default "". separator="...": Separator between parents, default is " > ".	Generates the parent link

• Related: METASEARCH

METASEARCH -- special search of meta data

• Syntax: %METASEARCH{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  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 "field" if searching for topics that have a particular form field value (use the name and value parameters to specify which field to search)	required
  web="%WEB%"	Wiki web to search: A web, a list of webs separated by whitespace, or all webs.	current web
  topic="%TOPIC%"	The topic the search relates to, for topicmoved and parent searches	current topic
  name	form field to search, for field type searches. May be a regular expression (see SEARCH).
  value	form field value, for field type searches. May be a regular expression (see SEARCH).
  title="Title"	Text that is prefixed to any search results	empty
  default="none"	Default text shown if no search hit	empty

• Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
• Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
  %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
• Example: %METASEARCH{type="field" name="Country" value="China"}%
• Related: SEARCH, META

NOP -- template text not to be expanded in instantiated topics

• Syntax: %NOP%
• Syntax: %NOP{...}%
• Available in template topics only. See TWikiTemplates#HtmlTemplates for details. In normal topic text, simply expands to whatever is in the curly braces (if anything).

NOTIFYTOPIC -- name of the notify topic

• Syntax: %NOTIFYTOPIC%
• Expands to: WebNotify, renders as WebNotify
• Related: HOMETOPIC, STATISTICSTOPIC, TOPIC

PLUGINDESCRIPTIONS -- list of plugin descriptions

• Syntax: %PLUGINDESCRIPTIONS%
• Expands to:
  • TWikiCompatibilityPlugin (Foswiki-1.0, $Rev: 1776 (2009-01-06) $): add TWiki personality to Foswiki
  • SpreadSheetPlugin (20 Sep 2009, $Rev: 5049 (2009-09-20) $): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
  • AttachmentListPlugin (1.3.3, $Rev: 4282 (2009-06-22) $):
  • CommentPlugin (12 Sep 2009, $Rev: 4843 (2009-09-11) $): Quickly post comments to a page without an edit/preview/save cycle
  • EditTablePlugin (4.33, $Rev: 4950 (2009-09-16) $): Edit tables using edit fields, date pickers and drop down boxes
  • ImageGalleryPlugin (5.01, $Rev: 4425 (2009-07-03) $): Displays image gallery with auto-generated thumbnails from attachments
  • InterwikiPlugin (20 Sep 2009, $Rev: 5022 (2009-09-20) $): Link ExternalSite?:Page text to external sites based on aliases defined in a rules topic
  • LinkOptionsPlugin (1.0.0, 4643): Extends the "Forced Specific Links" syntax [[URL or TopicName][Link Text][Options]]
  • PreferencesPlugin (20 Sep 2009, $Rev: 5037 (2009-09-20) $): Allows editing of preferences using fields predefined in a form
  • SlideShowPlugin (02 Aug 2008, $Rev: 2742 (2009-02-26) $): Create web based presentations based on topics with headings.
  • SmiliesPlugin (20 Sep 2009, $Rev: 5046 (2009-09-20) $): Render smilies like as icons
  • TablePlugin (1.042, $Rev: 4847 (2009-09-12) $): Control attributes of tables and sorting of table columns
  • TagMePlugin (11 Jun 2009, $Rev: 4104 (2009-06-11) $): Tag wiki content collectively to find content by keywords
  • TopicDataHelperPlugin (1.1.1, $Rev: 4253 (2009-06-20) $):
  • TopicTranslationsPlugin (Dakar, $Rev: 4525 (2009-07-21) $): Manages a topic's translations into several languages.
  • TwistyPlugin (1.5.3, $Rev: 4751 (2009-09-02) $): Twisty section Javascript library to open/close content dynamically
• Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API

• Syntax: %PLUGINVERSION{"name"}% to get the version of a specific plugin
• Example: %PLUGINVERSION{"InterwikiPlugin"}% expands to $Rev: 5022 (2009-09-20) $
• Syntax: %PLUGINVERSION% to get the version of the API
• Expands to: 2.0
• Related: WIKIVERSION, ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINDESCRIPTIONS

PUBURL -- the base URL of attachments

• Syntax: %PUBURL%
• Expands to: http://wiki.softwarelivre.org/pub
• Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
• Related: ATTACHURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments

PUBURLPATH -- the base URL path of attachments

• Syntax: %PUBURLPATH%
• Expands to: /pub
• Related: ATTACHURL, PUBURL, SCRIPTURL, SCRIPTURLPATH, FileAttachments

QUERYSTRING -- full, unprocessed string of parameters to this URL

• String of all the URL parameters that were on the URL used to get to the current page. For example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
• Note: URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and %URLPARAM{}%.
• Syntax: %QUERYSTRING%
• Expands to:
• Related: URLPARAM

REMOTE_ADDR -- environment variable

• Syntax: %REMOTE_ADDR%
• Expands to: 38.107.191.105
• Related: HTTP_HOST, REMOTE_PORT, REMOTE_USER

REMOTE_PORT -- environment variable

• Syntax: %REMOTE_PORT%
• Expands to:
• Related: HTTP_HOST, REMOTE_ADDR, REMOTE_USER

REMOTE_USER -- environment variable

• Syntax: %REMOTE_USER%
• Expands to:
• Related: HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, WIKINAME, WIKIUSERNAME

REVINFO -- revision information of current topic

• Syntax: %REVINFO%
• Expands to: r2 - 02 Dec 2008 - 18:31:39 - ViniciusMassuchetto
• Related: REVINFO{"format"}

REVINFO{"format"} -- formatted revision information of topic

• Syntax: %REVINFO{"format"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of revision information, see supported variables below	"r1.$rev - $date - $wikiusername"
  web="..."	Name of web	Current web
  topic="..."	Topic name	Current topic
  rev="1.5"	Specific revison number	Latest revision

• Supported variables in format:

  Variable:	Unit:	Example
  $web	Name of web	Current web
  $topic	Topic name	Current topic
  $rev	Revison number. Prefix r1. to get the usual r1.5 format	5
  $date	Revision date	11 Jul 2004
  $username	Login username of revision	jsmith
  $wikiname	WikiName of revision	JohnSmith
  $wikiusername	WikiName with Main web prefix	Main.JohnSmith

• Example: %REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
• Related: REVINFO

SCRIPTNAME -- name of current script

• The name of the current script is shown, including script suffix, if any (for example viewauth.cgi)
• Syntax: %SCRIPTNAME%
• Expands to: view
• Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH

SCRIPTSUFFIX -- script suffix

• Some Wiki-SL installations require a file extension for CGI scripts, such as .pl or .cgi
• Syntax: %SCRIPTSUFFIX%
• Expands to:
• Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH

SCRIPTURL -- base URL of TWiki scripts

• Syntax: %SCRIPTURL%
• Expands to: http://wiki.softwarelivre.org/bin
• Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL{"script"}, SCRIPTURLPATH

SCRIPTURL{"script"} -- URL of TWiki script

• Syntax: %SCRIPTURL{"script"}%
• Expands to: http://wiki.softwarelivre.org/bin/script
• Example: To get the authenticated version of the current topic you can write %SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to http://wiki.softwarelivre.org/bin/viewauth/TWikiPtbr/TWikiVariables
• Note: In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better
• Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SCRIPTURLPATH{"script"}

SCRIPTURLPATH -- base URL path of TWiki scripts

• As %SCRIPTURL%, but doesn't include the protocol and host part of the URL
• Syntax: %SCRIPTURLPATH%
• Expands to: /bin
• Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH{"script"}

SCRIPTURLPATH{"script"} -- URL path of TWiki script

• As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL
• Syntax: %SCRIPTURLPATH{"script"}%
• Expands to: /bin/script
• Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURL{"script"}, SCRIPTURLPATH

SEARCH{"text"} -- search content

• Inline search, shows a search result embedded in a topic
• Syntax: %SEARCH{"text" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "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"	Comma-separated list of webs to search. The special word all means all webs that doe not have the NOSEARCHALL variable set to on in their WebPreferences. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb".	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.	All topics in a web
  excludetopic="Web*" excludetopic="WebHome, WebChanges"	Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.	None
  type="keyword" type="literal" type="regex"	Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo	%SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
  scope="topic" scope="text" scope="all"	Search topic name (title); the text (body) of topic; or all (both)	"text"
  order="topic" order="created" order="modified" order="editby" order=  "formfield(name)"	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; if you want to sort across webs, create a formatted table and sort it with TablePlugin?'s initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table).	Sort by topic name
  limit="all" limit="16"	Limit the number of results returned. This is done after sorting if order is specified	All results
  date="..."	limits the results to those pages with latest edit time in the given TimeInterval.	All results
  reverse="on"	Reverse the direction of the search	Ascending search
  casesensitive="on"	Case sensitive search	Ignore case
  bookview="on"	BookView search, e.g. show complete topic text	Show topic summary
  nonoise="on"	Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"	Off
  nosummary="on"	Show topic title only	Show topic summary
  nosearch="on"	Suppress search string	Show search string
  noheader="on"	Suppress search header Topics: Changed: By:	Show search header, unless seach is inline and a format is specified (Cairo compatibility)
  nototal="on"	Do not show number of topics found	Show number
  zeroresults="off"	Suppress all output if there are no hits	zeroresults="on", displays: "Number of topics: 0"
  noempty="on"	Suppress results for webs that have no hits.	Show webs with no hits
  header="..." format="..."	Custom format results: see FormattedSearch for usage, variables & examples	Results in table
  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
  nofinalnewline="on"	If on, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate.	off
  recurse="on"	Recurse into subwebs, if subwebs are enabled.	off
  separator=", "	Line separator between hits	Newline "$n"

• Example: %SEARCH{"wiki" web="Main" scope="topic"}%
• 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)
• Hint: 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%" }%
• Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch

SECTION{"name"} -- marks the start of a named section

• Section boundaries are defined with %SECTION{"name"}% and %ENDSECTION{"name"}%; named sections can be included with %INCLUDE{ "Topic" section="name" }%
• Syntax: %SECTION{"name"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "name"	Name of the section. Must be unique inside a topic, and must have a matching %ENDSECTION% variable.	Mandatory parameter without a default

• Related: INCLUDE, ENDSECTION, STARTINCLUDE, STOPINCLUDE

SERVERTIME -- server time

• Syntax: %SERVERTIME%
• Expands to: 21 Nov 2009 - 09:33
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: DISPLAYTIME, GMTIME, SERVERTIME{"format"}

SERVERTIME{"format"} -- formatted server time

• Same format qualifiers as %GMTIME%
• Syntax: %SERVERTIME{"format"}%
• Example: %SERVERTIME{"$hou:$min"}% expands to 09:33
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: DISPLAYTIME, GMTIME, SERVERTIME

SESSION_VARIABLE -- get, set or clear a session variable

• Syntax: %SESSION_VARIABLE{"name"}%
• Syntax: %SESSION_VARIABLE{"name" set="value"}%
• Syntax: %SESSION_VARIABLE{"name" clear=""}%
• Hint: The users ID is in the AUTHUSER session variable, and is read-only
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, SESSIONVAR, LOGIN, LOGOUT

SESSIONID -- unique ID for this session

• Syntax: %SESSIONID%
• Expand to: 82af0fab6db55634ab49fbbf1efabfa8
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE

SESSIONVAR -- name of CGI and session variable that stores the session ID

• Syntax: %SESSIONVAR%
• Expand to: FOSWIKISID
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, LOGIN, LOGOUT, SESSION_VARIABLE

SPACEDTOPIC -- topic name, spaced and URL-encoded

• The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
• Syntax: %SPACEDTOPIC%
• Expands to: TWiki%20*Variables%20*Nto%20*Z
• Note: This is a deprecated variable. It can be duplicated with %URLENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
• Related: SPACEOUT, TOPIC, URLENCODE

SPACEOUT{"string"} -- renders string with spaces inserted in sensible places

• Inserts spaces after lower case letters that are followed by a digit or a capital letter, and after digits that are followed by a capital letter.
• Useful for spacing out WikiWords
• Syntax: %SPACEOUT{ "%TOPIC%" }%
• Expands to: TWiki Variables
• Supported parameters:

  Parameter:	Description:	Default:
  separator	The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies	' '

• Hint: Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home
• Related: SPACEDTOPIC, $PROPERSPACE()? of SpreadSheetPlugin?

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 everything exept the %STARTINCLUDE% variable itself. An optional parameter can be used to control whether the content is expanded.
• Syntax: %STARTINCLUDE%
• Syntax: %STARTINCLUDE{param}%
  • If param does not expand to a non-zero integer, then nothing will be included.
• Related: ENDSECTION, INCLUDE, SECTION, STOPINCLUDE

STATISTICSTOPIC -- name of statistics topic

• Syntax: %STATISTICSTOPIC%
• Expands to: WebStatistics, renders as WebStatistics
• Related: HOMETOPIC, NOTIFYTOPIC, TOPIC

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.
• Syntax: %STOPINCLUDE%
• Related: ENDSECTION, INCLUDE, SECTION, STARTINCLUDE

TOC -- table of contents of current topic

• Syntax: %TOC%
• Related: TOC{"Topic"}

TOC{"Topic"} -- table of contents

• Syntax: %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:

  Parameter:	Description:	Default:
  "TopicName"	topic name	Current topic
  web="Name"	Name of web	Current web
  depth="2"	Limit depth of headings shown in TOC	6
  title="Some text"	Title to appear at top of TOC	none

• Example: %TOC{depth="2"}%
• Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
• Example: see TWiki:Sandbox.TestTopicInclude
• Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
• Related: TOC

TOPIC -- name of current topic

• Syntax: %TOPIC%
• Expands to: TWikiVariables, renders as TWikiVariables
• Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB

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.
• Syntax: %TOPICLIST{"format" ...}%
• Supported parameters:

  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

• Example: %TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics
• Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
• Example: %TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
• Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

• The web containing all documentation and site-wide preference settings for Wiki-SL
• Syntax: %TWIKIWEB%
• Expands to: TWiki
• Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

• Returns the value of a URL parameter.
• Syntax: %URLPARAM{"name"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "name"	The name of a URL parameter	required
  default="..."	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. See ENCODE for more details.	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/TWikiPtbr/TWikiVariables?skin=print URL
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Note: There is a risk that this variable could be misused for cross-site scripting.
• Related: SEARCH, FormattedSearch, QUERYSTRING

USERNAME -- your login username

• TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like Main.JohnSmith. Un-authenticated users are all TWikiGuest?.
• Syntax: %USERNAME%
• Expands to: guest
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: REMOTE_USER, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication

USERLANGUAGE -- current user's language

• Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
• The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
  • Is the LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
  • Avoid to define it LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
• Related: LANGUAGES

VAR{"NAME" web="Web"} -- get a preference value from another web

• Syntax: %VAR{"NAME" web="Web"}%
• Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #FFEFA6
• Related: WEBPREFSTOPIC

WEB -- name of current web

• Syntax: %WEB%
• Expands to: TWikiPtbr
• Related: BASEWEB, INCLUDINGWEB, TOPIC

WEBLIST{"format"} -- index of all webs

• 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.
• Syntax: %WEBLIST{"format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of one line, may include $name (the name of the web), $qname (the name of the web in double quotes), $indentedname (the name of the web with parent web names replaced by indents, for use in indented lists), and $marker (which expands to marker for the item matching selection only)	"$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 if the item matches selection	"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="TWikiPtbr" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
• Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

• Syntax: %WEBPREFSTOPIC%
• Expands to: WebPreferences, renders as WebPreferences
• Related: HOMETOPIC, WIKIPREFSTOPIC, VAR

WIKIHOMEURL -- site home URL

• Note: DEPRECATED, use %WIKILOGOURL% defined in WebPreferences instead. This variables value is defined in lib/TWiki.cfg::$wikiHomeUrl which is marked deprecated. Will be removed in future versions.

WIKINAME -- your Wiki username

• The WikiName is the same as %USERNAME% if not defined in the WikiUsers topic
• Syntax: %WIKINAME%
• Expands to: WikiGuest
• Note: When used in a template topic, this variable will be expanded when the template is used to create new topic. See TWikiTemplates#TemplateTopicsVars for details.
• Related: REMOTE_USER, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC

WIKIPREFSTOPIC -- name of site-wide preferences topic

• Syntax: %WIKIPREFSTOPIC%
• Expands to: DefaultPreferences, renders as DefaultPreferences?
• Related: HOMETOPIC, WEBPREFSTOPIC

WIKITOOLNAME -- name of your TWiki site

• Syntax: %WIKITOOLNAME%
• Expands to: Wiki-SL
• Related: WIKIHOMEURL, WIKIVERSION

WIKIUSERNAME -- your Wiki username with web prefix

• Your %WIKINAME% with Main web prefix, useful to point to your Wiki-SL home page
• Syntax: %WIKIUSERNAME%
• Expands to: Main.WikiGuest, renders as WikiGuest
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details
• Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

• Syntax: %WIKIUSERSTOPIC%
• Expands to: WikiUsers, with Main prefix renders as WikiUsers
• Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

• Syntax: %WIKIVERSION%
• Expands to: Foswiki-1.0.7, Sun, 20 Sep 2009, build 5061
• Related: PLUGINVERSION, WIKITOOLNAME

---

File Attachments

Each topic can have one or more files of any type attached to it by using the Attach screen to upload (or download) files from your local PC. Attachments are stored under revision control: uploads are automatically backed up; all previous versions of a modified file can be retrieved.

What Are Attachments Good For?

File Attachments can be used to archive data, or to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.

Document Management System

• You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using web and topic-level access control; create a central reference library that's easy to share with an user group spread around the world.

File Sharing

• For file sharing, FileAttachments on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload!

Web Authoring

• Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to link to on a page) and place them on a single page, or use them across a web, or site-wide.
  • NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can use your browser to create TWikiVariables shortcuts, like this %H% = .

Uploading Files

• Click on the Attach link at the bottom of the page. The Attach screen lets you browse for a file, add a comment, and upload it. The uploaded file will show up in the File Attachment table.
  • NOTE: The topic must already exist. It is a two step process if you want to attach a file to a non-existing topic; first create the topic, then add the file attachment.
  • Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: *.php files are renamed to *.php.txt so that no one can place code that would be read in a .php file.
  • The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
  • TWiki can limit the file size. This is defined by the %ATTACHFILESIZELIMIT% variable of the TWikiPreferences, currently set at 10000 KB.
    • It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads.
• Automatic attachments:
  • When enabled, all files in a topic's attachment directory are shown as attachments to the topic - even if they were directly copied to the directory and never attached by using an 'Attach' link. This is a convenient way to quickly "attach" files to a topic without uploading them one by one; although at the cost of losing audit trail and version control.
  • To enable this feature, set the {AutoAttachPubDir} configuration option.
  • NOTE: The automatic attachment feature can only be used by an administrator who has access to the server's file system.

Downloading Files

• Click on the file in the File Attachment table.

• NOTE: There is no access control on individual attachments. If you need control over single files, create a separate topic per file and set topic-level access restrictions for each.

Moving Attachment Files

An attachment can be moved between topics.

• Click Manage on the Attachment to be moved.
• On the control screen, select the new web and/or topic.
• Click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data.

Deleting Attachments

Move unwanted Attachments to web Trash, topic TrashAttachment.

Linking to Attached Files

• Once a file is attached it can be referenced in the topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and enter: %ATTACHURL%/Sample.txt
  3. Preview: %ATTACHURL%/Sample.txt text appears as: /pub/TWikiPtbr/FileAttachment/Sample.txt, a link to the text file.

• To reference an attachment located in another topic, enter:
  • %PUBURLPATH%/%WEB%/OtherTopic/Sample.txt (if it's within the same web)
  • %PUBURLPATH%/Otherweb/OtherTopic/Sample.txt (if it's in a different web)

• Attached HTML files and text files can be inlined in a topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%
     • Content of attached file is shown inlined.
     • Read more about INCLUDE in TWikiVariables

• GIF, JPG and PNG images can be attached and shown embedded in a topic. Example:
  1. Attach file: Smile.gif
  2. Edit topic and write text: %ATTACHURL%/Smile.gif
  3. Preview: text appears as /pub/TWikiPtbr/FileAttachment/Smile.gif, an image.

File Attachment Contents Table

Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.

I	Attachment	Action	Size	Date	Who	Comment
	Sample.txt	manage	0.1 K	22 Jul 2000 - 19:37	UploadingUser	Just a sample
	Smile.gif	manage	0.1 K	22 Jul 2000 - 19:38	UploadingUser	Smiley face

File Attachment Controls

Clicking on a Manage link takes you to a new page that looks a bit like this (depending on what skin is selected):

Update attachment Sample.txt Version Action Date Who Comment 1 view 22 Jul 2000 - 19:37 UploadingUser Just a sample Previous upload Sample.txt (TWikiContributor) Select a new local file to update this attachment. Local file Upload up to 10000 KB. Comment Link Create a link to the attached file Images will be displayed, for other attachments a link will be created. Hide file Do not show attachment in table Attachments will not be shown in topic view page.

• The first table is a list of all attachments, including their attributes. An h means the attachment is hidden, it isn't listed when viewing a topic.

• The second table is all the versions of the attachment. Click on View to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want.
  • To change the comment on an attachment, enter a new comment and then click Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.
  • To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.

Known Issues

• Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.
• Attachments are not secured. Anyone can read them if they know the name of the web, topic and attachment.

---

TWiki Forms

Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database applications.

Overview

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. A form is enabled for a web and can be added to a topic. The form data is shown in tabular format when the topic is viewed, and can be changed in edit mode using edit fields, radio buttons, check boxes and list boxes. Many different form types can be defined in a web, though a topic can only have only form attached to it at a time.

Typical steps to build an application based on TWiki forms:

1. Define a form template
2. Enable the form for a web
3. Add the form to a template topic
4. Build an HTML form to create new topics based on that template topic
5. Build a FormattedSearch to list topics that share the same form

Defining a Form Template

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table is one form field.

Form Template Elements

• form template - a set of fields defining a form
  • A web can use one or more form templates
• form - additional meta data (besides the freeform TEXTAREA) attached to a topic
  • Within a form-enabled web, individual topics can have a form or no form
• form field - a named item in a form (also known as a key)
• field type - selects the field type:

  Input type	Type field	Size field	Value field
  One or more checkboxes	checkbox	number of items per line	comma list of item labels
  One or more checkboxes, plus Set and Clear buttons	checkbox+buttons	(same)	(same)
  One or more radio buttons (radio buttons are mutually exclusive; only one can be selected)	radio	(same)	(same)
  Read-only label text	label	ignored	text
  Drop-down menu or scrollable box	select	1 for drop down, 2 and up for scrollable box	comma-separated list of options
  A one-line text field	text	text box width in number of characters	initial text, if a new topic is created with a form template
  A text box	textarea	columns x rows, e.g. 80x6; default size is 40x5	initial text, if a new topic is created with a form template

• field value - one or more values from a fixed set (select, checkbox, radio type) or free-form (label, text, text area).

Defining a Form

1. Create a new topic with your form name: YourForm, ExpenseReportForm, InfoCategoryForm, RecordReviewForm, whatever you need.
2. Create a TWiki table, with each column head representing one element of an entry field: Name, Type, Size, Values, Tooltip message, and Attributes (see sample below).
3. For each field, fill in a new line; for the type of field, select from the list.
4. Save the topic (you can later choose to enable/disable individual forms).

Example: WebForm
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |
| TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... |   |
| OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... |   |
| OsVersion | text | 16 | | blah blah... |   |

Name	Type	Size	Values	Tooltip message	Attributes
TopicClassification	select	1	NoDisclosure, PublicSupported, PublicFAQ	blah blah...
OperatingSystem	checkbox	3	OsHPUX, OsLinux, OsSolaris, OsWin	blah blah...
OsVersion	text	16		blah blah...

You can also retrieve possible values for select, checkbox or radio types from other topics:

Example: WebForm

• In the WebForm topic, define the form:
  

  Name	Type	Size	Values	Tooltip message	Attributes
  TopicClassification	select	1		blah blah...
  OperatingSystem	checkbox	3		blah blah...
  OsVersion	text	16		blah blah...

  
  Leave the Values field blank.

• Then in the TopicClassification topic, define the possible values:
  

  Name	Type	Tooltip message
  NoDisclosure	option	blah blah...
  Public Supported	option	blah blah...
  Public FAQ	option	blah blah...

Field values can also be obtained as the result of a FormattedSearch. For example,

%SEARCH{"Office$" scope="topic" web="%MAINWEB%" nototal="on" nosummary="on" nosearch="on" regex="on" format="Main.$topic" separator=", " }%

when used in the value field of the form definition, will take the set of field values to be all topic names in the Main web which end in "Office".

Notes:

• A very few field names are reserved. if you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used.
• The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For label, text, and text area fields that value may also contain commas. Checkbox fields cannot be initialized through the form template.
• The topic definition is not read when a topic is viewed.
• Field names can include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a select, checkbox or radio field, and want to get the values from another topic, you can use [[...]] links. This notation can also be used when referencing another topic to obtain field values, but one wants to use a name other than the topic name as the name of the field.
• Field names have to be unique. If the same name is necessary (as when the field values for several fields are obtained from the same topic), an alternative name must be assigned using the [[...]] notation.
• The topic defining field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.
• Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.
• The Tooltip message column is used as a tooltip for the field name (only if field name is a WikiName) - you only see the tooltip in edit view.
• The Attributes column is used to define special behavior for that form field (multiple attributes can be entered, with or without separators):
  • An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.
  • An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asteriks next to the field name.

Enabling Forms by Web

Forms have to be enabled for each individual web. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.

Example:

• Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm

• With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

Add a form to a topic

• Edit a topic and follow the "Add form" button to add a Form to the topic. This is typically done to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

• Additionally a new topic can be given a Form using the formtemplate parameter in the (edit or save) URL. Initial values can then be provided in the URLs or as form values:
  • other than checkboxes: name, ex: ?BugPriority=1
  • checkbox: namevalue=1, ex: ?ColorRed=1.
    Boxes with a tick must be specified.
  • Example: This will add a textfield for the new topic name and a "Create"-Button to your topic. When the button is pressed, the topic editor will open with the form "MyForm" already attached to the new topic.

        <form name="newtopic" action="%SCRIPTURLPATH{"edit"}%/%WEB%/">
           <input type="hidden" name="formtemplate" value="MyForm" />
           New topic name <input type="text" name="topic" size="40" />
           <input type="submit" value="Create" />
        </form>
           

• Tip: For TWiki applications you can automatically generate unique topicnames.

• Note: Initial values will not be submitted to the form of a new topic if you only use the formtemplate parameter.

Build an HTML form to create new Form-based topics

• New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

Changing a form

• You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

• If you change the form definition, the changes will not take affect in a topic that uses that form until you edit and save it.

• If you add a new field to the form, then it will appear next time you edit a topic that uses the form.

• If you delete a field from the form, or change a field name, then the data will not be visible when you edit the topic (the changed form definition will be used). If you save the topic, the old data will be lost (though thanks to revision control, you can always see it in older versions of the topic)

Searching for Form Data

TWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData, FORMFIELD, SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search.

Example
TWiki users often want to have an overview of topics they contributed to. With the $formfield parameter it is easy to display the value of a classification field next to the topic link:

| *Topic* | *Classification* |
%SEARCH{"Main.UserName" scope="text" regex="off" nosearch="on" nototal="on" order="modified" reverse="on"
format="|<b>[[$web.$topic][$topic]]</b> |<nop>$formfield(TopicClassification) |" web="Sandbox"}%

Extending the range of form data types

Several Plugins allow you to extend the range of data types accepted by forms. For example, the TWiki:Plugins.DateFieldPlugin lets you add a 'date' type to the available data types. All data types are single-valued (can only have one value) with the following exceptions:

• any type name starting with checkbox
• any type name with +multi anywhere in the name

Types with names like this can both take multiple values.

Gotcha!

• Some browsers may strip linefeeds from text fields when a topic is saved. If you need linefeeds in a field, make sure it is a textarea.

Importing Category Table Data

Very, very old TWiki releases used a system called the "TWikiCategoryTable". Later releases support automatic import of this data.

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

If things aren't working correctly, there may be useful entries in data/warning.txt.

---

TWiki Templates

Definition of the templates used to render all HTML pages displayed in TWiki

Overview

There are three types of template:

• Master Templates: Define blocks of text for use in other templates
• HTML Page Templates: Define the layout of Wiki-SL pages
• Template Topics: Define default text when you create a new topic

All three types of template use the TWiki template system.

The TWiki Template System

Templates are plain text with embedded template directives that tell TWiki how to compose blocks of text together to create something new.

How Template Directives Work

• Template directives are embedded in templates.
• Directives are of the form %TMPL:<key>% and %TMPL:<key>{"attr"}%.
• Directives:
  • %TMPL:INCLUDE{"file"}%: Includes a template file. The file is found as described below.
  • %TMPL:DEF{"block"}%: Define a block. Text between this and the %TMPL:END% directive is not used in-place, but is saved for later use with %TMPL:P. Leading and trailing whitespace is ignored.
  • %TMPL:END%: Ends a block definition.
  • %TMPL:P{"var"}%: Includes a previously defined block.
  • %{...}%: is a comment.
• Two-pass processing lets you use a variable before or after declaring it.
• Templates and TWikiSkins work transparently and interchangeably. For example, you can create a skin that overloads only the twiki.tmpl master template, like twiki.print.tmpl, that redefines the header and footer.
• Use of template directives is optional: templates work without them.
• NOTE: Template directives work only for templates: they do not get processed in normal topic text.

TMPL:P also supports simple parameters. For example, given the definition %TMPL:DEF{"x"}% x%P%z%TMPL:END% then %TMPL:P{"x" P="y"}% will expand to xyz.

Note that parameters can simply be ignored; for example=%TMPL:P{"x"}%= will expand to x%P%z.

Any alphanumeric characters can be used in parameter names. You are highly recommended to use parameter names that cannot be confused with TWikiVariables.

Note that three parameter names, context, then and else are reserved. They are used to support a limited form of "if" condition that you can use to select which of two templates to use, based on a context identifier:

%TMPL:DEF{"link_inactive"}%<input type="button" disabled value="Link>%TMPL:END%
%TMPL:DEF{"link_active"}%<input type="button" onclick="link()" value="Link" />%TMPL:END%
%TMPL:P{context="inactive" then="inactive_link" else="active_link"}% for %CONTEXT%

When the "inactive" context is set, then this will expand the "link_inactive" template; otherwise it will expand the "link_active" template. See IfStatements for details of supported context identifiers.

Finding Templates

Templates are stored either in the twiki/templates directory, or can also be read from user topics. As an example, twiki/templates/view.tmpl is the default template file for the twiki/bin/view script.

Templates that are included using %TMPL:INCLUDE% are also found using the same search algorithm, unless you explicitly put '.tmpl' at the end of the template name. In this case, the string is assumed to be the full name of a template in the templates directory, and the algorithm isn't used.

TWiki uses the following search order to determine which template file or topic to use for a particular script. The skin path is set as described in TWikiSkins.

1. templates/web/script.skin.tmpl for each skin on the skin path
   • this usage is supported for compatibility only and is deprecated. Store web-specific templates in TWiki topics instead.
2. templates/script.skin.tmpl for each skin on the skin path
3. templates/web/script.tmpl
   • this usage is supported for compatibility only and is deprecated. Store web-specific templates in TWiki topics instead.
4. templates/script.tmpl
5. The TWiki topic web.topic if the template name can be parsed into web.topic
6. The TWiki topic web.SkinSkinScriptTemplate for each skin on the skin path
7. The TWiki topic web.ScriptTemplate
8. The TWiki topic TWiki.SkinSkinScriptTemplate for each skin on the skin path
9. The TWiki topic TWiki.ScriptTemplate

Legend:

• script refers to the script name, e.g view, edit
• Script refers to the same, but with the first character capitalized, e.g View
• skin refers to a skin name, e.g dragon, pattern. All skins are checked at each stage, in the order they appear in the skin path.
• Skin refers to the same, but with the first character capitalized, e.g Dragon
• web refers to the current web

For example, the example template file will be searched for in the following places, when the current web is Thisweb and the skin path is print,pattern:

1. templates/Thisweb/example.print.tmpl deprecated; don't rely on it
2. templates/Thisweb/example.pattern.tmpl deprecated; don't rely on it
3. templates/example.print.tmpl
4. templates/example.pattern.tmpl
5. templates/Thisweb/example.tmpl deprecated; don't rely on it
6. templates/example.tmpl
7. Thisweb.PrintSkinExampleTemplate
8. Thisweb.PatternSkinExampleTemplate
9. Thisweb.ExampleTemplate
10. TWiki.PrintSkinExampleTemplate
11. TWiki.PatternSkinExampleTemplate
12. TWiki.ExampleTemplate

Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the view and edit scripts, for example when a topic-specific template is required. Two preference variables can be user to override the templates used:

• VIEW_TEMPLATE sets the template to be used for viewing a topic
• EDIT_TEMPLATE sets the template for editing a topic.

If these preferences are set locally (using Local instead of Set) for a topic, in WebPreferences, in %LOCALSITEPREFS?, or [TWiki.TWikiPreferences]] (using Set), the indicated templates will be chosen for view and edit respectively. The template search order is as specified above.

Master Templates

Master templates use the block definition directives (%TMPL:DEF and %TMPL:END%) to define common sections that appear in two or more other templates. twiki.tmpl is the default master template.

Template variable:	Defines:
%TMPL:DEF{"sep"}%	"|" separator
%TMPL:DEF{"htmldoctype"}%	Start of all HTML pages
%TMPL:DEF{"standardheader"}%	Standard header (ex: view, index, search)
%TMPL:DEF{"simpleheader"}%	Simple header with reduced links (ex: edit, attach, oops)
%TMPL:DEF{"standardfooter"}%	Footer, excluding revision and copyright parts
%TMPL:DEF{"oops"}%	Skeleton of oops dialog

HTML Page Templates

HTML page templates are files of HTML mixed with template directives that tell TWiki how to build up an HTML page. As described above, the template system supports the use of 'include' directives that let you re-use the same sections of HTML - such as headers and footers - in several different places.

TWiki uses HTML page templates when composing the output from all actions, like topic view, edit, and preview. This allows you to change the look and feel of all pages by editing just a few template files.

HTML page templates are also used in the definition of TWikiSkins.

Template Topics

Template topics define the default text for new topics. There are three types of template topic:

Topic Name:	What it is:
WebTopicViewTemplate	Error page shown when you try to view a nonexistent topic
WebTopicNonWikiTemplate	Alert page shown when you try to view a nonexistent topic with a non-WikiName
WebTopicEditTemplate	Default text shown when you create a new topic.

When you create a new topic, TWiki locates a topic to use as a content template according to the following search order:

1. A topic name specified by the templatetopic CGI parameter
   • if no web is specified, the current web is searched first and then the TWiki web
2. WebTopicEditTemplate in the current web
3. WebTopicEditTemplate in the TWiki web

Edit Template Topics and Variable Expansion

The following variables get expanded when a user creates a new topic based on a template topic:

Variable:	Description:
%DATE%	Signature format date. See TWikiVariables#VarDATE
%GMTIME%	Date/time. See TWikiVariables#VarGMTIME
%GMTIME{...}%	Formatted date/time. See TWikiVariables#VarGMTIME2
%NOP%	A no-operation variable that gets removed. Useful to prevent a SEARCH from hitting an edit template topic; also useful to escape a variable like %URLPARAM%NOP%{...}%
%NOP{ ... }%	Text that gets removed when a new topic based on the template is created. See notes below.
%SERVERTIME%	Date/time. See TWikiVariables#VarSERVERTIME
%SERVERTIME{...}%	Formatted date/time. See TWikiVariables#VarSERVERTIME2
%USERNAME%	Login name of user who is instantiating the new topic, e.g. guest
%URLPARAM{"name"}%	Value of a named URL parameter
%WIKINAME%	WikiName of user who is instantiating the new topic, e.g. WikiGuest
%WIKIUSERNAME%	User name of user who is instantiating the new tpoic, e.g. Main.WikiGuest

The NOP tag is used to embed text that you do not want expanded when a new topic based on the template is created. For example, you might want to write in the template:

%NOP{
This template can only be changed by:
   * Set ALLOWTOPICCHANGE = WikiMastersGroup
}%

This will restrict who can edit the template, but will get removed when a topic based on the template is created.

%NOP% (or %NOP{}% can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g. %SERVERTIME%.

Notes:

• %NOP{ ... }% can span multiple lines.
• The scan for the closing }% pattern is "non-greedy", that is, it stops at the first occurence. That means you have to protect variables with parameters located inside %NOP{ ... }%. To do this, insert a %NOP% between } and %. Example: %NOP{ %GMTIME{"$year"}%NOP%% }%.

All other variables are unchanged, e.g. are carried over "as is" into the new topic.

Template Topics in Action

Here is an example for creating new topics based on a specific template topic:

• New example topic:   (date format is YYYYxMMxDD)

The above form asks for a topic name. A hidden input tag named templatetopic specifies ExampleTopicTemplate as the template topic to use. Here is the HTML source of the form:

<form name="new" action="%SCRIPTURLPATH{"edit"}%/%INTURLENCODE{"%WEB%"}%/">
   * New example topic: 
     <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" />
     <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />
     <input type="hidden" name="topicparent" value="%TOPIC%" />
     <input type="hidden" name="onlywikiname" value="on" />
     <input type="hidden" name="onlynewtopic" value="on" />
     <input type="submit" class="twikiSubmit" value="Create" />
     (date format is <nop>YYYYxMMxDD)
</form>

See TWikiScripts for details of the parameters that the edit script understands.

TIP: You can use the %WIKIUSERNAME% and %DATE% variables in your topic templates to include the signature of the person creating a new topic. The variables are expanded into fixed text when a new topic is created. The standard signature is:
-- %WIKIUSERNAME% - %DATE%

Automatically Generated Topicname

If you want to make a TWiki application where you need automatically generated unique topicnames, you can use 10 X's in the edit / save URL, and they will be replaced on topic save with a count value. For example, BugIDXXXXXXXXXX will result in topics named BugID0, BugID1, BugID2 etc.

Example link to create a new topic:
[[%SCRIPTURLPATH{"edit"}%/%WEB%/BugIDXXXXXXXXXX?templatetopic=BugTemplate&topicparent=%TOPIC%&t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]]

Master Templates by Example

Attached is an example of an oops based template oopsbase.tmpl and an example oops dialog oopstest.tmpl based on the base template. %A% NOTE: This isn't the release version, just a quick, simple demo.

Base template oopsbase.tmpl

The first line declares a delimiter variable called "sep", used to separate multiple link items. The variable can be called anywhere by writing %TMPL:P{"sep"}%

%TMPL:DEF{"sep"}% | %TMPL:END% <html> <head> <title> %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%</title> <base href="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%"> <meta name="robots" content="noindex"> </head> <body bgcolor="#FFFFFF"> <table width="100%" border="0" cellpadding="3" cellspacing="0"> <tr> <td bgcolor="%WEBBGCOLOR%" rowspan="2" valign="top" width="1%"> <a href="%WIKIHOMEURL%"> <img src="%PUBURLPATH%/wikiHome.gif" border="0"></a> </td> <td> <b>%WIKITOOLNAME% . %WEB% . </b><font size="+2"> <B>%TOPIC%</b> %TMPL:P{"titleaction"}%</font> </td> </tr> <tr bgcolor="%WEBBGCOLOR%"> <td colspan="2"> %TMPL:P{"webaction"}% </td> </tr> </table> --- ++ %TMPL:P{"heading"}% %TMPL:P{"message"}% <table width="100%" border="0" cellpadding="3" cellspacing="0"> <tr bgcolor="%WEBBGCOLOR%"> <td valign="top"> Topic <b>%TOPIC%</b> . { %TMPL:P{"topicaction"}% } </td> </tr> </table> </body>

Test template oopstest.tmpl

Each oops template basically just defines some variables and includes the base template that does the layout work.

</table >

Sample screen shot of oopstest.tmpl

With URL: .../bin/oops/Sandbox/TestTopic2?template=oopstest&param1=WebHome&param2=WebNotify

%TMPL:DEF{"titleaction"}% (test =titleaction=) %TMPL:END% %TMPL:DEF{"webaction"}% test =webaction= %TMPL:END% %TMPL:DEF{"heading"}% Test heading %TMPL:END% %TMPL:DEF{"message"}% Test =message=. Blah blah blah blah blah blah blah blah blah blah blah... * Some more blah blah blah blah blah blah blah blah blah blah... * Param1: %PARAM1% * Param2: %PARAM2% * Param3: %PARAM3% * Param4: %PARAM4% %TMPL:END% %TMPL:DEF{"topicaction"}% Test =topicaction=: [[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}% [[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END% %TMPL:INCLUDE{"oopsbase"}%

Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory

---

TWiki Skins

Skins overlay regular templates with alternate header/footer layouts; topic text is not affected

Overview

Skins are customized TWikiTemplates files. You can use skins to change the look of a TWiki topic, for example, the layout of the header and footer. Rendered text between header and footer does not change. You can also use skins to define an alternate view, like a view optimized for printing.

Defining Skins

Skin files are located in the twiki/templates directory and are named with the syntax: <scriptname>.<skin>.tmpl. For example, the Printable skin for the view template is view.print.tmpl. Skin files may also be defined in TWiki topics - see TWikiTemplates for details.

Use the existing TWikiTemplates (like view.tmpl) or skin files as a base for your own skin, name it for example view.myskin.tmpl.

Note: Two skin names have reserved meanings; text skin, and skin names starting with rss have hard-coded meanings.

The following template files are referenced in the TWiki core code, and must be defined in the templates directory for a skin to work. Remember that if a skin doesn't define a template, then TWiki will fall back to the default version of the file.

Certain template files are expected to provide certain TMPL:DEFs - these are listed in sub-bullets.

• addform
• attachagain
• attachnew
• attachtables
  • ATTACH:files:footer, ATTACH:files:header, ATTACH:files:row, ATTACH:versions:footer, ATTACH:versions:header, ATTACH:versions:row
• changeform
• changes
• edit
• form
• formtables
  • FORM:display:footer, FORM:display:header, FORM:display:row
• login
  • LOG_IN, LOG_IN_BANNER, LOG_OUT, LOGGED_IN_BANNER, NEW_USER_NOTE, UNRECOGNISED_USER
• mirrorlink
• mirrornote
• moveattachment
• oopsaccessdenied
  • no_such_topic, no_such_web, only_group, topic_access
• oopsattention
  • already_exists, bad_email, bad_ver_code, bad_wikiname, base_web_missing, confirm, created_web, delete_err, illegally_named_upload, invalid_web_color, invalid_web_name, in_a_group, mandatory_field, merge_notice, missing_action, missing_fields, move_err, missing_action, no_form_def, no_users_to_reset, notwikiuser, oversized_upload, password_changed, password_mismatch, problem_adding, remove_user_done, rename_err, rename_not_wikiword, rename_topic_exists, rename_web_err, rename_web_exists, rename_web_prerequisites, reset_bad, reset_ok, save_error, send_mail_error, thanks, topic_exists, unrecognized_action, web_creation_error, web_exists, web_missing, wrong_password, zero_size_upload
• oopsleaseconflict
  • active, old
• oopsmirror
• oopssaveerr
• preview
• rdiff
• registernotify
• registernotifyadmin
• rename
• renameconfirm
• renamedelete
• renameweb
• renamewebconfirm
• renamewebdelete
• searchbookview
• searchformat
• search
• settings
• view

twiki.tmpl is a master template conventionally used by other templates, but not used directly by code.

Variables in Skins

You can use template variables, TWikiVariables, and other predefined variables to compose your skins. Some commonly used variables in skins:

Variable:	Expanded to:
%WEBLOGONAME%	Filename of web logo
%WEBLOGOIMG%	Image URL of web logo
%WEBLOGOURL%	Link of web logo
%WEBLOGOALT%	Alt text of web logo
%WIKILOGOURL%	Link of page logo
%WIKILOGOIMG%	Image URL of page logo
%WIKILOGOALT%	Alt text of page logo
%WEBBGCOLOR%	Web-specific background color, defined in the WebPreferences
%WIKITOOLNAME%	The name of your TWiki site
%SCRIPTURL%	The script URL of TWiki
%SCRIPTURLPATH%	The script URL path
%SCRIPTSUFFIX%	The script suffix, ex: .pl, .cgi
%WEB%	The name of the current web. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%WEB%"}% for proper handling in an internationalized environment
%TOPIC%	The name of the current topic. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%TOPIC%"}% for proper handling in an internationalized environment
%WEBTOPICLIST%	Common links of current web, defined in the WebPreferences. It includes a Go box
%TEXT%	The topic text, e.g. the content that can be edited
%META{"form"}%	TWikiForm, if any
%META{"attachments"}%	FileAttachment table
%META{"parent"}%	The topic parent
%EDITTOPIC%	Edit link
%REVTITLE%	The revision title, if any, ex: (r1.6)
%REVINFO%	Revision info, ex: r1.6 - 24 Dec 2002 - 08:12 GMT - WikiGuest
%WEBCOPYRIGHT%	Copyright notice, defined in the WebPreferences
%BROADCASTMESSAGE%	Broadcast message at the beginning of your view template, can be used to alert users of scheduled downtimes; can be set in TWikiPreferences

The "Go" Box and Navigation Box

The %WEBTOPICLIST% includes a "Go" box, also called "Jump" box, to jump to a topic. The box also understands URLs, e.g. you can type http://www.google.com/ to jump to an external web site. The feature is handy if you build a skin that has a select box of frequently used links, like Intranet home, employee database, sales database and such. A little JavaScript gets into action on the onSelect method of the select tag to fill the selected URL into the "Go" box field, then submits the form.

Here is an example form that has a select box and the "Go" box for illustration purposes. You need to have JavaScript enabled for this to work:

Navigate... Intranet home Employee index Main web TWiki web Google Yahoo! Bare bones header for demo only

Welcome  |  Register  |  Changes  |  Topics  |  Index  |  Search  |  Go

Using Cascading Style Sheets

CSS is used by PatternSkin?, the default TWiki skin. See that skin topic for information how CSS is used.

CSS files are gererally attachments to the skin topic that are included in the the skin templates - in the case of PatternSkin? in the template css.pattern.tmpl.

Write in your main template:

<style type='text/css' media='all'>@import url('%PUBURLPATH%/%TWIKIWEB%/MySkin/mystyle.css');</style>

Attachment Tables

Controlling the look and feel of attachment tables is a little bit more complex than for the rest of a skin. By default, the attachment table is a standard TWiki table, and the look is controlled in the same way as other tables. In a very few cases you may want to change the content of the table as well.

The format of standard attachment tables is defined through the use of special TWiki template macros which by default, are defined in the templates/twiki.tmpl template using the %TMPL:DEF macro syntax described in TWikiTemplates. These macros are:

Macro	Description
ATTACH:files:header	Standard title bar
ATTACH:files:row	Standard row
ATTACH:files:footer	Footer for all screens
ATTACH:files:header:A	Title bar for upload screens, with attributes column
ATTACH:files:row:A	Row for upload screen
ATTACH:files:footer:A	Footer for all screens

The format of tables of file versions in the Upload screen are also formattable, using the macros:

Macro	Description
ATTACH:versions:header	Header for versions table on upload screen
ATTACH:versions:row	Row format for versions table on upload screen
ATTACH:versions:footer	Footer for versions table on upload screen

The ATTACH:row macros are expanded for each file in the attachment table, using the following special tags:

Tag	Description
%A_URL%	URL that will recover the file
%A_REV%	Revision of this file
%A_ICON%	A file icon suitable for representing the attachment content
%A_FILE%	The name of the file
%A_SIZE%	The size of the file
%A_DATE%	The date the file was uploaded
%A_USER%	The user who uploaded it
%A_COMMENT%	The comment they put in when uploading it
%A_ATTRS%	The attributes of the file as seen on the upload screen e.g "h" for a hidden file

Note: it is easy to change the look and feel for an entire site by editing the twiki.tmpl template file. However, to simplify upgrading, you should avoid doing this. Instead, write a skin-specific template file e.g. attach.myskin.tmpl and use %TMPL:INCLUDE{attach.myskin.tmpl}% to include it in each of your skin files. As long as it is included after twiki.tmpl, your macro definitions will override the defaults defined there.

Packaging and Publishing Skins

See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQ

Browsing Installed Skins

You can try out all installed skins in the TWikiSkinBrowser.

Activating Skins

TWiki uses a skin search path, which lets you combine skins additively. The skin path is defined using a combination of TWikiVariables and URL parameters.

TWiki works by asking for a template for a particular function - for example, 'view'. The detail of how templates are searched for is described in TWikiTemplates, but in summary, the templates directory is searched for a file called view.skin.tmpl, where skin is the name of the skin e.g. pattern. If no template is found, then the fallback is to use view.tmpl. Each skin on the path is searched for in turn. For example, if you have set the skin path to local,pattern then view.local.tmpl will be searched for first, then view.pattern.tmpl and finally view.tmpl.

The basic skin is defined by a SKIN setting:

• Set SKIN = catskin, bearskin

You can also add a parameter to the URL, such as ?skin=catskin, bearskin. Example activation of PrintSkin that generates a printable page:

• http://wiki.softwarelivre.org/TWikiPtbr/TWikiSkins?skin=print

Setting SKIN (or the ?skin parameter in the URL) replaces the existing skin path setting. You can also extend the existing skin path as well, using covers.

• Set COVER = ruskin

This pushes a different skin to the front of the skin search path (so for our example above, that final skin path will be ruskin, catskin, bearskin). There is also an equivalent cover URL parameter.

The full skin path is built up as follows: SKIN setting (or ?skin if it is set), then COVER setting is added, then ?cover.

Hard-Coded Skins

The text skin is reserved for TWiki internal use.

Skin names starting with rss also have a special meaning; if one or more of the skins in the skin path starts with 'rss' then 8-bit characters will be encoded as XML entities in the output, and the content-type header will be forced to text/xml.

Related Topics: AdminDocumentationCategory, DeveloperDocumentationCategory

---

TWiki Formatted Search Results

Inline search feature allows flexible formatting of search result

The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. Use the format="..." parameter to customize the search result. The format parameter typically defines a bullet or a table row containing variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%.

Syntax

Two parameters can be used to specify a customized search result:

1. header="..." parameter

Use the header parameter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional.
Example: header="| *Topic:* | *Summary:* |"

2. format="..." parameter

Use the format parameter to specify the format of one search hit.
Example: format="| $topic | $summary |"

Variables that can be used in the format string:

Name:	Expands To:
$web	Name of the web
$topic	Topic name
$topic(20)	Topic name, "- " hyphenated each 20 characters
$topic(30, -<br />)	Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...)	Topic name, shortended to 40 characters with "..." indication
$parent	Name of parent topic; empty if not set
$parent(20)	Name of parent topic, same hyphenation/shortening like $topic()
$text	Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.
$locked	LOCKED flag (if any)
$date	Time stamp of last topic update, e.g. 21 Nov 2009 - 11:33
$isodate	Time stamp of last topic update, e.g. 2009-11-21T11:33Z
$rev	Number of last topic revision, e.g. 4
$username	Login name of last topic update, e.g. jsmith
$wikiname	Wiki user name of last topic update, e.g. JohnSmith
$wikiusername	Wiki user name of last topic update, like Main.JohnSmith
$createdate	Time stamp of topic revision 1
$createusername	Login name of topic revision 1, e.g. jsmith
$createwikiname	Wiki user name of topic revision 1, e.g. JohnSmith
$createwikiusername	Wiki user name of topic revision 1, e.g. Main.JohnSmith
$summary	Topic summary, just the plain text, all formatting and line breaks removed; up to 162 characters
$summary(50)	Topic summary, up to 50 characters shown
$summary(showvarnames)	Topic summary, with %ALLTWIKI{...}% variables shown as ALLTWIKI{...}
$summary(noheader)	Topic summary, with leading ---+ headers removed Note: The tokens can be combined, for example $summary(100, showvarnames, noheader)
$changes	Summary of changes between latest rev and previous rev
$changes(n)	Summary of changes between latest rev and rev n
$formname	The name of the form attached to the topic; empty if none
$formfield(name)	The field value of a form field; for example, $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$formfield(name, 10)	Form field value, "- " hyphenated each 10 characters
$formfield(name, 20, -<br />)	Form field value, hyphenated each 20 characters with separator "-<br />"
$formfield(name, 30, ...)	Form field value, shortended to 30 characters with "..." indication
$pattern(reg-exp)	A regular expression pattern to extract some text from a topic (does not search meta data; use $formfield instead). In case of a multiple="on" search, the pattern is applied to the line found in each search hit. • Specify a RegularExpression that covers the whole text (topic or line), which typically starts with .*, and must end in .* • Put text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*) • Example: $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ... • This example has non-greedy .*? patterns to scan for the first occurance of the Email bullet; use greedy .* patterns to scan for the last occurance • Limitation: Do not use .*) inside the pattern, e.g. $pattern(.*foo(.*)bar.*) does not work, but $pattern(.*foo(.*?)bar.*) does • Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag
$count(reg-exp)	Count of number of times a regular expression pattern appears in the text of a topic (does not search meta data). Follows guidelines for use and limitations outlined above under $pattern(reg-exp). Example: $count(.*?(---[+][+][+][+]) .*) counts the number of <H4> headers in a page.
$n or $n()	New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$nop or $nop()	Is a "no operation". This variable gets removed; useful for nested search
$quot	Double quote ("). Alternatively write \" to escape it
$percnt	Percent sign (%)
$dollar	Dollar sign ($)

Examples

Bullet list showing topic name and summary

Write this:

%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header="   * *Topic: Summary:*" format="   * [[$topic]]: $summary" }%

To get this:

• Topic: Summary:
• TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...
• TWikiFAQ: Frequently Asked Questions About nop Wiki SL This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit ...
• TWikiFaqTemplate: FAQ: Answer: Back to: TWikiFAQ

Table showing form field values of topics with a form

In a web where there is a form that contains a TopicClassification field, an OperatingSystem field and an OsVersion field we could write:

| *Topic:* | *OperatingSystem:* | *OsVersion:* |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%

To get this:

Topic:	OperatingSystem:	OsVersion:
IncorrectDllVersionW32PTH10DLL	OsWin	95/98
WinDoze95Crash	OsWin	95

Extract some text from a topic using regular expression

Write this:

%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%

To get this:

TWiki FAQs:

• How can I create a simple TWiki Form based application? Answer...
• How do I delete or rename a file attachment? Answer...
• How do I delete or rename a topic? Answer...
• Why does the topic revision not increase when I edit a topic? Answer...
• TWiki has a GPL (GNU General Public License). What is GPL? Answer...
• I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
• What happens if two of us try to edit the same topic simultaneously? Answer...
• I would like to install TWiki on my server. Can I get the source? Answer...
• So what is this WikiWiki thing exactly? Answer...
• Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...

Nested Search

Search can be nested. For example, search for some topics, then form a new search for each topic found in the first search. The idea is to build the nested search string using a formatted search in the first search.

Here is an example. Let's search for all topics that contain the word "culture" (first search), and let's find out where each topic found is linked from (second search).

• First search:
  • %SEARCH{ "culture" format="   * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%
• Second search. For each hit we want this search:
  • %SEARCH{ "(topic found in first search)" format="$topic" nosearch="on" nototal="on" separator=", " }%
• Now let's nest the two. We need to escape the second search, e.g. the first search will build a valid second search string. Note that we escape the second search so that it does not get evaluated prematurely by the first search:
  • Use $percnt to escape the leading percent of the second search
  • Use \" to escape the double quotes
  • Use $dollar to escape the $ of $topic
  • Use $nop to escape the }% sequence

Write this:

%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%

To get this:

• ATasteOfTWiki is referenced by:
  • ATasteOfTWiki, ATasteOfTWikiTemplate, NewUserTemplate, TWikiUsersGuide, WebLeftBar, WebStatistics, WelcomeGuest
• FormattedSearch is referenced by:
  • DakarReleaseNotes, EmptyPlugin, ManagingWebs, SearchHelp, SearchPatternCookbook, TextFormattingRules, TWikiDocumentation, TWikiForms, TWikiHistory, TWikiReferenceManual, TWikiScripts, TWikiSiteTools, TWikiUpgradeTo01Dec2001, TWikiUpgradeTo01Feb2003, TWikiVariablesAtoM, TWikiVariablesNtoZ, WebLeftBar, WebStatistics, WelcomeGuest
• TWikiAccessControl is referenced by:
  • FileAttachment, MainFeatures, ManagingTopics, ManagingUsers, SitePermissions, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiHistory, TWikiPreferences, TWikiReferenceManual, TWikiScripts, TWikiSiteTools, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, TWikiUpgradeTo01Dec2001, TWikiUserAuthentication, TWikiVariables, WebPreferences, WebPreferencesHelp, WelcomeGuest, WikiCulture, WikiWord
• TWikiSite is referenced by:
  • AdminToolsCategory, InstantEnhancements, ManagingWebs, StartingPoints, TWikiDocumentation, TWikiGlossary, TWikiInstallationGuide, TWikiPreferences, TWikiReferenceManual, TWikiRegistration, TWikiSite, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, TWikiUsersGuide, WabiSabi, WebLeftBar, WebSiteTools, WebStatistics, WelcomeGuest, WhatIsWikiWiki, WikiCulture, WikiReferences
• WabiSabi is referenced by:
  • TWikiSite, WabiSabi, WebStatistics, WhatIsWikiWiki, WikiCulture
• WelcomeGuest is referenced by:
  • ATasteOfTWiki, NewUserTemplate, StartingPoints, TWikiSite, TWikiUpgradeTo01Dec2000, TWikiUsersGuide, WebPreferences, WebStatistics, WhatIsWikiWiki, WikiCulture, YouAreHere
• WhatIsWikiWiki is referenced by:
  • DakarReleaseNotes, WebStatistics, WikiCulture
• WikiCulture is referenced by:
  • TWikiAccessControl, TWikiSite, WabiSabi, WelcomeGuest, WhatIsWikiWiki

Note: Nested search can be slow, especially if you nest more then 3 times. Nesting is limited to 16 levels. For each new nesting level you need to "escape the escapes", e.g. write $dollarpercntSEARCH{ for level three, $dollardollarpercntSEARCH{ for level four, etc.

Most recently changed pages

Write this:

%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="| [[$topic]] | $wikiusername  | $date |" limit="7" }%

To get this:

WebStatistics	WikiGuest	21 Nov 2009 - 00:22
WebHome	ItaloValcy	30 Jul 2009 - 20:27
WebTopicViewTemplate	ViniciusMassuchetto	02 Dec 2008 - 18:34
WebTopicNonWikiTemplate	ViniciusMassuchetto	02 Dec 2008 - 18:34
WelcomeGuest	ViniciusMassuchetto	02 Dec 2008 - 18:31
WebNotify	TWikiContributor	27 Mar 2005 - 13:14
YouAreHere	TWikiContributor	27 Mar 2005 - 13:14

Search with conditional output

A regular expression search is flexible, but there are limitations. For example, you cannot show all topics that are up to exactly one week old, or create a report that shows all records with invalid form fields or fields within a certain range, etc. You need some additional logic to format output based on a condition:

1. Specify a search which returns more hits then you need
2. For each search hit apply a spreadsheet formula to determine if the hit is needed
3. If needed, format and output the result
4. Else supress the search hit

This requires the TWiki:Plugins.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old.

Write this:

%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%
%SEARCH{ "." scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="$percntCALC{$IF($TIME($date) < $GET(weekold), <nop>, | [[$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }%

• The first line sets the weekold variable to the serialized date of exactly one week ago
• The SEARCH has a deferred CALC. The $percnt makes sure that the CALC gets executed once for each search hit
• The CALC compares the date of the topic with the weekold date
• If topic is older, a <nop> is returned, which gets removed at the end of the TWiki rendering process
• Otherwise, the search hit is formatted and returned

To get this:

WebStatistics

WikiGuest

21 Nov 2009 - 00:22

203

Embedding search forms to return a formatted result

Use an HTML form and an embedded formatted search on the same topic. You can link them together with an %URLPARAM{"..."}% variable. Example:

Write this:

<form action="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%">
Find Topics: 
<input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />&nbsp;<input type="submit" class="twikiSubmit" value="Search" />
</form>
Result:
%SEARCH{ search="%URLPARAM{"q"}%" format="   * $web.$topic: %BR% $summary" nosearch="on" }%

To get this:

Find Topics:  

Result:

Related Topics: UserDocumentationCategory

---

TWiki Meta Data

Additional topic data, program-generated or from TWikiForms, is stored in META variable name/value pairs

Overview

TWikiMetaData uses META variables to store topic data that's separate from the main free-form content. This includes program-generated info like FileAttachment and topic movement data, and user-defined TWikiForms info. Use META variables to format and display Meta Data.

Meta Data Syntax

• Format is the same as in TWikiVariables, except all fields have a key.
  • %META:<type>{key1="value1" key2="value2" ...}%

• Order of fields within the meta variables is not defined, except that if there is a field with key name, this appears first for easier searching (note the order of the variables themselves is defined).

• Each meta variable is on one line.

• \n (new line) is represented in values by %_N_ and " (double-quotes) by %_Q_%.

Example of Format

%META:TOPICINFO{version="1.6" date="976762663" author="LastEditorWikiName" format="1.0"}%
   text of the topic
%META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName"
   by="TopicMoverWikiName" date="976762680"}%
%META:TOPICPARENT{name="NavigationByTopicContext"}%
%META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }%
%META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }%
%META:FORM{name="WebFormTemplate"}%
%META:FIELD{name="OperatingSystem" value="OsWin"}%
%META:FIELD{name="TopicClassification" value="PublicFAQ"}%

Meta Data Specifications

The current version of Meta Data is 1.0, with support for the following variables.

META:TOPICINFO

Key	Comment
version	Same as RCS version
date	integer, unix time, seconds since start 1970
author	last to change topic, is the REMOTE_USER
format	Format of this topic, will be used for automatic format conversion

META:TOPICMOVED

This is optional, exists if topic has ever been moved. If a topic is moved more than once, only the most recent META:TOPICMOVED meta variable exists in the topic, older ones are to be found in the rcs history.

%META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"}%

Key	Comment
from	Full name, i.e., web.topic
to	Full name, i.e., web.topic
by	Who did it, is the REMOTE_USER, not WikiName
date	integer, unix time, seconds since start 1970

Notes:

• at present version number is not supported directly, it can be inferred from the RCS history.
• there is only one META:TOPICMOVED in a topic, older move information can be found in the RCS history.

META:TOPICPARENT

Key	Comment
name	The topic from which this was created, WebHome if done from Go, othewise topic where ? or form used. Normally just topic, but is full web.topic format if parent is in a different Web. Renaming a Web will then only break a few of these references or they can be scanned and fixed.

META:FILEATTACHMENT

Key	Comment
name	Name of file, no path. Must be unique within topic
version	Same as RCS revision
path	Full path file was loaded from
size	In bytes
date	integer, unix time, seconds since start 1970
user	the REMOTE_USER, not WikiName
comment	As supplied when file uploaded
attr	h if hidden, optional

Extra fields that are added if an attachment is moved:

Key