|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TWiki Reference Manual (TWiki-5.0.0, Wed, 23 Jan 2008, build 16283)This page contains all documentation topics as one long, complete reference sheet.On this page:
Related Topics: TWikiSite, TWikiHistory, TWikiPlannedFeatures, TWikiEnhancementRequests, UserDocumentationCategory, AdminDocumentationCategory
TWiki System RequirementsServer 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 RequirementsTWiki 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.
Required CPAN ModulesThe following Perl modules are used by TWiki:
Optional CPAN ModulesThe following Perl modules may be used by TWiki:
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 RequirementsThe TWiki standard installation has relatively low browser requirements:
Important note about TWiki Plugins
TWiki Installation GuideThe following is installation instructions for the TWiki 4.2 production release on an Apache web server on Linux. Visit TWiki:TWiki.InstallingTWiki for the latest updates to this guide and supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites. If you are upgrading from a previous version of TWiki, you probably want to readTWikiUpgradeGuide instead.
Both this document and the TWikiUpgradeGuide are also available in the root of the distribution as HTML files. For this reason links to pages inside your own TWiki are written like TWiki.WebHome and not like live web links.
Preparing to install TWikiBefore attempting to install TWiki, you are encouraged to review the TWiki:TWiki.AdminSkillsAssumptions. This guide assumes the person installing TWiki has, at a minimum, basic knowledge of server administration on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership and installing missing perl CPAN libraries). To help setup a correct Apache configuration, you are very much encouraged to use the automatic tool TWiki:TWiki.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs. While this installation guide specifically describes installation on an Apache web server on Linux, TWiki should be fine with any web server and OS that meet the system requirements (see below). For additional notes on installing TWiki on other systems, see TWiki:TWiki.InstallingTWiki#OtherPlatforms. If you are installing TWiki without Unix/Linux root (administrator) priviledges (for example, on a hosted domain), see "Notes on Installing TWiki on Non-Root Account" below for supplemental instructions to the basic steps presented below. If you are upgrading from an earlier major version of TWiki such as Cairo (TWiki 3) you will need the information found in TWiki:TWiki.TWikiUpgradeGuide. There is also a static HTMLTWikiUpgradeGuide.html included in the root of your TWiki distribution.
Upgrading from a recent TWiki4 release is much simpler. Upgraders from earlier TWiki4 versions can follow the steps described in TWiki:TWiki.UpgradingTWiki04x00PatchReleases to ensure a safe upgrade without accidently overwriting customizations.
One of the more difficult tasks is installation of addition CPAN libraries. See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries.
If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)
Basic Installation
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
Important Server Security SettingsBefore you continue any further there are some basic and very important security settings you have to make sure are set correctly.
twiki_httpd_conf.txt and example htaccess.txt files include the needed settings that protect against all 3 security elements.
Next StepsOnce you have TWiki installed and running, you might consider the following optional steps for setting up and customizing your TWiki site. Many of the references below refer to topics within your TWiki installation. For example,TWiki.TWikiSkins refers to the TWikiSkins topic in your TWiki web. Easy way to jump directly to view the pages is to open your own TWiki in your browser and write TWiki.TWikiSkins in the Jump test box to the right in the top bar and hit Enter. You can find these topics in the on-line reference copy at the official TWiki website: TWiki Release 4.2
Enable Authentication of UsersThis step provides for site access control and user activity tracking on your TWiki site. This is particularly important for sites that are publicly accessible on the web. This guide describes only the most common of several possible authentication setups for TWiki and is suitable for public web sites. For information about other setups, seeTWiki.TWikiUserAuthentication, and TWiki:TWiki.TWikiUserAuthenticationSupplement.
These are the steps for enabling "Template Login" which asks for a username and password in a web page, and processes them using the Apache 'htpasswd' password manager. Users can log in and log out.
TWiki.TWikiUserAuthentication, TWiki:TWiki.TWikiUserAuthenticationSupplement, and TWiki:TWiki.SecuringTWikiSite for further information about managing users and security of your TWiki site.
Note! The other LoginManager option TWiki::Client::ApacheLogin uses a basic Apache type authentication where the browser itself prompts you for username and password. Most will find the TemplateLogin looking nicer. But ApacheLogin is required when you use Apache authentication methods like mod_ldap where all authentication is handled by an Apache module and not by the TWiki perl code. When you use ApacheLogin the apache configuration must be set up to require authentication of the some but not all the scripts in the bin directory. This section in the Apache config (or .htaccess) controls this
<FilesMatch "(attach|edit|manage|rename|save|upload|mail|logon|rest|.*auth).*"> require valid-user </FilesMatch>The TWiki:TWiki.ApacheConfigGenerator includes this section when you choose ApacheLogin. In the example twiki_httpd_conf.txt and bin/.htaccess.txt files this section is commented out with #. Uncomment the section when you use ApacheLogin. It is important that this section is commented out or removed when you use TemplateLogin.
Define the Administrator User(s)Administrators have read and write access to any topic in TWiki, irrespectively of TWiki access controls. When you install TWiki one of the first things you will want to do is define yourself as an administrator. You become an administrator simply by adding yourself to theTWikiAdminGroup. It is the WikiName and not the login name you add to the group. Editing the Main.TWikiAdminGroup topic requires that you are an administrator. So to add the first administrator you need to login using the internal TWiki admin user login and the password you defined in configure.
Set TWiki PreferencesPreferences for customizing many aspects of TWiki are set simply by editing a special topic with TWiki.
Enable Email NotificationEach TWiki web has an automatic email notification service that sends you an email with links to all of the topics modified since the last alert. To enable this service:
Enable WebStatisticsYou can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. For information on setting up this feature, see theTWiki.TWikiSiteTools topic.
Automate removal of expired sessions and lease filesPer default TWiki cleans out expired session and lease files each time any topic is viewed. This however cost performance. It is an advantage to define a negative value inconfigure for {Sessions}{ExpireAfter} and install let cron run the tools/tick_twiki.pl script. Read The topic TWikiScripts#tick_twiki_pl for details how to do this.
Enable LocalisationTWiki now supports displaying of national (non-ascii) characters and presentation of basic interface elements in different languages. To enable these features, see theLocalisation section of configure. For more information about these features, see TWiki:TWiki.InternationalizationSupplement.
Tailor New Users Home TopicWhen a new users registers on your TWiki, a home topic is created for them based on theTWiki.NewUserTemplate topic (and its TWiki.UserForm). It contains additional resources you can use to:
NewUserTemplate and UserForm to the Main web and tailor the Main web copies. TWiki will look for the NewUserTemplate in the Main web first and if it does not exist it uses the default from the TWiki web. By creating a Main.NewUserTemplate and its Main.UserForm you will not loose your tailorings next time you upgrade TWiki.
If you added or removed fields from the user form you may also need to tailor TWiki.TWikiRegistration.
Install PluginsTWiki: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. For more information on these, seeTWiki.InstalledPlugins.
You activate installed plugin in the Plugins section of configure. In this section you also find a Find More Extensions button which opens an application which can install additional plugins from the TWiki.org website. If you are behind a firewall or your server has no access to the Internet it is also possible to install plugins manually. Manual installation instructions for the plugins can be found in the plugin topics on TWiki.org. Additional documenation on TWiki plugins can be found at TWiki:TWiki.TWikiPluginsSupplement.
Some plugins require that you define their settings in configure. You fill find these under the Extensions section of configure.
Customize Your TWiki!The real power of TWiki lies in it's flexibility to be customized to meet your needs. You can with small means change the looks of the default skin (called PatternSkin) by reading theTWiki.PatternSkinCustomization
At the official TWiki website you can find more resources. A good place to start for exploring what's possible is TWiki:TWiki.TWikiAdminCookBook which offers tips and tricks for customizing your TWiki site. Many of these are appropriate to implement immediately after installing TWiki and before adding content so now's a good time to look at these.
Customization of Special PagesSome pages are meant to be customized after choice of authentication. If you do not use the internal TWiki password manager the topics that contains the features for changing and resetting passwords and changing the email address should be changed to a note describing how to perform these tasks in your organization. The topics are:
WYSIWYG vs Raw EditFrom TWiki release 4.2.0 the WYSIWYG editor has been replaced by a much better and more powerful editor and it was decided that WYSIWYG would be the default edit mode. An Edit Raw link is available for those that have a need or preference for this mode. However you may prefer to have the same user interface as in TWiki 4.1 where Edit was the raw text editor and you had a WYSIWYG button. You can modify the templates that define the buttons by following the description on TWiki:Codev.TWikiRawEditDefault04x02.Copyright, License and Classification StatementsIn the bottom of each topic you will find a default copyright messages saying "Copyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors." It is a setting WEBCOPYRIGHT that defines this. This is often not adequate.
TroubleshootingThe first step is to re-run theconfigure script and make sure you have resolved all errors, and are satisfied that you understand any warnings.
Failing that, please check TWiki:TWiki.InstallingTWiki on TWiki.org, the supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites. For example:
AppendicesTWiki System RequirementsLow client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.Server RequirementsTWiki 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.
Required CPAN ModulesMost of the CPAN libraries listesd below are part of a standard Perl installation so you most likely have them all! See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries The following Perl CPAN modules are used by TWiki:
Optional CPAN ModulesThe following Perl modules may be used by TWiki: See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries
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 RequirementsThe TWiki standard installation has relatively low browser requirements:
TWiki/TWikiSkinBrowser and more at TWiki:Plugins.SkinPackage.
Important note about TWiki Plugins
Notes on Installing TWiki on Non-Root AccountThe following supplemental notes to the Basic Installation instructions apply to installing TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else. Referring to the Basic Installation steps presented above:
Installing Manually Without ConfigureIt is highly recommended to use run configure from the browser when setting up TWiki. Configure does a lot of the hard work for you. But there may be instances where you do not want to use configure or where configure simply won't run because of a missing dependency. The manual steps you have to take are:
TWiki Upgrade GuideThis guide covers upgrading from a previous version of TWiki (such as Cairo or TWiki4.0) to TWiki 4.2OverviewTWiki-4.0.0 was a major new release. TWiki-4.1.0 was a minor release without dramatic changes since 4.0.0. TWiki-4.2.0 is also a minor release containing a few new features that can be seen by the end user, a large number of bug fixes, and a face lift for the skin. It also contains some important updates under the hood to the way users are handled which enables new types of authentication and integration with other systems. The most important new feature is the QuerySearch feature.Upgrade Requirements
Major Changes Compared to TWiki Release 01-Sep-2004 and TWiki Release 4.0.0See TWikiReleaseNotes04x00, TWikiReleaseNotes04x01 and TWikiReleaseNotes04x02Upgrade ProcedureThe 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. The main steps are:
Installation
Install Extensions
Copy your old webs to new TWiki
Copy Users And Their Topics From Main Web
Apply Customizations To The Skin
Apply Preferences From Old Installation
Customization of Special PagesSome pages in the TWiki web are meant to be customized after choice of authentication. If you do not use the internal TWiki password manager the topics that contains the features for changing and resetting passwords and changing the email address should be changed to a note describing how to perform these tasks in your organization. If you have made such customizations remember to replace these topics in the TWiki web with the tailored versions from your old installation. The topics are:
Upgrading from Cairo to TWiki4 (additional advice)FaviconTWiki4's PatternSkin introduces the use of the favicon feature which most browsers use to show a small icon in front of the URL and for bookmarks. In TWiki4 it is assumed that each web has a favicon.ico file attached to the WebPreferences topic. When you upgrade from Cairo to TWiki4 you do not have this file and you will get flooded with errors the error log of your web server. There are two solutions to this.
* Set FAVICON = %PUBURLPATH%/%SYSTEMWEB%/%WEBPREFSTOPIC%/favicon.ico TWikiUsers topic in Main webYour Cairo Main.TWikiUsers topic will work in TWiki4 but you will need to ensure that these 4 users from the default TWiki4 version of TWikiUsers are copied to the existing TWikiUsers topic. TWikiGuest is probably already there but the others are new
Set ALLOWTOPICCHANGE = TWikiAdminGroup, TWikiRegistrationAgent. Otherwise people will not be able to register.
Important Changes since 4.0.5Supported Perl versionTWiki 4.0.5 worked on Perl version 5.6.X. Reports from users has shown that unfortunately TWiki 4.1.0 does not support Perl versions older then 5.8.0. It is the goal that TWiki should work on at least Perl version 5.6.X but none of the developers have had access to Perl installations older than 5.8.0. Since TWiki 4.1.0 has some urgent bugs the development team decided to release TWiki 4.1.1 without resolving the issue with Perl 5.6.X. We will however address this and try and resolve it for a planned 4.1.2 release. The TWiki community is very interested in contributions from users that have fixes for the code which will enable TWiki to run on older versions of Perl. See the WhatVersionsOfPerlAreSupported topic to keep up to date with the discussion how to get back support for earlier Perl versions.Template spec changedUntil TWiki 4.0.5 TWikiTemplates the text inside template definition blocks (anything between %TMPL:DEF{"block"}% and %TMPL:END% was stripped of leading and trailing white space incl new lines. This caused a lot of problems for skin developers when you wanted a newline before or after the block text. From TWiki 4.1.0 this has changed so that white space is no longer stripped. Skins like PatternSkin and NatSkin have been updated so that they work with the new behavior. But if you use an older skin or have written your own you will most likely need to make some adjustments. It is not difficult. The general rule is - if you get mysterious blank lines in your skin, the newline after the %TMPL:DEF{"block"}% needs to be removed. Ie. the content of the block must follow on the same line as the TMPL:DEF. The spec change have the same impact on CommentPlugin templates where you may have to remove the first line break after the TMPL:DEF. See the CommentPluginTemplate for examples of how comment template definitions should look like in TWiki-4.1.X An example: A CommentPlugin template that adds a comment as appending a row to a table. Before the spec change this would work.
<verbatim>
%TMPL:DEF{OUTPUT:tabletest}%%POS:BEFORE%
|%URLPARAM{"comment"}%| -- %WIKIUSERNAME% - %DATE% |
%TMPL:END%
</verbatim>
From Twiki 4.1.0 the old template definition will add an empty line before the new table row. To fix it simply remove the new line before the table.
<verbatim>
%TMPL:DEF{OUTPUT:tabletest}%%POS:BEFORE%|%URLPARAM{"comment"}%| -- %WIKIUSERNAME% - %DATE% |
%TMPL:END%
</verbatim>
The advantage of the spec change is that now you can add leading and trailing white space including new lines. This was not possible before.
Important Changes since 4.1.0New location for session and other temporary filesAn upgrader upgrading to 4.1.1 should note the following important change The directory for passthrough files and session files have been replaced by a common directory for temporary files used by TWiki. Previously the two configure settings{PassthroughDir} and {Sessions}{Dir} were by default set to /tmp. These config settings have been replaced by {TempfileDir} with the default setting value /tmp/twiki. If the twiki directory does not exist twiki will create it first time it needs it.
It is highly recommended no longer to use the tmp directory common to other web applications and the new default will work fine for most. You may want to delete all the old session files in /tmp after the upgrade to 4.1.1. They all start with cgisess_. It is additionally highly recommended to limit write access to the {TempfileDir} for security reasons if you have non-admin users with login access to the webserver just like you would do with the other webserver directories.
Important Changes since 4.1.2New WYSIWYG EditorTWiki now ships with a new WYSIWYG editor based on TinyMCE replaces the Kupu based editor.TinyMCE is not a perfect Wysiwyg editor but it is magnitudes better than the Kupu editor The WysiwygPlugin that drives the engine behind both TinyMCE has additionally been heavily improved so that less TWiki Applications are negatively affected by editing WYSIWYG When TinyMCEPlugin is enabled the Edit button per default becomes WYSIWYG editing mode. A new Raw Edit link has been added to enable application developers to edit the good old way The WYSIWYG button has been removed. NEWTOPICLINKSYMBOL removedThe NEWTOPICLINKSYMBOL preference which was deprecated in 4.1 has now been removed from the code. If you want to control the appearance of new links, you can use NEWLINKFORMAT.UserForm and NewUserTemplate CustomizationWhen a new user registers on TWiki his user topic is created based on theNewUserTemplate and UserForm.
The NewUserTemplate was located in the TWiki web and the UserForm in the Main web. When upgrading TWiki these were some of the topics you had to take care not to overwrite.
From 4.2.0 the UserForm and NewUserTemplate are distributed in the TWiki web. If you create the two in the Main web the Main web version will be used instead. So if you tailor the user topic format or the form then you should always copy the two files to the Main web and modify the ones in the Main web. When you later upgrade TWiki your tailored template and form will not be overwritten.
TWikiUsers no longer distributedTheMain.TWikiUsers topic contains all the registered users. It is a topic you do not want to overwrite when you upgrade TWiki.
From 4.2.0 this file is no longer included in the TWiki distribution. When you register the first time TWiki creates the Main.TWikiUsers topic in the Main web if it does not exist already. This means that you can now upgrade TWiki without risk of overwriting the important TWikiUsers topic.
New
A new directory |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Web | Sitemap | VIEW | CHANGE | RENAME | |||
|---|---|---|---|---|---|---|---|
| Listed | DENY | ALLOW | DENY | ALLOW | DENY | ALLOW | |
  Main |
on | TWikiGuest | |||||
| TWiki |
on | TWikiAdminGroup | TWikiAdminGroup | ||||
| Applications |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.BlogUp |
on | TWikiGuest | BlogAdminGroup | ||||
| Applications.ClassificationApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.DashboardApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.DiscussionApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.EmployeePortalApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.MessageApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Applications.MovieApp |
on | TWikiGuest | TWikiAdminGroup | ||||
| Blog |
on | TWikiGuest | |||||
| Public |
on | PartnersGroup | |||||
- 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.
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 TWikiUsers topic.
Managing Groups
The following describes the standard TWiki support for groups. Your local TWiki may have an alternate group mapping manager installed. Check with your TWiki administrator if you are in doubt. Groups are defined by group topics located in theMain web. To create a new group, visit TWikiGroups and enter the name of the new group ending in Group into the "new group" form field. This will create a new group topic with two important settings: -
Set GROUP = < list of Users and/or Groups > -
Set ALLOWTOPICCHANGE = < list of Users and/or Groups >
-
Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup
-
Set ALLOWTOPICCHANGE = Main.KasabianGroup
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 Super Admin Group
A number of TWiki functions (for example, renaming webs) are only available to administrators. Administrators are simply users who belong to the SuperAdminGroup. This is a standard user group, the name of which is defined by {SuperAdminGroup} setting in configure. The default name of this group is theTWikiAdminGroup. The system administrator may have chosen a different name for this group if your local TWiki uses an alternate group mapping manager but for simplicity we will use the default name TWikiAdminGroup in the rest of this topic.
You can create new administrators simply by adding them to the TWikiAdminGroup topic. For example, -
Set GROUP = Main.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. When you restric VIEW to a topic or web, this also restricts INCLUDE and Formatted SEARCH from showing the content of the topics.
- Restricting CHANGE blocks creating new topics, changing topics or attaching files.
- Restricting RENAME prevents renaming of topics within a web.
Controlling access to a Web
You can define restrictions on who is allowed to view a WikiRing 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 >
-
ALLOWWEBVIEW set, this will also apply to the subweb. Also note that you will need to ensure that the parent web's FINALPREFERENCES does not include the access control settings listed above. Otherwise you will not be able override the parent web's access control settings in sub-webs.
Creation and renaming of sub-webs is controlled by the WEBCHANGE setting on the parent web (or ROOTCHANGE for root webs). Renaming is additionally restricted by the setting of WEBRENAME in the web itself.
Note: If you restrict access to the Main, make sure to add the TWikiRegistrationAgent so that users can register. Example: -
-
Set ALLOWWEBCHANGE = TWikiAdminGroup, TWikiRegistrationAgent
-
Controlling access to a Topic
- You can define these settings in any 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 >
-
-
Set ALLOWTOPICVIEW =
This means the same as not setting it at all. (This was documented wrong in versions 4.0.X, 4.1.0 and 4.1.1)
-
Set DENYTOPICVIEW =
Since TWiki 4.0 this means do not deny anyone the right to view this topic. If DENYTOPICVIEW is set to an empty value anyone has access even if ALLOWTOPICVIEW or ALLOWWEBVIEW is defined. This allows to have very restrictive default access rights to an entire web and still allow individual topics to have more open access.
The setting to an empty has caused confusion and great debate and it has been decided that the empty setting syntax will be replaced by something which is easier to understand in the 4.2 version of TWiki. A method to upgrade will be provided. Please read the release notes carefully when you upgrade.
See "How TWiki evaluates ALLOW/DENY settings" below for more on how ALLOW and DENY interacts.
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 Apachemod_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
RewriteCond %{REQUEST_URI} !^/+twiki/+pub/+TWiki/+.+
RewriteRule ^/+twiki/+pub/+([^/]+)/+((([^/]+)/+)+)(.+) /twiki/bin/viewfile/$1/$4?filename=$5 [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.
Controlling who can manage top-level webs
Top level webs are a special case, because they don't have a parent web with a WebPreferences. So there has to be a special control just for the root level.- You can define these settings in the Main.%TWIKIPREFSTOPIC% topic, preferable towards the end of the topic:
-
Set DENYROOTCHANGE = < comma-delimited list of Users and Groups > -
Set ALLOWROOTCHANGE = < comma-delimited list of Users and Groups >
-
ROOTCHANGE access to rename an existing top-level web. You just need WEBCHANGE in the web itself.
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.- If the user is an administrator
- access is PERMITTED.
- If DENYTOPIC is set to a list of wikinames
- people in the list will be DENIED.
- If DENYTOPIC is set to empty ( i.e. Set DENYTOPIC = )
- access is PERMITTED i.e no-one is denied access to this topic.
Attention: Use this with caution. This is deprecated and will likely change in the next release.
- access is PERMITTED i.e no-one is denied access to this topic.
- If ALLOWTOPIC is set
- people in the list are PERMITTED
- everyone else is DENIED
- If DENYWEB is set to a list of wikinames
- people in the list are DENIED access
- If ALLOWWEB is set to a list of wikinames
- people in the list will be PERMITTED
- everyone else will be DENIED
- 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 theall webs search option from accessing obfuscated webs. Do so by enabling the NOSEARCHALL variable in WebPreferences: -
Set NOSEARCHALL = on
Note: Obfuscating a web without view access control is very insecure, as anyone who knows the URL can access the web.
Restrict Access to Whole TWiki Site
For a firewalled TWiki, e.g. an intranet wiki or extranet wiki, you want to allow only invited people to access your TWiki. In this case, enable user authentication with ApacheLogin and lock down access to the wholetwiki/bin and twiki/pub directories to all but valid users. In the Apache .htaccess file or the appropriate .conf file, replace the <FilesMatch "(attach|edit|... section with this:
<FilesMatch ".*">
require valid-user
</FilesMatch>
If needed, you can further restrict access to selected webs with ALLOWWEBVIEW and other access control settings.
Note: With this configuration, someone with access to the site needs to register new users.
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.- Set
require valid-useron yourviewscript in .htaccess or the appropriate Apache .conf file. As of 4.x, this looks like:FilesMatch "(attach|edit|manage|rename|save|view|upload|mail|logon|.*auth).*"(normallyviewis not in that list). - 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:
DENYWEBVIEWis evaluated beforeALLOWWEBVIEW. Access is denied if the authenticated person is in theDENYWEBVIEWlist, or not in theALLOWWEBVIEWlist. Access is granted ifDENYWEBVIEWandALLOWWEBVIEWare not defined.
-
- If you still want public users to be able to register automatically follow TWiki:TWiki.RegisterOnViewRestrictedSite.
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.- 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:
DENYWEBVIEWis evaluated beforeALLOWWEBVIEW. Access is denied if the authenticated person is in theDENYWEBVIEWlist, or not in theALLOWWEBVIEWlist. Access is granted ifDENYWEBVIEWandALLOWWEBVIEWare not defined.
-
Hide Control Settings
Tip: To hide access control settings from normal browser viewing, you can put them into the topic-local settings. You can access those settings via the "More" screen, as explained in TWikiVariables.
Alternatively, place them in HTML comment markers, but this exposes the access setting during ordinary editing.
Back to top<!--
* 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 |
SushiMaguroNot 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 |
==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 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
|
|
|||||||||||||||||||||||||
|
Numbered List: Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
|
1. Sushi 1. Dim Sum 1. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue |
|
|||||||||||||||||||||||||
|
Definition List: Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. Deprecated syntax: Three spaces, the term with no spaces, a colon, a space, followed by the definition. |
$ 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.
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 | |
|
|||||||||||||||||||||||||
|
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. To link to a topic in a subweb write Otherweb.Subweb.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. Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.
It's generally a good idea to use the TWikiVariables %SYSTEMWEB% and %USERSWEB% instead of TWiki and Main.
|
WebStatistics Sandbox.WebNotify Sandbox.WebHome Sandbox.Subweb.TopicName | WebStatistics WebNotify Sandbox TopicName | |||||||||||||||||||||||||
|
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 of no more than 32 characters. 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 groups]] escaped: ![[wiki syntax]] | wiki syntax Main.TWiki groups 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 e-mail 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 | |||||||||||||||||||||||||
|
Literal content: TWiki generates HTML code from TWiki shorthand. Experts surround anything that must be output literally in the HTML code, without the application of TWiki shorthand rules, with <literal>..</literal> tags. any HTML
within literal tags must be well formed i.e. all tags must be properly closed before
the end of the literal block. TWiki Variables are expanded within literal blocks.
|
<literal> | Not | A | Table | <literal> |
| Not | A | Table | | |||||||||||||||||||||||||
|
Protected content: Experts protect text from mangling by WYSIWYG editors using <sticky>..</sticky> tags. Sticky tags don't have any effect on normal
topic display; they are only relevant when content has to be
protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it
is HTML that WYSIWYG would normally filter out or modify). Protected
content appears as plain text in the WYSIWYG editor.
|
<sticky>
<div> This div is required </div> <sticky>
|
This div is required
|
|||||||||||||||||||||||||
Using HTML
You can use most HTML tags in TWiki topics without a problem. This is useful where you want to add some content that is formatted in a way that is not supported using TWiki shorthand, for example, you can write<strike>deleted text</strike> to get - 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 using the plaintext editor.
- If you must use HTML, use XHTML 1.0 Transitional syntax.
- Use
<literal>..</literal>tags around blocks of HTML to avoid accidental interpretation of TWiki shorthand within the HTML. - Script tags may be filtered out, at the discretion of your TWiki administrator.
- 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 a 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.
Hyperlinks
Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs.Internal Links
- 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://...andmailto:...@...are linked automatically.
- E-mail addresses like
name@domain.comare 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.
- You can also write
TWiki Variables
TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example,%TOPIC% is expanded to TWikiVariablesQuickStart.
Some variables can take arguments in curly braces - for example, %INCLUDE{"OtherTopic" ARG="arg"}%.
Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own
TWiki Variables at the entire site, individual web, or individual topic level. For more information,
go to TWikiVariables
TWiki Variables are fully expanded before any of the TWiki text formatting rules are applied.
Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively. TWikiDocGraphics lists them all.
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%:
- GluePlugin (2.00, $Rev$): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev$): Render content conditionally
- SpreadSheetPlugin (any TWiki, 15269): Add spreadsheet calculation like
"$SUM( $ABOVE() )"to TWiki tables and other topic text - AliasPlugin (2.20, 15573): Define aliases which will be replaced with arbitrary strings automatically
- AutoViewTemplatePlugin (ipo, $Rev$): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
- BlogPlugin (0.99, $Rev$): Basic blogging features used to implement the BlogUp TWikiApplication
- BreadCrumbsPlugin (v2.00, $Rev$): A flexible way to display breadcrumbs navigation
- ClassificationPlugin (0.50, $Rev$): A topic classification plugin and application
- CommentPlugin (TWiki-4, 14241): Allows users to quickly post comments to a page without an edit/preview/save cycle
- DBCachePlugin (1.80, $Rev$): Lightweighted frontend to the DBCacheContrib
- EditChapterPlugin (1.13, $Rev$): An easy sectional edit facility
- EmployeePortalPlugin (v2.0-pre1, $Rev$): EmployeePortal extensions
- FilterPlugin (1.41, $Rev$): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.22, $Rev$): Flexible way to display hierarchical weblists
- HeadlinesPlugin (2.12, 15564): Build news portals that show headline news based on RSS news feeds from news sites.
- ImageGalleryPlugin (3.70, 15576): Displays image gallery with auto-generated thumbnails from attachments
- ImagePlugin (1.1, $Rev$): Control the display and alignment of images using an easy syntax
- InterwikiPlugin (Dakar, $Rev: 14913 (17 Sep 2007) $): Link
ExternalSite:Pagetext to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.50, $Rev$): jQuery JavaScript library for TWiki
- JQueryTwistyPlugin (1.0, $Rev$): Twisty section JavaScript library to open/close content dynamically
- LdapNgPlugin (v2.01, $Rev$): Query and display data from an LDAP directory
- LocalTimePlugin (Dakar, 11113): A plugin to give the current date and time of a particular city/timezone.
- MathModePlugin (2.96, 15934): Include LaTeX formatted math in your TWiki pages
- MediaWikiTablePlugin (v1.00, $Rev$): Format tables the MediaWiki way
- NatSkinPlugin (3.00-pre18, $Rev$): Supplements the bare bones NatSkin theme for TWiki
- PaginationPlugin (0.10, $Rev$): navigate among a double linked list of documents
- PingBackPlugin (v0.05-alpha, $Rev$): Pingback service for TWiki
- RedDotPlugin (1.40, $Rev$): Renders edit-links as little red dots
- SetVariablePlugin (0.10, $Rev$): Conditionally set variables while saving a topic
- SmiliesPlugin (Dakar, 16048): Render smilies as icons, like
for :-)or
for :eek: - TablePlugin (1.032, 16084): Control attributes of tables and sorting of table columns
- TagCloudPlugin (v1.01, $Rev$): Renders a tag cloud given a list of terms
- TimeSincePlugin (1.10, $Rev$):
- UserInfoPlugin (1.53, 10521): Render information about users on your TWikiSite
- VotePlugin (1.33, 14296): Simple way to count votes
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>'.
- A: The
- 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'.
- A: The
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: - Preferences variables: Can be defined and changed by the user
- 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 getTWikiVariables(a predefined variable) - type
%CALC{ "$UPPER(Text)" }%to getTEXT(a variable defined by Plugin)
- 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
Variable Names
Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g.%MYVAR%, %MyVar%, %My2ndVar%, and %My_Var% are all valid variable names. Variables are case sensitive. %MyVAR% and %MYVAR% are not the same variable.
By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.
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:- local site level in TWiki.TWikiPreferences
- plugin topics (see TWikiPlugins)
- local site level in Main.TWikiPreferences
- user level in individual user topics in Main web
- web level in WebPreferences of each web
- topic level in topics in webs
- session variables (if sessions are enabled)
Preview will show the wrong thing, and you must Save the topic to see it correctly.
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: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.
Set VARIABLENAME = value
Set VARIABLENAME = value
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 variableYou can also set preferences variables on a topic by clicking the link
- 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
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 usingLocal 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 = 20Then 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
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%.
ACTIVATEDPLUGINS -- list of currently activated plugins
- Syntax:
%ACTIVATEDPLUGINS% - Expands to: GluePlugin, IfDefinedPlugin, SpreadSheetPlugin, AliasPlugin, AutoViewTemplatePlugin, BlogPlugin, BreadCrumbsPlugin, ClassificationPlugin, CommentPlugin, DBCachePlugin, EditChapterPlugin, EmployeePortalPlugin, FilterPlugin, FlexWebListPlugin, HeadlinesPlugin, ImageGalleryPlugin, ImagePlugin, InterwikiPlugin, JQueryPlugin, JQueryTwistyPlugin, LdapNgPlugin, LocalTimePlugin, MathModePlugin, MediaWikiTablePlugin, NatSkinPlugin, PaginationPlugin, PingBackPlugin, RedDotPlugin, SetVariablePlugin, SmiliesPlugin, TablePlugin, TagCloudPlugin, TimeSincePlugin, UserInfoPlugin, VotePlugin
- Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION
ALLVARIABLES -- list of currently defined TWikiVariables
- Syntax:
%ALLVARIABLES% - Expands to: a table showing all defined TWikiVariables in the current context
AQUA -- start aqua colored text
-
AQUAis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%AQUA% aqua text %ENDCOLOR% - Expands to: aqua text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
ATTACHURL -- full URL for attachments in the current topic
- Syntax:
%ATTACHURL% - Expands to:
http://www.wikiring.com/pub/TWiki/VarATTACHURL - Example: If you attach a file you can refer to it as
%ATTACHURL%/image.gif - Related: ATTACHURLPATH, PUBURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments
ATTACHURLPATH -- path of the attachment URL of the current topic
- Syntax:
%ATTACHURLPATH% - Expands to:
/pub/TWiki/VarATTACHURLPATH - Related: ATTACHURL, PUBURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, 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 TWikiRegistration 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
BB -- bullet with line break
- Line break and bullet without indentation.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BB =
• - Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR
BB2 -- level 2 bullet with line break
- Line break and bullet, level 2.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BB2 =
• - Related: BR, BULLET, BB, BB3, BB4, VBAR
BB3 -- level 3 bullet with line break
- Line break and bullet, level 3.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BB3 =
• - Related: BR, BULLET, BB, BB2, BB4, VBAR
BB4 -- level 4 bullet with line break
- Line break and bullet, level 4.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BB4 =
• - Related: BR, BULLET, BB, BB2, BB3, VBAR
BLACK -- start black colored text
-
BLACKis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%BLACK% black text %ENDCOLOR% - Expands to: black text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
BLUE -- start blue colored text
-
BLUEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%BLUE% blue text %ENDCOLOR% - Expands to: blue text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
BR -- line break
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BR =
- Related: BULLET, BB, BB2, BB3, BB4, CARET, VBAR
BROWN -- start brown colored text
-
BROWNis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%BROWN% brown text %ENDCOLOR% - Expands to: brown text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
BULLET -- bullet character
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: BULLET = •
- Related: BR, BB, BB2, BB3, BB4, CARET, VBAR
CARET -- caret symbol
- The caret variable can be used in TWiki tables.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: CARET = ^
- Related: BR, BULLET, BB, BB2, BB3, BB4, VBAR
COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.
- A
%COMMENT%without parameters shows a simple text box. - The following standard attributes are recognized
Name Description Default typeThis is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see Customisation, below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. belowdefaultDefault text to put into the textarea of the prompt. targetName of the topic to add the comment to the current topic locationRegular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation! modeFor compatibility with older versions only, synonymous with typenonotifySet to "on" to disable change notification for target topics offnoformSet to "on" to disable the automatic form that encloses your comment block - remember to insert <form>tags yourself! See CommentPluginExamples#noform for an example.offnopostSet to "on" to disable insertion of the posted text into the topic. offremoveSet to "on" to remove the comment prompt after the first time it is clicked. offbuttonButton label text Add comment
- See CommentPlugin for more information
DATE -- signature format date
- Syntax:
%DATE% - Expands to:
21 May 2012 - Date format defined as {DefaultDateFormat} in configure
- 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 May 2012 - 18:50 - Date format defined as {DefaultDateFormat} in configure
- 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 to18:50 - Related: DISPLAYTIME, GMTIME, SERVERTIME
EDITTABLE{ attributes } -- edit TWiki tables using edit fields and other input fields
- The
%EDITTABLE{}%variable is handled by the EditTablePlugin - Syntax:
%EDITTABLE{ attributes }%
- Supported attributes:
Attribute Comment Default headerSpecify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button(no header) formatThe format of one column when editing the table. A cell can be a text input field, or any of these edit field types:
• Text input field (1 line):
| text, <size>, <initial value> |
• Textarea input field:
| textarea, <rows>x<columns>, <initial value> |
• Drop down box:
| select, <size>, <option 1>, <option 2>, etc* |
*only one item can be selected
• Radio buttons:
| radio, <size*>, <option 1>, <option 2>, etc |
*size indicates the number of buttons per line in edit mode
• Checkboxes:
| checkbox, <size*>, <option 1>, <option 2>, etc |
*size indicates the number of checkboxes per line in edit mode
• Fixed label:
| label, 0, <label text> |
• Row number:
| row, <offset> |
• Date:
| date, <size>, <initial value>, <DHTML date format> |(see Date Field Type)"text, 16"
for all cellschangerowsRows can be added and removed if "on"
Rows can be added but not removed if"add"
Rows cannot be added or removed if"off"CHANGEROWS
Plugin settingquietsaveQuiet Save button is shown if "on", hidden if"off"QUIETSAVE
Plugin settingincludeOther topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. (none) helptopicTopic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown. (no help text) headerislabelTable header cells are read-only (labels) if "on"; header cells can be edited if"off"or "0""on"editbuttonSet edit button text, e.g. "Edit this table"; set button image with alt text, e.g."Edit table, %PUBURL%/%TWIKIWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with"hide"(Note: Button is automatically hidden if an edit button is present in a cell)EDITBUTTON
Plugin setting
- Example:
%EDITTABLE{ format="| text, 20 | select, 1, one, two, three |" changerows="on" }%
| *Name* | *Type* |
| Foo | two | - Related: See EditTablePlugin for more details
ENCODE{"string"} -- encodes a string to HTML entities
- Encode "special" characters to HTML numeric entities. Encoded characters are:
- all non-printable ASCII characters below space, except newline (
"\n") and linefeed ("\r") - HTML special characters
"<",">","&", single quote (') and double quote (") - TWiki special characters
"%","[","]","@","_","*","="and"|"
- all non-printable ASCII characters below space, except newline (
- 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 ". Does not encode\nor\r.type="url"type="html"As type="entity"except it also encodes\nand\rtype="url"type="quotes"Escape double quotes with backslashes ( \"), does not change other characterstype="url"type="url"Encode special characters for URL parameter use, like a double quote into %22(this is the default) - Example:
%ENCODE{"spaced name"}%expands tospaced%20name - Note: Values of HTML input fields must be entity encoded.
Example:<input type="text" name="address" value="%ENCODE{ "any text" type="entity" }%" /> - Note: Double quotes in strings must be escaped when passed into other TWiki variables.
Example:%SEARCH{ "%ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%
- Related: URLPARAM
ENDCOLOR -- end colored text
-
ENDCOLORis a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%RED% red text %ENDCOLOR% - Expands to: red text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: VarAQUA, VarBLACK, VarBLUE, VarBROWN, VarGRAY, VarGREEN, VarLIME, VarMAROON, VarNAVY, VarOLIVE, VarORANGE, VarPINK, VarPURPLE, VarRED, VarSILVER, VarTEAL, VarWHITE, VarYELLOW, TWikiPreferences, StandardColors
ENDSECTION{"name"} -- marks the end of a named section within a topic
- Syntax:
%ENDSECTION{"name"}% - Syntax:
%ENDSECTION{type="include"}% - Supported parameter:
Parameter: Description: "name"Name of the section. type="..."Type of the section being terminated; supported types "section","include","templateonly". - If the
STARTSECTIONis named, the correspondingENDSECTIONmust also be named with the same name. If theSTARTSECTIONspecifies a type, then the correspondingENDSECTIONmust also specify the same type. If the section is unnamed,ENDSECTIONwill match with the nearest unnamed%STARTSECTION%of the same type above it. - Related: STARTSECTION
ENV{"varname"} -- inspect the value of an environment variable
- Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is the environment that the TWiki scripts run in on the web server.
- Note: For security reasons, only those variables whose names match the regular expression in
{AccessibleENV}in the Security Settings/Miscellaneous section ofconfigurecan be displayed. Any other variable will just be shown as an empty string, irrespective of its real value. - Example:
%ENV{MOD_PERL}%displays as: not set - If a variable is undefined (as against being set to the empty string) it will be returned as
not set. - Related: HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER
FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list
- Syntax:
%FAILEDPLUGINS% - Expands to: See TWikiPlugins#FAILEDPLUGINS
- Related: PLUGINDESCRIPTIONS, ACTIVATEDPLUGINS, PLUGINVERSION
FORMFIELD{"fieldname"} -- 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.TopicNameCurrent topic format="..."Format string. $valueexpands to the field value, and$titleexpands to the fieldname (also expands $name, $attributes, $type, $size and $definingTopic)"$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 May 2012 - 16:50 - Date format defined as {DefaultDateFormat} in configure
- 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 $secondsseconds 59 $minutesminutes 59 $hourshours 23 $dayday of month 31 $wdayday of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) Thu $dowday of the week (Sun = 0) 2 $weeknumber of week in year (ISO 8601) 34 $monthshort name of month Dec $mo2 digit month 12 $year4 digit year 1999 $ye2 digit year 99 $tzeither "GMT" (if set to gmtime), or "Local" (if set to servertime) GMT $isoISO format timestamp 2012-05-21T16:50:25Z $rcsRCS format timestamp 2012/05/21 16:50:25 $httpE-mail & http format timestamp Mon, 21 May 2012 16:50:25 GMT $epochNumber of seconds since 00:00 on 1st January, 1970 1337619025 - Variables can be shortened to 3 characters
- Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}%expands to21 May, 2012 - 16:50:25 - 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, REVINFO, SERVERTIME
GRAY -- start gray colored text
-
GRAYis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%GRAY% gray text %ENDCOLOR% - Expands to: gray text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
GREEN -- start green colored text
-
GREENis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%GREEN% green text %ENDCOLOR% - Expands to: green text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
GROUPS -- a formatted list of groups
- Expands to a formatted list of user groups in your WikiRing.
- Syntax:
%GROUPS% - The variable is intended to be used in TWikiGroups, to allow a group listing for various user mapping managers.
- Related: REMOTE_USER, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC
H -- help icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: H =
- Related: I, ICON, M, N, P, Q, S, T, U, X, Y
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
HTTP_HOST -- environment variable
- Syntax:
%HTTP_HOST% - Expands to:
www.wikiring.com - Related: ENV, 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
I -- idea icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: I =
- Related: H, ICON, M, N, P, Q, S, T, U, X, Y
ICON{"name"} -- small documentation graphic or icon of common attachment types
- Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
- Syntax:
%ICON{"name"}% - Examples:
-
%ICON{"flag-gray"}%returns
-
%ICON{"pdf"}%returns
-
%ICON{"smile.pdf"}%returns
-
%ICON{"/dont/you/dare/smile.pdf"}%returns
-
%ICON{"http://twiki.org/doc/xhtml.xsl"}%returns
-
- Graphic samples:
arrowbright,
bubble, choice-yes,
hand - File type samples:
bmp,
doc,
gif,
hlp,
html,
mp3, pdf,
ppt,
txt,
xls,
xml,
zip - Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURL{"name"} -- URL of small documentation graphic or icon
- Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related
%ICON{"name"}%generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.) - Syntax:
%ICONURL{"name"}% - Examples:
-
%ICONURL{"arrowbright"}%returns http://www.wikiring.com/pub/TWiki/TWikiDocGraphics/arrowbright.gif -
%ICONURL{"novel.pdf"}%returns http://www.wikiring.com/pub/TWiki/TWikiDocGraphics/pdf.gif -
%ICONURL{"/queen/boheme.mp3"}%returns http://www.wikiring.com/pub/TWiki/TWikiDocGraphics/mp3.gif
-
- Related: ICONURLPATH, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURLPATH{"name"} -- URL path of small documentation graphic or icon
- Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
- Syntax:
%ICONURLPATH{"name"}% - Examples:
-
%ICONURLPATH{"locktopic"}%returns /pub/TWiki/TWikiDocGraphics/locktopic.gif -
%ICONURLPATH{"eggysmell.xml"}%returns /pub/TWiki/TWikiDocGraphics/xml.gif -
%ICONURLPATH{"/doc/xhtml.xsl"}%returns /pub/TWiki/TWikiDocGraphics/xsl.gif
-
- Related: ICONURL, ICON, TWikiPreferences, 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 toTRUE, otherwise"ELSE"will be shown - Example:
%IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else="FUNFACTOR is not defined"}%renders asFUNFACTOR is not defined - 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 aretext/htmlandtext/plain.
if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. pattern="..."Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ( '^') to end and contains the text you want to keep in parenthesis, e.g.,pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more.none rev="2"Include a previous topic revision; N/A for URLs top revision raw="on"When a page is included, normally WikiRing will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on.
raw="on"is short fordisableremoveheaders="on",disableremovescript="on",disableremovebody="on",disablecompresstags="on"anddisablerewriteurls="on".disabled literal="on"While using the rawoption will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set theliteraloption to"on".disabled disableremoveheaders="on"Bypass stripping headers from included HTML (everything until first </head>tag)disabled disableremovescript="on"Bypass stripping all <script>tags from included HTMLdisabled disableremovebody="on"Bypass stripping the </body>tag and everything around over and below itdisabled disablecompresstags="on"Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into <entities unless bypasseddisabled disablerewriteurls="on"Bypass rewriting relative URLs into absolute ones disabled warn="off"Warn if topic include fails: Fail silently (if off); output default warning (if set toon); else, output specific text (use$topicfor topic name)%INCLUDEWARNING%preferences settingsection="name"Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. 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. - Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with
disableremovescriptparameter) - Examples: See IncludeTopicsAndWebPages
- Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, 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
LANGUAGE -- 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:
- If the
LANGUAGEpreference is set, it's used as user's language instead of any language detected from the browser. - Avoid defining
LANGUAGEat a non per-user way, so each user can choose his/her preferred language.
- If the
- Related: LANGUAGES
LANGUAGES -- list available TWiki languages
- List the languages available (as
POfiles) to TWiki. Those are the languages in which TWiki's user interface is available. - Syntax:
%LANGUAGES{...}% - Supported parameters:
Parameter: Description: Default: formatformat for each item. See below for variables available in the format string. " * $langname"separatorseparator between items. "\n"(newline)marker="selected"Text for $markerif the item matchesselection"selected"selection="%LANGUAGE%"Current language to be selected in list (none) -
formatvariables:Variable Meaning $langnamelanguage's name, as informed by the translators $langtaglanguage's tag. Ex: en,pt-br, etc. - Example:
<select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select>creates an option list of the available languages with the current language selected
LIME -- start lime colored text
-
LIMEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%LIME% lime text %ENDCOLOR% - Expands to: lime text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
LOCALSITEPREFS -- web.topicname of site preferences topic
- The full name of the local site preferences topic. These local site preferences overload the system level preferences defined in TWiki.TWikiPreferences.
- Syntax:
%LOCALSITEPREFS% - Expands to:
Main.TWikiPreferences, renders as TWikiPreferences
LOGIN -- present a full login link
- Syntax:
%LOGIN% - Expand to: Login
- Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION_VARIABLE
LOGOUT -- present a full logout link
- Syntax:
%LOGOUT% - Expand to:
- Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSION_VARIABLE
M -- moved to... icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: M =
- Related: H, I, ICON, N, P, Q, S, T, U, X, Y
MAINWEB -- synonym for USERSWEB
- Deprecated. Please use %USERSWEB% instead.
MAKETEXT -- creates text using TWiki's I18N infrastructure
- Syntax:
%MAKETEXT{"string" args="..."}% - Supported parameters:
Parameter Description Default "text"orstring="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{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}%
expands to
If you have any questions, please contact webmaster@michaeldaumconsulting.com. -
%MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"}%
expands to
Did you want to reset Main.TWikiGuest's password?
-
- Notes:
- TWiki will translate the
stringto 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 cannot 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).
- TWiki will translate the
MAROON -- start maroon colored text
-
MAROONis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%MAROON% maroon text %ENDCOLOR% - Expands to: maroon text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
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
formfielditem 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
newline="...": by default, each newline character will be rewritten to<br />to allow metadata that contains newlines to be used in tables, etc.$nindicates a newline character.
bar="...": by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator.Show a single form field "form"none Generates the table showing the form fields. See Form Templates "attachments"all="on"to show hidden attachments.
title="..."to show a title - only if attachments are displayed.
template="..."to use a custom template for the rendering of attachments; defaultattachtablesis used.Generates the list of 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"".
format="...": Format string used to display each parent topic where$webexpands to the web name, and$topicexpands to the topic name; default:"[[$web.$topic][$topic]]"
suffix="...": Suffix, only appears if there are parents; default"".
separator="...": Separator between parents; default" > ".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 thenameandvalueparameters to specify which field to search)Required web="%WEB%"Wiki web to search: A web, a list of webs separated by whitespace, or allwebs.Current web topic="%TOPIC%"The topic the search relates to, for topicmovedandparentsearchesAll topics in a web nameform field to search, for fieldtype searches. May be a regular expression (see SEARCH).valueform field value, for fieldtype searches. May be a regular expression (see SEARCH).title="Title"Text that is prefixed to any search results empty format="..."Custom format results. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples Results in table 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
- Note: METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and QuerySearch.
N -- "new" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: N =
- Related: H, I, ICON, M, P, Q, S, T, U, X, Y
NAVY -- start navy blue colored text
-
NAVYis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%NAVY% navy text %ENDCOLOR% - Expands to: navy text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
NOP -- template text not to be expanded in instantiated topics
- Syntax:
%NOP%- In normal topic text, expands to <nop>, which prevents expansion of adjacent variables and wikiwords
- When the topic containing this is used as a template for another topic, it is removed.
- Syntax:
%NOP{...}%deprecated- In normal topic text, expands to whatever is in the curly braces (if anything).
- Note: This is deprecated. Do not use it. Use
%STARTSECTION{type="templateonly"}%..%ENDSECTION{type="templateonly"}%instead (see TWikiTemplates for more details).
- Related: STARTSECTION, TWikiTemplates
NOTIFYTOPIC -- name of the notify topic
- Syntax:
%NOTIFYTOPIC% - Expands to:
WebNotify, renders as WebNotify - Related: HOMETOPIC, STATISTICSTOPIC, TOPIC
OLIVE -- start olive green colored text
-
OLIVEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%OLIVE% olive text %ENDCOLOR% - Expands to: olive text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
ORANGE -- start orange colored text
-
ORANGEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%ORANGE% orange text %ENDCOLOR% - Expands to: orange text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
P -- pencil icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: P =
- Related: H, I, ICON, M, N, Q, S, T, U, X, Y
PINK -- start pink colored text
-
PINKis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%PINK% pink text %ENDCOLOR% - Expands to: pink text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
PLUGINDESCRIPTIONS -- list of plugin descriptions
- Syntax:
%PLUGINDESCRIPTIONS% - Expands to:
- GluePlugin (2.00, $Rev$): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev$): Render content conditionally
- SpreadSheetPlugin (any TWiki, 15269): Add spreadsheet calculation like
"$SUM( $ABOVE() )"to TWiki tables and other topic text - AliasPlugin (2.20, 15573): Define aliases which will be replaced with arbitrary strings automatically
- AutoViewTemplatePlugin (ipo, $Rev$): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
- BlogPlugin (0.99, $Rev$): Basic blogging features used to implement the BlogUp TWikiApplication
- BreadCrumbsPlugin (v2.00, $Rev$): A flexible way to display breadcrumbs navigation
- ClassificationPlugin (0.50, $Rev$): A topic classification plugin and application
- CommentPlugin (TWiki-4, 14241): Allows users to quickly post comments to a page without an edit/preview/save cycle
- DBCachePlugin (1.80, $Rev$): Lightweighted frontend to the DBCacheContrib
- EditChapterPlugin (1.13, $Rev$): An easy sectional edit facility
- EmployeePortalPlugin (v2.0-pre1, $Rev$): EmployeePortal extensions
- FilterPlugin (1.41, $Rev$): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.22, $Rev$): Flexible way to display hierarchical weblists
- HeadlinesPlugin (2.12, 15564): Build news portals that show headline news based on RSS news feeds from news sites.
- ImageGalleryPlugin (3.70, 15576): Displays image gallery with auto-generated thumbnails from attachments
- ImagePlugin (1.1, $Rev$): Control the display and alignment of images using an easy syntax
- InterwikiPlugin (Dakar, $Rev: 14913 (17 Sep 2007) $): Link
ExternalSite:Pagetext to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.50, $Rev$): jQuery JavaScript library for TWiki
- JQueryTwistyPlugin (1.0, $Rev$): Twisty section JavaScript library to open/close content dynamically
- LdapNgPlugin (v2.01, $Rev$): Query and display data from an LDAP directory
- LocalTimePlugin (Dakar, 11113): A plugin to give the current date and time of a particular city/timezone.
- MathModePlugin (2.96, 15934): Include LaTeX formatted math in your TWiki pages
- MediaWikiTablePlugin (v1.00, $Rev$): Format tables the MediaWiki way
- NatSkinPlugin (3.00-pre18, $Rev$): Supplements the bare bones NatSkin theme for TWiki
- PaginationPlugin (0.10, $Rev$): navigate among a double linked list of documents
- PingBackPlugin (v0.05-alpha, $Rev$): Pingback service for TWiki
- RedDotPlugin (1.40, $Rev$): Renders edit-links as little red dots
- SetVariablePlugin (0.10, $Rev$): Conditionally set variables while saving a topic
- SmiliesPlugin (Dakar, 16048): Render smilies as icons, like for
:-)or for :eek: - TablePlugin (1.032, 16084): Control attributes of tables and sorting of table columns
- TagCloudPlugin (v1.01, $Rev$): Renders a tag cloud given a list of terms
- TimeSincePlugin (1.10, $Rev$):
- UserInfoPlugin (1.53, 10521): Render information about users on your TWikiSite
- VotePlugin (1.33, 14296): Simple way to count votes
- 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: 14913 (17 Sep 2007) $ - Syntax:
%PLUGINVERSION%to get the version of the API - Expands to:
1.2 - Related: WIKIVERSION, ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINDESCRIPTIONS
PUBURL -- the base URL of attachments
- Syntax:
%PUBURL% - Expands to:
http://www.wikiring.com/pub - Example: You can refer to a file attached to another topic with
%PUBURL%/%WEB%/OtherTopic/image.gif - Related: ATTACHURL, ATTACHURLPATH, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments
PUBURLPATH -- the base URL path of attachments
- Syntax:
%PUBURLPATH% - Expands to:
/pub - Related: ATTACHURL, ATTACHURLPATH, PUBURL, SCRIPTURL, SCRIPTURLPATH, FileAttachments
PURPLE -- start purple colored text
-
PURPLEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%PURPLE% purple text %ENDCOLOR% - Expands to: purple text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
Q -- question icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Q =
- Related: H, I, ICON, M, N, P, S, T, U, X, Y
QUERYPARAMS -- show paramaters to the query
- Expands the parameters to the query that was used to display the page.
- Syntax:
%QUERYPARAMS{...}% - Parameters:
-
format="..."format string for each entry, default$name=$value -
separator="..."separator string, defaultseparator="$n"(newline) -
encoding="..."the encoding to apply to parameter values; see ENCODE for a description of the available encodings. If this parameter is not given, no encoding is performed.
-
- The following escape sequences are expanded in the format string:
| Sequence: | Expands To: |
|---|---|
$name |
Name of the parameter |
$value |
String value of the parameter. Multi-valued parameters will have a "row" for each value. |
$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 (") (\" also works) |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
- Example:
-
%QUERYPARAMS{format="<input type='hidden' name='$name' value='$value' encoding="entity" />"}%
-
- See also QUERYSTRING, URLPARAM
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
%QUERYPARAMS%. - Syntax:
%QUERYSTRING% - Expands to:
- Related: QUERYPARAMS, URLPARAM
RED -- start red colored text
-
REDis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%RED% red text %ENDCOLOR% - Expands to: red text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
REMOTE_ADDR -- environment variable
- Syntax:
%REMOTE_ADDR% - Expands to:
38.107.179.240 - Related: ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER
REMOTE_PORT -- environment variable
- Syntax:
%REMOTE_PORT% - Expands to:
49041 - Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER
REMOTE_USER -- environment variable
- Syntax:
%REMOTE_USER% - Expands to:
- Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, WIKINAME, WIKIUSERNAME
REVINFO -- revision information of current topic
- Syntax:
%REVINFO% - Expands to:
r0 - 27 Mar 2005 - 15:14:15 - TWikiContributor - Date format defined as {DefaultDateFormat} in configure
- 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 $webName of web Current web $topicTopic name Current topic $revRevison number. Prefix r1.to get the usualr1.5format5$usernameLogin username of revision jsmith$wikinameWikiName of revision JohnSmith$wikiusernameWikiName with Main web prefix Main.JohnSmith$dateRevision date. Actual date format defined as {DefaultDateFormat} in configure 21 Sep 2006$timeRevision time 23:24:25$isoRevision date in ISO date format 2006-09-22T06:24:25Z$min,$sec, etc.Same date format qualifiers as GMTIME{"format"} - Example:
%REVINFO{"$date - $wikiusername" rev="1.1"}%returns revision info of first revision - Related: GMTIME{"format"}, REVINFO
S -- red star icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: S =
- Related: H, I, ICON, M, N, P, Q, T, U, X, Y
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:
twiki - Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH
SCRIPTSUFFIX -- script suffix
- Some WikiRing installations require a file extension for CGI scripts, such as
.plor.cgi - Syntax:
%SCRIPTSUFFIX% - Expands to:
- Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH
SCRIPTURL -- base URL of TWiki scripts
- Syntax:
%SCRIPTURL% - Expands to:
http://www.wikiring.com/ - Note: The
editscript should always be used in conjunction with?t=%GMTIME{"$epoch"}%to ensure pages about to be edited are not cached in the browser - Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL{"script"}, SCRIPTURLPATH
SCRIPTURL{"script"} -- URL of TWiki script
- Syntax:
%SCRIPTURL{"script"}% - Expands to:
http://www.wikiring.com/script - Example: To get the authenticated version of the current topic you can write
%SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC%which expands tohttp://www.wikiring.com/view/TWiki/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:
/ - Note: The
editscript should always be used in conjunction with?t=%GMTIME{"$epoch"}%to ensure pages about to be edited are not cached in the browser - 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:
/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, regular expression search, or query, depending on the typeparameter. SearchHelp has morerequired search="text"(Alternative to above) N/A web="Name"
web="Main, Know"
web="all"Comma-separated list of webs to search. You can specifically exclude webs from an allsearch using a minus sign - for example,web="all,-Secretweb". The special wordallmeans all webs that do not have theNOSEARCHALLvariable set toonin their WebPreferences. Note that TWikiAccessControls are respected when searching webs; it is much better to use them thanNOSEARCHALL.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. Note this is a list of topic names and must not include web names. 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. Note this is a list of topic names and must not include web names. None scope="topic"
scope="text"
scope="all"Search topic name (title); the text (body) of topic; or all (title and body) "text"type="keyword"
type="word"
type="literal"
type="regex"
type="query"Control how the search is performed when scope="text"orscope="all"
keyword: use Google-like controls as insoap "web service" -shampoo; searches word parts: using the example, topics with "soapsuds" will be found as well, but topics with "shampoos" will be excluded
word: identical tokeywordbut searches whole words: topics with "soapsuds" will not be found, and topics with "shampoos" will not be excluded
literal: search for the exact string, likeweb service
regex: use a RegularExpression search likesoap;web service;!shampoo; to search on whole words use\bsoap\b
query: query search of form fields and other meta-data, like(Firstname='Emma' OR Firstname='John') AND Lastname='Peel'%SEARCHVAR- DEFAULTTYPE%preferences setting (literal)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 orderis specifiedAll results date="..."limits the results to those pages with latest edit time in the given time interval. 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 default search header
Topics: Changed: By: , unless aheaderis explicitly specifiedShow default search header, unless search 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 formulaRaw 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.offrecurse="on"Recurse into subwebs, if subwebs are enabled. offseparator=", "Line separator between search hits "$n"(Newline)newline="%BR%"Line separator within a search hit. Useful if the format="" parameter contains a $pattern() that captures more than one line, i.e. contents of a textfield in a form. "$n"(Newline) - 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, SearchHelp, SearchPatternCookbook, RegularExpression
SERVERTIME -- server time
- Syntax:
%SERVERTIME% - Expands to:
21 May 2012 - 18:50 - Date format defined as {DefaultDateFormat} in configure
- 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 to18:50 - 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
SESSIONID -- unique ID for this session
- Syntax:
%SESSIONID% - Expand to: 0d417a650a9cff216eeabaa26f2e565c
- Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE
SESSIONVAR -- name of CGI and session variable that stores the session ID
- Syntax:
%SESSIONVAR% - Expand to: TWIKISID
- Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, LOGIN, LOGOUT, SESSION_VARIABLE
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
AUTHUSERsession variable, and is read-only - Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, SESSIONVAR, LOGIN, LOGOUT
SILVER -- start silver colored text
-
SILVERis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%SILVER% silver text %ENDCOLOR% - Expands to: silver text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
SPACEDTOPIC -- topic name, spaced and URL-encoded deprecated
- 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:
Var%20*SPACEDTOPIC - Note: This is a deprecated variable. It can be duplicated with
%ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}% - Related: SPACEOUT, TOPIC, ENCODE
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: separatorThe 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. - Note: If you want more than one part of the topic included, use
%STARTSECTION{type="include"}%instead - Syntax:
%STARTINCLUDE% - Related: INCLUDE, STARTSECTION, STOPINCLUDE
STARTSECTION -- marks the start of a section within a topic
- Section boundaries are defined with
%STARTSECTION{}%and%ENDSECTION{}%. - Sections may be given a name to help identify them, and/or a type, which changes how they are used.
-
type="section"- the default, used for a generic section, such as a named section used by INCLUDE. -
type="include"- like%STARTINCLUDE%...%STOPINCLUDE%except that you can have as many include blocks as you want (%STARTINCLUDE%is restricted to only one). -
type="templateonly"- start position of text to be removed when a template topic is used. This is used to embed text that you do not want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
-
- Syntax:
%STARTSECTION{"name"}% ................ %ENDSECTION{"name"}% - Syntax:
%STARTSECTION{type="include"}% ........ %ENDSECTION{type="include"}% - Syntax:
%STARTSECTION{type="templateonly"}% ... %ENDSECTION{type="templateonly"}% - Supported parameters:
Parameter: Description: Default "name"Name of the section. Must be unique inside a topic. Generated name type="..."Type of the section; type "section","include"or"templateonly""section" - Note: If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with
_SECTION0for the first unnamed section in the topic,_SECTION1for the second, etc.. - Note: You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.
- Related: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, 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: INCLUDE, STARTINCLUDE
SYSTEMWEB -- name of TWiki documentation web
- The web containing all documentation and default preference settings
- Syntax:
%SYSTEMWEB% - Expands to:
TWiki - Related: USERSWEB
T -- tip icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: T =
- Related: H, I, ICON, M, N, P, Q, S, U, X, Y
TABLE{ attributes } -- control attributes of tables and sorting of table columns
- The
%TABLE{}%variable is handled by the TablePlugin - Syntax:
%TABLE{ attributes }%
- Supported attributes:
Argument Comment Default value Example sortSet table sorting by clicking headers "on"or"off".unspecified sort="on"initsortColumn to sort initially ( "1"to number of columns).unspecified initsort="2"initdirectionInitial sorting direction for initsort, set to"up"(descending) or"down"(ascending).unspecified initdirection="up"disableallsortDisable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table. unspecified disableallsort="on"headerbgHeader cell background colour. "#6b7f93"headerbg="#999999"headerbgsortedHeader cell background colour of a sorted column. the value of headerbgheaderbgsorted="#32596c"headercolorHeader cell text colour. "#ffffff"headercolor="#0000cc"databgData cell background colour, a comma separated list. Specify "none"for no colour, that is to use the colour/background of the page the table is on."#edf4f9,#ffffff"databg="#f2f2f2,#ffffff"databgsortedData cell background colour of a sorted column; see databg.the values of databgdatabgsorted="#d4e8e4,#e5f5ea"datacolorData cell text colour, a comma separated list. unspecified datacolor="#0000CC, #000000"tableborderTable border width (pixels). "1"tableborder="2"tableframeTable frame, set to "void"(no sides),"above"(the top side only),"below"(the bottom side only),"hsides"(the top and bottom sides only),"lhs"(the left-hand side only),"rhs"(the right-hand side only),"vsides"(the right and left sides only),"box"(all four sides),"border"(all four sides).unspecified tableframe="hsides"tablerulesTable rules, set to "none"(no rules),"groups"(rules will appear between row groups and column groups only),"rows"(rules will appear between rows only),"cols"(rules will appear between columns only),"all"(rules will appear between all rows and columns).unspecified tablerules="rows"cellpaddingCell padding (pixels). "0"cellpadding="0"cellspacingCell spacing (pixels). "0"cellspacing="3"cellborderCell border width (pixels). unspecified cellborder="0"valignVertical alignment of cells and headers, set to "top","middle","bottom"or"baseline".unspecified valign="top"headervalignVertical alignment of header cells; overrides valign.unspecified headervalign="top"datavalignVertical alignment of data cells; overrides valign.unspecified datavalign="top"headeralignHeader cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left","center","right"or"justify". Overrides individual cell settings.unspecified headeralign="left,right"dataalignData cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left","center","right"or"justify". Overrides individual cell settings.unspecified dataalign="center"tablewidthTable width: Percentage of window width, or absolute pixel value. unspecified tablewidth="100%"columnwidthsColumn widths: Comma delimited list of column widths, percentage or absolute pixel value. unspecified columnwidths="80%,20%"headerrowsNumber of header rows to exclude from sort. (will be rendered in a HTML theadsection)"1"headerrows="1"footerrowsNumber of footer rows to exclude from sort. (will be rendered in a HTML tfootsection)"0"footerrows="1"idUnique table identifier string, used for targeting a table with CSS. tableN(where N is the table order number on the page)id="userTable"summaryTable summary used by screenreaders: A summary of what the table presents. It should provide an orientation for someone who listens to the table. unspecified summary="List of subscribed users"captionTable caption: A title that will be displayed just above the table. unspecified caption="Users"
- Example:
%TABLE{ tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" }%
| *A1* | *B1* |
| A2 | B2 | - Related: See TablePlugin for more details
TEAL -- start teal colored text
-
TEALis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%TEAL% teal text %ENDCOLOR% - Expands to: teal text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
TOC -- table of contents of current topic
- Syntax:
%TOC% - Related: TOC{"Topic"}
TOC{"Topic"} -- table of contents
- 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 - Syntax:
%TOC{"SomeTopic" ...}% - 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
-
%TOPIC%expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic. - Syntax:
%TOPIC% - Expands to:
TWikiVariables, renders as TWikiVariables - Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB
TOPICLIST{"format"} -- topic index of a web
- List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The
$topicvariable gets expanded to the topic name,$markertomarkerparameter where topic matchesselection, and$webto the name of the web, or any of the standard FormatTokens. - Syntax:
%TOPICLIST{"format" ...}% - Supported parameters:
Parameter: Description: Default: "format"Format of one line, may include $web(name of web),$topic(name of the topic),$marker(which expands tomarkerfor the item matchingselectiononly)"$topic"format="format"(Alternative to above) "$topic"separator=", "line separator "$n"(new line)marker="selected"Text for $markerif the item matchesselection"selected"selection="TopicA, TopicB"Current value to be selected in list (none)web="Name"Name of web Current web - Example:
%TOPICLIST{" * $web.$topic"}%creates a bullet list of all topics - Example:
%TOPICLIST{separator=", "}%creates a comma separated list of all topics - Example:
%TOPICLIST{" <option>$topic</option>"}%creates an option list (for drop down menus) - Example:
<select>%TOPICLIST{" <option $marker value='$topic'>$topic</option>" separator=" " selection="%TOPIC%"}%</select>creates an option list of web topics with the current topic selected - Related: SEARCH, WEBLIST
TOPICURL -- shortcut to viewing the current topic
- This variable always expands to an url pointing to the current base topic.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: TOPICURL = http://www.wikiring.com/TWiki/TWikiDocumentation
TWIKIWEB -- synonym for SYSTEMWEB
- Deprecated. Please use
%SYSTEMWEB%instead.
U -- "updated" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: U =
- Related: H, I, ICON, M, N, P, Q, S, T, X, Y
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 %22no encoding encode="quote"Escape double quotes with backslashes ( \"), does not change other characters; required when feeding URL parameters into other TWiki variablesno encoding multiple="on"
multiple="[[$item]]"If set, gets all selected elements of a <select multiple="multiple">tag. A format can be specified, with$itemindicating 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"}%returnsprintfor a.../view/TWiki/TWikiVariables?skin=printURL - Note: URL parameters passed into HTML form fields must be entity ENCODEd.
- Note: Double quotes in URL parameters must be escaped when passed into other TWiki variables.
Example:%SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }% - 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: ENCODE, SEARCH, FormattedSearch, QUERYSTRING
%URLPARAM{ in the value of a URL parameter, it will be modified to %<nop>URLPARAM{. This is to prevent an infinite loop during expansion.
USERINFO{"WikiName"} -- retrieve details about a user
- Syntax:
%USERINFO% - Expands to:
guest, TWikiGuest,(comma-separated list of the username, wikiusername, and emails) - With formatted output, using tokens
$emails,$username,$wikiname,$wikiusername,$groupsand$admin($admin returns 'true' or 'false'):- Example:
%USERINFO{ format="$username is really $wikiname" }% - Expands to:
guest is really TWikiGuest
- Example:
- Retrieve information about another user:
- Example:
%USERINFO{ "TWikiGuest" format="$username is really $wikiname" }% - Expands to:
guest is really TWikiGuest - Note: The parameter should be the wikiname of a user. You can only get information about another user if the
{AntiSpam}{HideUserDetails}configuration option is not enabled, or if you are an admin. (User details are hidden in this TWiki)
- Example:
- Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress
USERNAME -- your login username
- TWiki makes names available in three formats: USERNAME like
jsmith, WIKINAME likeJohnSmithand WIKIUSERNAME likeMain.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, USERINFO, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication
USERSWEB -- name of users web
- The web containing individual user topics, TWikiGroups, and customised site-wide preferences.
- Syntax:
%USERSWEB% - Expands to:
Main - Related: SYSTEMWEB
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
VBAR -- vertical bar
- The vertical bar variable can be used in TWiki tables.
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: VBAR = |
- Related: BR, BULLET, BB, BB2, BB3, BB4, CARET
WEB -- name of current web
-
%WEB%expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web where the included topic is located. - Syntax:
%WEB% - Expands to:
TWiki - Related: BASEWEB, INCLUDINGWEB, TOPIC
WEBLIST{"format"} -- index of all webs
- List of all webs. Obfusticated webs are excluded, e.g. webs with a
NOSEARCHALL = onpreference variable. The"format"defines the format of one web item. The$namevariable gets expanded to the name of the web,$qnamegets expanded to double quoted name,$markertomarkerwhere web matchesselection. - 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 tomarkerfor the item matchingselectiononly)"$name"format="format"(Alternative to above) "$name"separator=", "Line separator "$n"(new line)web=""if you specify $webin format, it will be replaced with this""webs="public"Comma separated list of webs, publicexpands to all non-hidden.
NOTE: Administrators will see all webs, not just the public ones"public"marker="selected"Text for $markerif the item matchesselection"selected"selection="%WEB%"Current value to be selected in list selection="%WEB%"subwebs="Sandbox"show webs that are a sub-web of this one (recursivly) "" - Example:
%WEBLIST{" * [[$name.WebHome]]"}%- creates a bullet list of all webs. - Example:
<form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form>- creates a dropdown of all public webs + Trash web, with the current web highlighted. - Related: TOPICLIST, SEARCH
WEBPREFSTOPIC -- name of web preferences topic
- Syntax:
%WEBPREFSTOPIC% - Expands to:
WebPreferences, renders as WebPreferences - Related: HOMETOPIC, WIKIPREFSTOPIC, VAR
WHITE -- start white colored text
-
WHITEis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%WHITE% white text %ENDCOLOR% - Expands to: white text (shown with a gray background here)
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
WIKIHOMEURL -- site home URL
- Syntax
%WIKIHOMEURL% - Expands to ==
- Defined in TWikiPreferences and normally per default set to
%SCRIPTURLPATH{"view"}% - Note: For the top bar logo URL use
%WIKILOGOURL%defined in WebPreferences instead. - Related: WIKITOOLNAME
WIKINAME -- your Wiki username
- The WikiName is the same as
%USERNAME%if not defined in the TWikiUsers topic - Syntax:
%WIKINAME% - Expands to:
TWikiGuest - 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, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC
WIKIPREFSTOPIC -- name of site-wide preferences topic
- Syntax:
%WIKIPREFSTOPIC% - Expands to:
TWikiPreferences, renders as TWikiPreferences - Related: HOMETOPIC, WEBPREFSTOPIC
WIKITOOLNAME -- name of your TWiki site
- Syntax:
%WIKITOOLNAME% - Expands to:
WikiRing - Related: WIKIHOMEURL, WIKIVERSION
WIKIUSERNAME -- your Wiki username with web prefix
- Your %WIKINAME% with Main web prefix, useful to point to your WikiRing home page
- Syntax:
%WIKIUSERNAME% - Expands to:
Main.TWikiGuest, renders as TWikiGuest - 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, USERINFO, USERNAME, WIKINAME
WIKIUSERSTOPIC -- name of topic listing all registers users
- Syntax:
%WIKIUSERSTOPIC% - Expands to:
TWikiUsers, with Main prefix renders as TWikiUsers - Related: WIKIUSERNAME
WIKIVERSION -- the version of the installed TWiki engine
- Syntax:
%WIKIVERSION% - Expands to:
TWiki-5.0.0, Wed, 23 Jan 2008, build 16283 - Related: PLUGINVERSION, WIKITOOLNAME
X -- warning icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: X =
- Related: H, I, ICON, M, N, P, Q, S, T, U, Y
Y -- "yes" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Y =
- Related: H, I, ICON, M, N, P, Q, S, T, U, X
YELLOW -- start yellow colored text
-
YELLOWis one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors. - Syntax:
%YELLOW% yellow text %ENDCOLOR% - Expands to: yellow text
- Note:
%<color>%text must end with%ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with%ENDCOLOR%, e.g. write%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%. - Related: ENDCOLOR, TWikiPreferences, StandardColors
TWiki Formatted Search
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 |" }%. See %SEARCH{...}% for other search parameters, such as separator="".
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:* |"
Variables that can be used in the header string:
| Name: | Expands To: |
|---|---|
$web |
Name of the web |
$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 (") (\" also works) |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
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 May 2012 - 16:50 |
$isodate |
Time stamp of last topic update, e.g. 2012-05-21T16:50Z |
$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 removedNote: 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 e-mail 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 (") (\" also works) |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
Examples
Here are some samples of formatted searches. The SearchPatternCookbook has other examples, such as creating a picklist of usernames, searching for topic children and more.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:
- NatSkinFAQ: NatSkinFAQ The documentation of NatSkin is crap. I'm lost! If you need help there are a couple of options: Create a support request on TWiki:Support/WebHome ...
- TWikiFAQ: Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of an easily implemented knowledge base solution. To see how it's done, view the source ...
- TWikiFaqTemplate: FAQ: Answer: Back to: TWikiFAQ
- TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...
Table showing form field values of topics with a form
In a web where there is a form that contains aTopicClassification field, an OperatingSystem field and an OsVersion field we could write:
| *Topic:* | *OperatingSystem:* | *OsVersion:* | %SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" type="regex" 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" type="regex" 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 topic? Answer...
- How do I delete or rename a file attachment? 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...
- What does the "T" in TWiki stand for? 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
$percntto escape the leading percent of the second search - Use
\"to escape the double quotes - Use
$dollarto escape the$of$topic - Use
$nopto escape the}%sequence
- Use
%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:
- FormattedSearch is referenced by:
- ActionTrackerPlugin, AntiWikiSpamPlugin, BatchUploadPlugin, BlogPlugin, BreadCrumbsPlugin, CalendarPlugin, ChecklistPlugin, ClassificationPlugin, DBCachePlugin, EditTablePlugin, EditTablerowPlugin, EndNotePlugin, FilterPlugin, FirefoxBoosterPlugin, FlexWebListPlugin, FormatTokens, GenerateSearchPlugin, GlobalReplacePlugin, GluePlugin, GoogleAnalyticsPlugin, HeadlinesPlugin, HistoryPlugin, HolidaylistPlugin, IfDefinedPlugin, ImagePlugin, InlineEditPlugin, InterwikiPlugin, LatexModePlugin, LdapNgPlugin, LinkOptionsPlugin, MathModePlugin, MediaWikiTablePlugin, MySideBarTemplate, NatEditHelpText, NatEditWordHelpText, NatSkinPlugin, PaginationPlugin, PingBackPlugin, PublishContribHistory, RedDotPlugin, RenderListPlugin, RevCommentPlugin, SearchHelp, SearchPatternCookbook, SlideShowPlugin, SlidyPlugin, SmiliesPlugin, SpreadSheetPlugin, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiHistory, TWikiMetaData, TWikiReferenceManual, TWikiReleaseNotes04x00, TWikiReleaseNotes04x01, TWikiScripts, TWikiSiteTools, TagCloudPlugin, TagMePlugin, TimeSincePlugin, TopicCreatePlugin, TopicListPlugin, TreeBrowserPlugin, TreePlugin, TwistyPlugin, UpdateInfoPlugin, UserInfoPlugin, VarMETA, VarMETASEARCH, VarSEARCH, VarURLPARAM, WebLeftBar, WebStatistics, WelcomeGuest, XmlQueryPlugin
- PublishContribHistory is referenced by:
- TWikiAccessControl is referenced by:
- EditTablePlugin, FileAttachment, MainFeatures, ManagingTopics, ManagingUsers, PublishContribHistory, SitePermissions, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiHistory, TWikiReferenceManual, TWikiReleaseNotes04x01, TWikiReleaseNotes04x02, TWikiScripts, TWikiSiteTools, TWikiTopics, TWikiTutorial, TWikiUserAuthentication, TWikiVariables, VarSEARCH, WebPermissionsPlugin, WebPreferences, WebPreferencesHelp, WebStatistics, WikiCulture, WikiWord
- TWikiSite is referenced by:
- AdminToolsCategory, InstantEnhancements, InterwikiPlugin, ManagingWebs, PublishContribHistory, StartingPoints, TWikiDocumentation, TWikiGlossary, TWikiInstallationGuide, TWikiReferenceManual, TWikiReleaseNotes04x02, TWikiScripts, TWikiSite, TWikiTopics, TWikiTutorial, TWikiUserAuthentication, TWikiUsersGuide, UserInfoPlugin, WabiSabi, WebLeftBar, WebSiteTools, WebStatistics, WelcomeGuest, WhatDoesTWikiStandFor, WhatIsWikiWiki, WikiCulture, WikiReferences
- WabiSabi is referenced by:
- WebStatistics is referenced by:
- AdminToolsCategory, PublishContribHistory, SiteChanges, TWikiEditingShorthand, TWikiHistory, TWikiInstallationGuide, TWikiReleaseNotes04x02, TWikiScripts, TWikiSiteTools, TWikiWebLinks, TagMePlugin, TemplateWeb, WebHome, WebLeftBar, WebRssBase, WebRssBaseWC, WebSearch, WebSearchAdvanced, WebStatistics
- WhatIsWikiWiki is referenced by:
- WikiCulture is referenced by:
$dollarpercntSEARCH{ for level three, $dollardollarpercntSEARCH{ for level four, etc.
Most recently changed pages
Write this:%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" order="modified" reverse="on" format="| [[$topic]] | $wikiusername | $date |" limit="7" }%
To get this:
| WebStatistics | TWikiAdminGroup | 20 May 2012 - 23:00 |
| NatSkinStyleBrowser | MichaelDaum | 13 May 2010 - 09:50 |
| FlexWebListExamples | MichaelDaum | 29 May 2009 - 10:52 |
| NatSkinWebCreateNewTopicTemplate | MichaelDaum | 07 May 2009 - 09:29 |
| TWikiWebLinks | MichaelDaum | 07 May 2009 - 09:21 |
| RtfContrib | TWikiGuest | 26 Mar 2008 - 21:02 |
| EditChapterPlugin | TWikiGuest | 13 Mar 2008 - 22:44 |
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:- Specify a search which returns more hits then you need
- For each search hit apply a spreadsheet formula to determine if the hit is needed
- If needed, format and output the result
- Else supress the search hit
%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}% %SEARCH{ "." scope="topic" type="regex" 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
weekoldvariable to the serialized date of exactly one week ago - The SEARCH has a deferred CALC. The
$percntmakes sure that the CALC gets executed once for each search hit - The CALC compares the date of the topic with the
weekolddate - 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
| WebStatistics | TWikiAdminGroup | 20 May 2012 - 23:00 | 1812 |
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"}%" /> <input type="submit" class="twikiSubmit" value="Search" />
</form>
Result:
%SEARCH{ search="%URLPARAM{"q"}%" format=" * $web.$topic: %BR% $summary" nosearch="on" }%
To get this:
Result:
Related Topics: UserDocumentationCategory, SearchHelp, TWikiVariables#VarSEARCH, SearchPatternCookbook, RegularExpression
-- Contributors: TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Back to top
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% = .
- 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
Attachlink at the bottom of the page. TheAttachscreen 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:
*.phpfiles are renamed to*.php.txtso 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 0 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
Manageon 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 webTrash, topic TrashAttachment.
Linking to Attached Files
- Once a file is attached it can be referenced in the topic. Example:
-
Attachfile:Sample.txt -
Edittopic and enter:%ATTACHURL%/Sample.txt -
Preview:%ATTACHURL%/Sample.txttext appears as: /pub/TWiki/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:
-
Attachfile:Sample.txt -
Edittopic 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:
-
Attachfile:Smile.gif -
Edittopic and write text:%ATTACHURL%/Smile.gif -
Preview: text appears as /pub/TWiki/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 |
|---|---|---|---|---|---|---|
 txt | Sample.txt | manage | 0.1 K | 22 Jul 2000 - 19:37 | TWikiContributor | Just a sample |
 gif | Smile.gif | manage | 0.1 K | 22 Jul 2000 - 19:38 | TWikiContributor | Smiley face |
File Attachment Controls
Clicking on aManage link takes you to a new page that looks a bit like this (depending on what skin is selected):
Attach new file
Select a new local file to update attachmentSample.txt (UploadingUser)Upload up to 10000 KB.
or Cancel
- The first table is a list of all attachments, including their attributes. An
hmeans 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 filecheckbox, then clickChange 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 one form attached to it at a time. Typical steps to build an application based on TWiki forms:- Define a form template
- Enable the form for a web
- Add the form to a template topic
- Build an HTML form to create new topics based on that template topic
- Build a FormattedSearch to list topics that share the same form
Defining a Form
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 specifies one form field.- Create a new topic with your form name:
YourForm,ExpenseReportForm,InfoCategoryForm,RecordReviewForm, whatever you need. - Create a TWiki table, with each column representing one element of an entry field:
Name,Type,Size,Values,Tooltip message, andAttributes(see sample below). - For each field, fill in a new line; for the type of field, select from the list.
- Save the topic (you can later choose to enable/disable individual forms).
Example:See structure of a form for full details of what types are available and what all the columns mean. You can also retrieve possible values for
| *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...
select, checkbox or radio types from other topics:
Example:Field values can also be set using the result of expanding other TWiki variables. For example,
- 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...
Valuesfield blank.
- Then in the TopicClassification topic, define the possible values:
| *Name* |
| NoDisclosure |
| Public Supported |
| Public FAQ |
Name NoDisclosure Public Supported Public FAQ
%SEARCH{"Office$" scope="topic" web="%USERSWEB%" nonoise="on" type="regex" format="$web.$topic" separator=", " }%
When used in the value field of the form definition, this will find all topic names in the Main web which end in "Office" and use them as the legal field values.
Enabling Forms by Web
Forms have to be enabled for each individual web. TheWEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.
Example:
- Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm
- With
WEBFORMSenabled, 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 inWEBFORMS, or the No form option. - You have to list the available form topics explicitly. You cannot use a
SEARCHto defineWEBFORMS.
Adding a form to a topic
- Edit the topic and follow the "Add form" button to add a Form. This is typically done to a template topic, either to the
WebTopicEditTemplatetopic 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
formtemplateparameter 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" class="twikiSubmit" value="Create" /> </form>
- other than checkboxes:
- Tip: For TWiki applications you can automatically generate unique topicnames.
- Note: Initial values will not be set in the form of a new topic if you only use the formtemplate parameter.
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)
- If two people edit the same topic containing a form at exactly the same time, and both change fields in the form, TWiki will try to merge the changes so that no data is lost.
Structure of 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 specifies one form field. Each column of the table is one element of an entry field:Name, Type, Size, Values, Tooltip message, and Attributes.
The Name, Type and Size columns are required. Other columns are optional. The form must have a header row (e.g. | *Name* | *Type* | *Size* |).
Name is the name of the form field.
The Type, Size and Value fields describe the legal values for this field, and how to display them. -
Typecheckboxspecifies one or more checkboxes. TheSizefield specifies how many checkboxes will be displayed on each line. TheValuefield should be a comma-separated list of item labels.-
Typecheckbox+buttonswill add Set and Clear buttons to the basiccheckboxtype.
-
-
Typeradiois likecheckboxexcept that radio buttons are mutually exclusive; only one can be selected. -
Typelabelspecifies read-only label text. TheValuefield should contain the text of the label. -
Typeselectspecifies a select box. TheValuefield should contain a comma-separated list of options for the box. TheSizefield can specify a fixed size for the box (e.g.1, or a range e.g.3..10. If you specify a range, then the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options.- There are two modifiers that can be applied to the
selecttype:-
select+multiturns multiselect on for the select, to allow Shift+Click and Ctrl+Click to select (or deselect) multiple items. -
select+valuesallows the definition of values that are different to the displayed text. For example:| Field 9 | select+values | 5 | One, Two=2, Three=III, Four | Various values formats |
shows but the values or optionsTwoandThreeare2andIIIrespectively.
You can combine these modifiers e.g.select+multi+values
-
- There are two modifiers that can be applied to the
-
Typetextspecifies a one-line text field.Sizespecifies the text box width in number of characters.Valueis the initial (default) content when a new topic is created with this form template. -
Typetextareaspecifies a multi-line text box. TheSizefield should specify columns x rows, e.g.80x6; default size is 40x5. As fortext, theValuefield specifies the initial text -
Typedatespecifies a single-line text box and a button next to it; clicking on the button will bring up a calendar from which the user can select a date. The date can also be typed into the text box.Sizespecifies the text box width in characters. As fortext, theValuefield specifies the initial text
Tooltip message is a message that will be displayed when the cursor is hovered over the field in edit view.
Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces. - An attribute
Hindicates that this field should not be shown in view mode. However, the field is available for editing and storing information. - An attribute
Mindicates 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 anoopspage. Mandatory fields are indicated by an asterisks next to the field name.
| *Name* | *Type* | *Size* | | Name | text | 80 | | Date | date | 30 |Field Name Notes:
- Field names have to be unique.
- 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.
- You can space out the title of the field, and it will still find the topic e.g.
Aeroplane Manufacturersis equivalent toAeroplaneManufacturers. - If a
labelfield has no name, it will not be shown when the form is viewed, only when it is edited. - Field names can in theory include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a
select,checkboxorradiofield, 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 a name other than the topic name is required as the name of the field. - Leading and trailing spaces are not significant.
- 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, andtextareafields the value may also contain commas.checkboxfields cannot be initialized through the form template. - Leading and trailing spaces are not significant.
- Field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.
- Variables in the initial values of a form definition get expanded when the form definition is loaded.
- If you want to use a
|character in the initial values field, you have to precede it with a backslash, thus:\|. - You can use
<nop>to prevent TWiki variables from being expanded. - The FormatTokens can be used to prevent expansion of other characters.
- If you want to use a
- The topic definition is not read when a topic is viewed.
- 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.
Values in Other Topics
As described above, you can also retrieve possible values for select, checkbox or radio types from other topics. For example, if you have a rows defined like this:| *Name* | *Type* | *Size* | | AeroplaneManufacturers | select | |the TWiki will look for the topic AeroplaneManufacturers to get the possible values for the
select.
The AeroplaneManufacturers topic must contain a table, where each row of the table describes a possible value. The table only requires one column, Name. Other columns may be present, but are ignored.
For example:
| *Name* | | Routan | | Focke-Wulf | | De Havilland |Notes:
- The
Valuescolumn must be empty in the referring form definition.
Extending the range of form data types
You can extend the range of data types accepted by forms by using TWikiPlugins. All such extended data types are single-valued (can only have one value) with the following exceptions:- any type name starting with
checkbox - any type name with
+multianywhere in the name
Hints and Tips
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
SubmitExpenseReporttopic where you can create new expense reports, aSubmitVacationRequesttopic, and so on. These can specify the required template topic with its associated form. Template topics has more.
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.
ExampleSearching forms this way is obviously pretty inefficient, but it's easy to do. If you want better performance, take a look at some of the structured wiki extensions that support higher performance searching e.g. TWiki:Plugins.DBCachePlugin.
TWiki users often want to have an overview of topics they contributed to. With the$formfieldparameter it is easy to display the value of a classification field next to the topic link:| *Topic* | *Classification* | %SEARCH{"%USERSWEB%.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" format="|<b>[[$web.$topic][$topic]]</b> |<nop>$formfield(TopicClassification) |" web="Sandbox"}%
Gotcha!
- Some browsers may strip linefeeds from
textfields when a topic is saved. If you need linefeeds in a field, make sure it is atextarea.
TWiki Templates
Definition of the templates used to render all HTML pages displayed in TWikiOverview
Templates are plain text with embedded template directives that tell TWiki how to compose blocks of text together, to create something new. There are two types of template:- Master Templates: Define the HTML used to display TWiki pages.
- Template Topics: Define default text when you create a new topic
Tip: TWiki:TWiki.TWikiTemplatesSupplement on TWiki.org has supplemental documentation on TWiki templates.
Master Templates
TWiki uses master 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. Master templates are also used in the definition of TWikiSkins. Master templates are stored as text files with the extension.tmpl. They are usually HTML with embedded template directives. The directives are expanded when TWiki wants to generate a user interface screen.
How Template Directives Work
- 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. All text between this and the next%TMPL:END%directive is removed and saved for later use with%TMPL:P. -
%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.tmplmaster template, liketwiki.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: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
The master templates shipped with a twiki release are stored in the twiki/templates directory. As an example,twiki/templates/view.tmpl is the default template file for the twiki/bin/view script.
You can save templates in other directories as long as they are listed in the {TemplatePath} configuration setting. The {TemplatePath} is defined in the Miscellaneous section of the configure page.
You can also save templates in user topics. The {TemplatePath} configuration setting defines which topics will be accepted as templates.
Templates that are included with an explicit '.tmpl' extension are looked for only in the templates/ directory. For instance %TMPL:INCLUDE{"example.tmpl"}% will only return templates/example.tmpl, regardless of {TemplatePath} and SKIN settings.
The out-of-the-box setting of {TemplatePath} supports the following search order to determine which template file or topic to use for a particular script or %TMPL:INCLUDE{"script"}% statement. The skin path is set as described in TWikiSkins.
- 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.
-
- templates/script.skin.tmpl for each skin on the skin path
- templates/web/script.tmpl
- this usage is supported for compatibility only and is deprecated. Store web-specific templates in TWiki topics instead.
-
- templates/script.tmpl
- The TWiki topic aweb.atopic if the template name can be parsed into aweb.atopic
- The TWiki topic web.SkinSkinScriptTemplate for each skin on the skin path
- The TWiki topic web.ScriptTemplate
- The TWiki topic %SYSTEMWEB%.SkinSkinScriptTemplate for each skin on the skin path
- The TWiki topic %SYSTEMWEB%.ScriptTemplate
- 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
example template file will be searched for in the following places, when the current web is Thisweb and the skin path is print,pattern:
-
templates/Thisweb/example.print.tmpldeprecated; don't rely on it -
templates/Thisweb/example.pattern.tmpldeprecated; don't rely on it -
templates/example.print.tmpl -
templates/example.pattern.tmpl -
templates/Thisweb/example.tmpldeprecated; don't rely on it -
templates/example.tmpl -
Thisweb.PrintSkinExampleTemplate -
Thisweb.PatternSkinExampleTemplate -
Thisweb.ExampleTemplate -
TWiki.PrintSkinExampleTemplate -
TWiki.PatternSkinExampleTemplate -
TWiki.ExampleTemplate
view and edit scripts, for example when a topic-specific template is required. Two preference variables can be used to override the templates used: -
VIEW_TEMPLATEsets the template to be used for viewing a topic -
EDIT_TEMPLATEsets the template for editing a topic.
view and edit respectively. The template search order is as specified above.
TMPL:INCLUDE recursion for piecewise customisation, or mixing in new features
If there is recursion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains%TMPL:INCLUDE{"twiki"}%, the templating system will include the next twiki.SKIN in the skin path.
For example, to create a customisation of pattern skin, where you only want to over-ride the breadcrumbs for the view script, you can create only a view.yourlocal.tmpl:
%TMPL:INCLUDE{"view"}%
%TMPL:DEF{"breadcrumb"}% We don't want any crumbs %TMPL:END%
and then set SKIN=yourlocal,pattern
The default {TemplatePath} will not give you the desired result if you put these statements in the topic Thisweb.YourlocalSkinViewTemplate. The default {TemplatePath} will resolve the request to the template/view.pattern.tmpl, before it gets to the Thisweb.YourlocalSkinViewTemplate resolution. You can make it work by prefixing the {TemplatePath} with: $web.YourlocalSkin$nameTemplate.
Default master template
twiki.tmpl is the default master template. It defines the following sections.
| 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 |
Template Topics
The second type of template in TWiki are template topics. Template topics define the default text for new topics. There are three types of template topic:| Topic Name: | What it is: |
|---|---|
| WebTopicViewTemplate | Alert page shown when you try to view a nonexistent topic. This page is usually used as a prompt to help you create a new topic. |
| WebTopicNonWikiTemplate | Alert page shown when you try to view a nonexistent topic with a non-WikiName. Again, this page is used as a prompt to help you create the new topic. |
| WebTopicEditTemplate | Default text used in a new topic. |
edit script, TWiki locates a topic to use as a content template according to the following search order: - A topic name specified by the
templatetopicCGI parameter- if no web is specified, the current web is searched first and then the TWiki web
- WebTopicEditTemplate in the current web
- WebTopicEditTemplate in the TWiki web
Variable Expansion
When the following variables are used in a template topic, they automatically get expanded when new topic is created based on it:| Variable: | Description: |
|---|---|
%DATE% |
Signature format date. See VarDATE |
%GMTIME% |
Date/time. See VarGMTIME |
%GMTIME{...}% |
Formatted date/time. See 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, such as %URLPA%NOP%RAM{...}% escaping URLPARAM |
%STARTSECTION{type="templateonly"}% |
Text that gets removed when a new topic based on the template is created. See notes below. |
%SERVERTIME% |
Date/time. See VarSERVERTIME |
%SERVERTIME{...}% |
Formatted date/time. See 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. TWikiGuest |
%WIKIUSERNAME% |
User name of user who is instantiating the new tpoic, e.g. Main.TWikiGuest |
%STARTSECTION{type="templateonly"}%
...
%ENDSECTION{type="templateonly"}% markers are used to embed text that you do not want expanded when a new topic based on the template topic is created. For example, you might want to write in the template topic:
%STARTSECTION{type="templateonly"}%
This template can only be changed by:
* Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
%ENDSECTION{type="templateonly"}%
This will restrict who can edit the template topic, but will get removed when a new topic based on that template topic is created.
%NOP% can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape %SERVERTIME% with %SER%NOP%VERTIME%.
All other variables are unchanged, e.g. are carried over "as is" into the new topic.
Specifying a Form
When you create a new topic based on a template, you often want the new topic to have a form attached to it. You can attach a form to the template topic, in which case it will be copied into the new topic. Sometimes this isn't quite what you want, as it copies all the existing data from the template topic into the new topic. To avoid this and use the default values specified in the form definition instead, you can use theformtemplate CGI parameter to the edit script to specify the name of a form to attach.
See TWikiScripts for information about all the other parameters to edit.
Automatically Generated Topic Names
For TWiki applications it is useful to be able to automatically generate unique topicnames, such as BugID0001, BugID0002, etc. You can addAUTOINC<n> to the topic name in the edit and save scripts, and it will be replaced with an auto-incremented number on topic save. <n> is a number starting from 0, and may include leading zeros. Leading zeros are used to zero-pad numbers so that auto-incremented topic names can sort properly. Deleted topics are not re-used to ensure uniqueness of topic names. That is, the auto-incremented number is always higher than the existing ones, even if there are gaps in the number sequence.
Examples: -
BugAUTOINC0- creates topic namesBug0,Bug1,Bug2, ... (does not sort properly) -
ItemAUTOINC0000- creates topic namesItem0000,Item0001,Item0002, ... (sorts properly up to 9999) -
DocIDAUTOINC10001- start withDocID10001,DocID10002, ... (sorts properly up to 99999; auto-links)
[[%SCRIPTURLPATH{edit}%/%WEB%/BugIDAUTOINC00001?templatetopic=BugTemplate;topicparent=%TOPIC%;t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]]
Template Topics in Action
Here is an example for creating new topics (in the Sandbox web) based on a specific template topic and form: The above form asks for a topic name. A hidden input tag namedtemplatetopic specifies ExampleTopicTemplate as the template topic to use. Here is the HTML source of the form:
<form name="new" action="%SCRIPTURLPATH{edit}%/Sandbox/">
* New example topic:
<input type="text" name="topic" value="ExampleTopicAUTOINC0001" size="30" />
<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" />
</form>
See TWikiScripts#edit 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%
Using Absolute vs Relative URLs in Templates
When you use TWikiVariables such as %PUBURL% and %PUBURLPATH% in templates you should be aware that using %PUBURL% instead of %PUBURLPATH% puts absolute URLs in the produced HTML. This means that when a user saves a TWiki page in HTML and emails the file to someone outside a company firewall, the receiver has a severe problem viewing it. It is therefore recommended always to use the %PUBURLPATH% to refer to images, CSS, Javascript files etc so links become relative. This way browsers just give up right away and show a usable html file. Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory Back to topTWiki Skins
Skins overlay regular templates to give different looks and feels to TWiki screens.Overview
TWiki uses TWikiTemplates files as the basis of all the screens it uses to interact with users. Each screen has an associated template file that contains the basic layout of the screen. This is then filled in by the code to generate what you see in the browser. TWiki ships with a default set of template files that give a very basic, CSS-themable, look-and-feel. TWiki also includes support for skins that can be selected to give different, more sophisticated, look and feels. A default TWiki installation will usually start up with the PatternSkin already selected. Skins may also be defined by third parties and loaded into a TWiki installation to give more options. To see how TWiki looks when no skin is selected, view this topic with a non-existant skin. Topic text is not affected by the choice of skin, though a skin can be defined to use a CSS (Cascading Style Sheet), which can sometimes give a radically different appearance to the text. Relevant links on TWiki.org:- TWiki:TWiki.TWikiSkinsSupplement - tip: supplemental documentation on TWiki skins
- TWiki:Plugins.SkinPackage - list of all contributed skin packages
- TWiki:Plugins.SkinDevelopment - discussion and feedback on contributed skins
- TWiki:Plugins.SkinBrainstorming - open forum for new skin ideas
- TWiki:Plugins.SkinPackageHowTo - template to create a new skin package
Changing the default TWiki skin
TWiki default ships with the skin PatternSkin activated. You can set the skin for the whole site, a single web or topic, or for each user individually, by setting the SKIN variable to the name of a skin. If the skin you select doesn't exist, then TWiki will pick up the default templates.Defining Skins
You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share. There are a couple of places you an start doing this. The TWikiTemplates files used for skins are located in thetwiki/templates directory and are named according to the skin: <scriptname>.<skin>.tmpl. Skin files may also be defined in TWiki topics - see TWikiTemplates for details.
To start creating a new skin, copy the default TWikiTemplates (like view.tmpl), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as TWiki can be configured to fall back to another skin if a template is not defined in your skin. Name the files as described above (for example view.myskin.tmpl.
If you use PatternSkin as your starting point, and you want to modify the layout, colors or even the templates to suit your own needs, have a look first at the topics PatternSkinCustomization and PatternSkinCssCookbook.
For your own TWiki skin you are encouraged to show a small 80x31 pixel 
logo at the bottom of your skin:
<a href="http://twiki.org/"><img src="%PUBURL%/%SYSTEMWEB%/TWikiLogos/T-logo-80x15.gif" alt="This site is powered by the TWiki collaboration platform" width="80" height="15" title="This site is powered by the TWiki collaboration platform" border="0" /></a>
The standard TWiki skins show the logo in the %WEBCOPYRIGHT% variable.
Note: Two skin names have reserved meanings; text skin, and skin names starting with rss have hard-coded meanings.
The following template files are used for TWiki screens, and are referenced in the TWiki core code. If a skin doesn't define its own version of a template file, then TWiki will fall back to the next skin in the skin path, or finally, to the default version of the template file.
(Certain template files are expected to provide certain TMPL:DEFs - these are listed in sub-bullets) -
addform- used to select a new form for a topic -
attachagain- used when refreshing an existing attachment -
attachnew- used when attaching a new file to a topic -
attachtables- defines the format of attachments at the bottom of the standard topic view-
ATTACH:files:footer,ATTACH:files:header,ATTACH:files:row,ATTACH:versions:footer,ATTACH:versions:header,ATTACH:versions:row
-
-
changeform- used to change the form in a topic -
changes- used by thechangesscript -
edit- used for the edit screen -
form -
formtables- used to defined the format of forms-
FORM:display:footer,FORM:display:header,FORM:display:row
-
-
login- used for loggin in when using the TemplateLoginManager-
LOG_IN,LOG_IN_BANNER,LOG_OUT,LOGGED_IN_BANNER,NEW_USER_NOTE,UNRECOGNISED_USER
-
-
moveattachment- used when moving an attachment -
oopsaccessdenied- used to format Access Denied messages-
no_such_topic,no_such_web,only_group,topic_access
-
-
oopsattention- used to format Attention messages-
already_exists,bad_email,bad_ver_code,bad_wikiname,base_web_missing,confirm,created_web,delete_err,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,upload_name_changed,web_creation_error,web_exists,web_missing,wrong_password,zero_size_upload
-
-
oopschangelanguage- used to prompt for a new language when internationalisation is enabled -
oopsgeneric- a basic dialog for user information; provides "ok" button only -
oopslanguagechanged- used to confirm a new language when internationalisation is enabled -
oopsleaseconflict- used to format lease Conflict messages-
lease_active,lease_old
-
-
preview- used for previewing edited topics before saving -
rdiff- used for viewing topic differences -
registernotify- used by the user registration system -
registernotifyadmin- used by the user registration system -
rename- used when renaming a topic -
renameconfirm- used when renaming a topic -
renamedelete- used when renaming a topic -
renameweb- used when renaming a web -
renamewebconfirm- used when renaming a web -
renamewebdelete- used when renaming a web -
searchbookview- used to format inline search results in book view -
searchformat- used to format inline search results -
search- used by thesearchCGI script -
settings -
view- used by theviewCGI script -
viewprint- used to create the printable view
twiki.tmpl is a master template conventionally used by other templates, but not used directly by code.
Note: It is best to create these templates for your skin. If you TMPL:INCLUDE the default templates, or templates from other skins, when you are defining your own skin, you run the risk that the included file might change and break your skin.
Partial customisation, or adding in new features to an existing skin
You can use recusion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains%TMPL:INCLUDE{"twiki"}%, the templating system will include the next twiki.SKIN in the skin path.
For example, to create a customisation of pattern skin, where you only want to remove the edit & WYSIWYG buttons from view page, you create only a view.yourlocal.tmpl:
%TMPL:INCLUDE{"view"}%
%TMPL:DEF{"edit_topic_link"}%%TMPL:END%
%TMPL:DEF{"edit_wysiwyg_link"}%%TMPL:END%
and then set SKIN=yourlocal,pattern.
Because ClassicSkin and the default templates use the same Template definition names, you can over-ride the edit links in them (or any skin derived from them) using the same view.yourlocal.tmpl (just set SKIN=yourlocal,classic either in TWikiPreferences for globally, or a Web's Webname.WebPreferences for a particular web)
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. |
%TOPIC% |
The name of the current topic. |
%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 - TWikiGuest |
%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 default skins include a "Go" box, also called "Jump" box, to jump to a topic. The box also understands URLs, e.g. you can typehttp://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 onchange 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:
Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous, {AllowRedirectUrl}).
Using Cascading Style Sheets
CSS files are gererally attachments to the skin topic that are included in the the skin templates - in the case of PatternSkin in the templatestyles.pattern.tmpl.
- To see how CSS is used in the default TWiki skin, see: PatternSkin
- If you write a complete new skin, this is the syntax to use in a template file:
<style type='text/css' media='all'>@import url('%PUBURLPATH%/%SYSTEMWEB%/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 theattachtables.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 |
| 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 |
ATTACH:row macros are expanded for each file in the attachment table, using the following special tags:
| Tag | Description |
|---|---|
%A_URL% |
viewfile 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. To get the 'pub' url of the file, use %PUBURL%/%WEB%/%TOPIC%/%A_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 |
Packaging and Publishing Skins
See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQBrowsing 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 calledview.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
?skin=catskin,bearskin:
Setting SKIN (or the ?skin parameter in the URL) replaces the existing skin path setting, for the current page only. You can also extend the existing skin path as well, using covers.
-
Set COVER = ruskin
ruskin, catskin, bearskin). There is also an equivalent cover URL parameter. The difference between setting SKIN vs. COVER is that if the chosen template is not found (e.g., for included templates), SKIN will fall back onto the next skin in line, or the default skin, if only one skin was present, while COVER will always fall back onto the current skin.
An example would be invoking the printable mode, which is achieved by applying ?cover=print. The view.print.tmpl simply invokes the viewprint template for the current skin which then can appropriately include all other used templates for the current skin. Where the printable mode be applied by using SKIN, all skins would have the same printable appearance.
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
Thetext 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: TWikiSkinBrowser, AdminDocumentationCategory, DeveloperDocumentationCategory, TWiki:TWiki.TWikiSkinsSupplement
-- Contributors: TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.CrawfordCurrie
Back to top
TWiki Meta Data
Additional topic data, program-generated or from TWikiForms, is stored embedded in the topic text usingMETA: tags
Overview
By default, TWiki stores topics in files on disk, in a really simple and obvious directory structure. The big advantage of this approach is that it makes it really easy to manipulate topics from outside TWiki, and is also very safe; there are no complex binary indexes to maintain, and moving a topic from one TWiki to another is as simple as copying a couple of text files. To keep eveything together in one place, TWiki uses a simple method for embedding additional data (program-generated or from TWikiForms) in topics. It does this usingMETA: tags.
META: data includes program-generated info like FileAttachment and topic movement data, and user-defined TWikiForms info.
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.
- Values in meta-data are URL encoded so that characters such as \n can be stored.
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 |
- 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, typically when clicking on a ? questionmark link, or by filling out a form. Normally just TopicName, but it can be a full Web.TopicName format if the parent is in a different Web. |
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 |
| Key | Comment |
|---|---|
| movedfrom | full topic name - web.topic |
| movedby | the REMOTE_USER, not WikiName |
| movedto | full topic name - web.topic |
| moveddate | integer, unix time, seconds since start 1970 |
META:FORM
| Key | Comment |
|---|---|
| name | A topic name - the topic represents one of the TWikiForms. Can optionally include the web name (i.e., web.topic), but doesn't normally |
META:FIELD
Should only be present if there is a META:FORM entry. Note that this data is used when viewing a topic, the form template definition is not read.| Key | Name |
|---|---|
| name | Ties to entry in TWikiForms template, is title with all bar alphanumerics and . removed |
| title | Full text from TWikiForms template |
| value | Value user has supplied via form |
Recommended Sequence
There is no absolute need for Meta Data variables to be listed in a specific order within a topic, but it makes sense to do so a couple of good reasons:- form fields remain in the order they are defined
- the
difffunction output appears in a logical order
-
META:TOPICINFO -
META:TOPICPARENT(optional) - text of topic
-
META:TOPICMOVED(optional) -
META:FILEATTACHMENT(0 or more entries) -
META:FORM(optional) -
META:FIELD(0 or more entries; FORM required)
Viewing Meta Data in Page Source
When viewing a topic theRaw Text link can be clicked to show the text of a topic (i.e., as seen when editing). This is done by adding raw=on to URL. raw=debug shows the meta data as well as the topic data, ex: debug view for this topic
Rendering Meta Data
Meta Data is rendered with the %META% variable. This is mostly used in theview, preview and edit scripts.
You can render form fields in topic text by using the FORMFIELD variable. Example:%FORMFIELD{"TopicClassification"}% For details, see VarFORMFIELD. Current support covers:
| Variable usage: | Comment: |
|---|---|
%META{"form"}% |
Show form data, see TWikiForms. |
%META{"formfield"}% |
Show form field value. Parameter: name="field_name". Example:%META{ "formfield" name="TopicClassification" }% |
%META{"attachments"}% |
Show attachments, except for hidden ones. Options: all="on": Show all attachments, including hidden ones. |
%META{"moved"}% |
Details of any topic moves. |
%META{"parent"}% |
Show topic parent. Options: dontrecurse="on": By default recurses up tree, at some cost. nowebhome="on": Suppress WebHome. prefix="...": Prefix for parents, only if there are parents, default "". suffix="...": Suffix, only appears if there are parents, default "". separator="...": Separator between parents, default is " > ". |
TWiki Add-Ons
Add functionality to TWiki with extensions not based on the TWiki scripts.Overview
An add-on runs separately from the TWiki scripts, e.g. for data import, export to static HTML, etc. Add-Ons normally do not call any TWiki code directly, though may invoke TWiki scripts. There are different types of add-ons, they may be stand alone scripts, browser plugins, office tool extensions, or even a set of TWiki topics that form a TWiki application. Relevant links on TWiki.org:- TWiki:Plugins.AddOnPackage - list of all contributed add-on scripts
- TWiki:Plugins.AddOnDevelopment - discussion and feedback on contributed add-on scripts
- TWiki:Plugins.AddOnBrainstorming - open forum for new add-on script ideas
- TWiki:Plugins.AddOnPackageHowTo - instructions and template to create a new add-on topic
Add-Ons Installed on this TWiki
- CompareRevisionsAddOn: - version 07 Nov 2007
Author: TWiki:Main/JChristophFuchs - last modified: r1 - 13 Apr 2006 - 21:17 - TWikiContributor - GenPDFAddOn: Generate a PDF from a single TWiki page - version 2 Nov 2007
Author: TWiki:Main/BrianSpinar, TWiki:Main/WadeTurland - last modified: r0 - 28 Jun 2005 - 01:49 - TWikiContributor - MediaWikiToTWikiAddOn: MediaWiki 2 TWiki Conversion Tool - version v1.0
Author: TWiki:Main.MichaelDaum - last modified: r0 - 20 Jul 2007 - 21:10 - TWikiContributor - SearchEnginePluceneAddOn: - version v3.1
Author: TWiki:Main/SopanShewale, TWiki:Main/JoanMVigo, TWiki:Main/MichaelDaum - last modified: r0 - 13 Sep 2007 - 19:06 - TWikiContributor - TWikiWorkbenchAddOn: IDE for TWikiApplications - version v0.6
Author: TWiki:Main.MichaelDaum - last modified: r0 - 05 Mar 2007 - 00:18 - TWikiContributor
Found 5 topic(s).
Installing Add-Ons
- Download an add-on from TWiki:Plugins.AddOnPackage.
- Follow the installation instructions in the add-on topic.
Creating new Add-Ons
- Visit TWiki:Plugins.AddOnPackageHowTo and follow the instructions.
TWiki Contribs
Reusable code that may be used over several plugins and add-ons.Overview
TWiki contribs extend the functionality of TWiki, typically used by plugins and add-ons. They may also provide alternative implementations for sections of the TWiki core e.g. user management, or when an extension just can't be implemented as a plugin because it requires very close access to TWiki internals. Relevant links on TWiki.org:- TWiki:Plugins.ContribPackage - list of all contributed contrib packages
- TWiki:Plugins.ContribDevelopment - discussion and feedback on contributed packages
- TWiki:Plugins.ContribBrainstorming - open forum for new contrib ideas
- TWiki:Plugins.ContribPackageHowTo - instructions and template to create a new contrib package
TWiki Contribs Installed on this TWiki
- BehaviourContrib:
BehaviourJavascript event library to create javascript based interactions that degrade well when javascript is not available - version %$VERSION%
Author: TWiki:Main.ArthurClemens - last modified: r1 - 08 Jul 2007 - 18:54 - TWikiContributor - BenchmarkContrib: Web/TWiki based performance measurement tool for TWiki - version %$VERSION%
Author: TWiki:Main/HaraldJoerg - last modified: r1 - 09 Oct 2006 - 10:40 - TWikiGuest - BuildContrib: Automate build process for Plugins, Add-ons and Contrib modules - version %$VERSION%
Author: TWiki:Main.CrawfordCurrie - last modified: r1 - 01 Feb 2008 - 16:52 - TWikiGuest - DBCacheContrib: Reusable code that treats TWiki forms as if they were table rows in a database - version %$VERSION%
Author: TWiki:Main/CrawfordCurrie - last modified: r1 - 05 Feb 2008 - 20:11 - TWikiGuest - ExampleHeaderArtContrib: Some random images from my travels - version %$VERSION%
Author: TWiki:Main/WillNorris - last modified: r1 - 14 Nov 2007 - 13:31 - TWikiGuest - FuncUsersContrib: EXPERTS ONLY Proposed API for user access, for use with TWiki-4.0.x - version %$VERSION%
Author: TWiki:Main/CrawfordCurrie http://www.c-dot.co.uk - last modified: r1 - 06 Dec 2007 - 20:06 - TWikiGuest - JSCalendarContrib: Mishoo JSCalendar, packaged for use by plugins, skins and add-ons. - version %$VERSION% of the Mishoo calendar
Author: TWiki:Main/CrawfordCurrie http://c-dot.co.uk - last modified: r1 - 14 Nov 2007 - 13:29 - TWikiGuest - KupuContrib: Integration of the OSCOM Kupu WYSIWYG editor with TWiki. - version %$VERSION%
Author: TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk (from original work by TWiki:Main.RomainRaugi, TWiki:Main.DamienMandrioli, TWiki:Main.FredericLuddeni, and TWiki:Main.ColasNahaboo) - last modified: r1 - 06 Dec 2007 - 20:07 - TWikiGuest - LdapContrib: LDAP services for TWiki - version v2.99.4
Author: TWiki:Main/MichaelDaum - last modified: r0 - 22 Nov 2007 - 14:25 - TWikiContributor - MailInContrib: Supports submissions to TWiki via e-mail - version %$VERSION%
Author: TWiki:Main/CrawfordCurrie (http://c-dot.co.uk) - last modified: r1 - 06 Dec 2007 - 20:06 - TWikiGuest - MailerContrib: Supports e-mail notification of changes. - version %$VERSION%
Author: TWiki:Main/CrawfordCurrie (http://c-dot.co.uk) - last modified: r1 - 29 Jan 2008 - 13:55 - TWikiGuest - NatEditContrib: A Wikiwyg Editor - version v2.00-pre1
Author: TWiki:Main/MichaelDaum - last modified: r0 - 04 Apr 2007 - 14:16 - TWikiContributor - PubAccessContrib: Using TWiki's ACLs to secure topic attachments security - version 1.0
Author: TWiki:Main/MichaelDaum - last modified: r0 - 15 Jun 2007 - 15:32 - TWikiContributor - PublishContrib: Generate static output (HTML, PDF) for a TWiki Web and optionally upload (FTP) the output to a publishing site. - version %$VERSION%
Author: TWiki:Main/CrawfordCurrie, TWiki:Main/EricScouten, TWiki:Main.SvenDowideit, TWiki:Main.MartinCleaver - last modified: r2 - 28 Nov 2006 - 14:28 - MichaelDaum - RatingContrib: Rating widget for TWiki forms - version %$VERSION%
Author: - last modified: r1 - 14 Nov 2007 - 13:29 - TWikiGuest - RtfContrib: Extension to translate TWiki markup to RTF - version v0.50
Author: - last modified: r1 - 26 Mar 2008 - 21:02 - TWikiGuest - SoleilContrib: NatSkin theme based on Soleil theme for MovalbleType - version v1.0
Author: Michael Daum http://wikiring.de - last modified: r0 - 29 Mar 2007 - 22:28 - TWikiContributor - TWikiUserMappingContrib: Traditional TWikiTopic based mapping and user management - version 4.2.0
Author: - last modified: r1 - 01 Oct 2007 - 19:31 - TWikiGuest - TdbContrib: TDB is the tiny database from the Samba project. This contrib bundles it to make it easily installable for use with other TWiki extensions. - version %$VERSION% build %$DATE%
Author: TWiki:Main/CrawfordCurrie http://c-dot.co.uk - last modified: r1 - 09 Oct 2006 - 10:41 - TWikiGuest - TwistyContrib: Twisty section javascript library to open/close content dynamically - version 20 Jun 2007 (version 1.4.1)
Author: JavaScript written by TWiki:Main.ArthurClemens; Contrib packaged by TWiki:Main.RafaelAlvarez; original JavaScript written by TWiki:Main.SamHasler. - last modified: r0 - 22 Feb 2006 - 09:42 - TWikiContributor - UnitTestContrib: TWiki Unit-Test Framework - version %$VERSION%
Author: - last modified: r1 - 14 Nov 2007 - 13:29 - TWikiGuest - XmlRpcContrib: XML-RPC services for TWiki - version v0.03
Author: TWiki:Main/MichaelDaum - last modified: r0 - 13 Jun 2002 - 07:54 - TWikiContributor - YahooUserInterfaceContrib: Yahoo User Interface AJAX library packaged as a contrib for plugins and TWiki application - version %$VERSION%
Author: TWiki:Main.SvenDowideit - SvenDowideit@DistributedINFORMATION.com DistributedINFORMATION - a
WikiRing.com partner - last modified: r1 - 14 Nov 2007 - 13:31 - TWikiGuest
Found 23 topic(s).
Installing Contribs
- Download an add-on from TWiki:Plugins.ContribPackage.
- Follow the installation instructions in the contrib topic.
Creating new Contribs
- Visit TWiki:Plugins.ContribPackageHowTo and follow the instructions.
TWiki Plugins
Add functionality to TWiki with readily available Plugins; create Plugins based on APIsOverview
You can add Plugins to extend TWiki functionality, without altering the core code. A plug-in approach lets you:- add virtually unlimited features while keeping the main TWiki code compact and efficient;
- heavily customize an installation and still do clean updates to new versions of TWiki;
- rapidly develop new TWiki functions in Perl using the Plugin API.
- TWiki:TWiki.TWikiPluginsSupplement - tip: supplemental documentation on TWiki plugins
- TWiki:Plugins.PluginPackage - list of all contributed plugin packages
- TWiki:Plugins.PluginDevelopment - discussion and feedback on contributed plugins
- TWiki:Plugins.PluginBrainstorming - open forum for new plugin ideas
- TWiki:Plugins.PluginPackageHowTo - template to create a new plugin package
Installing Plugins
Each TWiki Plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many Plugins have an install script that automates these steps for you. Special Requirements: Some Plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, and templates. You should be able to find detailed instructions in the Plugin's documentation. Each Plugin has a standard release topic, located in the TWiki:Plugins web at TWiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.On-Site Pretesting
The recommended approach to testing new Plugins before making them public is to create a second local TWiki installation, and test the Plugin there. You can allow selected users access to the test area. Once you are satisfied that it won't compromise your main installation, you can install it there as well. InstalledPlugins shows which Plugins are: 1) installed, 2) loading properly, and 3) what TWiki:Codev.PluginHandlers they invoke. Any failures are shown in the Errors section. The%FAILEDPLUGINS% variable can be used to debug failures. You may also want to check your webserver error log and the various TWiki log files.
Some Notes on Plugin Performance
The performance of the system depends to some extent on the number of Plugins installed and on the Plugin implementation. Some Plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). You can only really tell the performance impact by installing the Plugin and by measuring the performance with and without the new Plugin. Use the TWiki:Plugins.PluginBenchmarkAddOn, or test manually with the Apacheab utility. Example on Unix:time wget -qO /dev/null /TWiki/AbcPlugin
If you need to install an "expensive" Plugin, but you only need its functionality only in a subset of your data, you can disable it elsewhere by defining the %DISABLEDPLUGINS% TWiki variable.
Define DISABLEDPLUGINS to be a comma-separated list of names of plugins to disable. Define it in Main.TWikiPreferences to disable those plugins everywhere, in the WebPreferences topic to disable them in an individual web, or in a topic to disable them in that topic. For example,
* Set DISABLEDPLUGINS = SpreadSheetPlugin, EditTablePlugin
Managing Installed Plugins
Some Plugins require additional settings or offer extra options that you have to select. Also, you may want to make a Plugin available only in certain webs, or temporarily disable it. And may want to list all available Plugins in certain topics. You can handle all of these management tasks with simple procedures:Enabling Plugins
Plugins can be enabled and disabled with the configure script. An installed Plugin needs to be enabled before it can be used.Plugin Evaluation Order
By default, TWiki executes Plugins in alphabetical order on Plugin name. It is possible to change the order, for example to evaluate database variables before the spreadsheet CALCs. This can be done with{PluginsOrder} in the Plugins section of configure.
Plugin-Specific Settings
Plugins are usually configured by variables accessible though the configure interface, but in some cases (usually older plugins) TWiki preferences are used. If a TWiki variable is defined in a Plugin topic e.g:- Set SETTING = Create dynamic foo bar reports
%<pluginname>_<var>%. For example, %RUBBERPLUGIN_SETTING% shows the value of SETTING in the RubberPlugin topic.
Listing Active Plugins
Plugin status variables let you list all active Plugins wherever needed. This site is running TWiki version TWiki-5.0.0, Wed, 23 Jan 2008, build 16283, Plugin API version 1.2 %ACTIVATEDPLUGINS%
On this TWiki site, the enabled Plugins are: GluePlugin, IfDefinedPlugin, SpreadSheetPlugin, AliasPlugin, AutoViewTemplatePlugin, BlogPlugin, BreadCrumbsPlugin, ClassificationPlugin, CommentPlugin, DBCachePlugin, EditChapterPlugin, EmployeePortalPlugin, FilterPlugin, FlexWebListPlugin, HeadlinesPlugin, ImageGalleryPlugin, ImagePlugin, InterwikiPlugin, JQueryPlugin, JQueryTwistyPlugin, LdapNgPlugin, LocalTimePlugin, MathModePlugin, MediaWikiTablePlugin, NatSkinPlugin, PaginationPlugin, PingBackPlugin, RedDotPlugin, SetVariablePlugin, SmiliesPlugin, TablePlugin, TagCloudPlugin, TimeSincePlugin, UserInfoPlugin, VotePlugin.
%PLUGINDESCRIPTIONS%
- GluePlugin (2.00, $Rev$): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev$): Render content conditionally
- SpreadSheetPlugin (any TWiki, 15269): Add spreadsheet calculation like
"$SUM( $ABOVE() )"to TWiki tables and other topic text - AliasPlugin (2.20, 15573): Define aliases which will be replaced with arbitrary strings automatically
- AutoViewTemplatePlugin (ipo, $Rev$): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
- BlogPlugin (0.99, $Rev$): Basic blogging features used to implement the BlogUp TWikiApplication
- BreadCrumbsPlugin (v2.00, $Rev$): A flexible way to display breadcrumbs navigation
- ClassificationPlugin (0.50, $Rev$): A topic classification plugin and application
- CommentPlugin (TWiki-4, 14241): Allows users to quickly post comments to a page without an edit/preview/save cycle
- DBCachePlugin (1.80, $Rev$): Lightweighted frontend to the DBCacheContrib
- EditChapterPlugin (1.13, $Rev$): An easy sectional edit facility
- EmployeePortalPlugin (v2.0-pre1, $Rev$): EmployeePortal extensions
- FilterPlugin (1.41, $Rev$): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.22, $Rev$): Flexible way to display hierarchical weblists
- HeadlinesPlugin (2.12, 15564): Build news portals that show headline news based on RSS news feeds from news sites.
- ImageGalleryPlugin (3.70, 15576): Displays image gallery with auto-generated thumbnails from attachments
- ImagePlugin (1.1, $Rev$): Control the display and alignment of images using an easy syntax
- InterwikiPlugin (Dakar, $Rev: 14913 (17 Sep 2007) $): Link
ExternalSite:Pagetext to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.50, $Rev$): jQuery JavaScript library for TWiki
- JQueryTwistyPlugin (1.0, $Rev$): Twisty section JavaScript library to open/close content dynamically
- LdapNgPlugin (v2.01, $Rev$): Query and display data from an LDAP directory
- LocalTimePlugin (Dakar, 11113): A plugin to give the current date and time of a particular city/timezone.
- MathModePlugin (2.96, 15934): Include LaTeX formatted math in your TWiki pages
- MediaWikiTablePlugin (v1.00, $Rev$): Format tables the MediaWiki way
- NatSkinPlugin (3.00-pre18, $Rev$): Supplements the bare bones NatSkin theme for TWiki
- PaginationPlugin (0.10, $Rev$): navigate among a double linked list of documents
- PingBackPlugin (v0.05-alpha, $Rev$): Pingback service for TWiki
- RedDotPlugin (1.40, $Rev$): Renders edit-links as little red dots
- SetVariablePlugin (0.10, $Rev$): Conditionally set variables while saving a topic
- SmiliesPlugin (Dakar, 16048): Render smilies as icons, like for
:-)or for :eek: - TablePlugin (1.032, 16084): Control attributes of tables and sorting of table columns
- TagCloudPlugin (v1.01, $Rev$): Renders a tag cloud given a list of terms
- TimeSincePlugin (1.10, $Rev$):
- UserInfoPlugin (1.53, 10521): Render information about users on your TWikiSite
- VotePlugin (1.33, 14296): Simple way to count votes
%FAILEDPLUGINS%
| Plugin | Errors |
|---|---|
| GluePlugin | none |
| IfDefinedPlugin | none |
| SpreadSheetPlugin | none |
| AliasPlugin | none |
| AutoViewTemplatePlugin | none |
| BlogPlugin | none |
| BreadCrumbsPlugin | none |
| ClassificationPlugin | none |
| CommentPlugin | none |
| DBCachePlugin | none |
| EditChapterPlugin | none |
| EmployeePortalPlugin | none |
| FilterPlugin | none |
| FlexWebListPlugin | none |
| HeadlinesPlugin | none |
| ImageGalleryPlugin | none |
| ImagePlugin | none |
| InterwikiPlugin | none |
| JQueryPlugin | none |
| JQueryTwistyPlugin | none |
| LdapNgPlugin | none |
| LocalTimePlugin | none |
| MathModePlugin | none |
| MediaWikiTablePlugin | none |
| NatSkinPlugin | none |
| PaginationPlugin | none |
| PingBackPlugin | none |
| RedDotPlugin | none |
| SetVariablePlugin | none |
| SmiliesPlugin | none |
| TablePlugin | none |
| TagCloudPlugin | none |
| TimeSincePlugin | none |
| UserInfoPlugin | none |
| VotePlugin | none |
| Handler | Plugins |
|---|---|
| afterSaveHandler | ClassificationPlugin DBCachePlugin PingBackPlugin |
| beforeSaveHandler | ClassificationPlugin CommentPlugin SetVariablePlugin |
| commonTagsHandler | GluePlugin IfDefinedPlugin SpreadSheetPlugin AliasPlugin BlogPlugin ClassificationPlugin CommentPlugin EditChapterPlugin FilterPlugin HeadlinesPlugin ImageGalleryPlugin ImagePlugin JQueryPlugin LocalTimePlugin MathModePlugin MediaWikiTablePlugin NatSkinPlugin PingBackPlugin RedDotPlugin SmiliesPlugin UserInfoPlugin |
| finishHandler | EditChapterPlugin |
| initPlugin | GluePlugin IfDefinedPlugin SpreadSheetPlugin AliasPlugin AutoViewTemplatePlugin BlogPlugin BreadCrumbsPlugin ClassificationPlugin CommentPlugin DBCachePlugin EditChapterPlugin EmployeePortalPlugin FilterPlugin FlexWebListPlugin HeadlinesPlugin ImageGalleryPlugin ImagePlugin InterwikiPlugin JQueryPlugin JQueryTwistyPlugin LdapNgPlugin LocalTimePlugin MathModePlugin MediaWikiTablePlugin NatSkinPlugin PaginationPlugin PingBackPlugin RedDotPlugin SetVariablePlugin SmiliesPlugin TablePlugin TagCloudPlugin TimeSincePlugin UserInfoPlugin VotePlugin |
| modifyHeaderHandler | ClassificationPlugin |
| postRenderingHandler | AliasPlugin BlogPlugin EditChapterPlugin MathModePlugin NatSkinPlugin RedDotPlugin |
| preRenderingHandler | AliasPlugin InterwikiPlugin SmiliesPlugin TablePlugin |
| redirectCgiQueryHandler | RedDotPlugin |
| renderFormFieldForEditHandler | ClassificationPlugin |
The TWiki Plugin API
The Application Programming Interface (API) for TWiki Plugins provides the specifications for hooking into the core TWiki code from your external Perl Plugin module.Available Core Functions
The TWikiFuncDotPm module (lib/TWiki/Func.pm) describes all the interfaces available to Plugins. Plugins should only use the interfaces described in this module.
Note: If you use other core functions not described in Func.pm, you run the risk of creating security holes. Also, your Plugin will likely break and require updating when you upgrade to a new version of TWiki.
Predefined Hooks
In addition to TWiki core functions, Plugins can use predefined hooks, or callbacks, as described in thelib/TWiki/Plugins/EmptyPlugin.pm module.
- All but the initPlugin are disabled. To enable a callback, remove
DISABLE_from the function name.
Hints on Writing Fast Plugins
- Delay initialization as late as possible. For example, if your Plugin is a simple syntax processor, you might delay loading extra Perl modules until you actually see the syntax in the text.
- For example, use an
evalblock like this:
eval { require IPC::Run }
return "<font color=\"red\">SamplePlugin: Can't load required modules ($@)</font>" if $@;
- For example, use an
- Keep the main plugin package as small as possible; create other packages that are loaded if and only if they are used. For example, create sub-packages of BathPlugin in
lib/TWiki/Plugins/BathPlugin/. - Avoid using preferences in the plugin topic; set
$NO_PREFS_IN_TOPICif you possibly can, as that will stop TWiki from reading the plugin topic for every page. Use Config.spec instead. - Use registered tag handlers
- Measure the performance to see the difference
Version Detection
To eliminate the incompatibility problems that are bound to arise from active open Plugin development, a Plugin versioning system is provided for automatic compatibility checking.- All plugin packages require a
$VERSIONvariable. This should be an integer, or a subversion version id.
- The
initPluginhandler should check all dependencies and return 1 if the initialization is OK or 0 if something went wrong.- The Plugin initialization code does not register a Plugin that returns 0 (or that has no
initPluginhandler).
- The Plugin initialization code does not register a Plugin that returns 0 (or that has no
-
$TWiki::Plugins::VERSIONin theTWiki::Pluginsmodule contains the TWiki Plugin API version, currently 1.2.- You can also use the
%PLUGINVERSION{}%variable to query the Plugin API version or the version of installed Plugins.
- You can also use the
Security
- Badly written Plugins can open huge security holes in TWiki. This is especially true if care isn't taken to prevent execution of arbitrary commands on the server.
- Don't allow sensitive configuration data to be edited by users. it is better to add sensitive configuration options to the
%TWiki::cfghash than adding it as preferences in the Plugin topic- See TWiki:Plugins.MailInContrib for an example of this
- TWiki:Plugins.BuildContrib can help you with this
- Always use the TWiki::Sandbox to execute commands.
- Always audit the Plugins you install, and make sure you are happy with the level of security provided. While every effort is made to monitor Plugin authors activities, at the end of the day they are uncontrolled user contributions.
Creating Plugins
With a reasonable knowledge of the Perl scripting language, you can create new Plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The TWiki Plugin API Plugins by providing a programming interface for TWiki.Anatomy of a Plugin
A (very) basic TWiki Plugin consists of two files:- a Perl module, e.g.
MyFirstPlugin.pm - a documentation topic, e.g.
MyFirstPlugin.txt
MyFirstPlugin topic. Other needed Perl code is best placed in a lib/TWiki/Plugins/MyFirstPlugin/ directory.
The Plugin API handles the details of connecting your Perl module with main TWiki code. When you're familiar with the Plugin API, you're ready to develop Plugins.
The TWiki::Plugins.BuildContrib module provides a lot of support for plugins development, including a plugin creator, automatic publishing support, and automatic installation script writer. If you plan on writing more than one plugin, you probably need it.
Creating the Perl Module
Copy filelib/TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm. The EmptyPlugin.pm module contains mostly empty functions, so it does nothing, but it's ready to be used. Customize it. Refer to the Plugin API specs for more information.
If your Plugin uses its own modules and objects, you must include the name of the Plugin in the package name. For example, write Package MyFirstPlugin::Attrs; instead of just Package Attrs;. Then call it using:
use TWiki::Plugins::MyFirstPlugin::Attrs; $var = MyFirstPlugin::Attrs->new();
Writing the Documentation Topic
The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as FileAttachments for downloading. (The doc topic is also included in the distribution package.) To create a documentation topic:- Copy the Plugin topic template from TWiki.org. To copy the text, go to TWiki:Plugins/PluginPackage and:
- enter the Plugin name in the "How to Create a Plugin" section
- click Create
- select all in the Edit box & copy
- Cancel the edit
- go back to your site to the TWiki web
- In the GoBox enter your Plugin name, for example
MyFirstPlugin, press enter and create the new topic - paste & save new Plugin topic on your site
- Customize your Plugin topic.
- Important: In case you plan to publish your Plugin on TWiki.org, use Interwiki names for author names and links to TWiki.org topics, such as TWiki:Main/TWikiGuest. This is important because links should work properly in a Plugin topic installed on any TWiki, not just on TWiki.org.
- Document the performance data you gathered while measuring the performance
- Save your topic, for use in packaging and publishing your Plugin.
OUTLINE: Doc Topic Contents
Check the Plugins web on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered: Syntax Rules: <Describe any special text formatting that will be rendered.>" Example: <Include an example of the Plugin in action. Possibly include a static HTML version of the example to compare if the installation was a success!>" Plugin Settings: <Description and settings for custom Plugin %VARIABLES%, and those required by TWiki.>"Plugin Installation Instructions: <Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.>" Plugin Info: <Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the TWiki:Plugins web.>"
- Plugins Preferences <If user settings are needed, explain... Entering values works exactly like TWikiPreferences and WebPreferences: six (6) spaces and then:>"
- Set <EXAMPLE = value added>
Packaging for Distribution
The TWiki:Plugins.BuildContrib is a powerful build environment that is used by the TWiki project to build TWiki itself, as well as many of the Plugins. You don't have to use it, but it is highly recommended! If you don't want (or can't) use the BuildContrib, then a minimum Plugin release consists of a Perl module with a WikiName that ends inPlugin, ex: MyFirstPlugin.pm, and a documentation page with the same name(MyFirstPlugin.txt).
- Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them all:
-
lib/TWiki/Plugins/MyFirstPlugin.pm -
data/TWiki/MyFirstPlugin.txt -
pub/TWiki/MyFirstPlugin/uparrow.gif[a required graphic]
-
- Create a zip archive with the Plugin name (
MyFirstPlugin.zip) and add the entire directory structure from Step 1. The archive should look like this:-
lib/TWiki/Plugins/MyFirstPlugin.pm -
data/TWiki/MyFirstPlugin.txt -
pub/TWiki/MyFirstPlugin/uparrow.gif
-
Measuring and Improving the Plugin Performance
A high quality Plugin performs well. You can use the TWiki:Plugins.PluginBenchmarkAddOn to measure your TWiki:Plugins.PluginBenchmarks. The data is needed as part of the Documentation Topic. See also Hints on Writing Fast Plugins.Publishing for Public Use
You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web. All Plugins submitted to TWiki.org are available for download and further development in TWiki:Plugins/PluginPackage. Publish your Plugin by following these steps:- Post the Plugin documentation topic in the TWiki:Plugins/PluginPackage:
- enter the Plugin name in the "How to Create a Plugin" section, for example
MyFirstPlugin - paste in the topic text from Writing the Documentation Topic and save
- enter the Plugin name in the "How to Create a Plugin" section, for example
- Attach the distribution zip file to the topic, ex:
MyFirstPlugin.zip - Link from the doc page to a new, blank page named after the Plugin, and ending in
Dev, ex:MyFirstPluginDev. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.) - Put the Plugin into the SVN repository, see TWiki:Plugins/ReadmeFirst (optional)
Once you have done the above steps once, you can use the BuildContrib to upload updates to your Plugin.
Thank you very much for sharing your Plugin with the TWiki community
Recommended Storage of Plugin Specific Data
Plugins sometimes need to store data. This can be Plugin internal data such as cache data, or data generated for browser consumption such as images. Plugins should store data using TWikiFuncDotPm functions that support saving and loading of topics and attachments.Plugin Internal Data
You can create a Plugin "work area" using theTWiki::Func::getWorkArea() function, which gives you a persistent directory where you can store data files. By default they will not be web accessible. The directory is guaranteed to exist, and to be writable by the webserver user. For convenience, TWiki::Func::storeFile() and TWiki::Func::readFile() are provided to persistently store and retrieve simple data in this area.
Web Accessible Data
Topic-specific data such as generated images can be stored in the topic's attachment area, which is web accessible. Use theTWiki::Func::saveAttachment() function to store the data.
Recommendation for file name: - Prefix the filename with an underscore (the leading underscore avoids a name clash with files attached to the same topic)
- Identify where the attachment originated from, typically by including the Plugin name in the file name
- Use only alphanumeric characters, underscores, dashes and periods to avoid platform dependency issues and URL issues
- Example:
_FooBarPlugin_img123.gif
TWiki::Func::saveAttachment() function to store the data.
Recommendation for file names in Plugin attachment area: - Prefix the filename with an underscore
- Include the name of the web in the filename
- Use only alphanumeric characters, underscores, dashes and periods to avoid platform dependency issues and URL issues
- Example:
_Main_roundedge-ul.gif
Integrating with configure
Some TWiki extensions have setup requirements that are best integrated into configure rather than trying to use TWiki preferences variables. These extensions use Config.spec files to publish their configuration requirements.
Config.spec files are read during TWiki configuration. Once a Config.spec has defined a configuration item, it is available for edit through the standard configure interface. Config.spec files are stored in the 'plugin directory' e.g. lib/TWiki/Plugins/BathPlugin/Config.spec.
Structure of a Config.spec file
The Config.spec file for a plugin starts with the plugin announcing what it is:
# ---+ BathPlugin # This plugin senses the level of water in your bath, and ensures the plug # is not removed while the water is still warm.This is followed by one or more configuration items. Each configuration item has a type, a description and a default. For example:
# **SELECT Plastic,Rubber,Metal**
# Select the plug type
$TWiki::cfg{BathPlugin}{PlugType} = 'Plastic';
# **NUMBER**
# Enter the chain length in cm
$TWiki::cfg{BathPlugin}{ChainLength} = '30';
# **BOOLEAN EXPERT**
# Turn this option off to disable the water temperature alarm
$TWiki::cfg{BathPlugin}{TempSensorEnabled} = '1';
The type (e.g. **SELECT** ) tells configure to how to prompt for the value. It also tells configure how to do some basic checking on the value you actually enter. All the comments between the type and the configuration item are taken as part of the description. The configuration item itself defines the default value for the configuration item. The above spec defines the configuration items $TWiki::cfg{BathPlugin}{PlugType}, $TWiki::cfg{BathPlugin}{ChainLength}, and $TWiki::cfg{BathPlugin}{TempSensorEnabled} for use in your plugin. For example,
if( $TWiki::cfg{BathPlugin}{TempSensorEnabled} && $curTemperature > 50 ) {
die "The bathwater is too hot for comfort";
}
The config.spec file is read by configure, and configure then writes LocalSite.cfg with the values chosen by the local site admin.
A range of types are available for use in Config.spec files:
| BOOLEAN | A true/false value, represented as a checkbox |
| COMMAND length | A shell command |
| LANGUAGE | A language (selected from {LocalesDir} |
| NUMBER | A number |
| OCTAL | An octal number |
| PASSWORD length | A password (input is hidden) |
| PATH length | A file path |
| PERL | A perl structure, consisting of arrays and hashes |
| REGEX length | A perl regular expression |
| SELECT choices | Pick one of a range of choices |
| SELECTCLASS root | Select a perl package (class) |
| STRING length | A string |
| URL length | A url |
| URLPATH length | A relative URL path |
| EXPERT | means this an expert option |
| M | means the setting is mandatory (may not be empty) |
| H | means the option is not visible in configure |
lib/TWiki.spec for many more examples.
Config.spec files are also used for other (non-plugin) extensions. in this case they are stored under the Contrib directory instead of the Plugins directory.
Maintaining Plugins
Discussions and Feedback on Plugins
Each published Plugin has a Plugin development topic on TWiki.org. Plugin development topics are named after your Plugin and end inDev, such as MyFirstPluginDev. The Plugin development topic is a great resource to discuss feature enhancements and to get feedback from the TWiki community.
Maintaining Compatibility with Earlier TWiki Versions
The Plugin interface (TWikiFuncDotPm functions and handlers) evolve over time. TWiki 4.0 introduced new API functions to address the needs of Plugin authors. It also deprecated some functions. Some Plugins written for earlier TWiki releases using unofficial TWiki internal functions no longer work on the TWiki 4.0 codebase. All this means that some Plugins need to be updated to work on the TWiki 4.0 codebase. Organizations typically do not upgrade to the latest TWiki for many months. However, many administrators still would like to install the latest versions of a Plugin on their older TWiki installation. This need is fulfilled if Plugins are maintained in a compatible manner. Tip: Plugins can be written to be compatible with older and newer TWiki releases. This can be done also for Plugins using unofficial TWiki internal functions of an earlier release that no longer work on the latest TWiki codebase. TWiki:TWiki.TWikiPluginsSupplement#MaintainPlugins has more.
Handling deprecated functions
From time-to-time, the TWiki developers will add new functions to the interface (either to TWikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more TWiki release, and probably longer, though this cannot be guaranteed. When a plugin defines deprecated handlers, a warning will be shown in the list generated by %FAILEDPLUGINS%. Admins who see these warnings should check TWiki.org and if necessary, contact the plugin author, for an updated version of the plugin. Updated plugins may still need to define deprecated handlers for compatibility with old TWiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %FAILEDPLUGINS%. This is done by defining a map from the handler name to theTWiki::Plugins version in which the handler was first deprecated. For example, if we need to define the endRenderingHandler for compatibility with TWiki::Plugins versions before 1.1, we would add this to the plugin:
package TWiki::Plugins::SinkPlugin;
use vars qw( %TWikiCompatibility );
$TWikiCompatibility{endRenderingHandler} = 1.1;
If the currently-running TWiki version is 1.1 or later, then the handler will not be called and the warning will not be issued. TWiki with versions of TWiki::Plugins before 1.1 will still call the handler as required.
Back to top
Warning: Can't find topic TWiki.TWikiFuncDotPm Back to top
TWiki CGI and Command Line Scripts
Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki scripts are located in thetwiki/bin and twiki/tools directories. This topic describes the interfaces to some of those scripts. All scripts in the twiki/bin directory can be called from the CGI (Common Gateway Interface) environment or from the command line. The scripts in the twiki/tools directory can only be called from the command line.
CGI Scripts
Details on CGI scripts located in thetwiki/bin directory.
General Information
CGI environment
In the CGI environment parameters are passed to the scripts via the URL and URL parameters. Environment variables are also used to determine the user performing the action. If the environment is not set up, the default TWiki user is used (usuallyguest).
Command-line
You must be have thetwiki/bin directory on the perl path to run the scripts from the command line. To avoid issues with file permissions, run the scripts as the web server user such as nobody or www.
Parameters are passed on the command line using '-name' - for example,
$ cd /usr/local/twiki/bin $ save -topic MyWeb.MyTopic -user admin -action save -text "New text of the topic"All parameters require a value, even if that is the empty string.
Common parameters
All the scripts accept a number of common parameters. The first two components of the URL after the script name are taken as the web and the topic, respectively. Standard URL parameters are:| Parameter | Description | Default |
|---|---|---|
topic |
If this is set to a URL, TWiki will immediately redirect to that URL. Otherwise it overrides the URL and is taken as the topic name (you can pass Web.TopicName) | |
user |
Command-line only; set the name of the user performing the action. Note: this usage is inherently insecure, as it bypasses webserver login constraints. For this reason only authorised users should be allowed to execute scripts from the command line. | |
skin |
Overrides the default skin path (see TWikiSkins) | |
cover |
Specifies temporary skin path to prepend to the skin path for this script only (see TWikiSkins) |
attach
Despite the name, this script doesn't actually attach a file to a topic - for that, use upload. This script is part of the transactions sequence executed when a file is uploaded from the browser. it just generates the "new attachment" page for a topic.
| Parameter | Description | Default |
|---|---|---|
filename |
Name of existing attachment (if provided, this is a "manage attachment" action) | none (in which case this is a "new attachment" action) |
changes
Shows all the changes in the given web.
The changes script can receive one parameter:
| Parameter | Description | Default |
|---|---|---|
minor |
If 0, show only major changes. If 1, show all the changes (both minor and major) | 0 |
%SEARCH%, while this script reads the changes file in each web, making it much faster.
NOTE: The result from changes script and the topic WebChanges can be different, if the changes file is deleted from a web. In particular, in new installations the changes script will return no results while the WebChanges topic will.
configure
configure is the browser script used for inspection and configuration of the TWiki configuration. None of the parameters to this script are useable for any purpose except configure. See configure.
edit
The edit scipt understands the following parameters, typically supplied by HTML input fields:
| Parameter | Description | Default |
|---|---|---|
action |
Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. | |
onlynewtopic |
If set, error if topic already exists | |
onlywikiname |
If set, error if topic name is not a WikiWord | |
templatetopic |
The name of the template topic, copied to get the initial content | |
text |
Initial text for the topic | |
topicparent |
The parent topic | |
formtemplate |
Name of the form to instantiate in the topic. Overrides the form set in the templatetopic if defined. |
|
contenttype |
Optional parameter that defines the application type to write into the CGI header. Defaults to text/html. May be used to invoke alternative client applications |
|
anyname |
Any parameter can passed to the new topic; if the template topic contains %URLPARAM{"anyname"}%, it will be replaced by its value |
|
breaklock |
If set, any lease conflicts will be ignored, and the edit will proceed even if someone is already editing the topic. | |
redirectto |
If the user continues from edit to save, and if the save (or cancels the edit) process is successful, save will redirect to this topic or URL. The parameter value can be a TopicName, a Web.TopicName, or a URL.Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous {AllowRedirectUrl}). |
Status the parameter name is Status. - The first sequence of ten or more
Xcharacters in the topic name will be converted on save to a number such that the resulting topic name is unique in the target web.
EDIT_SKIN, which is used as the value of the cover parameter in edit URLs. This allows you to override the default edit skin on a web, topic or user basis.
login
Used for logging in when TWiki login is being used (e.g TemplateLoginManager).
| Parameter | Description | Default |
|---|---|---|
origurl |
URL that was being accessed when an access violation occurred. the login process will redirect to this URL if it is successful | none |
username |
username of user logging in | none |
password |
password of user logging in | none |
logon
Used for logging in when Web Server authentication is being used (e.g. ApacheLoginManager). The script does nothing; it is purely a placeholder for triggering the login process. The webserver will be set up to require a valid user to access this script, thus triggering the webserver login process.
manage
Performs a range of management functions.
| Parameter | Description | Default |
|---|---|---|
action |
One of createweb, deleteUserAccount, editSettings or saveSettings |
none |
action=createweb
| Parameter | Description | Default |
|---|---|---|
newweb |
Name of the new web | '' |
baseweb |
Name of the web to copy to create the new web | '' |
webbgcolor |
value for WEBBGCOLOR | '' |
sitemapwhat |
Value for SITEMAPWHAT | '' |
sitemapuseto |
Value for SITEMAPUSETO | '' |
nosearchall |
Value for NOSEARCHALL | '' |
action=editSettings
No parameters
action=saveSettings
| Parameter | Description | Default |
|---|---|---|
text |
Text of the topic | '' |
originalrev |
Revision that the edit started on | Most recent revision |
redirectto |
If the savesettings process is successful, save will redirect to this topic or URL. The parameter value can be a TopicName, a Web.TopicName, or a URL.Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous {AllowRedirectUrl}). |
action=bulkRegister
See BulkRegistration.
| Parameter | Description | Default |
|---|---|---|
OverwriteHomeTopics |
Whether to overwrite existing home topics or not | false |
EmailUsersWithDetails |
Whether to mail registered users or not | false |
LogTopic |
Topic to save the log in | Same as topic name, with 'Result' appended. |
action=changePassword
Change password, email address, or both, of a user.
| Parameter | Description | Default |
|---|---|---|
username |
god alone knows | none |
oldpassword |
current password | none |
password |
new password | none |
passwordA |
new password confirmation | none |
email |
new email address | none |
password, =passwordA and email are optional. If neither or password and passwordA is set, then the user password is left unchanged. If email is unset, their email is left unchanged.
action=resetPassword
Reset the password for a single or multiple users
| Parameter | Description | Default |
|---|---|---|
LoginName |
list of usernames to reset | none - error if not set |
Introduction |
message to be sent alongside the reset, most often used to announce to the user that they have been given an account. | '' |
action=deleteUserAccount
Unregisters (removes) the currently logged-in user.
| Parameter | Description | Default |
|---|---|---|
password |
Users' password | none |
oops
This script is mainly used for rendering pages containing error messages, though it is also used for some functional actions such as manage pages (move topic etc).
oops templates are used with the oops script to generate system messages. This is done to make internationalisation or other local customisations simple.
The oops script supports the following parameters:
| Parameter | Description | Default |
|---|---|---|
template |
Name of the template file to display | |
def |
Optional, can be set to the name of a single definition within template. This definition will be instantiated in the template wherever %INSTANTIATE% is seen. This lets you use a single template file for many messages. For an example, see oopsmanagebad.tmpl. |
|
paramN |
Where N is an integer from 1 upwards. These values will be substituted into template for %PARAM1% etc. |
preview
This script is deprecated. Its functions are covered by the save script.
rdiff
Renders the differences between version of a TWiki topic
| Parameter | Description | Default |
|---|---|---|
| rev1 | the higher revision | |
| rev2 | the lower revision | |
| render | the rendering style {sequential, sidebyside, raw, debug} | DIFFRENDERSTYLE, sequential |
| type | {history, diff, last} history diff, version to version, last version to previous | diff |
| context | number of lines of context |
- add a {word} render style
register
| Parameter | Description | Default |
|---|---|---|
action |
register or verify or resetPassword or approve |
rename
Used for renaming topics.
| Parameter | Description | Default |
|---|---|---|
skin |
skin(s) to use | |
newweb |
new web name | |
newtopic |
new topic name | |
breaklock |
||
attachment |
||
confirm |
if defined, requires a second level of confirmation | |
currentwebonly |
if defined, searches current web only for links to this topic | |
nonwikiword |
if defined, a non-wikiword is acceptable for the new topic name | |
redirectto |
If the rename process is successful, rename will redirect to this topic or URL. The parameter value can be a TopicName, a Web.TopicName, or a URL.Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous {AllowRedirectUrl}). |
rest
This REST (Representational State Transfer) script can be invoked via http in the same way as the other TWiki scripts (see Invocation Examples, below) to execute a function that is associated to a "subject" and a "verb" (see below). These functions are usually registered by plugins using the TWiki::Func::registerRESTHandler method. The rest script will print the result directly to the browser unless the endPoint parameter is specified, in which case it will output a redirect to the given topic.
The rest script supports the following parameters:
username |
If TemplateLogin, or a similar login manager not embedded in the web server, is used, then you need to pass a username and password to the server. The username and password parameters are used for this purpose. |
password |
See username |
topic |
If defined as the full name (including web) of a topic, then when the script starts up plugins will be passed this as the "current" topic. If not defined, then %USERWEB%.WebHome will be passed to plugins. |
endPoint |
Where to redirect the response once the request is served, in the form "Web.Topic" |
The rest script should always require authentication in any TWiki that has logins. Otherwise there is a risk of opening up major security holes. So make sure you add it to the list of authenticated scripts if you are using ApacheLogin.
Invocation Examples
Therest script assumes that it will be called with URL in the form:
http://my.host/bin/rest/<subject>/<verb>
where <subject> must be the WikiWord name of one of the installed TWikiPlugins, and the <verb> is the alias for the function registered using the TWiki::Func::registerRESTHandler method. The <subject> and <verb> are then used to lookup and call the registered function.
<subject> and <verb> are checked for illegal characters exactly in the same way as the web and topic names.
As an example, the EmptyPlugin has registered a function to be used with the rest script under the subject EmptyPlugin and the verb example. Click below to see the rest script in action (run as TWikiGuest).
Call the Plugin
Note that for Plugins to register REST handlers, they must be enabled in configure.
save
The save script performs a range of save-related functions, as selected by the action parameter.
| Parameter | Description | Default |
|---|---|---|
action_save=1 |
default; save, return to view, dontnotify is off |
|
action_quietsave=1 |
save, and return to view, dontnotify is on |
|
action_checkpoint |
save and redirect to the edit script, dontnotify is on |
|
action_cancel |
exit without save, return to view | |
action_preview |
preview edited text | |
action_addform |
Redirect to the "change form" page. | |
action_replaceform... |
Redirect to the "change form" page. | |
action_delRev |
Administrators only delete the most recent revision of the topic - all other parameters are ignored. You have to be an administrator to use this, and not all store implementations will support it. | |
action_repRev |
Administrators only replace the text of the most recent revision of the topic with the text in the text parameter. text must included embedded meta-data tags. All other parameters are ignored. You have to be an administrator to use this, and not all store implementations will support it. |
|
onlynewtopic |
If set, error if topic already exists | |
onlywikiname |
If set, error if topic name is not a WikiWord | |
dontnotify |
if defined, suppress change notification | |
templatetopic |
Name of a topic to use as a template for the text and form | |
text |
New text of the topic | |
forcenewrevision |
if set, forces a revision even if TWiki thinks one isn't needed | |
topicparent |
If 'none' remove any current topic parent. If the name of a topic, set the topic parent to this. | |
formtemplate |
if defined, use the named template for the form | |
editaction |
When action is checkpoint, add form or replace form..., this is used as the action parameter to the edit script that is redirected to after the save is complete. |
|
originalrev |
Revision on which the edit started. | |
edit |
The script to use to edit the topic when action is checkpoint |
edit |
editparams |
The parameter string to use to edit the topic | |
redirectto |
The save process will redirect to this topic or URL if it is successful. (Typically this would be the URL that was being viewed when edit was invoked). The parameter value can be a TopicName, a Web.TopicName, or a URL.Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous {AllowRedirectUrl}). |
view topic being edited |
oops page.
The parameters are interpreted in according to the following rules.
- The first sequence of ten or more
Xcharacters in the topic name will be converted to a number such that the resulting topic name is unique in the target web. - When the action is
save,checkpoint,quietsave, orpreview:- The new text is taken from the
textparameter, if it is defined,- otherwise it is taken from the
templatetopic, if it is defined, - otherwise it is taken from the previous version of the topic, if any,
- otherwise it is taken from the
- The name of the new form is taken from the
formtemplate, if defined- otherwise it is taken from the
templatetopic, if defined, - otherwise it is taken from the previous version of the topic, if any,
- otherwise no form is attached.
- otherwise it is taken from the
- The value for each field in the form is taken from the query, if it is defined
- otherwise it is taken from the
templatetopic, if defined, - otherwise it is taken from the previous version of the topic, if any,
- otherwise it defaults to the empty string.
- otherwise it is taken from the
- The new text is taken from the
text and originalrev is > 0 and is not the same as the revision number of the most recent revision. If merging is enabled both the topic and the meta-data are merged.
Form field values are passed in parameters named 'field' - for example, if I have a field Status the parameter name is Status.
search
CGI gateway to the %SEARCH% functionality driven by the following CGI 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. See TWikiVariables#VarSEARCH for more details. | 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= |
Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort | Sort by topic name |
limit="all" limit="16" |
Limit the number of results returned. This is done after sorting if order is specified |
All results |
date="..." |
limits the results to those pages with latest edit time in the given time interval. | 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 |
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 tag on the same line will be rendered as part of the table generated by the search, if appropriate. |
off |
separator=", " |
Line separator between hits | Newline "$n" |
statistics
Refresh the WebStatistics topics in range of webs.
| Parameter | Description | Default |
|---|---|---|
webs |
comma-separated list of webs to run stats on | all accessible webs |
logdate |
YYYYMM to generate statistics for | current month |
- from browser http://www.wikiring.com/statistics updates all user webs
- from browser http://www.wikiring.com/statistics?webs=TWiki,Main,Sandbox updates TWiki,Main,Sandbox
- from browser http://www.wikiring.com/statistics/TWiki updates TWiki
- from command line twiki/bin/statistics updates all user webs
- from command line twiki/bin/statistics -webs=TWiki,Main,Sandbox updates TWiki,Main,Sandbox
- from command line twiki/bin/statistics TWiki.WebHome updates TWiki
upload
Uploads an attachment to a topic. The HTTP request is expected to be in multipart/form-data format.
| Parameter | Description | Default |
|---|---|---|
hidefile |
if defined, will not show file in attachment table | |
filepath |
local (client) path name of the file being uploaded. This is used to look up the data for the file in the HTTP query. | |
filename |
deprecated, do not use | |
filecomment |
Comment to associate with file in attachment table | |
createlink |
if defined, will create a link to file at end of topic | |
changeproperties |
if defined, this is a property change operation only - no file will be uploaded. | null |
curl to upload files from the command line using this script.
view
Used for viewing topics.
| Parameter | Description | Default |
|---|---|---|
raw=on |
Shows the text of the topic in a scrollable textarea | |
raw=debug |
As raw=on, but also shows the metadata (forms etc) associated with the topic. |
|
raw=text |
Shows only the source of the topic, as plain text (Content-type: text/plain). Only shows the body text, not the form or other meta-data. | |
raw=all |
Shows only the source of the topic, as plain text (Content-type: text/plain), with embedded meta-data. This may be useful if you want to extract the source of a topic to a local file on disc. | |
section |
Allows to view only a part of the topic delimited by a named section (see VarSTARTSECTION). If the given section is not present, no topic content is displayed. | |
contenttype |
Allows you to specify a different Content-Type: (e.g. contenttype=text/plain) |
|
rev |
Revision to view (e.g. rev=45) |
|
template |
Allows you to specify a different skin template, overriding the 'view' template the view script would normally use. The default template is view. For example, you could specify /TWiki/TWikiScripts?template=edit. This is mainly useful when you have specialised templates for a TWiki Application. |
|
topic |
redirects (at the beging of the cgi script running) to show the spcified Web.Topic, or, redirects to a URL, if allowed by {AllowRedirectUrl} and {PermittedRedirectHostUrls} |
For historical reasons, the view script has a special interpretation of the text skin. In earlier TWiki versions the skin=text parameter was used like this:
http://.../view/MyWeb/MyTopic?skin=text&contenttype=text/plain&raw=on
which shows the topic as plain text; useful for those who want to download plain text for the topic.
Using skin=text this way is DEPRECATED, use raw=text instead.
viewfile
Used for viewing attachments. Normally, a site will publish the attachments (pub) directory using a URL. However if it contains sensitive information, you will want to protect attachments using TWikiAccessControls. In this case, you can use the viewfile script to give access to attachments while still checking access controls.
| Parameter | Description | Default |
|---|---|---|
filename |
name of attachment | |
rev |
Revision to view |
filename parameter, you can append the attachment name
to the end of the URL path (after the topic) e.g. http://www.wikiring.com/viewfile/Webname/TopicName/Attachment.gif
Command Line Scripts
Details on command line scripts located in thetwiki/tools directory.
geturl.pl
This is a very simple script to get the content of a web site. It is marked as deprecated and might be removed (or enhanced) in a future TWiki release. Its functions are covered by the standard wget and curl commands. - Usage:
geturl.pl <host> <path> [<port> [<header>]] - Example:
geturl.pl some.domain /some/dir/file.html 80 - Will get:
http://some.domain:80/some/dir/file.html
rewriteshebang.pl
Simple script to rewrite the #!/usr/bin/perl shebang lines specific to your local Perl installation. It will rewrite the first line of all your TWiki cgi scripts so they use a different shebang line. Use it if your perl is in a non-standard location, or you want to use a different interpreter (such as 'speedy').
tick_twiki.pl
This script executes a number of non-essential regular administration tasks that will help keep your TWiki healthy and happy, such as removing expired sessions and lease files.
It is intended to be run as a cron job or a scheduled task once a week. Example crontab entry:0 0 * * 0 cd /usr/twiki/bin && perl ../tools/tick_twiki.pl
Note: The script has to be run by a user who can write files created by the webserver user.
Related Topics: AdminDocumentationCategory, DeveloperDocumentationCategory
Back to top
TWiki Site Tools
Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up with site activity. Preferences can be configured by web or site-wide. You are currently in the TWiki web. In particular, TWiki provides two highly configurable, automated site monitoring tools, WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports.WebNotify - recent changes alert
Each TWiki web has an automatic e-mail alert service that sends a list of recent changes on a preset schedule, like once a day. Users can subscribe and unsubscribe using WebNotify in each web. The Perl scriptmailnotify is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run.
- You can create a WebNotify link using TWikiVariables with
%NOTIFYTOPIC%
Web Changes Notification Service
Each TWiki web has an automatic e-mail notification service that sends you an e-mail with links to all of the topics modified since the last alert. Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track, WWhole groups of users can also be subscribed for notification. The general format of a subscription is: three spaces* subscriber [ : topics ]
Where subscriber can be a WikiName, an E-mail address, or a
group name. If subscriber contains any characters that are not legal in
an email address, then it must be enclosed in 'single' or "double" quotes.
topics is an optional space-separated list of topics: - ... without a Web. prefix
- ...that exist in this web.
- Using wild-card character in topic names - You can use
*in a topic name, where it is treated as a wildcard character. A*will match zero or more other characters - so, for example,Fred*will match all topic names starting withFred,*Fredwill match all topic names ending withFred, and*will match all topic names. - Unsubscribing to specific topics - Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic". The '-' sign means "unsubscribe" or "don't send notifications regarding this particular topic". This allows users to elect to filter out certain topics. Topic filters ('-') take precedence over topic includes ('+') i.e. if you unsubscribe from a topic it will cancel out any subscriptions to that topic.
- Including chid-topics in subscription - Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
- Subscribing to entire topic ("news mode") - Each topic may optionally be immediately followed by an exclamation mark ! or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as complete topics instead of change summaries. ! causes the topic to be mailed every time even if there have been no changes, and ? will mail the topic only if there have been changes to it. One can limit the content of the subscribed topic to send out by inserting %STARTPUBLISH% and %STOPPUBLISH% markers within the topic. Note that "news mode" subscriptions require a corresponding cron job that includes the "-news" option (see details).
* daisy.cutter@flowers.comSubscribe Daisy to all changes to topics that start with
Web.
* daisy.cutter@flowers.com : Web*Subscribe Daisy to changes to topics starting with
Petal, and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers
* DaisyCutter: Petal* (1) WeedKillers (3) Pretty*FlowersSubscribe StarTrekFan to changes to all topics that start with
Star except those that end in Wars, sInTheirEyes or shipTroopers.
* StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopersSubscribe Daisy to the full content of NewsLetter whenever it has changed
* daisy@flowers.com: NewsLetter?Subscribe buttercup to NewsLetter and its immediate children, even if it hasn't changed.
* buttercup@flowers.com: NewsLetter! (1)Subscribe GardenGroup (which includes Petunia) to all changed topics under AllnewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter, which she would normally get as a member of GardenGroup:
* GardenGroup: AllNewsLetters? (3) * petunia@flowers.com: - ManureNewsLetterSubscribe
IT:admins (a non-TWiki group defined by an alternate user mapping) to all changes to Web* topics.
* 'IT:admins' : Web*A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes that topic once (though they will still receive individual mails for news topics). If a group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members. __
Warning: Because an email address is not linked to a user name, there is no way for TWiki to check access controls for email addresses. A user identified by an email address will only be sent change notifications if the topic they are asubscribed to is readable by guest users. You can limit what email addresses can be used in WebNotify, or even block use of emails altogther, using the {MailerContrib}{EmailFilterIn} setting in =configure.
Tip: List names in alphabetical order to make it easier to find the names.
Note for System Administrators: Notification is supported by an add-on to the TWiki kernel called the MailerContrib. See the MailerContrib topic for details of how to set up this service.
Note: If you prefer a news feed, point your reader to WebRss (for RSS 1.0 feeds) or WebAtom (for ATOM 1.0 feeds). Learn more at WebRssBase and WebAtomBase, respectively.
You can also use %USERSWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring {MainWebName} in configure.
WebSearch - search TWiki site
WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. WebSearchAdvanced offers more options, including:- topic title or full-text search
- regular expressions
- search within web or site-wide
- index-style A-Z alphabetical listing sorted topic title
- many more
WebChanges - what's new
To check for the most recently edited topics while on-site, use the WebChanges link, usually located in the toolbar. It lists the most recently modified topics, newest first, along with the first couple of lines of the page content. This is simply a presetSEARCH. The number of topics listed by the limit parameter.:
%SEARCH{ ".*" web="TWiki" type="regex" nosearch="on" order="modified"
reverse="on"
limit="50" }%
WebRss and WebAtom - news feeds on recent changes
You can point your news reader at WebRss and WebAtom to find out what is new in a TWiki web. WebRssBase and WebAtomBase have the details. Like WebChanges, this is based on a%SEARCH{}%.
WebIndex - list of topics
WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a presetSEARCH:
%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" }%
WebStatistics - site statistics
You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. Compiled as a running total on a monthly basis. Includes totals for Topic Views, Topic Saves, Attachment Uploads, Most Popular Topics with number of views, and Top Contributors showing total of saves and attachment uploads. Previous months are saved.- You can create a WebStatistics link using TWikiVariables with
%STATISTICSTOPIC%
Configuring for automatic operation
- You can automatically generate usage statistics for all webs. To enable this:
- Make sure variable {Log}{view}, {Log}{save} and *{Log}{upload} in are set in configure. This will generate log file entries (see below).
- The WebStatistics topic must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
- Call the
twiki/bin/statisticsscript from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs. - Attention: The script must run as the same user as the CGI scripts are running, which is user
nobodyon many systems. Example crontab entry:
0 0 * * * (cd /path/to/twiki/bin; ./statistics >/dev/null 2>&1) - There is a workaround in case you can't run the script as user
nobody: Run the utilitytwiki/tools/geturl.plin your cron job and specify the URL of thetwiki/bin/statisticsscript as a parameter. Example:
0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1) - NOTE:
geturl.plwill do a TWiki CGI request as the TWikiGuest user, so if you use this workaround, the WebStatistics topics you are updating will have to be writable by TWikiGuest.
./statistics -logdate 200605 -webs TWiki,Sandbox
Generating statistics manually by URL
- The
twiki/bin/statisticsscript can also be executed as a CGI script, just enter the URL in your browser. Examples:- Update current month for all webs you have access to:
/statistics - Update current month for Main web only:
/statistics/Main - Update May 2012 for Main web:
/statistics/Main?logdate=201205 - Update May 2012 for the ProjectX, ProjectY and ProjectZ webs:
/statistics?logdate=201205;webs=ProjectX,ProjectY,ProjectZ
- Update current month for all webs you have access to:
Log Files
TWiki generates monthly log files which are used by the statistics script- The log file is defined by the {LogFileName} setting in configure
- The file name is
log<year><month>.txt - Example path name:
twiki/logs/log201205.txt - Each access gets logged as:
| <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> | - Example log entry:
| 21 May 2012 - 18:50 | TWikiGuest | view | WebRss | | 66.124.232.02 | - Actions are logged if enabled in configure by the {Log}{action} flags
- Logged actions:
Script Action name Extra info attach attachwhen viewing attach screen of previous uploaded attachment: filenamechanges changesedit editwhen editing non-existing topic: (not exist)rdiff rdiffhigher and lower revision numbers: 4 3register regstartWikiUserName, e-Mail address, LoginName: user attempts to registerregister registerE-mail address: user successfully registersregister bulkregisterWikiUserName of new, e-mail address, admin ID rename renamewhen moving topic: moved to Newweb.NewTopicrename movewhen moving attachment: Attachment filename moved to Newweb.NewTopicsave savewhen replacing existing revision: repRev 3
when user checks the minor changes box:dontNotify
when user changes attributes to an exising attachment:filename.extsave cmdspecial admin parameter used when saving search searchsearch string upload uploadfilename view viewwhen viewing non-existing topic: (not exist)
when viewing previous topic revision:r3
Configuring outgoing mail
Outgoing mail is required for TWikiRegistration and for recent changes alert. TWiki will use theNet::SMTP module if it is installed on your system. Set this with the SMTPMAILHOST variable in TWikiPreferences.
The notify e-mail uses the default changes.tmpl template, or a skin if activated in the TWikiPreferences.
mailnotify also relies on two hidden files in each twiki/data/Web directory: .changes and .mailnotify. Make sure both are writable by your web server process. .changes contains a list of changes; go ahead and make this empty. .mailnotify contains a timestamp of the last time notification was done.
You can use an external mail program, such as sendmail, if the Net::SMTP module is not installed. Set the program path in {MailProgram} in configure.
- Net::SMTP can be easily disabled (if there is an installation error) by setting
SMTPMAILHOSTin TWikiPreferences to an empty value.
- You can set a separate
SMTPSENDERHOSTvariable to define the mail sender host (some SMTP installations require this).
Setting the automatic e-mail schedule
For Unix platforms: Edit thecron table so that mailnotify is called in an interval of your choice. Please consult man crontab of how to modify the table that schedules program execution at certain intervals. Example:
% crontab -e 0 1 * * * (cd /path/to/twiki/bin; ./mailnotify -q)The above line will run mailnotify nightly at 01:00. The
-q switch suppresses all normal output.
For ISP installations: Many ISPs don't allow hosted accounts direct cron access, as it's often used for things that can heavily load the server. Workaround scripts are available.
On Windows: You can use a scheduled task if you have administrative privileges. TWiki:Codev/CronTabWin is a free scheduler for Windows.
Site Permissions
- TWikiAccessControl describes how to restrict read and write access to topics and webs, by users and groups
- SitePermissions lists the permissions settings of the webs on this TWiki site
Help with crontab
The crontab command is used to schedule commands to be executed periodically.- Wikipedia.org:Crontab - crontab documentation
- pycron - crontab for Windows
Managing Topics
Browser-based rename, move, and delete for individual topicsOverview
You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hiddenTrash web.
How to Rename/Move/Delete a Topic
- Click on
[More](bottom right of page) on the topic to be changed, then, in the new screen, on[Rename/move]. You can now rename and/or move/delete in one operation: - Move/Delete: Select the target web if other than the current web - choose
Trashto delete a topic. - Rename: Enter the new topic name - default is current name
NOTE: You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.
- Prevent updates by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, all referring links will be updated).
- Click on
[Rename/Move]: the topic will be renamed and links to the topic updated as requested.- If any of the referring pages are locked then they will be listed: you can correct these later by again pressing
[Rename/Move]. - There is a Put back feature that allows you to undo a
Rename/Move/Delete- an instruction line and undo link will appear at the bottom of the modified topic. This allows you to revert from the last modification only.
- If any of the referring pages are locked then they will be listed: you can correct these later by again pressing
Deleted Topics: How to Clear the Trash
Deleted topics are moved to a specialTrash web - they are NOT physically erased from the server. All webs share Trash - in case of a name conflict with a topic already Trash, the user is alerted and asked to choose a new name.
The Trash web should be be cleared periodically, by archiving (saving) the text and RCS files if required (recommended), then deleting them from the Trash directory.
- This can only be done from on the server, not through the browser.
- Since simple FTP access to the
Trashdirectory is all that's required for maintenance, it's possible to grantTrashadmin privileges to multiple users, while strictly limiting server access.
-
Redirecting from an Old Topic
You can use TWikiMetaData to place a command in the WebTopicViewTemplate and WebTopicNonWikiTemplate that will indicate that a topic has been moved by searching for the tag %META:TOPICMOVED{...}%. Customize something like this:
%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%"
title="This topic used to exist and was moved to: "}%
How Rename/Move Works
- %SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant TWikiMetaData definitions.
- User can omit one or more topics from the update list by unchecking them.
-
<pre>and<verbatim>are honoured - no changes are made to text within these areas.
- The topic is moved (if locks allow).
- References are changed (locks and permissions permitting).
- Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
How Referring Topics Are Found
First, matching topics in the current web are listed - matches are totopic. Next, all webs (including the current one) are listed that match web.topic. All webs will be searched during rename, even if NOSEARCHALL is defined on a web, though access permissions will of course be honoured.
Changed references are kept are as short as possible, ex: topic is used in preference to web.topic.
Effect of User Access Settings
User permissions affect the 'rename' functions in various ways. To rename a topic, you need all ofVIEW, CHANGE and RENAME access to that topic. To alter referring topics, you need CHANGE access. See TWikiAccessControl for information on setting up access permissions.
Special Considerations
Consider carefully whether to make browser-based Rename/Move/Delete widely available, or to restrict it to an administrator/moderator group. Allowing all users to easily manipulate topics can be extremely useful in refactoring a busy web or site. However, there are at least two significant potential drawbacks to take into account:- When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
- Due to current limitations, fairly heavy use of Rename/Move/Delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename... is used heavily, these negatives will obviously increase, in number and effect.
Known Issues
Rename/Move is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present. Instead, %SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is thatsearch can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different.
The following shows some limitations of square bracket processing.
Related Topics: UserDocumentationCategory, AdminDocumentationCategory Back to top[[Old Topic]] => [[NewTopic][Old Topic]] [[old topic]] => [[NewTopic][old topic]] [[old t opic]] => not changed [[OldTopic]] => [[NewTopic]]
Managing Webs
Adding, renaming and deleting webs are all web-based operations.Overview
A TWikiSite is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.Choose Web Template
There are two methods used to create a new web. First you can use a specially designed TemplateWeb. This is an invisible web that begins with an underscore "_" character (for example_default). All topics in the template web will be copied into your new web.
The second method is to use an existing web as a template web. This may be useful if you already have a web that you would like to use as a starting point. Only topics that have names beginning with Web... (like "WebHome", "WebNotify", etc.) are copied.
In either case you will want to be sure to verify that your new web has all the custom modifications that you desire. Any TWikiVariables defined in the form below will automatically be set in the WebPreferences of the new web.
Adding a New Web
Notes:- You must have
ROOTCHANGEaccess to create a top-level web (one with no parent) - Only the person who created it has permission to change the WebPreferences in the new web
Hierarchical Webs
You can only create hierarchical webs (webs within webs) if the{EnableHierarchicalWebs} setting in configure is enabled. Hierarchical webs are currently enabled.
Note: You might not need hierarchical webs. TWiki topics already have a parent/child relationship within a web, which is shown in the breadcrumb. Try to keep the number of webs to a minimum in order to keep search and cross-referencing simple.
You can create hierarchical webs via the Adding a New Web form above, by using a slash- or dot-separated path name which is based on an existing web name in the Name of new web: field.
Example:
To create a subweb named Bar inside a web named Foo, use Foo/Bar or Foo.Bar as the new web name in the form above.
Subweb Preferences are Inherited
The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the TWiki.TWikiPreferences topic. Example Preference Inheritance forSandbox/TestWeb/SubWeb.SubWebTopic topic:
-
TWiki.TWikiPreferencessite-wide preferences -
Sandbox.WebPreferencesinherits from and overrides settings inTWiki.TWikiPreferences -
Sandbox/TestWeb.WebPreferencesinherits from and overrides settings inSandbox.WebPreferences -
Sandbox/TestWeb/SubWeb.WebPreferencesinherits from and overrides settings inSandbox/TestWeb.WebPreferences -
Sandbox/TestWeb/SubWeb.SubWebTopicinherits from and overrides settings inSandbox/TestWeb/SubWeb.WebPreferences
Navigation
The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.Renaming or Deleting a Web
Rename a web via the Tools section in each WebPreferences topic. You may delete a web by moving it into a Trash web.Permissions
You may only rename a web if you have permissions to rename all the topics within that web, including any topics in that web's subwebs. You will also need permissions to update any topics containing references to that web.Edit Conflicts
If anyone is editing a topic which requires updating, or which lives in the web being renamed, a second confirmation screen will come up which will indicate which topics are still locked for edit. You may continue to hit the refresh button until an edit lease is obtained for each topic which requires updating (the "Refresh" button will change to "Submit"), or hit "Cancel", which will cancel your edit lease on all affected topics.Renaming the webs in the distribution
It is possible, though not recommended, to change the names of the webs in the distribution. If you plan to rename the Main web, remember that TWiki stores user topics in this web. That means that every WikiName signature -Main.SomeUserName - points to it and would need updating (unless the variable, %USERSWEB%.SomeUserName, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of WebPreferences, as described above.
If you want to rename the TWiki or Main webs, remember they are referred to in the TWiki configuration. You will need to change the {SystemWebName}, {UsersWebName} and/or {LocalSitePreferences} settings in the configuration using the configure interface.
Renaming the webs in the distribution is not recommended because it makes upgrades much more complicated.
Related Topics: AdminDocumentationCategory, AdminToolsCategory
Back to top
Manage Users
Register users on your TWiki site; change/reset/install passwords; remove user accounts Some of the features below may be disabled, depending on your TWiki
configuration.
Authentication and Access Control
- TWikiUserAuthentication describes your options for user authentication
- TWikiAccessControl describes how to define groups and how to restrict access to content
Register User
You don't have to have user home pages in TWiki for Authentication to work - see TWikiUserAuthentication for details.- TWikiRegistration is used when you want new users to individually register with TWiki by filling out a form
- You can create a custom versions of NewUserTemplate and UserForm
- BulkRegistration is used by administrators to register multiple users at the same time
Change, Reset and Install Passwords
Note that the below features are only relevant when you use an internal password manager where TWiki can set and reset passwords.- ChangePassword is for users who can remember their password and want to change it
- ResetPassword is for users who cannot remember their password; a system generated password is e-mailed to them
- BulkResetPassword if for administrators who want to reset many passwords at once
- ChangeEmailAddress changes the hidden email address stored in the password file
Changing User Account Names
To change the user's WikiName:- Rename the user's TWiki homepage in the Main web, such as from
JaneSmithtoJaneMiller.- Fix backlinks in the Main web only
- Make sure the group topics are updated (if any.)
- Edit the Main.TWikiUsers topic and move the user's entry so that the list is in proper alphabetical order.
- Recreate the old topic with a pointer to the new topic, so that links in other webs work properly. Example content:
%M% Jane Smith is now known as JaneMiller
- The login name needs to be changed in the authentication server (e.g. Active Directory)
- In TWiki's Main.TWikiUsers topic, fix the mapping from login name to WikiName:
* JaneSmith - jsmith - 13 Sep 2006
to:
* JaneMiller - jmiller - 13 Sep 2006
Removing User Accounts
To remove a user account (FredQuimby, who logs in as "fred"):- If you are using a
.htpasswdfile, edit the.htpasswdfile to delete the line startingfred:- Warning: Do not use the Apache
htpasswdprogram with.htpasswdfiles generated by TWiki!htpasswdwipes out email addresses that TWiki plants in the info fields of this file.
- Warning: Do not use the Apache
- Remove the
FredQuimby - fredline from the Main.TWikiUsers topic - Remove
FredQuimbyfrom all groups and from all theALLOWWEB/ALLOWTOPIC...declarations, if any.
Note: If you fail to do this you risk creating a security hole, as the next user to register with the wikiname FredQuimby will inherit the old FredQuimby's permissions. - [optional] Delete their user topic Main.FredQuimby (including attachments, if any.)
Appendix A: TWiki Development Time-line
TWiki Release 4.2 (Freetown), 22 Jan 2008
New Features and Enhancements of TWiki Release 4.2- Easier Installation and Upgrade
- New Internal Admin Login feature
- The Main.TWikiUsers topic is no longer distributed as a default topic in Main web
- A new directory
workingwhich per default is located in the TWiki root which contains registration_approvals, tmp, and work_areas - Configure can now authenticate when connecting to local plugins repository.
- Usability Enhancements
- New WYSIWYG editor based on TinyMCE replaces the Kupu based editor
- New "Restore topic" feature has been added to the More Topic Actions menu to easily restore an older version of a topic
- Application Platform Enhancements
- Enhancements to IF: allows, ingroup, istopic, and isweb
- Search Enhancements
- New
querysearch mode supports SQL-style queries over form fields and other meta-data
- New
- Skins and Templates Enhancements
- The PatternSkin which is the default skin for TWiki has got a face lift
- The default templates have been heavily refactored to make it easier to create skins reusing the default skin.
- Miscellaneous Feature Enhancements
- Many new functions in the API for plugin developers
- Table of Content (TOC) feature enhanced
- re-architected Pluggable user mapping (between login name and WikiName) to integrate with alternative authentication and Management schemes
- Topic based User management has been extracted into a separately update-able package (TWikiUsersContrib)
- Enhancements of Pre-installed Plugins
- CommentPlugin: New
templatetopicparameter to point to custom comment template topic - EditTablePlugin: Move and delete rows
- MailerContrib: Allow Exclusion Of Webs
- SpreadSheetPlugin: 6 new math formulas; formula to format time diff
- CommentPlugin: New
- Bug Fixes
- More than 300 bugs fixes since 4.1.2
- Release management led by TWiki:Main.KennethLavrsen, ably assisted by TWiki:Main.SvenDowideit
- Design and development driven by TWiki:Main.CrawfordCurrie, TWiki:Main.ArthurClemens, and TWiki:Main.SvenDowideit
- Testing driven by TWiki:Main.KennethLavrsen
- Sponsor and facilitator: TWiki:Main.PeterThoeny
- Testing and bug fixing: TWiki:Main.KennethLavrsen, TWiki:Main.CrawfordCurrie, TWiki:Main.ArthurClemens, TWiki:Main.SvenDowideit, TWiki:Main.SteffenPoulsen, TWiki:Main.MichaelDaum, TWiki:Main.PeterThoeny, TWiki:Main.RichardDonkin
- Spec and code: TWiki:Main.CrawfordCurrie (2323), TWiki:Main.ArthurClemens (566), TWiki:Main.SvenDowideit (507), TWiki:Main.PeterThoeny (83), TWiki:Main.KennethLavrsen (73), TWiki:Main.SteffenPoulsen (72), TWiki:Main.AntonioTerceiro (63) - ( 3857 changes by 20 authors )
- Templates and skins: TWiki:Main.ArthurClemens (587), TWiki:Main.CrawfordCurrie (130), TWiki:Main.AndreUlrich (73), TWiki:Main.SvenDowideit (44) - ( 869 changes by 12 authors )
- Documentation: TWiki:Main.ArthurClemens (460), TWiki:Main.CrawfordCurrie (377), TWiki:Main.PeterThoeny (233), TWiki:Main.AndreUlrich (157), TWiki:Main.SvenDowideit (118), TWiki:Main.KennethLavrsen (68) - ( 1450 changes by 14 authors )
- Release package builds: TWiki:Main.SvenDowideit
- Usability: TWiki:Main.CarloSchulz, TWiki:Main.ArthurClemens
- Translations: Coordinated by TWiki:Main.AntonioTerceiro
- Bulgarian: TWiki:Main.KrassimirBerov
- Danish: TWiki:Main.SteffenPoulsen
- Dutch: TWiki:Main.ArthurClemens
- Finnish: TWiki:Main.HeikkiToivonen
- French: TWiki:Main.BenVoui
- German: TWiki:Main.OliverKrueger, TWiki:Main.AndreUlrich
- Italian: TWiki:Main.MassimoMancini
- Portuguese: TWiki:Main.CarlinhosCecconi
- Simplified Chinese: TWiki:Main.CheDong
- Swedish: TWiki:Main.ErikAman
- Traditional Chinese: TWiki:Main.CheDong
- Ukrainian: TWiki:Main.SerhijDubyk
- Marketing: TWiki:Main.RodBeckstrom, TWiki:Main.PeterThoeny, TWiki:Main.MichaelCorbett, TWiki:Main.KoenMartens
- Public relations: TWiki:Main.PeterThoeny, TWiki:Main.MichaelCorbett
- Meetups: TWiki:Main.AmirShobeiri
- TWiki.org wiki champions: TWiki:Main.PeterThoeny, TWiki:Main.ArthurClemens, TWiki:Main.CrawfordCurrie, TWiki:Main.KennethLavrsen, TWiki:Main.SvenDowideit, TWiki:Main.MichaelDaum, TWiki:Main.CarloSchulz, TWiki:Main.StephaneLenclud, TWiki:Main.RichardDonkin, TWiki:Main.KoenMartens
- Customer support: TWiki:Main.PeterThoeny, TWiki:Main.ArthurClemens, TWiki:Main.CrawfordCurrie, TWiki:Main.SvenDowideit, TWiki:Main.HaraldJoerg
- System administration: TWiki:Main.SvenDowideit, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
TWiki Release 4.1 (Edinburgh), 16 Jan 2007
New Features and Enhancements of TWiki Release 4.1- Easier Installation and Upgrade
- Plugins can now be installed from the configure script.
- The loading of plugin preferences settings has been moved earlier in the preferences evaluation order so that plugin settings can be redefined in Main.TWikiPreferences, WebPreferences and in topics. To make TWiki upgrades easier, it is recommended to set the plugin settings in Main.TWikiPreferences, and not to customize the settings in the plugin topic. For example, to change the TEMPLATES setting of the CommentPlugin, create a new COMMENTPLUGIN_TEMPLATES setting in Main.TWikiPreferences.
- Plugin settings can now be defined in configure instead of in the plugin topic (requires that the individual plugin has implemented this). TWiki performs slightly better by not looking for preferences settings in plugin topics.
- Configure no longer shows many unnecessary errors when run first time.
- The webmaster email address is now defined in configure instead of TWikiPreferences.
- Default file access rights in the distribution package have been changed to be more universally defined and in line with the default access rights for new topics.
- Usability Enhancements
- Redesigned result page when typing incomplete topic name into the Jump box, so that it is possible to quickly navigate to a topic, also in a very large TWiki installation. For example, "I know there is a topic about Ajax somewhere in the Eng web. OK, let my type
Eng.ajaxinto the Jump box... Here we go, the third link is the AjaxCookbook I was looking for." - Many user documentation improvements.
- URL parameters maintained in Table of Contents links so you can stay in a temporary skin (e.g. print) and keep URLPARAM values when you click the TOC links
- Attachment tables now sorted alphabetically.
- Better printing of tables and verbatim text in PatternSkin.
- Redesigned result page when typing incomplete topic name into the Jump box, so that it is possible to quickly navigate to a topic, also in a very large TWiki installation. For example, "I know there is a topic about Ajax somewhere in the Eng web. OK, let my type
- Application Platform Enhancements
- Auto-incremented topic name on save with AUTOINC<n> in topic name; used by TWiki applications to create topic based database records.
- The edit and save scripts support a
redirecttoparameter to redirect to a topic or a URL; for security, redirect to URL needs to be enabled with a{AllowRedirectUrl}configure flag. - CommentPlugin supports the
redirecttoparameter to redirect to a URL or link to TWiki topic after submitting comment. - The
topicURL parameter also respects the{AllowRedirectUrl}configure flag so redirects to URLs can be disabled which could be abused for phishing attacks. - The view script supports a
sectionURL parameter to view just a named section within a topic. Useful for simple AJAX type applications. - New plugin handler for content move.
- Enhancements for Ajax based applications with TWiki:Plugins/YahooUserInterfaceContrib and TWiki:Plugins.TWikiAjaxContrib (available at twiki.org).
- Search Enhancements
- METASEARCH handles a format parameter like SEARCH.
- Topic not found / WebTopicViewTemplate search now case insensitive.
- FormattedSearch header supporting
$nop,$quot,$percnt,$dollar. - Add search by createdate option to SEARCH.
- New newline option for SEARCH to protect e.g. formfields from being altered during rendering in SEARCH.
- Skins and Templates Enhancements
- Support for templates to have text rendering affecting aspect outside of textarea.
- Pattern skin dependence on TwistyPlugin instead of TwistyContrib (performance improvement.)
- Don't strip newlines from the front of TMPL:DEFs.
- Miscellaneous Feature Enhancements
- Change in WikiWord definition: Numbers are treated as lower case letters, e.g. Y2K is now a WikiWord.
- Configurable template load path. Advanced feature for those that work with customized templates.
- Added %VBAR% to TWikiPreferences for vertical bar symbol.
- On topic creation, force initial letter of topic name to be upper case.
- Allow date format in form fields.
- Enhance REVINFO{} variable with same date qualifiers as GMTIME{}.
- WebTopicCreator - adding ability to select a template from any topic name ending in ...Template
- Functionality of TWiki:Plugins.DateFieldPlugin merged into core
- Enhancements of Pre-installed Plugins
- CommentPlugin: Supports removal of comment prompt after a comment is made.
- EditTablePlugin: Default date format based on JSCalendarContrib instead of plugin topic.
- InterwikiPlugin: Supports custom link formats.
- SlideShowPlugin: Preserves URL parameters in slideshow
- SpreadSheetPlugin: New functions
$LISTRAND(),$LISTSHUFFLE(),$LISTTRUNCATE(). - TablePlugin: New attribute
cellborder. - TablePlugin: Highlight the sorted column with custom colors; includes also a general cosmetic update of default colors.
- TablePlugin: Support for initsort on more than one table. A table with the initsort option is initsorted UNLESS it is sorted by clicking on a column header. If you click on a header of another table all other tables goes back to the default sort defined by initsort or not sorted if no initsort, and the new table is sorted based on the user clicking on a table header.
- Bugfixes
- More than 200 bugs fixed since 4.0.5
- Sponsor and facilitator: TWiki:Main.PeterThoeny
- Process improvement: TWiki:Main.KennethLavrsen, TWiki:Main.PeterThoeny, TWiki:Main.SteffenPoulsen, TWiki:Main.CrawfordCurrie
- Release management: TWiki:Main.KennethLavrsen
- Spec, code, testing: TWiki:Main.CrawfordCurrie, TWiki:Main.ArthurClemens, TWiki:Main.SteffenPoulsen, TWiki:Main.PeterThoeny, TWiki:Main.ThomasWeigert, TWiki:Main.KennethLavrsen, TWiki:Main.SvenDowideit, TWiki:Main.HaraldJoerg, TWiki:Main.MichaelDaum, TWiki:Main.MeredithLesly, TWiki:Main.WillNorris, TWiki:Main.RafaelAlvarez, TWiki:Main.AntonioTerceiro
- Templates and skins: TWiki:Main.ArthurClemens, TWiki:Main.MichaelDaum, TWiki:Main.SvenDowideit
- Documentation: TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.ArthurClemens, TWiki:Main.SteffenPoulsen, TWiki:Main.KennethLavrsen
- Translations: Coordinated by TWiki:Main.AntonioTerceiro
- Chinese: TWiki:Main.CheDong
- Czech: TWiki:Main.IvanKuncl
- Danish: TWiki:Main.SteffenPoulsen
- Dutch: TWiki:Main.ArthurClemens
- French: TWiki:Main.BenVoui
- German: TWiki:Main.AndreUlrich
- Italian: TWiki:Main.MassimoMancini
- Polish: TWiki:Main.ZbigniewKulesza
- Portuguese: TWiki:Main.AntonioTerceiro, TWiki:Main.CarlinhosCecconi
- Russian: TWiki:Main.AndreyTkachenko, TWiki:Main.SergejZnamenskij, TWiki:Main.SergeyJSinx, TWiki:Main.AlexTananaev
- Spanish: TWiki:Main.WillNorris, TWiki:Main.MiguelABayona
- Swedish: TWiki:Main.ErikAman
- Public relations: TWiki:Main.PeterThoeny, TWiki:Main.TomTansy
- TWiki.org wiki champions: TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.KennethLavrsen, TWiki:Main.SteffenPoulsen, TWiki:Main.ArthurClemens, TWiki:Main.ThomasWeigert, TWiki:Main.MichaelDaum
- Customer support: TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.ArthurClemens, TWiki:Main.SteffenPoulsen, TWiki:Main.SteveStark, TWiki:Main.MichaelDaum
- System administration: TWiki:Main.SvenDowideit, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
TWiki Release 4.0.0 (Dakar), 01 Feb 2006
Major New Features- Much simpler install and configuration
- Integrated session support
- Webserver-independent login/logout
- Security sandbox blocking exploits for remote command execution on the server
- Edit conflict resolution with automatic merge
- Multilingual UI
- E-mail confirmations for registration
- WYSIWYG editor (beta)
- Hierarchical sub-webs (beta)
| Installation & configuration | Contributor |
|---|---|
| Much simpler install and configuration | Crawford Currie, LynnwoodBrown, ArthurClemens |
mod_perl safe code for better performance |
Crawford Currie |
| Security | |
| Security sandbox blocking exploits for remote command execution on the server | Florian Weimer, Crawford Currie, Sven Dowideit |
| Reworked access permission model | Crawford Currie |
| Internationalization & localization | |
| User Interface Internationalisation | AntonioTerceiro |
| Chinese translation | CheDong |
| Danish translation | SteffenPoulsen |
| Dutch translation | ArthurClemens |
| French translation | BenVoui |
| German translation | AndreUlrich |
| Italian translation | MassimoMancini |
| Polish translation | ZbigniewKulesza |
| Portuguese translation | AntonioTerceiro, CarlinhosCecconi |
| Spanish translation | WillNorris, MiguelABayona |
| Swedish translation | Erik Åman |
| New features for users | |
| Edit conflict resolution with automatic merge | Crawford Currie |
| Fine grained change notification on page level and parent/child relationship | Crawford Currie |
| WYSIWYG editor | Crawford Currie, ColasNahaboo, DamienMandrioli, RomainRaugi |
| Integrated session support | GregAbbas, Crawford Currie |
| Webserver-independent login/logout | Crawford Currie |
| Registration process with e-mail confirmation | MartinCleaver |
| Tip of the Day box in TWiki Home | PaulineCheung, Peter Thoeny, AntonAylward |
| ATOM feeds | Peter Thoeny |
| "Force New Revision" check box for topic save | WillNorris |
| New features for TWiki administrators and wiki application developers | |
| Improved preferences handling | ThomasWeigert, Crawford Currie |
| Named include sections | RafaelAlvarez |
| Create topic names with consecutive numbers | Sven Dowideit |
| Parameterized includes | Crawford Currie |
| Dynamic form option definitions of TWikiForms with FormattedSearch | MartinCleaver |
SEARCH enhancements with new parameters excludeweb, newline, noempty, nofinalnewline, nonoise, recurse, zeroresults |
Crawford Currie, ArthurClemens, Peter Thoeny, ThomasWeigert |
FormattedSearch enhancements with $changes, $count, $formfield(name, 30, ...), $summary(expandvar), $summary(noheaders), $summary(showvarnames) |
ColasNahaboo, Crawford Currie, Peter Thoeny, Sven Dowideit |
| New TWikiVariables ACTIVATEDPLUGINS, ALLVARIABLES, AUTHREALM, EMAILS, FAILEDPLUGINS, HTTP, HTTPS, ICONURL, ICONURLPATH, IF, LANGUAGES, LOCALSITEPREFS, LOGIN, LOGOUT, MAKETEXT, META, PLUGINDESCRIPTIONS, QUERYSTRING, STARTSECTION/ENDSECTION, SESSION_VARIABLE, SESSIONID, SESSIONVAR, SPACEOUT, USERLANGUAGE, WIKIHOMEURL | ArthurClemens, AntonioTerceiro, Crawford Currie, GregAbbas, Peter Thoeny, Sven Dowideit, WillNorris and many more |
| TWiki form with hidden type and other form enhancements | LynnwoodBrown, ThomasWeigert |
| Support topic-specific templates for TWiki applications | ThomasWeigert |
| Direct save feature for one-click template-based topic creation | LynnwoodBrown, Crawford Currie, ThomasWeigert |
| Automatic Attachments showing all files in the attachment directory | MartinCleaver |
| Rename, move or delete webs | PeterNixon |
| Hierarchical subwebs (beta) | PeterNixon |
| New features for Plugin developers | |
| REST (representational state transfer) interface for Plugins | RafaelAlvarez, TWiki:Main.MartinCleaver, Sven Dowideit |
| New and improved Plugins APIs | Crawford Currie, ThomasWeigert |
| Improvements in the TWiki engine room | |
| Major OO redesign and refactoring of codebase | Crawford Currie |
| Automatic build system | Crawford Currie |
| Extensive test suite, unit tests and testcases | Crawford Currie |
| TWiki:Codev.DevelopBranch , DEVELOP branch Bugs system | Sven Dowideit |
| Documentation, logo artwork, skins: | |
| Documentation | Crawford Currie, LynnwoodBrown, Peter Thoeny, Sven Dowideit and others |
| Design of TWikiLogos with big "T" in a speech bubble | ArthurClemens, Peter Thoeny |
| Improved templates and PatternSkin | ArthurClemens |
01-Sep-2004 Release (Cairo)
Major New Features- Automatic upgrade script, and easier first-time installation
- Attractive new skins, using a standard set of CSS classes, and a skin browser to help you choose
- New easier-to-use save options
- Many improvements to SEARCH
- Improved support for internationalisation
- Better topic management screens
- More pre-installed Plugins: CommentPlugin, EditTablePlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TablePlugin
- Improved Plugins API and more Plugin callbacks
- Better support for different authentication methods
- Many user interface and usability improvements
- And many, many more enhancements
| Details of New Features and Enhancements of 01-Sep-2004 Release | Developer, Sponsor |
|---|---|
| Install: Ship with an automatic upgrade script to facilitate TWiki upgrades. Details | TWiki:Main.MartinGregory TWiki:Main.SvenDowideit |
| Install: New testenv function to change the locks in the TWiki database to the web server user id (automates installation step). Details | TWiki:Main.MattWilkie TWiki:Main.SvenDowideit |
| Install: The shipped .htaccess.txt now needs to be edited before it is valid, to help reduce chances of error. Details | TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| Install: Configurable password file handling for different types of encryption. Details | TWiki:Main.PavelGoran TWiki:Main.SvenDowideit |
| Install: Remove office locations from registration. Details | TWiki:Main.PeterThoeny |
| Install: Changes to support shorter URLs with Apache Rewrite rules. Details | TWiki:Main.AntonioBellezza TWiki:Main.WalterMundt |
| Install: Remove the Know web from the distribution. Details | TWiki:Main.PeterThoeny |
| Internationalization: Support use of UTF-8 URLs for I18N characters in TWiki page and attachment names. Details | TWiki:Main.RichardDonkin |
| Authentication: Authenticate users when creating new topic in view restricted web. Details | TWiki:Main.JonathanGraehl TWiki:Main.SvenDowideit |
| Preferences: TWiki Preferences need to be secured properly. Details | TWiki:Main.PeterThoeny |
| Preferences: Use TWiki Forms to set user preferences. Details | TWiki:Main.JohnTalintyre |
| Skins: New pre-installed skins PatternSkin and DragonSkin. Details | TWiki:Main.ArthurClemens TWiki:Main.PeterThoeny |
| Skins: New skin browser to choose from installed skins. Details | TWiki:Main.PeterThoeny |
| Skins: Documented set of CSS classes that are used in standard skins. Details | TWiki:Main.ArthurClemens TWiki:Main.SvenDowideit |
| Skins: Added CSS class names to Diff output. Details | TWiki:Main.SvenDowideit |
| Skins: Templates can now be read from user topics, as well as from files in the templates diretcory. Details | TWiki:Main.CrawfordCurrie TWiki:Main.WalterMundt |
| Skins: Ensure that the default template gets overridden by a template passed in. Details | TWiki:Main.MartinCleaver TWiki:Main.WalterMundt |
| Skin: Convey an important broadcast message to all users, e.g. scheduled server downtime. Details | TWiki:Main.PeterThoeny |
| Skin: Balanced pastel colors for TWiki webs. Details | TWiki:Main.ArthurClemens |
| Rendering: Use exclamation point prefix to escape TWiki markup rendering. Details | TWiki:Main.ArthurClemens |
| Rendering: Ordered lists with uppercase & lowercase letters, uppercase & lowercase Roman numerals. Details | TWiki:Main.DanBoitnott TWiki:Main.PeterThoeny |
| Rendering: Allow custom styles for the "?" of uncreated topics. Details | TWiki:Main.SvenDowideit |
| Rendering: Render IRC and NNTP as a URL. Details | TWiki:Main.PeterThoeny |
| Rendering: Make acronym linking more strict by requiring a trailing boundary, e.g. excluding TLAfoobar. Details | TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| Rendering: TWiki Form with Label type. Details | TWiki:Main.PeterThoeny |
| Rendering: Web names can now be WikiWords. Details | TWiki:Main.PeterThoeny |
| Rendering: New syntax for definition list with dollar sign and colon. Details | TWiki:Main.AdamTheo TWiki:Main.PeterThoeny |
| Rendering: Table with multi-span rows, functionality provided by Table Plugin. Details | TWiki:Main.WalterMundt |
| Variables: New title parameter for TOC variable. Details | TWiki:Main.PeterThoeny TWiki:Main.ArthurClemens |
| Variables: New REVINFO variable in templates supports flexible display of revision information. Details | TWiki:Main.PeterThoeny TWiki:Main.SvenDowideit |
| Variables: Set times to be displayed as gmtime or servertime. Details | TWiki:Main.SueBlake TWiki:Main.SvenDowideit |
| Variables: Properly encode parameters for form fields with ENCODE variable. Details | TWiki:Main.PeterThoeny |
| Variables: Expand USERNAME and WIKINAME in Template Topics. Details | TWiki:Main.PeterThoeny |
| Variables: Expand same variables in new user template as in template topics. Details | TWiki:Main.PeterThoeny |
| Variables: Optionally warn when included topic does not exist; with the option to create the included topic. Details | TWiki:Main.PeterThoeny |
| Variables: In topic text show file-types of attached files as icons. Details | TWiki:Main.PeterThoeny |
| Variables: New variable FORMFIELD returns the value of a field in the form attached to a topic.. Details | TWiki:Main.DavidSachitano TWiki:Main.SvenDowideit |
| Variables: Meta data rendering for form fields with META{"formfield"}. Details | TWiki:Main.PeterThoeny |
| Variables: New PLUGINVERSION variable. Details | TWiki:Main.PeterThoeny |
Variables: URLPARAM now has a default="..." argument, for when no value has been given. Details |
TWiki:Main.PeterThoeny |
| Variables: URLPARAM variable with newline parameter. Details | TWiki:Main.PeterThoeny |
| Variables: URLPARAM variable with new multiple=on parameter. Details | TWiki:Main.PaulineCheung TWiki:Main.PeterThoeny |
| Search: New switch for search to perform an AND NOT search. Details | TWiki:Main.PeterThoeny |
| Search: Keyword search to search with implicit AND. Details | TWiki:Main.PeterThoeny |
| Search: Multiple searches in same topic with new multiple="on" paramter. Details | TWiki:Main.PeterThoeny |
| Search: Remove limitation on number of topics to search in a web. Details | TWiki:Main.PeterThoeny |
| Search: Exclude topics from search with an excludetopic parameter. Details | TWiki:Main.PeterThoeny |
| Search: Expand Variables on Formatted Search with expandvariables Flag. Details | TWiki:Main.PeterThoeny |
| Search: Formatted Search with Web Form variable to retrieve the name of the form attached to a topic. Details | TWiki:Main.FrankSmith TWiki:Main.PeterThoeny |
| Search: Formatted Search with Conditional Output. Details | TWiki:Main.PeterThoeny |
| Search: Formatted Search with $parent token to get the parent topic. Details | TWiki:Main.PeterThoeny |
| Search: New separator parameter to SEARCH supports better SEARCH embedding. Details | TWiki:Main.PeterThoeny |
| Search: Improved search performance when sorting result by topic name. Details | TWiki:Main.PeterThoeny |
Search: New scope=all search parameter to search in topic name and topic text at the same time. Details |
TWiki:Main.PeterThoeny |
Search: New topic parameter for AND search on topic text and topic name. Details |
TWiki:Main.PeterThoeny |
| Search modules uses Perl-style keyword parameters (code cleanup). Details | TWiki:Main.PeterThoeny |
| Search: New $wikiname variable in format parameter of formatted search. Details | TWiki:Main.ArthurClemens |
| Search: Sort search by topic creation date. Details | TWiki:Main.PeterThoeny |
| Search: Topic creation date and user in Formatted Search. Details | TWiki:Main.CoreyFruitman TWiki:Main.SvenDowideit |
| Search: Increase levels of nested search from 2 to 16. Details | TWiki:Main.PeterThoeny |
| Plugins: New pre-installed Plugins CommentPlugin, EditTablePlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TablePlugin. Details | TWiki:Main.PeterThoeny |
Plugins: New callback afterSaveHandler, called after a topic is saved. Details |
TWiki:Main.WalterMundt |
Plugins: New callbacks beforeAttachmentSaveHandler and afterAttachmentSaveHandler, used to intervene on attachment save event. Details |
TWiki:Main.MartinCleaver TWiki:Main.WalterMundt |
Plugins: New callbacks beforeCommonTagsHandler and afterCommonTagsHandler. Details |
TWiki:Main.PeterThoeny |
Plugins: New callback renderFormFieldForEditHandler to render form field for edit. Details |
TWiki:Main.JohnTalintyre |
Plugins: New callback renderWikiWordHandler to custom render links. Details |
TWiki:Main.MartinCleaver TWiki:Main.WalterMundt |
Plugins: New function TWiki::Func::formatTime to format time into a string. Details |
TWiki:Main.SvenDowideit |
Plugins: New function TWiki::Func::getRegularExpression to get predefined regular expressions. Details |
TWiki:Main.RichardDonkin |
Plugins: New functions TWiki::Func::getPluginPreferences* to get Plugin preferences. Details |
TWiki:Main.WalterMundt |
Plugins: New function TWiki::Func::extractParameters to extract all parameters from a variable string. Details |
TWiki:Main.PeterThoeny |
Plugins: New function TWiki::Func::checkDependencies to check for module dependency. Details |
TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| Plugins: A recommendation for where a Plugin can store its data. Details | TWiki:Main.PeterThoeny |
| UI: Show tool-tip topic info on WikiWord links. Details | TWiki:Main.PeterThoeny |
| UI: Save topic and continue edit feature. Details | TWiki:Main.ColasNahaboo |
| UI: Change topic with direct save (without edit/preview/save cycle) and checkpoint save. Details | TWiki:Main.MattWilkie TWiki:Main.SvenDowideit |
| UI: In attachment table, change 'action' to 'manage'. Details | TWiki:Main.PeterThoeny TWiki:Main.ArthurClemens |
| UI: Smaller usability enhancements on the file attachment table. Details | TWiki:Main.PeterThoeny TWiki:Main.ArthurClemens |
| UI: Removes anchor links from header content and places them before the text to fix 'header becomes link'. Details | TWiki:Main.ArthurClemens |
| UI: Improved functionality of the More screen. Details | TWiki:Main.PeterThoeny TWiki:Main.ArthurClemens |
| UI: Quick reference chart of most used markup is now listed on the edit screen. Details | TWiki:Main.ArthurClemens |
| UI: Flag for edit script to avoid overwrite of existing topic text and form data. Details | TWiki:Main.NielsKoldso TWiki:Main.PeterThoeny |
| UI: Disable Escape key in IE textarea to prevent it cancelling work. Details | TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny |
| UI: Improved warning message on unsaved topic. Details | TWiki:Main.MartinGregory TWiki:Main.SvenDowideit |
| UI: Reverse order of words in page title for better multi-window/tab navigation. Details | TWiki:Main.ArthurClemens |
| UI: Provides a framework to create and modify a topic without going through edit->preview->save sequence. Details | TWiki:Main.AndreUlrich TWiki:Main.SvenDowideit |
| UI: Set the topic parent to none in More screen, e.g. remove the current topic parent. Details | TWiki:Main.PeterThoeny |
| UI: Use templates to define how file attachments are displayed. Was previously hard-coded. Details | TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| UI: Topic diff shows unified diff with unchanged context. Details | TWiki:Main.SvenDowideit |
| UI: Diff feature shows TWiki form changes in nice tables. Details | TWiki:Main.SvenDowideit |
| Code refactoring: The log entry for a save now has a dontNotify flag in the extra field if the user checked the minor changes flag. Details | TWiki:Main.PeterThoeny |
| Code refactoring: Server-side include of attachments accelerates INCLUDE. Details | TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny |
| Code refactoring: Move functionality out of bin scripts and into included modules. Details | TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| Code refactoring: Move bin script functionality into TWiki::UI modules. Details | TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny |
| Code refactoring: Optimize preferences handling for better performance. Details | TWiki:Main.PavelGoran TWiki:Main.WalterMundt |
| Code refactoring: Refactor variable expansion for edit and register. Details | TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny |
| Code refactoring: Move savemulti script into TWiki::UI::Save. Details | TWiki:Main.MattWilkie TWiki:Main.SvenDowideit |
| Code refactoring: Topic search is done natively in Perl, it does not depend anymore on system calls with pipes. Details | TWiki:Main.PeterThoeny |
| Code refactoring: Fix logical error in upload script which prevented MIME filename from being used. Details | TWiki:Main.WalterMundt |
| Bug Fixes of 01-Sep-2004 Release | Developer, Sponsor |
|---|---|
| Fix: Consistently create headings with empty anchor tags. Details | TWiki:Main.PeterThoeny |
| Fix: TOC does not work for headings containing & without spaces surrounding it. Details | TWiki:Main.PeterThoeny |
| Fix: Backslash line break breaks TWiki form definitions. Details | TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny |
| Fix: Rename fixes unrelated topic references. Details | TWiki:Main.RichardDonkin |
| Fix: Bug with infinite recursion in search. Details | TWiki:Main.PeterThoeny |
| Fix: Can't send mail with full 'From' address. Details | TWiki:Main.PeterThoeny |
| Fix: All scripts change to $bin before execute (for mod_perl2). Details | TWiki:Main.PeterThoeny |
| Fix: Several RSS readers do not show all entries seen in the WebChanges list; repeated updates to the same topics get lost. Details | TWiki:Main.ArthurClemens |
| Fix: TWiki::Access::checkAccessPermission function improperly handles Main and TWiki webs. Details | TWiki:Main.SvenDowideit |
| Fix: Topic save returns error CI Date precedes date in revision. Details | TWiki:Main.PeterThoeny |
| Fix: Double quotes got replaced by " in TWiki forms. Details | TWiki:Main.MichaelSparks TWiki:Main.PeterThoeny |
| Fix: Duplicated Wiki name in .htpasswd entry for sha1 encoding. Details | TWiki:Main.PeterThoeny |
| Fix: When viewing a previous version of a topic, the view script substitutes only one occurrence of the variable EDITTOPIC. Details | TWiki:Main.PeterThoeny |
| Fix: Form default values are not working for text fields. Details | TWiki:Main.ThomasWeigert TWiki:Main.SvenDowideit |
| Fix: Formatted searches using a $pattern which unbalanced parenthesis crash TWiki. Details | TWiki:Main.PeterThoeny |
| Fix: Formatted Search uses title but should use name for formfield parameter. Details | TWiki:Main.PeterThoeny |
| Fix: GMTIME variable returns unwanted GMT text. Details | TWiki:Main.SvenDowideit |
| Fix: Include from other Web links ACRONYMS. Details | TWiki:Main.PeterThoeny |
| Fix: Including an HTML file is very slow. Details | TWiki:Main.JohnTalintyre |
| Fix: includeUrl() mess up absolute URLs. Details | TWiki:Main.SvenDowideit |
| Fix: Filter out fixed font rendering in TOC to avoid unrendered = equal signs in TOC. Details | TWiki:Main.PeterThoeny |
| Fix: The initializeUserHandler is broken for session Plugins. Details | TWiki:Main.JohnTalintyre |
| Fix: SEARCH fails with very large webs. Details | TWiki:Main.PeterThoeny |
| Fix: Security alert: User could gain view access rights of another user. Details | TWiki:Main.KimCovil TWiki:Main.PeterThoeny |
| Fix: 'print to closed file handle' error of log files are not writable. Details | TWiki:Main.MartinGregory TWiki:Main.SvenDowideit |
| Fix: Meta data handler can't process CR-LF line endings. Details | TWiki:Main.PeterThoeny |
| Fix: METAFIELD meta data is not shown in view raw=on mode. Details | TWiki:Main.PeterThoeny |
| Fix: Minor XHTML non-compliance in templates and code. Details | TWiki:Main.PeterThoeny |
| Fix: Getting pages from virtual hosts fails. Details | TWiki:Main.JohnTalintyre |
| Fix: Create new web fails if RCS files do not exist. Details | TWiki:Main.ClausBrunzema TWiki:Main.SvenDowideit |
| Fix: Metacharacters can be passed through to the shell in File Attach. Details | TWiki:Main.PeterThoeny |
| Fix: Ability to delete non-WikiWord topics without confirmation. Details | TWiki:Main.PeterThoeny |
| Fix: + symbol in password reset fails. Details | TWiki:Main.PeterThoeny |
| Fix: Pathinfo cleanup for hosted sites. Details | TWiki:Main.MikeSalisbury TWiki:Main.SvenDowideit |
| Fix: Software error in SEARCH if regular expression pattern has unmached parenthesis. Details | TWiki:Main.PeterThoeny |
| Fix: Pipe chars in the comment field of the attachment table are not escaped. Details | TWiki:Main.PeterThoeny |
| Fix: Link escaping in preview fails for not quoted hrefs. Details | TWiki:Main.TedPavlic TWiki:Main.PeterThoeny |
| Fix: Preview expands variables twice. Details | TWiki:Main.PeterThoeny |
| Fix: Using a proxy with TWiki fails; no proxy-HTTP request, minimal request not HTTP 1.0, requests marked 1.1 are at best 1.0. Details | TWiki:Main.MichaelSparks TWiki:Main.JohnTalintyre |
| Fix: Runaway view processes with TWiki::Sore::RcsLite. Details | TWiki:Main.SvenDowideit |
| Fix: Regex Error in WebTopicList with topics that have meta characters in the name. Details | TWiki:Main.PeterThoeny |
| Fix: Rename script misses some ref-by topics. Details | TWiki:Main.JohnTalintyre |
| Fix: Links to self within the page being renamed are not changed. Details | TWiki:Main.SvenDowideit |
| Fix: Rename topic does 'Main.Main.UserName' for attachments. Details | TWiki:Main.PeterThoeny |
| Fix: Revision date is set to Jan 1970 when using RCS Lite. Details | TWiki:Main.SvenDowideit |
| Fix: The new dynamically-created SiteMap is very nice, but somewhat slow. Details | TWiki:Main.PeterThoeny |
| Fix: The makeAnchorName function did not produce the same results if called iteratively, resulting in problems trying to link to headers.. Details | TWiki:Main.WalterMundt |
| Fix: Statistics page does not provide links to non-wikiword topics. Details | TWiki:Main.PeterThoeny |
| Fix: Make TOC link URI references relative. Details | TWiki:Main.MartinGregory TWiki:Main.PeterThoeny |
| Fix: TWiki hangs when used on Apache 2.0. Details | TWiki:Main.SvenDowideit |
| Fix: TOC incorrectly strips out links in headers. Details | TWiki:Main.PeterThoeny |
| Fix: The HTML tags that are generated by TOC do not close properly. Details | TWiki:Main.PeterThoeny |
| Fix: TOC on INCLUDEd topic ignores STOPINCLUDE. Details | TWiki:Main.WillNorris TWiki:Main.PeterThoeny |
| Fix: Quotes in tooltip message can break a TWiki form. Details | TWiki:Main.PeterThoeny |
| Fix: Better error message if the file attachment directory is not writable. Details | TWiki:Main.CrawfordCurrie TWiki:Main.SvenDowideit |
| Fix: Image size of PNG files. Details | TWiki:Main.ArthurClemens |
| Fix: The testenv script distinguishes between real user ID and effective user ID. Details | TWiki:Main.RichardDonkin |
| Fix: Variables in square bracket links dont work in form fields. Details | TWiki:Main.SvenDowideit |
| Fix: Variable with Parameters in Form Fields Disappear. Details | TWiki:Main.PeterThoeny |
| Fix: Verbatim tag should escape HTML entities. Details | TWiki:Main.PeterThoeny |
| Fix: Field names of TWiki Forms can be WikiWords, this is used to link to a help topic. Details | TWiki:Main.PeterThoeny |
| Fix: Clean up the WebRssBase INCLUDES to use VARIABLES set in TWikiPreferences. Details | TWiki:Main.SvenDowideit |
| Fix: Resolving variables in included topics. Details | TWiki:Main.OliverKrueger TWiki:Main.SvenDowideit |
01-Feb-2003 Release (Beijing)
- 18 Jan 2003 - TWiki:Main.PeterThoeny
- Support for
/bin/view/Web.TopicNametopic view URL (besides the default/bin/view/Web/TopicNameURL); useful for InterwikiPlugin links like TWiki:Codev.ReadmeFirst
- Support for
- 31 Dec 2002 - TWiki:Main.PeterThoeny
- Enhanced Plugin API to manipulate topic data with new functions in Func.pm:
readTopicText,saveTopicText,setTopicEditLock,checkTopicEditLock
- Enhanced Plugin API to manipulate topic data with new functions in Func.pm:
- 31 Dec 2002 - TWiki:Main.PeterThoeny
- New
%NOAUTOLINK%setting in the TWikiPreferences to disable the auto-linking of WikiWords
- New
- 29 Dec 2002 - TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.RichardDonkin, TWiki:Main.SvenDowideit
- New Plugin hooks
registrationHandler,beforeEditHandler,afterEditHandler,beforeSaveHandler,writeHeaderHandler,redirectCgiQueryHandler,getSessionValueHandler,setSessionValueHandler
- New Plugin hooks
- 30 Nov 2002 - TWiki:Main.RichardDonkin
- Internationalization ('I18N') support for international characters in WikiWords, such as ISO-8859-15, KOI8-R - also supports Chinese, Japanese, etc.
- 25 Nov 2002 - TWiki:Main.PeterThoeny
- Include previous topic revision with
%INCLUDE{ "OtherTopic" rev="1.2" }%
- Include previous topic revision with
- 15 Nov 2002 - TWiki:Main.PeterThoeny
- The Go box understands also URLs, useful for special TWikiSkins handling
- 08 Nov 2002 - TWiki:Main.ColasNahaboo, TWiki:Main.RichardDonkin
- 30 Oct 2002 - TWiki:Main.PeterThoeny
- New
%NOP{}%variable in TWikiTemplates topic gets removed at topic creation time; useful to write protect template topics
- New
- 28 Sep 2002 - TWiki:Main.PeterThoeny
- The
%URLPARAM{}%variable in TWikiTemplates topic gets expanded at topic creation time; useful for dynamic content creation
- The
- 28 Sep 2002 - TWiki:Main.PeterThoeny
- New
$logDirintroduced in TWiki.cfg to set the log directory
- New
- 13 Sep 2002 - TWiki:Main.PeterThoeny
- Renamed the Test web to Sandbox
- 03 Aug 2002 - TWiki:Main.RichardDonkin
- New
setlib.cfgfile in the bin directory to set the TWiki library path
- New
- 02 Aug 2002 - TWiki:Main.PeterThoeny, TWiki:Main.RyanFreebern
- Support for outbound HTTP proxy when including URLs based on new
%PROXYHOSTand%PROXYPORT%settings in the TWikiPreferences
- Support for outbound HTTP proxy when including URLs based on new
- 12 Jul 2002 - TWiki:Main.PeterThoeny
- The page logo is configurable with new
%WIKILOGOIMG%,%TWIKILOGOURL%and%WIKILOGOALT%variables in TWikiPreferences; replacing$wikiHomeUrlin TWiki.cfg
- The page logo is configurable with new
- 12 Jun 2002 - TWiki:Main.PeterThoeny
- New
%WIKITOOLNAME%variable in TWikiPreferences; replacing$wikiToolNamein TWiki.cfg
- New
- 31 May 2002 - TWiki:Main.PeterThoeny
- New
%EDITBOXSTYLE%preferences variable which sets the edit box width automatically to the window width
- New
- 17 May 2002 - TWiki:Main.PeterThoeny
- New
%URLENCODE{}%variable to encodes a string for using in a URL parameter, e.g.%URLENCODE{"spaced name"}%returnsspaced%20name
- New
- 17 May 2002 - TWiki:Main.PeterThoeny
- FormattedSearch can be nested
- 05 May 2002 - TWiki:Main.PeterThoeny
- New user home pages are now based on the NewUserTemplate, replacing the
/twiki/templates/register.tmpltemplate file
- New user home pages are now based on the NewUserTemplate, replacing the
- 26 Apr 2002 - TWiki:Main.PeterThoeny
- New markup to exclude heading from a
%TOC%table of content, e.g.---+!! This headingis not shown in a TOC
- New markup to exclude heading from a
- 13 Apr 2002 - TWiki:Main.PeterThoeny
- Form and script to create new webs, see ManagingWebs
- 01 Apr 2002 - TWiki:Main.JohnTalintyre
- New data storage framework that lets you use external RCS commands for revision control, or a new native Perl implementation that does not depend on the external RCS commands
- 28 Mar 2002 - TWiki:Main.RichardDonkin
- Fixed IE5/IE6-specific problem whereby going back from preview sometimes removes all edit changes
- 23 Mar 2002 - TWiki:Main.JohnTalintyre
- New AND search; with regular expression enabled, use the semicolon ";" as the AND operator in
%SEARCH{}%variable, FormattedSearch and WebSearch
- New AND search; with regular expression enabled, use the semicolon ";" as the AND operator in
- 21 Mar 2002 - TWiki:Main.ColasNahaboo, TWiki:Main.RichardDonkin
- Fixed cache issue where the edit page showed outdated content
- 06 Mar 2002 - TWiki:Main.RichardDonkin
- Improved statistics script which uses less memory to process large log files
- 09 Jan 2002 - TWiki:Main.JohnTalintyre
- Variables inside
<verbatim>tags are no longer expanded
- Variables inside
01-Dec-2001 Release (Athens)
- 25 Oct 2001 - TWiki:Main.PeterThoeny
- Added FormattedSearch to
%SEARCH{}%variable for database like reporting.
- Added FormattedSearch to
01-Sep-2001 Release
- 30 Aug 2001 - TWiki:Main.JohnTalintyre
- Easier install for Windows, including auto detection in
TWiki.cfg
- Easier install for Windows, including auto detection in
- 30 Aug 2001 - TWiki:Main.JohnTalintyre
- Ability to move attachments between topics, see FileAttachments
- 21 Aug 2001 - TWiki:Main.PeterThoeny
- Convert to XHTML 1.0 function: first step to XHTML-ifying TWiki
- 26 Jun 2001 - TWiki:Main.JohnTalintyre
- Category information to forms using the TWikiMetaData format, see TWikiForms
- 07 Jun 2001 - TWiki:Main.PeterThoeny
- New topic templates as topics instead of templates. Customize by editing the topic. Retired
notedited.tmpl,notext.tmplandnotwiki.tmpltemplates. More in TWikiTemplates.
- New topic templates as topics instead of templates. Customize by editing the topic. Retired
- 07 Jun 2001 - TWiki:Main.PeterThoeny
- New
%TOPICLIST{"format"}%and%WEBLIST{"format"}%variables to get a formatted topic index and web index, respectively. More in TWikiVariables.
- New
- 01 Jun 2001 - TWiki:Main.PeterThoeny
- New
%URLPARAM{"name"}%variable to query URL parameters. More in TWikiVariables.
- New
- 01 Jun 2001 - TWiki:Main.AndreaSterbini
- API to extend TWiki, see TWikiPluginAPI
- 01 Jun 2001 - TWiki:Main.KlausWriessnegger, TWiki:Main.AndreaSterbini
- Forms to change/reset/install passwords, see ChangePassword & ResetPassword
- 01 May 2001 - TWiki:Main.AndreaSterbini
- The TWikiAdminGroup (or other group) can be enabled as a SuperAdminGroup. Members have browser edit access to all locked topics.
- 01 May 2001 - TWiki:Main.JohnTalintyre
- Meta information format, see TWikiMetaData
- 01 May 2001 - TWiki:Main.JohnTalintyre
- Attachment under revision control See FileAttachment
- 01 May 2001 - TWiki:Main.JohnTalintyre
- Ability to rename/move topics, ManagingTopics
- 27 Mar 2001 - TWiki:Main.PeterThoeny
- The table syntax has been enhanced to (i) render
| *bold* |cells as table headers, (ii) render space padded cells| center aligned |and| right aligned |, (iii) span multiple columns using| empty cells |||. More in TextFormattingRules.
- The table syntax has been enhanced to (i) render
- 25 Mar 2001 - TWiki:Main.PeterThoeny
- Security fix Questionable files like PHP scripts (executables) and
.htaccessfiles that are attached to a topic get a.txtsuffix appended to the file name. See also TWiki:Codev/FileAttachmentFilterSecurityAlert
- Security fix Questionable files like PHP scripts (executables) and
- 28 Feb 2001 - TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
- New Wiki rule for headings, i.e.
---++ My Title; and new%TOC%variable to build a table of content from headings in a topic. More in TWikiVariables.
- New Wiki rule for headings, i.e.
- 28 Feb 2001 - TWiki:Main.PeterThoeny
- New Wiki rule to specify arbitrary text for external links (i.e.
[[http://TWki.org][TWiki]]) and internal links (i.e[[WikiSyntax][syntax]]). More in TWikiVariables.
- New Wiki rule to specify arbitrary text for external links (i.e.
- 28 Feb 2001 - TWiki:Main.PeterThoeny
- New Wiki rule for named anchors, e.g. links within a topic. Define a named anchor with
#MyAnchorat the beginning of a line, and link to it with[[#MyAnchor]]. More in TWikiVariables.
- New Wiki rule for named anchors, e.g. links within a topic. Define a named anchor with
- 25 Feb 2001 - TWiki:Main.NicholasLee, TWiki:Main.PeterThoeny
- Use
Net::SMTPmodule instead ofsendmailif installed.
- Use
- 01 Feb 2001 - TWiki:Main.PeterThoeny
- Added
<verbatim>...</verbatim>tags to show source code "as is". Unlike the<pre>...</pre>tags, it also shows<,>,&characters "as is".
- Added
- 01 Feb 2001 - TWiki:Main.PeterThoeny
- 21 Jan 2001 - TWiki:Main.PeterThoeny
- Added a "Minor change, don't notify" checkbox in preview. More in DontNotify.
- 21 Jan 2001 - TWiki:Main.PeterThoeny
- Added Bold Fixed formatting using double-equal signs, e.g. write
==Bold Fixed==to getBold Fixed.
- Added Bold Fixed formatting using double-equal signs, e.g. write
- 20 Jan 2001 - TWiki:Main.PeterThoeny
- Format changed of
%GMTIME{"..."}%and%SERVERTIME{"..."}%variables. Format is now"$hour:$min"instead of"hour:min". More in TWikiVariables. Attention: Check your existing topics when you upgrade TWiki!
- Format changed of
- 18 Jan 2001 - TWiki:Main.PeterThoeny
- WebChanges, WebSearch and e-mail notification indicate also the revision number of a topic (i.e. 18 Jan 2001 16:43 r1.5), or NEW for a new topic (i.e. i.e. 18 Jan 2001 16:43 NEW).
- 16 Jan 2001 - TWiki:Main.PeterThoeny
- New variable
%STARTINCLUDE%and%STOPINCLUDE%variables to control what gets included of a topic. More in TWikiVariables.
- New variable
- 16 Jan 2001 - TWiki:Main.PeterThoeny
- TWiki skins Define a different page layout with a customized header and footer layout, i.e. a
printskin for a printable view of a topic. More in TWikiSkins and TWiki:Codev/TWikiSkins.
- TWiki skins Define a different page layout with a customized header and footer layout, i.e. a
- 07 Jan 2001 - TWiki:Main.StanleyKnutson
- Better error handling when saving a topic.
- 05 Jan 2001 - TWiki:Main.PeterThoeny
- View authorization based on groups. Define who is allowed to see a TWiki web. More in TWikiAccessControl and TWiki:Codev/AuthenticationBasedOnGroups.
- 05 Dec 2000 - TWiki:Main.PeterThoeny
- Improved include handling. Infinite recursion of includes are prevented; new variables
%BASEWEB%,%INCLUDINGWEB%,%BASETOPIC%and%INCLUDINGTOPIC%to have more control over include handling. More in TWikiVariables and TWiki:Codev/IncludeHandlingImprovements.
- Improved include handling. Infinite recursion of includes are prevented; new variables
- 03 Dec 2000 - TWiki:Main.PeterThoeny
- New
noheader="on"switch in%SEARCH{...}%to suppress table header. More in TWikiVariables.
- New
01-Dec-2000 Release
- 03 Nov 2000 - TWiki:Main.PeterThoeny
- Flag
$doHidePasswdInRegistrationinwikicfg.pmto hide plain text password in registration e-mail.
- Flag
- 01 Nov 2000 - TWiki:Main.PeterThoeny
- New variable
%VAR{"NAME" web="Web"}%to get web-specific preferences. More in TWikiVariables.
- New variable
- 01 Nov 2000 - TWiki:Main.PeterThoeny
- Added a "Cancel" link in edit that releases the edit lock.
- 23 Oct 2000 - TWiki:Main.PeterThoeny
- Authorization based on groups. Define fine graned control who is allowed to change or create topics. More in TWikiAccessControl and TWiki:Codev/AuthenticationBasedOnGroups.
- 05 Oct 2000 - TWiki:Main.PeterThoeny
- Remember user by IP address so that
view"knows" the user once authenticated inedit. More in TWikiUserAuthentication.
- Remember user by IP address so that
- 26 Sep 2000 - TWiki:Main.AlWilliams, TWiki:Main.PeterThoeny
- Fixed TWiki:Codev/UppercaseAttachments bug and added
pngimage support.
- Fixed TWiki:Codev/UppercaseAttachments bug and added
- 26 Sep 2000 - TWiki:Main.HaroldGottschalk, TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
- Allow nesting of variables, i.e.
%INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%. More in TWiki:Codev/BetterTWikiTagTemplateProcessing.
- Allow nesting of variables, i.e.
- 20 Sep 2000 - TWiki:Main.ManpreetSingh
- New -q switch in
mailnotifyto suppress all normal output.
- New -q switch in
- 19 Sep 2000 - TWiki:Main.PeterThoeny
- 18 Sep 2000 - TWiki:Main.ManpreetSingh, TWiki:Main.PeterThoeny
- Added forced internal links. Write
[[text formatting FAQ]]to get the link text formatting FAQ that points to topic TextFormattingFAQ.
- Added forced internal links. Write
- 19 Aug 2000 - TWiki:Main.PeterThoeny
- Ref-By link searches all webs (not just the current web.)
- 16 Aug 2000 - TWiki:Main.PeterThoeny
- New TWikiPreferences variables
%HTTP_EQUIV_ON_VIEW%,%HTTP_EQUIV_ON_EDIT%and%HTTP_EQUIV_ON_PREVIEW%that define the<meta http-equiv="...">meta tags for the TWiki templates. This can be used for example to set a document expiration time.
- New TWikiPreferences variables
- 29 Jul 2000 - TWiki:Main.PeterThoeny
- New variables
%GMTIME{"..."}%and%SERVERTIME{"..."}%. More in TWikiVariables.
- New variables
- 23 Jul 2000 - TWiki:Main.PeterThoeny
- Changed include syntax from
%INCLUDE{"Web/TopicName.txt"}%to%INCLUDE{"Web.TopicName"}%. Legacy syntax still supported.
- Changed include syntax from
- 23 Jul 2000 - TWiki:Main.PeterThoeny
- BookView search allows you show a set of topics for easy printing.
- 22 Jul 2000 - TWiki:Main.PeterThoeny
- More forgiving syntax for
*bold*, italic, __bold italic__andfixed, where it is not necessary anymore to have a trailing space before.,;:?!characters.
- More forgiving syntax for
- 22 Jul 2000 - TWiki:Main.PeterThoeny
- Split the TWiki.Main web into TWiki.Main (users, company data) and TWiki.TWiki (TWiki related documentation, registration)
- 07 Jul 2000 - TWiki:Main.PeterThoeny
- Added an "Release edit lock" checkbox in preview to let other people edit the topic immediately without the one hour lock.
- 07 Jul 2000 - TWiki:Main.PeterThoeny
- Fixed problem of losing carriage returns when editing topics with KDE KFM browser or W3M browser.
- 21 Jun 2000 - TWiki:Main.PeterThoeny
- Fixed problem that a page redirect on some server environments is not working (host name is needed in URL).
- 21 Jun 2000 - TWiki:Main.CrisBailiff, TWiki:Main.PeterThoeny
- Fixed security issue to prevent a server side
%INCLUDE%of arbitrary files.
- Fixed security issue to prevent a server side
- 29 May 2000 - TWiki:Main.PeterThoeny
- New
%GMTIME%variable that shows the current GM time.
- New
- 28 May 2000 - TWiki:Main.PeterThoeny
- Lock warning shows remaining lock time in minutes.
- 15 May 2000 - TWiki:Main.PeterFokkinga
- Each topic can have its own template file. TWikiTemplates has more.
- 02 May 2000 - TWiki:Main.KevinKinnell, TWiki:Main.PeterThoeny
- Advanced search features like search multiple webs; sort by topic name / modified time / author; limit the number of results returned. More in TWikiVariables.
01-May-2000 Release
- 21 Apr 2000 - TWiki:Main.PeterThoeny
- New TWikiVariables
%HTTP_HOST%,%REMOTE_ADDR%,%REMOTE_PORT%and%REMOTE_USER%.
- New TWikiVariables
- 21 Apr 2000 - TWiki:Main.JohnAltstadt, TWiki:Main.PeterThoeny
- TWikiRegistration is done separately for Intranet use (depends on remote_user) or Internet use (depends on .htpasswd file).
- 20 Mar 2000 - TWiki:Main.PeterThoeny
- Uploading a file (topic file attachment) will optionally create a link to the uploaded file at the end of the topic. The preference variable
%ATTACHLINKBOX%controls the default state of the link check box in the attach file page.
- Uploading a file (topic file attachment) will optionally create a link to the uploaded file at the end of the topic. The preference variable
- 11 Mar 2000 - TWiki:Main.PeterThoeny
- Better security with taint checking (
Perl -Toption )
- Better security with taint checking (
- 25 Feb 2000 - TWiki:Main.PeterThoeny
- New preference variables
%EDITBOXWIDTH%and%EDITBOXHEIGHT%to specify the edit box size.
- New preference variables
- 25 Feb 2000 - TWiki:Main.PeterThoeny
- Edit preferences topics to set TWiki variables. There are three level of preferences Site-level (TWikiPreferences), web-level (WebPreferences in each web) and user-level preferences (for each of the TWikiUsers). With this, discontinue use of server side include of
wikiwebs.inc,wikiwebtable.inc,weblist.inc,webcopyright.incandwebcolors.incfiles.
- Edit preferences topics to set TWiki variables. There are three level of preferences Site-level (TWikiPreferences), web-level (WebPreferences in each web) and user-level preferences (for each of the TWikiUsers). With this, discontinue use of server side include of
- 11 Feb 2000 - TWiki:Main.PeterThoeny
- New variable
%SCRIPTSUFFIX%/ $scriptSuffix containing an optional file extension of the TWiki Perl script. Templates have been changed to use this variable. This allows you to rename the Perl script files to have a file extension like for example ".cgi".
- New variable
- 11 Feb 2000 - TWiki:Main.PeterThoeny
- New variable
%SCRIPTURLPATH%/ $scriptUrlPath containing the script URL without the domain name. Templates have been changed to use this variable instead of%SCRIPTURL%. This is for performance reasons.
- New variable
- 07 Feb 2000 - TWiki:Main.PeterThoeny
- Changed the syntax for server side include variable from
%INCLUDE:"filename.ext"%to%INCLUDE{"filename.ext"}%. (Previous syntax still supported. Change was done because of inline search syntax)
- Changed the syntax for server side include variable from
- 07 Feb 2000 - TWiki:Main.PeterThoeny
- Inline search. New variable
%SEARCH{"str" ...}%to show a search result embedded in a topic text. TWikiVariables has more on the syntax. Inline search combined with the category table feature can be used for example to create a simple bug tracking system.
- Inline search. New variable
- 04 Feb 2000 - TWiki:Main.PeterThoeny
- Access statistics. Each web has a WebStatistics topic that shows monthy statistics with number of topic views and changes, most popular topics, and top contributors. (It needs to be enabled, TWikiDocumentation has more.)
- 29 Jan 2000 - TWiki:Main.PeterThoeny
- Fixed bug where TWiki would not initialize correctly under certain circumstances, i.e. when running it under mod_perl. Sub
initializeinwiki.pmdid not handle$thePathInfocorrectly.
- Fixed bug where TWiki would not initialize correctly under certain circumstances, i.e. when running it under mod_perl. Sub
- 24 Jan 2000 - TWiki:Main.PeterThoeny
- Fixed bug where an e-mail address starting with a WikiName was rendered as an internal Wiki link instead of an e-mail address, i.e. SomeWikiName@somewhere.test .
- 10 Jan 2000 - TWiki:Main.PeterThoeny
- No more escaping for '%' percent characters. (Number of consecutive '%' entered and displayed is identical.)
- 03 Oct 1999 - TWiki:Main.PeterThoeny
01-Sep-1999 Release
- 31 Aug 1999 - TWiki:Main.PeterThoeny
- Fixed Y2K bug. (Date in year 2000 had wrong format.)
- 08 Aug 1999 - TWiki:Main.PeterThoeny
- New text formatting rule for creating tables. Text gets rendered as a table if enclosed in " " vertical bars. Example line as it is written and how it shows up
- 03 Aug 1999 - TWiki:Main.PeterThoeny
- Online registration of new user using web form in TWikiRegistration. Authentication of users.
- 22 Jul 1999 - TWiki:Main.PeterThoeny
- Flags
$doLogTopic*in wikicfg.pm to selectively log topic view, edit, save, rdiff, attach, search and changes to monthly log file.
- Flags
- 21 Jul 1999 - TWiki:Main.PeterThoeny
- Flag
$doRemovePortNumberin wikicfg.pm to optionally remove the port number from the TWiki URL. Examplewww.some.domain:1234/twikigetswww.some.domain/twiki.
- Flag
- 15 Jul 1999 - TWiki:Main.PeterThoeny
- Search path for include files in
%INCLUDE:"file.inc"%variable. Search first in the current web, then in parent data directory. Useful to overload default include text in the data directory by web-specific text, like for examplewebcopyright.inctext.
- Search path for include files in
- 07 Jul 1999 - TWiki:Main.ChristopheVermeulen
- Link a plural topic to a singular topic in case the plural topic does not exist. Example
TestVersion/TestVersions,TestPolicy/TestPolicies,TestAddress/TestAddresses,TestBox/TestBoxes.
- Link a plural topic to a singular topic in case the plural topic does not exist. Example
01-Jul-1999 Release
- 23 Jun 1999 - TWiki:Main.PeterThoeny
- New TextFormattingRules to write bold italic text by enclosing words with double underline characters.
- 23 Jun 1999 - TWiki:Main.PeterThoeny
- Separate wiki.pm into configuration (wikicfg.pm) and TWiki core (wiki.pm) . This is to ease the upgrade of TWiki installations, it also allows customized extensions to TWiki without affecting the TWiki core.
- 21 May 1999 - TWiki:Main.DavidWarman
- Externalize copyright text at the bottom of every page into a web-specific
webcopyright.incfile. This is to easily customize the copyright text.
- Externalize copyright text at the bottom of every page into a web-specific
- 20 May 1999 - TWiki:Main.PeterThoeny
- Added meta tag so that robots index only /view/ of topics, not /edit/, /attach/ e.t.c. Tag <META NAME="ROBOTS" CONTENT="NOINDEX">
- 20 May 1999 - TWiki:Main.PeterThoeny
- New variables
%WIKIHOMEURL%(link when pressing the icon on the upper left corner) and%WIKITOOLNAME%(the name of the wiki toolWikiRing).
- New variables
- 15 Apr 1999 - TWiki:Main.PeterThoeny
- Topic locking Warn user if a topic has been edited by an other person within one hour. This is to prevent contention, e.g. simultaneous topic updates.
- 26 Mar 1999 - TWiki:Main.PeterThoeny
- File attachments Upload and download any file as a topic attachment by using the browser. FileAttachment has more.
- 26 Mar 1999 - TWiki:Main.PeterThoeny
- New variables
%PUBURL%(Public directory URL) and%ATTACHURL%(URL of topic file attachment).
- New variables
- 09 Feb 1999 - TWiki:Main.PeterThoeny
- New text formatting rule for creating
fixed font text. Words get showns infixed fontby enclosing them in "=" equal signs. Example Writing =fixed font= will show up asfixed font.
- New text formatting rule for creating
- 09 Feb 1999 - TWiki:Main.PeterThoeny
- No new topic revision is created if the same person saves a topic again within one hour.
- 03 Feb 1999 - TWiki:Main.PeterThoeny
- Possible to view complete revision history of a topic on one page. Access at the linked date in the Changes page, or the
Diffslink at the bottom of each topic, e.g.
Topic TWikiHistory . { Edit Ref-By Diffs r1.3 > r1.2 > r1.1 }
Revision r1.3 1998/11/10 01:34 by PeterThoeny
- Possible to view complete revision history of a topic on one page. Access at the linked date in the Changes page, or the
- 04 Jan 1999 - TWiki:Main.PeterThoeny
- Fixed bug when viewing differences between topic revisions that include HTML table tags like <table>, <tr>, <td>.
1998 Releases
- 08 Dec 1998 - TWiki:Main.PeterThoeny
- Signature is shown below the text area when editing a topic. Use this to easily copy & paste your signature into the text.
- 07 Dec 1998 - TWiki:Main.PeterThoeny
- Possible to add a category table to a TWiki topic. This permits storing and searching for more structured information. Editing a topic shows a HTML form with the usual text area and a table with selectors, checkboxes, radio buttons and text fields. TWikiDocumentation has more on setup. The TWiki.Know web uses this category table to set classification, platform and OS version.
- 18 Nov 1998 - TWiki:Main.PeterThoeny
- Internal log of topic save actions to the file
data/logYYYYMM.txt, whereYYYYMMthe year and month in numeric format is. Intended for auditing only, not accessible from the web.
- Internal log of topic save actions to the file
- 10 Nov 1998 - TWiki:Main.PeterThoeny
- The e-mail notification and the Changes topic have now a topic date that is linked. Clicking on the link will show the difference between the two most recent topic revisions.
- 10 Nov 1998 - TWiki:Main.PeterThoeny
- View differences between topic revisions. Each topic has a list of revisions (e.g.
r1.3) and differences thereof (e.g.>) at the bottom
Topic TWikiHistory . { Edit Ref-By r1.3 > r1.2 > r1.1 }
Revision r1.3 1998/11/10 01:34 by TWiki:Main.PeterThoeny
- View differences between topic revisions. Each topic has a list of revisions (e.g.
- 26 Oct 1998 - TWiki:Main.PeterThoeny
- Added preview of topic changes before saving the topic. This was necessary to prevent unneeded revisions.
- 26 Oct 1998 - TWiki:Main.PeterThoeny
- Added revision control using RCS. Each topic has now a list of revisions at the bottom and a revision info, e.g.
Topic TWikiHistory . { Edit Ref-By r1.3 r1.2 r1.1 }
Revision r1.3 1998/10/26 01:34:00 by TWiki:Main.PeterThoeny
- Added revision control using RCS. Each topic has now a list of revisions at the bottom and a revision info, e.g.
- 14 Oct 1998 - TWiki:Main.PeterThoeny
- Refered-By Find out which topics have a link to the current topic. Each topic has a Ref-By link for that. Note Only references from the current web are shown, not references from other webs.
- 13 Oct 1998 - TWiki:Main.PeterThoeny
- Alphabetical topic index in WebSearch.
- 24 Sep 1998 - TWiki:Main.PeterThoeny
- Corrected templates for automatic e-mail notification so that MS Outlook can display attachment as an HTML file.
- 13 Aug 1998 - TWiki:Main.PeterThoeny
- WikiNotation allows also numbers after the
AaAsequence, e.g.AaA1is a valid TWikiTopics name, but notAa1.
- WikiNotation allows also numbers after the
- 07 Aug 1998 - TWiki:Main.PeterThoeny
- Automatic e-mail notification when something has changed in a TWiki web. Each web has a topic WebNotify where one can subscribe and unsubscribe.
- 06 Aug 1998 - TWiki:Main.PeterThoeny
- Added server side include of files. Syntax is
%INCLUDE:"filename.ext"%
- Added server side include of files. Syntax is
- 05 Aug 1998 - TWiki:Main.PeterThoeny
- Signature and date is inserted automatically when creating a new topic.
- 04 Aug 1998 - TWiki:Main.PeterThoeny
- Separate templates for text of non existing topic and default text of new topic. (template file templates/Web/notedited.tmpl)
- 04 Aug 1998 - TWiki:Main.PeterThoeny
- Warn user if new topic name is not a valid Wiki name. (template file templates/Web/notwiki.tmpl)
- 31 Jul 1998 - TWiki:Main.PeterThoeny
- Support for quoted text with a '>' at the beginning of the line.
- 28 Jul 1998 - TWiki:Main.PeterThoeny
- Added TWiki variables, enclosed in % signs
%TOPIC%(Topic name),%WEB%(web name),%SCRIPTURL%(script URL),%DATE%(current date),%WIKIWEBMASTER%(Wiki webmaster address),%WIKIVERSION%(Wiki version),%USERNAME%(user name),%WIKIUSERNAME%(Wiki user name).
- Added TWiki variables, enclosed in % signs
- 28 Jul 1998 - TWiki:Main.PeterThoeny
- Topic WebChanges shows Wiki username instead of Intranet username, e.g.
PeterThoenyinstead ofthoenyin case the Wiki username exists. Implementation Automatic lookup of Wiki username in topic TWikiUsers.
- Topic WebChanges shows Wiki username instead of Intranet username, e.g.
- 28 Jul 1998 - TWiki:Main.PeterThoeny
- Topic index. (Technically speaking a simple '.*' search on topic names.)
- 28 Jul 1998 - TWiki:Main.PeterThoeny
- Topic WebSearch allows full text search and and topic search with/without regular expressions.
- 27 Jul 1998 - TWiki:Main.PeterThoeny
- Added automatic links to topics in other TWiki webs by specifying <web name>.<topic name>, e.g.
Know.WebSeach.
- Added automatic links to topics in other TWiki webs by specifying <web name>.<topic name>, e.g.
- 23 Jul 1998 - TWiki:Main.PeterThoeny
- Installed initial version, based on the JOS Wiki. See WikiWikiClones for details.
Dev Flow
The typical TWiki development flow...- TWiki:Codev.FeatureBrainstorming: open forum for new ideas
- TWiki:Codev.FeatureEnhancementRequest: specific detailed request
- TWiki:Codev.FeatureToDo: prioritized to up-next dev status
- TWiki:Codev.FeatureUnderConstruction: currently in development
- TWiki:Codev.FeatureDone: completed and implemented
- TWiki:Codev.DocRequest: request for documentation
- TWiki:Codev.DocsToDo: feature documentation pending
- TWiki:Codev.FeatureDocumented: documented feature
- TWikiDocumentation: reference manual for the latest TWiki
Appendix B: Encode URLs With UTF8
Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N.Current Status
To simplify use of internationalised characters within WikiWords and attachment names, TWiki now supports UTF-8 URLs, converting on-the-fly to virtually any character set, including ISO-8859-*, KOI8-R, EUC-JP, and so on. Support for UTF-8 URL encoding avoids having to configure the browser to turn off this encoding in URLs (the default in Internet Explorer, Opera Browser and some Mozilla Browser URLs) and enables support of browsers where only this mode is supported (e.g. Opera Browser for Symbian smartphones). A non-UTF-8 site character set (e.g. ISO-8859-*) is still used within TWiki, and in fact pages are stored and viewed entirely in the site character set - the browser dynamically converts URLs from the site character set into UTF-8, and TWiki converts them back again. System requirements are updated as follows:- ASCII or ISO-8859-1-only sites do not require any additional CPAN modules to be installed.
- Perl 5.8 sites using any character set do not require additional modules, since CPAN:Encode is installed as part of Perl.
- This feature still works on Perl 5.005_03 as per TWikiSystemRequirements, or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.
{SiteLocale} setting in configure - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp').
This feature should also support use of Mozilla Browser with TWiki:Codev.TWikiOnMainframe (as long as mainframe web server can convert or pass through UTF-8 URLs) - however, this specific combination is not tested. Other browser-server combinations should not have any problems.
Please note that use of UTF-8 as the site character set is not yet supported - see Phase 2 of TWiki:Codev.ProposedUTF8SupportForI18N for plans and work to date in this area.
This feature is complete in TWiki releases newer than February 2004.
Note for skin developers: is no longer required (TWiki:Plugins.InternationalisingYourSkin).
Details of Implementation
URLs are not allowed to contain non-ASCII (8th bit set) characters: http://www.w3.org/TR/html4/appendix/notes.html#non-ascii-chars The overall plan for UTF-8 support for TWiki is described in two phases in TWiki:/Codev.ProposedUTF8SupportForI18N - this page addresses the first phase, in which UTF-8 is supported for URLs only. UTF-8 URL translation to virtually any character set is supported as of TWiki Release 01 Sep 2004, but full UTF-8 support (e.g. pages in UTF-8) is not supported yet - this will be phase 2. The code automatically detects whether a URL is UTF-8 or not, taking care to avoid over-long and illegal UTF-8 encodings that could introduce TWiki:Codev.MajorSecurityProblemWithIncludeFileProcessing (tested against a comprehensive UTF-8 test file, which IE 5.5 fails quite dangerously, and Opera Browser passes). Any non-ASCII URLs that are not valid UTF-8 are then assumed to be directly URL-encoded as a single-byte or multi-byte character set (as now), e.g. EUC-JP. The main point is that you can use TWiki with international characters in WikiWords without changing your browser setup from the default, and you can also still use TWiki using non-UTF-8 URLs. This works on any Perl version from 5.005_03 onwards and corresponds to Phase 1 of TWiki:Codev.ProposedUTF8SupportForI18N. You can have different users using different URL formats transparently on the same server. UTF-8 URLs are automatically converted to the current {Site}{Charset}, using modules such as CPAN:Encode if needed. TWiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used. Since Apache serves attachment downloads without TWiki being involved, TWiki's code can't do its UTF-8 decoding trick, so TWiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset. TWiki:Codev.TWikiOnMainframe uses EBCDIC web servers that typically translate their output to ASCII, UTF-8 or ISO-8859-1 (and URLs in the other direction) since there are so few EBCDIC web browsers. Such web servers don't work with even ISO-8859-1 URLs if they are URL encoded, since the automated translation is bypassed for URL-encoded characters. For TWiki on Mainframe, TWiki assumes that the web server will automatically translate UTF-8 URLs into EBCDIC URLs, as long as URL encoding is turned off in TWiki pages.Testing and Limitation
It should work with TWiki:Codev.TWikiOnMainframe. Tested with IE 5.5, Opera 7.11 and Mozilla (Firebird 0.7). Opera Browser on the P800 smartphone is working for page viewing but leads to corrupt page names when editing pages. For up to date information see TWiki:Codev.EncodeURLsWithUTF8 Back to topAppendix C: TWiki CSS
Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release.Who should read this document?
Most html elements generated by TWiki core code now have Cascading Style Sheet (CSS) tags. Skin builders and others who want to change the appearance of the default TWiki installation or any of the skins can use this document to see what styles can be created for these html elements.Naming conventions
- All TWiki class names have the prefix
twiki. So: twikiAlert, twikiToc, etcetera. Remember that CSS class names are case sensitive - TWiki CSS uses lowercasetw. - If you define your own CSS classes, it is preferable that you do not use the
twikiprefix to prevent undesired overriding effects.
TWiki styles in core code
| .twikiAlert | Client.pm, Form.pm, Statistics.pm |
| .twikiFirstCol | Render.pm |
| .twikiForm | Render.pm |
| .twikiNew | Changes.pm, Search.pm |
| .twikiHelp | Changes.pm |
| .twikiTopRow | Manage.pm |
| .twikiSummary | Manage.pm |
| .twikiGrayText | Manage.pm |
| .twikiCheckBox | Manage.pm |
| .twikiLink | Render.pm |
| .twikiNewLink | Render.pm |
| .twikiAnchorLink | Render.pm |
| .twikiCurrentWebHomeLink | Render.pm |
| .twikiCurrentTopicLink | Render.pm |
| .twikiEmulatedLink | Preview.pm |
| .twikiWebIndent | TWiki.pm |
| .twikiEditFormDateField | Form.pm |
| .twikiEditFormTextField | Form.pm |
| .twikiEditFormLabelField | Form.pm |
| .twikiEditFormTextAreaField | Form.pm |
| .twikiEditFormCheckboxButton | Form.pm |
| .twikiEditFormCheckboxField | Form.pm |
| .twikiRadioButton | Form.pm |
| .twikiEditFormRadioField | Form.pm |
| .twikiEditFormError | Form.pm |
| .twikiDiffTable | RDiff.pm |
| .twikiDiffDeletedHeader | RDiff.pm |
| .twikiDiffDeletedMarker | RDiff.pm |
| .twikiDiffDeletedText | RDiff.pm |
| .twikiDiffAddedHeader | RDiff.pm |
| .twikiDiffAddedMarker | RDiff.pm |
| .twikiDiffAddedText | RDiff.pm |
| .twikiDiffChangedHeader | RDiff.pm |
| .twikiDiffChangedText | RDiff.pm |
| .twikiDiffUnchangedText | RDiff.pm |
| .twikiDiffUnchangedTextContents | RDiff.pm |
| .twikiDiffLineNumberHeader | RDiff.pm |
| .twikiDiffDebug | RDiff.pm |
| .twikiDiffDebugRight | RDiff.pm |
| .twikiDiffDebugLeft | RDiff.pm |
| .twikiToc | TWiki.pm |
| .twikiTocTitle | TWiki.pm |
TWiki Styles in Plugins
TablePlugin
.twikiTable |
The table |
.twikiSortedCol |
A sorted column |
.twikiSortedAscendingCol |
Sorted column, ascending |
.twikiSortedDescendingCol |
Sorted column, descending |
.tableSortIcon |
The sort icon holder (span) |
.twikiFirstCol |
The first column |
.twikiTableEven |
Even numbered rows |
.twikiTableOdd |
Odd numbered rows |
.twikiTableCol + column number |
Unique column identifier, for instance: twikiTableCol0 |
.twikiTableRow + type + row number |
Unique row identifier, for instance: twikiTableRowdataBg0 |
TWiki Styles in Templates
| .twikiPage | twiki.tmpl |
| .twikiMiddleContainer | twiki.tmpl |
| .twikiMain | twiki.tmpl |
| .twikiFormTable | formtables.tmpl, form.tmpl |
| .twikiFormTableHRow | formtables.tmpl, form.tmpl |
| .twikiFormTableRow | formtables.tmpl |
| .twikiFormTableFooter | formtables.tmpl |
| .twikiAttachments | attachtables.tmpl |
| .twikiEditForm | form.tmpl |
| .twikiSubmit | |
| .twikiSubmitDisabled | |
| .twikiInputField | |
| .twikiInputFieldDisabled | |
| .twikiInputFieldReadOnly | |
| .twikiInputFieldFocus | For Internet Explorer that does not recognize the :focus pseudo class selector |
| .twikiInputFieldBeforeFocus | for use with Javascript: the color of the input text when not clicked in the field |
| .twikiTextarea | |
| .twikiTextareaRawView | |
| .twikiButton | |
| .twikiFocus | Behaviour marker so a field can be given input focus |
| .twikiLeft | |
| .twikiRight | |
| .twikiClear | |
| .twikiHidden | |
| .twikiSmall | |
| .twikiBottomRow | |
| .twikiSRAuthor | |
| .twikiSRRev | |
| .twikiPageForm | |
| .twikiSeparator | |
| .twikiAccessKey | |
| .twikiLinkLabel | |
| .twikiFormSteps | container around a form, such as the attach form: attach.tmpl |
| .twikiFormStep | form row |
| .twikiNoBreak | no break on whitespace |
| .twikiMakeVisible | For elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. Defaults to inline. |
| .twikiMakeVisibleInline | For span elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. |
| .twikiMakeVisibleBlock | For div elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. |
| .twikiMakeHidden | For elements that should be hidden with javascript on: no default style, is made hidden by javascript. |
| .twikiFooterNote | |
| .twikiPopUp | Behaviour marker so a popup-window can be invoked |
TWiki Styles used in configure
| #twikiLogin | CSS.pm |
| .twikiFormSteps | CSS.pm |
| .twikiFormStep | CSS.pm |
TWiki Styles in topics
| .twikiBroadcastMessage | TWikiPreferences |
| #twikiSearchTable | WebSearch, WebSearchAdvanced |
TWiki Styles in Skins
| #twikiLogin | login.pattern.tmpl |
Reserved Styles
| .twikiImage | defined in PatternSkin | div creates border around enclosed image |
| .twikiNotification | defined in PatternSkin | temporary alert, lighter than broadcast message |
| .twikiUnvisited | defined in PatternSkin | link style that ignores the visited link state; useful for form links |
Tips
PatternSkin makes extensive use of CSS in its templates. Read the PatternSkin topic and PatternSkinCss to learn more about creating your own CSS-based skin. Practical introduction to CSS: http://www.w3.org/Style/LieBos2e/enter/ Related Topics: TWikiSkins, PatternSkin, DeveloperDocumentationCategory, AdminDocumentationCategory Back to top
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding WikiRing? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiDocumentation