TWiki Reference Manual (01-Sep-2001)
This page contains all documentation topics as one long, complete reference sheet.
Doubleclick anywhere to return to the top of the page.
Note: Read the most up to date version of this document at http://TWiki.org/cgi-bin/view/TWiki/TWikiDocumentation
Related Topics: TWikiSite, TWikiHistory, TWikiPlannedFeatures, TWikiEnhancementRequests
Installation instructions for the TWiki 01-Sep-2004 production release.
If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues.
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Official documentation for platforms other than Linux is somewhat limited, so please check the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.
diff
and grep
tools if in doubt!) and TWiki:Codev/TWikiOnLinux.
Download the TWiki 01-Sep-2004 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.
/home/httpd/twiki
and unzip the TWiki distribution into this directory.
twiki/bin
directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin
to file httpd.conf
(typcially located in /etc/httpd/
) with only ExecCGI
option.
twiki/pub
directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki
to file httpd.conf
with normal access options (copy from /home/httpd/html
).
ScriptAlias
for /twiki/bin
and Alias
for /twiki
to file httpd.conf
.
ScriptAlias
must come before the Alias
, otherwise, Apache will fail to correctly set up /twiki/bin/
, by treating it as just another subdirectory of the /twiki/
alias.
twiki/data
and twiki/templates
directories should be set so that they are not visible as URLs. Add them to httpd.conf
with deny from all
.
Examplehttpd.conf
entries:ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/" Alias /twiki/ "/home/httpd/twiki/" <Directory "/home/httpd/twiki/bin"> Options +ExecCGI SetHandler cgi-script Allow from all </Directory> <Directory "/home/httpd/twiki/pub"> Options FollowSymLinks +Includes AllowOverride None Allow from all </Directory> <Directory "/home/httpd/twiki/data"> deny from all </Directory> <Directory "/home/httpd/twiki/templates"> deny from all </Directory>
service httpd restart
(or as appropriate to your flavor of UNIX or Linux).
twiki/bin
directory is CGI-enabled by trying visiting it in your browser:
bin
directory, http://yourdomain.com/twiki/bin/
"Forbidden. You don't have permission to access /twiki/bin/ on this server"
.
"Index of /twiki/bin"
- recheck your httpd.conf
file.
To install 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:
pub
)
TWiki dir: What it is: Where to copy: Example: twiki
start-up pages root TWiki dir /home/smith/twiki/
twiki/bin
CGI bin CGI-enabled dir /home/smith/twiki/bin
twiki/lib
library files same level as twiki/bin
/home/smith/twiki/lib
twiki/pub
public files htdoc enabled dir /home/smith/twiki/pub
twiki/data
topic data dir secure from public access /home/smith/twiki/data
twiki/templates
web templates dir secure from public access /home/smith/twiki/templates
Note: Don't worry if you are not able to put the twiki/lib
directory at the same level as the twiki/bin
directory (e.g. because CGI bin
directories can't be under your home directory and you don't have root access). You can create this directory elsewhere and configure the /twiki/bin/setlib.cfg
file (done in Step 3)
/usr/bin/perl
. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin
directory, or create a symbolic link from /usr/bin/perl
.
.cgi
extension to run. Some systems need .pl
, the regular Perl extension. Rename all twiki/bin
scripts if necessary.
twiki/bin/.htaccess
that contains the single line SetHandler cgi-script
, which tells Apache to treat all files in this directory as CGI scripts.
twiki/bin
directory as executable to -rwxr-xr-x
(755).
.tmpl
files it is necessary to chown
and chgrp -R twiki
so all the files have the owner you want.
nobody
ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki
for all other files. You can:
nobody
with another user if your server executes scripts under a different name (ex: default for Debian is www-data
).
testenv
script from your browser: http://yourdomain.com/twiki/bin/testenv
. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg
configuration file (you'll configure that in a minute).
twiki
with your own username
twiki/data
so that they are writable by user nobody
. A simple way is to chmod
them to -rw-rw-r--
(664) and to chown
them to nobody
.
twiki/data
directory and its subdirectories so that files in there are writable by user nobody
. A simple way is to chmod them to drwxrwxr-x
(775) and to chown
them to nobody
.
twiki/pub
directory and all its subdirectories so that files in there are writable by user nobody
. A simple way is to chmod
them to drwxrwxr-x
(775) and to chown
them to nobody
.
twiki/data/*/*.txt,v
RCS repository files in the installation package are locked by user nobody
. If your CGI scripts are not running as user nobody
, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data
, or delete them all - new files will be automatically created the first time each topic is edited. You have two options to change ownership of the RCS lock user:
testenv
script from your browser; in the Fix line you can relock all the rcs files (recommended)
cd twiki/data
find . -name *,v -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} \;
*,v~
backup files which you should remove after verification: find . -name *,v~ -exec rm -f {} \;
/twiki/bin/setlib.cfg
$twikiLibPath
to the absolute file path of your /twiki/lib
as seen by the web server.
"../lib"
path or Plugins might fail to initialize properly
$localPerlLibPath
if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.
setlib.cfg
file.
twiki/lib/TWiki.cfg
, setting the variables to your needs.
$scriptSuffix
variable to cgi
or pl
if required.
$storeTopicImpl = "RcsWrap";
for the RCS executables and make sure RCS is installed. Set $rcsDir
in twiki/lib/TWiki.cfg
to match the location of your RCS binaries. You can check this by issuing the command rcs
at the prompt, it should result in something like "rcs: no input file"
.
diff
, by typing diff -v
- an error indicates you have a non-GNU diff, so install the GNU diffutils
package and make sure that diff
is on the PATH used by TWiki (see $safeEnvPath
in the TWiki.cfg
file).
$storeTopicImpl = "RcsLite";
for the Perl based RCS
twiki/data
, twiki/templates
and all their subdirectories should be set so that they are not visible through URLs. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg
accordingly)
testenv
script from your browser: http://yourdomain.com/twiki/bin/testenv
. Check if your twiki/lib/TWiki.cfg
configuration file settings are correct.
By default, TWiki is configured to support US ASCII letters (no accents) in WikiWords, and ISO-8859-1 (Western European) characters in page contents. If that's OK for you, skip this step.
If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or I18N). Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and will support virtually any character set in the contents of pages. NOTE: TWiki does not currently support UTF-8, so you are advised not to use this - however, improved UTF-8 support is under development, see TWiki:Codev/ProposedUTF8SupportForI18N.
To configure internationalisation suppport:
TWiki.cfg
file's Internationalisation section to set the $useLocale
parameter to 1
. TWiki will now use the I18N parameters set in the rest of this section.
locale -a
to find a suitable 'locale' for your use of TWiki. A locale that includes a dot followed by a character set is recommended, e.g. pl_PL.ISO-8859-2
for Poland. Consult your system administrator if you are not sure which locale to use.
TWiki.cfg
, set the $siteLocale
parameter to your chosen locale, e.g. pl_PL.ISO-8859-2
for Poland.
testenv
(download the latest testenv
from TWiki:Support/SupportGuidelines if possible) - this provides some diagnostics for I18N setup, and in particular checks that your locale can be used successfully.
If international characters in WikiWords do not seem to work, and you are on Perl 5.6 or higher, you may need to set the TWiki.cfg
parameter $localeRegexes
to 0 - this disables some features but enables TWiki to work even if your system has locales that do not work. Then, set the $upperNational
and $lowerNational
parameters to the valid upper and lower case accented letters for your locale.
If international characters in WikiWords aren't working, and you are on Perl 5.005 with working locales, keep $useLocale
set to 1 and set $localeRegexes
to 0, then set $upperNational
and $lowerNational
- if testenv
generates the lists of characters for you, your locales are working so there is no need to set $localeRegexes
to 0 in this case. See the comments in TWiki.cfg
for more information.
WIKIWEBMASTER
email address, and other email settings required for registration and WebChangesAlert to work:
WIKIWEBMASTER
should be set to the email address of the TWiki administrator
SMTPMAILHOST
is typically set on Windows or other non-Unix/Linux systems, where sendmail
or similar is not available. When this is set and the Perl module Net::SMTP
is installed, TWiki will connect to this SMTP server (e.g. mail.yourdomain.com
) to send email for user registration and WebChangesAlerts. If you do have a sendmail-type program, leave SMTPMAILHOST
unset so that the external sendmail program is used instead (defined by $mailProgram
in TWiki.cfg
).
SMTPSENDERHOST
is optional, and set to the domain name sending the email (e.g. twiki.yourdomain.com
). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, Net::SMTP
will guess it for you.
http://yourdomain.com/twiki/bin/view
and start TWiki-ing away!
http://yourdomain.com/twiki/
to get the pre-TWiki index.html
page, with a link to the view
script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to view
.
WEBCOPYRIGHT
messages, and other preferences.
%VARIABLES%
. Define site-level variables in the TWikiPreferences topic. See also: TWikiVariables.
That's it for the standard installation of TWiki. Read on for server-level customization options.
With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
.htaccess.txt
in the twiki/bin
directory to .htaccess
and change it to your needs. The comment at the top of the file explains what need to be done, basically replace !FILE_path_to_TWiki!
and !URL_path_to_TWiki!
with paths specific to your installation. For the details of how this file works, consult the HTTP server documentation (for Apache server: [1], [2]).
.cgi
or .pl
file extension to the bin
scripts, make sure to do the same for edit
, view
, preview
, and all the other script names in .htaccess
.
.htaccess
does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf
for your twiki/bin
directory.
twiki/data/.htpasswd.txt
file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd
. Do not remove the guest user if you want to allow guest logins.
$htpasswdFormatFamily
, $htpasswdEncoding
and $htpasswdFilename
in the TWiki.cfg file. The supported options are htpasswd:plain, htpasswd:crypt, htpasswd:sha1, htdigest:md5
.txt
and .txt,v
files in the twiki/data/TWiki
directory.
name=""
parameter of the input tags must start with: "Twk0..."
(if this is an optional entry), or "Twk1..."
(if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
data/.htpasswd
file. The .htpasswd
file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.
NOTE: User home topics are located in the TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to TWiki.Main web, using a
Main.UserName
or %MAINWEB%.UserName
format. (The %MAINWEB%
variable is an advantage if you ever change the Main web name, but the standard Main.UserName
is easier for users to enter, which is the bottom line!)
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
-- TWiki:Main/PeterThoeny - 29 Aug 2004
-- TWiki:Main/MikeMannix - 16 May 2002
Upgrade from the previous TWiki 01-Feb-2003 production release to TWiki 01-Sep-2004
This guide describes how to upgrade from TWiki 01-Feb-2003 to TWiki 01-Sep-2004. This is a major new release. You can chose between an automated upgrade using a script or a manual update.
With the 01-Sep-2004 Release, for the first time, comes a helper script for upgrading from a previous version. This feature is currently at beta stage, it has only been sanity tested under Unix. It should be worth giving it a try, it won't mess up your existing TWiki installation because it leaves that untouched.
If you would prefer to do things manually than trust a beta script, skip to the manual upgrade procedure below.
The upgrade script is called "UpgradeTwiki"
, and is found in the root of the distribution.
It will:
To perform the upgrade, you need to:
UpgradeTwiki
script available, see TWiki:Codev.UpgradeTwiki
distro/
distro/
new_twiki
. This directory must not already exist.
distro/
and run: ./UpgradeTwiki <full path to new_twiki>
Assuming all goes well, UpgradeTwiki
will give you the final instructions.
There are a few points worth noting:
UpgradeTwiki
may not be able to merge all the changes you made in your existing TWiki into the new installation, but it will tell you which ones it couldn't deal with
UpgradeTwiki
creates the new installation in a new directory tree. It makes a complete copy of all your existing data, so:
data/
directory in your existing installation, these are reproduced as actual directories in the new structure. It is up to you to pull these sub-directories out again and re-symlink as needed
UpgradeTwiki
doesn't deal with custom templates or Plugins, you will have to reinstall these in the new installation
TWiki.cfg
file, then you will need to manually examine the new TWiki.cfg
file and possibly put your tricky changes in there manually
If you use it, and would be kind enough to add your experiences to TWiki:Codev.UpgradeTwiki, it would be much appreciated. The report of your experience will help to make UpgradeTwiki
more robust.
The following steps describe the upgrade assuming that $TWIKIROOT
is the root of your current 01-Feb-2003 release. As written this will require some downtime. A process for switching over without downtime is described at the end of this section.
$TWIKIROOT/bin
, $TWIKIROOT/pub
, $TWIKIROOT/data
, $TWIKIROOT/templates
, $TWIKIROOT/lib
*.html
and *.txt
files in $TWIKIROOT
with the new ones
$TWIKIROOT/templates
with the new ones
%BROADCASTMESSAGE%
somewhere on the top of the rendered HTML page (see the new view.tmpl
for reference)
preview
to save
: <form name="main" action="%SCRIPTURLPATH%/save%SCRIPTSUFFIX%/%WEB%/%TOPIC%" method="post">
%TMPL:DEF{"topicaction"}%
<input type="submit" class="twikiSubmit" name="action" value="Cancel" id="cancel" />
<input type="submit" class="twikiSubmit" name="action" value="Preview" id="preview" />
<input type="submit" class="twikiSubmit" name="action" value="Checkpoint" id="checkpoint" />
<input type="submit" class="twikiSubmit" name="action" value="QuietSave" id="quietsave" />
<input type="submit" class="twikiSubmit" name="action" value="Save" id="save" />%TMPL:END%
$TWIKIROOT/bin
with the new ones.
.cgi
$TWIKIROOT/bin/setlib.cfg
and point $twikiLibPath
to the absolute file path of $TWIKIROOT/lib
$TWIKIROOT/bin/.htaccess
file to include a directive for the new rdiffauth
script:<Files "rdiffauth">
require valid-user
</Files>
chmod 775 $TWIKIROOT/bin/*
755
(do so if you get a "Premature end of script headers" messages in the Apache error log)
TWiki.cfg
configuration file in $TWIKIROOT/lib
with the new one
TWiki.pm
library in $TWIKIROOT/lib
with the new one
$TWIKIROOT/lib
with the new ones. Make sure to preserve any extra Plugins you might have in $TWIKIROOT/lib/TWiki/Plugins
chmod 664 `find -type f $TWIKIROOT/lib`
(for files) and chmod 775 `find -type d $TWIKIROOT/lib`
(for directories)
bin/testenv
script from the browser (e.g. http://localhost/bin/testenv
) to verify if the cgi-scripts are running as user nobody
. In case not:
*,v
RCS repository files delivered with the installation package are locked by user nobody
and need to be changed to the user of your cgi-scripts, for example www-data
testenv
script from your browser; in the Fix line you can relock all the rcs files (recommended)
twiki/data/TWiki
directory where you unzipped the installation package:
InterWikis.*
, TWikiRegistration.*
, TWikiRegistrationPub.*
, WebPreferences.*
, WebStatistics.*
and all WebTopic*
files
$TWIKIROOT/data/TWiki/TWikiPreferences.*
to TWikiPreferencesSave.*
.
*.txt
and *.txt,v
files from the temporary data/TWiki
directory to your $TWIKIROOT/data/TWiki
directory, overwriting the existing ones
TWikiPreferencesSave.txt
settings into $TWIKIROOT/data/TWiki/TWikiPreferences.txt
. Notable changes are:
data/_default
directory from the temporary location to your $TWIKIROOT/data
directory
$TWIKIROOT/data
are writable by your cgi-script user
TWiki
and _default
):
%INCLUDE{"%TWIKIWEB%.WebSearchAdvanced"}%
pub/TWiki
from your temporary directory into your $TWIKIROOT/pub/TWiki
directory
$TWIKIROOT/pub/TWiki
are writable by your cgi-script user
pub/icn
directory from the temporary location to your $TWIKIROOT/pub/icn
directory
$TWIKIROOT/bin/testenv
script from your browser (e.g. http://localhost/bin/testenv
) to see if it reports any issues; address any potential problems
Note: These steps assume a downtime during the time of upgrade. You could install the new version in parallel to the existing one and switch over in an instant without affecting the users. As a guideline, install the new version into $TWIKIROOT/bin1
, $TWIKIROOT/lib1
, $TWIKIROOT/templates1
, $TWIKIROOT/data/TWiki1
(from data/TWiki
), $TWIKIROOT/pub/TWiki1
(from pub/TWiki
), and configure TWiki.cfg
to point to the same data and pub directory like the existing installation. Once tested and ready to go, reconfigure $TWIKIROOT/bin1/setlib.cfg
and $TWIKIROOT/lib1/TWiki.cfg
, then rename $TWIKIROOT/bin
to $TWIKIROOT/bin2
, $TWIKIROOT/bin1
to $TWIKIROOT/bin
. Do the same with the lib
, templates
and data/TWiki
directories.
-- TWiki:Main.PeterThoeny - 29 Aug 2004
TWiki site access control and user activity tracking options
TWiki does not authenticate users internally, it depends on the REMOTE_USER
environment variable. This variable is set when you enable Basic Authentication (.htaccess) or SSL "secure server" authentication (https protocol).
TWiki uses visitor identification to keep track of who made changes to topics at what time and to manage a wide range of personal site settings. This gives a complete audit trail of changes and activity.
No special installation steps are required if the server is already authenticated. If it isn't, you have these options for controlling user access:
attach
, edit
, installpasswd
, manage
, preview
, rename
, save
, upload
. The TWikiInstallationGuide has step-by-step instructions.
twiki/bin
directory. Consult your web server documentation.
Tracking by IP address is an experimental feature, enabled in lib/TWiki.cfg
. It lets you combine open access to some functions, with authentication on others, with full user activity tracking:
REMOTE_USER
environment variable is set for the scripts that are under authentication. If, for example, the edit
, save
and preview
scripts are authenticated, but not view
, you would get your WikiName in preview
for the %WIKIUSERNAME%
variable, but view
will show TWikiGuest
instead of your WikiName.
view
, will show the correct username instead of TWikiGuest.
$doRememberRemoteUser
flag in TWiki.cfg
. TWiki then persistently stores the IP address/username pairs in the file, $remoteUserFilename
, which is "$dataDir/remoteusers.txt"
by default.
view
script to viewauth
(or better, create a symbolic link)
viewauth
to the list of authenticated scripts in the twiki/bin/.htaccess
file. The view
script should not be listed in the .htaccess
file.
Quick Authentication Test - Use the %WIKIUSERNAME% variable to return your current identity:
This section applies only if your TWiki site is installed on a server that is both authenticated and on an intranet.
TWiki internally manages two usernames: Login Username and TWiki Username.
pthoeny
. This name is normally passed to TWiki by the REMOTE_USER
environment variable, and used internally. Login Usernames are maintained by your system administrator.
PeterThoeny
, is recorded when you register using TWikiRegistration; doing so also generates a personal home page in the Main web.
TWiki can automatically map an Intranet (Login) Username to a TWiki Username, provided that the username pair exists in the TWikiUsers topic. This is also handled automatically when you register.
twiki/data
, there are two registration form topics, TWikiRegistration and TWikiRegistrationPub. The original form includes an intranet Login Username field. For Basic Authentication, the original form is replaced by the Pub version. If you started using TWiki on Basic Authentication and want to change, you have to switch back forms for future use, and manually correct the existing entries, by editing TWikiUsers, adding the Login Username for each member - PeterThoeny - pthoeny - 01 Jan 1999
- and also in the .htpasswd
file, where you can either replace the WikiNames or duplicate the entries and have both, so both usernames will work.
NOTE: To correctly enter a WikiName - your own or someone else's - be sure to include the Main web name in front of the Wiki username, followed by a period, and no spaces. Ex:This pointsMain.WikiUsername
or%MAINWEB%.WikiUsername
WikiUser
to the TWiki.Main web, where user registration pages are stored, no matter which web it's entered in. Without the web prefix, the name appears as a NewTopic? everywhere but in the Main web.
Change and reset passwords using forms on regular pages. Use TWikiAccessControl to restrict use as required.
TWiki/ChangePassword
):
Forgot your old password? Then use ResetPassword instead. Please only use ResetPassword in case you really forgot your password. Thank you.
After submitting this form your password will be changed.
If you have questions please contact the TWiki webmaster dkessler@operamail.com.
TWiki/ResetPassword
):
Please only use this ResetPassword form in case you really forgot your password. Otherwise just change it using ChangePassword. Thank you.
After submitting this form you will see a page with your new password appearing encrypted.
You will have to e-mail this information to the Wiki webmaster, dkessler@operamail.com, who will set your account to use the new password.
-- TWiki:Main.MikeMannix - 19 May 2002
-- TWiki:Main.PeterThoeny - 25 Apr 2004
Restricting read and write access to topics and webs, by Users and groups
TWikiAccessControl allows you restrict access to single topics and entire webs, by individual user and by user Groups, in three areas: view; edit & attach; and rename/move/delete. Access control, combined with TWikiUserAuthentication, lets you easily create and manage an extremely flexible, fine-grained privilege system.
Open, freeform editing is the essence of WikiCulture - what makes TWiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with care - the more restrictions, the less Wiki in the mix. Experience shows that unrestricted write access works very well because:
As a collaboration guideline:
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.
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.
A user can create an account in TWikiRegistration. The following actions are performed:
.htpasswd
if authentication is enabled.
Users can be authenticated using Basic Authentication (htaccess) or SSL (secure server). In either case, TWikiUserAuthentication is required in order to track user identities, and use User and Group access control.
The default visitor name is TWikiGuest. This is the non-authenticated user.
Groups are defined by group topics created in the Main
web, like the TWikiAdminGroup. To create a new group:
Edit
TWikiGroups by entering a new topic with a name that ends in Group
. Example:
SomeGroup
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.TWikiAdminGroup
You can define who is allowed to make changes to a web or a topic.
Denying editing of a topic also restricts file attachment; both privileges are assigned together.
Set DENYTOPICCHANGE = < list of Users and Groups >
Set ALLOWTOPICCHANGE = < list of Users and Groups >
Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup
Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup
Restricting web-level editing blocks creating new topics, changing topics or attaching files.
Set DENYWEBCHANGE = < list of Users and Groups >
Set ALLOWWEBCHANGE = < list of Users and Groups >
The same rules apply as for restricting topics, with these additions:
You can define who is allowed to rename, move or delete a topic, or rename a web.
To allow a user to rename, move or delete a topic, they also need write (editing) permission. They also need write access to change references in referring topics.
Set DENYTOPICRENAME = < list of Users and Groups >
Set ALLOWTOPICRENAME = < list of Users and Groups >
Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup
Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup
You can define restrictions of who is allowed to rename a TWiki web.
Set DENYWEBRENAME = < list of Users and Groups >
Set ALLOWWEBRENAME = < list of Users and Groups >
The same rules apply as for topics, with these additions:
You can define who is allowed to see a web.
Technically it is possible to restrict read access to an individual topic based on
DENYTOPICVIEW
/ ALLOWTOPICVIEW
preferences variables, provided that the view script is authenticated. However this setup is not recommended since all content is searchable within a web - a search will turn up view restricted topics.
You can define restrictions of who is allowed to view a TWiki web. You can restrict access to certain webs to selected Users and Groups, by:
The idea is to keep a web hidden by not publishing its URL and by preventing the all webs
search option from accessing obfuscated webs. Do so by enabling the NOSEARCHALL
variable in WebPreferences:
Set NOSEARCHALL = on
This setup can be useful to hide a new web until content its ready for deployment.
Obfuscating webs is insecure, as anyone who knows the URL can access the web.
Use the following setup to authenticate users for topic viewing in all webs and to restrict access to selected webs:
Set DENYWEBVIEW = < list of Users and Groups >
Set ALLOWWEBVIEW = < list of Users and Groups >
DENYWEBVIEW
is evaluated before ALLOWWEBVIEW
. Access is denied if the authenticated person is in the DENYWEBVIEW
list, or not in the ALLOWWEBVIEW
list. Access is granted in case DENYWEBVIEW
and ALLOWWEBVIEW
is not defined.
NOSEARCHALL
variable in its WebPreferences topic:
Set NOSEARCHALL = on
view
to the list of authenticated scripts in the .htaccess
file.
This method only works if the
view
script is authenticated, which means that all Users have to login, even for read-only access. (An open guest account, like TWikiGuest, can get around this, allowing anyone to login to a common account with, for example, view-only access for public webs.) TWikiInstallationGuide has more on Basic Authentication, using the .htaccess
file.
Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:
Set DENYWEBVIEW = < list of Users and Groups >
Set ALLOWWEBVIEW = < list of Users and Groups >
DENYWEBVIEW
is evaluated before ALLOWWEBVIEW
. Access is denied if the authenticated person is in the DENYWEBVIEW
list, or not in the ALLOWWEBVIEW
list. Access is granted in case DENYWEBVIEW
and ALLOWWEBVIEW
is not defined.
NOSEARCHALL
variable in its WebPreferences topic:
Set NOSEARCHALL = on
$doRememberRemoteUser
flag in lib/TWiki.cfg
as described in TWikiUserAuthentication. TWiki will now remember the IP address of an authenticated user.
view
script to viewauth
(or better, create a symbolic link)
viewauth
to the list of authenticated scripts in the .htaccess
file. The view
script should not be listed in the .htaccess
file.
When a user accesses a web where you enabled view restriction, TWiki will redirect from the view
script to the viewauth
script once (this happens only if the user has never edited a topic). Doing so will ask for authentication. The viewauth
script shows the requested topic if the user could log on and if the user is authorized to see that web.
Authenticating webs is not very secure, as there is a way to circumvent the read access restriction. It can be useful in certain situations - for example, to simplify site organization and clutter, by hiding low traffic webs - but is not recommended for securing sensitive content.
To hide access control settings from normal browser viewing, place them in comment markers.
By mistyping a user or group name in the ALLOWTOPICCHANGE setting, it's possible to lock a topic so that no-one can edit it from a browser. To avoid this, you can create Web-based superusers:
$superAdminGroup
variable in lib/TWiki.cfg
to the name of a group of Users who are always allowed to edit/view topics.
$superAdminGroup = "TWikiAdminGroup";
-- TWiki:Main.PeterThoeny - 04 May 2002
-- TWiki:Main.MikeMannix - 12 May 2002
Definition of the templates used to render all HTML pages displayed in TWiki
The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML markup for template-specific content. Templates are used to define page layout, and also to supply default content for new pages.
Where the old templates were each complete HTML documents, the new templates are defined using variables to include template parts from a master file. You can now change one instance of a common element to update all occurrences; previously, every affected template had to be updated. This simplifies the conversion of templates into XHTML format, and provides a more versatile solution for templates and for TWikiSkins. The new system:
&TWiki::Store::readTemplate()
so that the caller simply gets an expanded template file (the same as before).
%TMPL:<key>%
and %TMPL:<key>{"attr"}%
.
%TMPL:INCLUDE{"file"}%
: Includes a template file. The template directory of the current web is searched first, then the templates root (twiki/templates
).
%TMPL:DEF{"var"}%
: Define a variable. Text between this and the END directive is not returned, but put into a hash for later use.
%TMPL:END%
: Ends variable definition.
%TMPL:P{"var"}%
: Prints a previously defined variable.
twiki.tmpl
master template, like twiki.print.tmpl
, that redefines the header and footer.
There are three types of template:
Common parts, appearing in two or more templates, can be defined in a master template and then shared by others: twiki.tmpl
is the default master template.
Template variable: Defines: %TMPL:DEF{"sep"}% "|" separator %TMPL:DEF{"htmldoctype"}% Start of all HTML pages %TMPL:DEF{"standardheader"}% Standard header (ex: view, index, search) %TMPL:DEF{"simpleheader"}% Simple header with reduced links (ex: edit, attach, oops) %TMPL:DEF{"standardfooter"}% Footer, excluding revision and copyright parts %TMPL:DEF{"oops"}% Skeleton of oops dialog
TWiki uses HTML template files for 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.
Templates are stored either in the twiki/templates
directory or in user topics. As an example, twiki/templates/view.tmpl
is the template file for the twiki/bin/view
script.
Templates can be overloaded by individual webs.
TWikiSkins can overload the standard templates.
TWiki uses the following search order to determine which template to use:
If a skin is specified If no skin is specified templates/%WEB%/script.skin.tmpl
templates/%WEB%/script.tmpl
templates/script.skin.tmpl
templates/script.tmpl
data/%WEB%/SkinSkinScriptTemplate.txt
data/%WEB%/ScriptTemplate.txt
data/TWiki/SkinSkinScriptTemplate.txt
data/TWiki/ScriptTemplate.txt
Legend:
• script refers to the script name, e.gview
,edit
• Script refers to the same, but with the first character capitalized, e.gView
• skin refers to the skin name, e.gdragon
,pattern
• Skin refers to the same, but with the first character capitalized, e.gDragon
•%WEB%
refers to the current web
Additionally (and primarily for use in %TMPL:INCLUDE{}%
) the template name may be a wiki topic name, specified as Web.Topic
, in which case the search is:
If Web is not specified in the INCLUDE, it defaults to TWiki, and the search to the first type.
If a skin is specified If no skin is specified templates/web/Web.Topic.skin.tmpl
templates/web/Web.Topic.tmpl
templates/Web.Topic.skin.tmpl
templates/Web.Topic.tmpl
data/Web/Topic.txt
Special variables are used in templates, especially in view
, to display meta data.
Template topics define the default text for new topics. There are three types of template topic:
All template topics are located in the TWiki web. The WebTopicEditTemplate can be overloaded. When you create a new topic, TWiki locates a topic to use as a content template according to the following search order:
Topic Name: What it is: WebTopicViewTemplate Error page shown when you try to view a nonexistent topic WebTopicNonWikiTemplate Alert page shown when you try to view a nonexistent topic with a non-WikiName WebTopicEditTemplate Default text shown when you create a new topic.
templatetopic
CGI parameter.
The following variables get expanded when a user creates a new topic based on a template topic:
Variable: Description: %DATE%
Current date, e.g. 03 May 2025
%USERNAME%
Login name, e.g. jsmith
%WIKINAME%
WikiName of user, e.g. JohnSmith
%WIKIUSERNAME%
User name, e.g. Main.JohnSmith
%URLPARAM{"name"}%
Value of a named URL parameter %NOP%
A no-operation variable that gets removed. Useful to prevent a SEARCH from hitting an edit template topic; also useful to escape a variable like %URLPARAM%NOP%{...}%
%NOP{ ... }%
A no-operation text that gets removed. Useful to write-protect an edit template topic, but not the topics based this template topic. See notes below. Example:
%NOP{
* Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
}%
Notes:
%NOP{ ... }%
can span multiple lines.
}%
pattern is "non-greedy", that is, it stops at the first occurance. That means, you need to escape variables with parameters located inside %NOP{ ... }%
: Insert a %NOP%
between }
and %
. Silly example: %NOP{ %GMTIME{"$year"}%NOP%% }%
.
All other variables are unchanged, e.g. are carried over "as is" into the new topic.
Here is an example for creating new topics based on a specific template topic:
The above form asks for a topic name. A hidden input tag named templatetopic
specifies ExampleTopicTemplate as the template topic to use. Here is the HTML source of the form:
<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%INTURLENCODE{"%WEB%"}%/"> * New example topic: <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" /> <input type="hidden" name="topicparent" value="%TOPIC%" /> <input type="hidden" name="onlywikiname" value="on" /> <input type="hidden" name="onlynewtopic" value="on" /> <input type="submit" value="Create" /> (date format is <nop>YYYYxMMxDD) </form>
The edit
scipt understands the following parameters, typically supplied by HTML input fields:
Parameter: Description: topic
Name of topic to create. Can be set in a text field, or is set programmatically (e.g. with a sequential number) onlywikiname
If set, TWiki will complain if the topic name is not a WikiWord onlynewtopic
If set, TWiki will complain if a topic of the same name already exists templatetopic
The name of the template topic, e.g. topic used to copy the initial content topicparent
Sets the parent topic TopicClassification
Assuming the template topic has a form with a field called "TopicClassification", it will set the value of the field 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 applicationsanyname
Any parameter can passed to the new topic; if the template topic contains %URLPARAM{"anyname"}%
, it will be replaced by its value
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%
Attached is an example of an oops based template oopsbase.tmpl
and an example oops dialog oopstest.tmpl
based on the base template. %A% NOTE: This isn't the release version, just a quick, simple demo.
The first line declares a delimiter variable called "sep", used to separate multiple link items. The variable can be called anywhere by writing %TMPL:P{"sep"}%
%TMPL:DEF{"sep"}% | %TMPL:END% <html> <head> <title> %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%</title> <base href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%"> <meta name="robots" content="noindex"> </head> <body bgcolor="#FFFFFF"> <table width="100%" border="0" cellpadding="3" cellspacing="0"> <tr> <td bgcolor="%WEBBGCOLOR%" rowspan="2" valign="top" width="1%"> <a href="%WIKIHOMEURL%"> <img src="%PUBURLPATH%/wikiHome.gif" border="0"></a> </td> <td> <b>%WIKITOOLNAME% . %WEB% . </b><font size="+2"> <B>%TOPIC%</b> %TMPL:P{"titleaction"}%</font> </td> </tr> <tr bgcolor="%WEBBGCOLOR%"> <td colspan="2"> %TMPL:P{"webaction"}% </td> </tr> </table> --- ++ %TMPL:P{"heading"}% %TMPL:P{"message"}% <table width="100%" border="0" cellpadding="3" cellspacing="0"> <tr bgcolor="%WEBBGCOLOR%"> <td valign="top"> Topic <b>%TOPIC%</b> . { %TMPL:P{"topicaction"}% } </td> </tr> </table> </body>
Each oops template basically just defines some variables and includes the base template that does the layout work.
%TMPL:DEF{"titleaction"}% (test =titleaction=) %TMPL:END% %TMPL:DEF{"webaction"}% test =webaction= %TMPL:END% %TMPL:DEF{"heading"}% Test heading %TMPL:END% %TMPL:DEF{"message"}% Test =message=. Blah blah blah blah blah blah blah blah blah blah blah... * Some more blah blah blah blah blah blah blah blah blah blah... * Param1: %PARAM1% * Param2: %PARAM2% * Param3: %PARAM3% * Param4: %PARAM4% %TMPL:END% %TMPL:DEF{"topicaction"}% Test =topicaction=: [[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}% [[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END% %TMPL:INCLUDE{"oopsbase"}%
With URL: .../bin/oops/Sandbox/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify
.tmpl
filename extension - it contained unresolved %VARIABLES%
, but could still be previewed directly in a browser.
-- TWiki:Main.CrawfordCurrie - 30 Jun 2004
-- TWiki:Main.PeterThoeny - 15 Aug 2004
-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.DavidLeBlanc - 11 Mar 2002
Skins overlay regular templates with alternate header/footer layouts; topic text is not affected
Skins are customized TWikiTemplates files. You can use skins to change the look of a TWiki topic, for example, the layout of the header and footer. Rendered text between header and footer does not change. You can also use skins to define an alternate view, like a view optimized for printing.
Skin files are located in the twiki/templates
directory and are named with the syntax: <scriptname>.<skin>.tmpl
. For example, the Printable skin for the view
template is view.print.tmpl
.
Use the existing TWikiTemplates (like view.tmpl
) or skin files as a base for your own skin, name it for example view.myskin.tmpl
.
You can use template variables, TWikiVariables, and other predefined variables to compose your skins. Some commonly used variables in skins:
Variable: | Expanded to: |
---|---|
%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 |
%SCRIPTSUFFIX% | The script suffix, ex: .pl , .cgi |
%WEB% | The name of the current web. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%WEB%"}% for proper handling in an internationalized environment |
%TOPIC% | The name of the current topic. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%TOPIC%"}% for proper handling in an internationalized environment |
%WEBTOPICLIST% | Common links of current web, defined in the WebPreferences. It includes a #GoBox |
%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; is set in TWikiPreferences |
The %WEBTOPICLIST%
includes a "Go" box to jump to a topic. The box also understand URLs, e.g. you can type http://www.google.com/ to jump to an external web site. The feature is handy if you build a skin that has a select box of frequently used links, like Intranet home, employee database, sales database and such. A little JavaScript gets into action on the onSelect method of the select tag to fill the selected URL into the "Go" box field, then submits the form.
Here is an example form that has a select box and the "Go" box for illustration purposes. You need to have JavaScript enabled for this to work:
Although work is underway at TWiki:Codev.CssClassNames, the regular templates files currently do not use style sheets. Many skin developers, however, choose to use them; it helps in separating style from content.
Example: To use a style sheet for the broadcast message, add this to view.myskin.tmpl
:
<style type="text/css"> .broadcastmessage { background: yellow; display:block; border-style:solid;border-width: 2px;border-color:red; } .broadcastmessage strong {color: red} </style>
Then add a div tag to the %BROADCASTMESSAGE%
variable located after the #PageTop
anchor or after the opening form tag:
<div class="broadcastmessage"> %BROADCASTMESSAGE% </div>
The format of standard attachment tables is defined through the use of special TWiki template macros which by default are defined in the templates/twiki.tmpl
template using the %TMPL:DEF
macro syntax described in TWikiTemplates. These macros are:
Macro | Description |
---|---|
ATTACH:files:header | Standard title bar |
ATTACH:files:row | Standard row |
ATTACH:files:footer | Footer for all screens |
ATTACH:files:header:A | Title bar for upload screens, with attributes column |
ATTACH:files:row:A | Row for upload screen |
ATTACH:files:footer:A | Footer for all screens |
Macro | Description |
---|---|
ATTACH:versions:header | Header for versions table on upload screen |
ATTACH:versions:row | Row format for versions table on upload screen |
ATTACH:versions:footer | Footer for versions table on upload screen |
The ATTACH:row
macros are expanded for each file in the attachment table, using the following special tags:
Tag | Description |
---|---|
%A_URL% | URL that will recover the file |
%A_REV% | Revision of this file e.g. "1.1" |
%A_ICON% | A file icon suitable for representing the attachment content |
%A_FILE% | The name of the file |
%A_SIZE% | The size of the file |
%A_DATE% | The date the file was uploaded |
%A_USER% | The user who uploaded it |
%A_COMMENT% | The comment they put in when uploading it |
%A_ATTRS% | The attributes of the file as seen on the upload screen e.g "h" for a hidden file |
Note: it is easy to change the look and feel for an entire site by editing the twiki.tmpl
template file. However, to simplify upgrading, you should avoid doing this. Instead, write a skin-specific template file e.g. attach.myskin.tmpl
and use %TMPL:INCLUDE{attach.myskin.tmpl}%
to include it in each of your skin files. As long as it it included after twiki.tmpl, your macro definitions will override the defaults defined there.
See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQ
You can try all installed skins in TWikiSkinBrowser.
A skin can be activated in two ways:
SKIN
Preference variable in TWikiPreferences, one of the WebPreferences, or in a user - TWikiGuest - topic.
Set SKIN = print
?skin=name
to the URL, for this example:
The ?skin=name
URL parameter overrides the SKIN Preference value.
-- TWiki:Main.PeterThoeny - 25 Jul 2004
-- TWiki:Main.CrawfordCurrie - 30 Jun 2004
Special text strings expand on the fly to display user data or system info
TWikiVariables are text strings - %VARIABLE%
- that expand into content whenever a page is rendered for viewing. VARIABLES
are replaced by data, either user-entered or automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you can configure. You can also define custom variables, with new names and values.
Notes:
!%TOPIC%
to get %TOPIC%.
Most predefined variables return values that were either set in the lib/twiki.cfg
file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.
%INCLUDINGTOPIC%
, %INCLUDE%
, and the mighty %SEARCH%
.
This version of TWiki - 01 Sep 2004 $Rev: 1742 $ - expands the following variables (enclosed in %
percent signs):
%ATTACHURL%
http://pyqplayer.sourceforge.net/pub/TWiki/TWikiVariablesAtoM
%ATTACHURL%/image.gif
%ATTACHURLPATH%
/pub/TWiki/TWikiVariablesAtoM
%TOPIC%
if there is no INCLUDE
%BASETOPIC%
%WEB%
in case there is no include.
%BASEWEB%
%DISPLAYTIME%
03 May 2025 - 02:05
%GMTIME%
%DISPLAYTIME{"format"}%
%DISPLAYTIME{"$hou:$min"}%
expands to 02:05
%ENCODE{"string"}%
Parameter: | Description: | Default: |
---|---|---|
"string" | String to encode | required (can be empty) |
type="entity" | Encode special characters into HTML entities, like a double quote into " | URL encoding |
type="url" | Encode special characters for URL parameter use, like a double quote into %22 | (this is the default) |
%ENCODE{"spaced name"}%
expands to spaced%20name
%FORMFIELD{"fieldname"}%
Parameter: | Description: | Default: |
---|---|---|
"fieldname" | The name of a TWiki form field | required |
topic="..." | Topic where form data is located. May be of the form Web.TopicName | Current topic |
format="..." | Format string. $value expands to the field value | "$value" |
default="..." | Text shown when no value is defined for the field | "" |
alttext="..." | Text shown when field is not found in the form | "" |
%FORMFIELD{"ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field found"}%
%GMTIME%
03 May 2025 - 02:05
%GMTIME{"format"}%
Variable: | Unit: | Example |
---|---|---|
$seconds | seconds | 59 |
$minutes | minutes | 59 |
$hours | hours | 23 |
$day | day of month | 31 |
$wday | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu |
$month | month in ISO format | Dec |
$mo | 2 digit month | 12 |
$year | 4 digit year | 1999 |
$ye | 2 digit year | 99 |
$tz | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT |
$iso | ISO format timestamp | 2025-05-03T02:05Z |
$rcs | RCS format timestamp | 2025/05/03 02:05:52 |
$http | E-mail & http format timestamp | Sat, 03 May 2025 02:05:52 GMT |
%GMTIME{"$day $month, $year - $hour:$min:$sec"}%
expands to 03 May, 2025 - 02:05:52
%HOMETOPIC%
WebHome
, renders as WebHome
%HTTP_HOST%
pyqplayer.sourceforge.net
%ICON{"type"}%
bmp
, doc
, gif
, hlp
, html
, mp3
, pdf
, ppt
, txt
, xls
, xml
, zip
%ICON{"pdf"}%
expands to %INCLUDE{"page" ...}%
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/"}% Note if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. | |
pattern="..." | A RegularExpression pattern to include a subset of a topic or page | none |
rev="1.2" | Include a previous topic revision; N/A for URLs | top revision |
warn="off" | Warn if topic include fails: Fail silently (if off ); output default warning (if set to on ); else, output specific text (use $topic for topic name) | %INCLUDE- WARNING% preferences setting |
%TOPIC%
in case there is no include
%INCLUDINGTOPIC%
%WEB%
if there is no INCLUDE.
%INCLUDINGWEB%
%MAINWEB%
Main
%METASEARCH{...}%
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 | required |
web="%WEB%" | Wiki web to search: A web, a list of webs separated by whitespace, or all webs. | current web |
topic="%TOPIC%" | The topic the search relates to | current topic |
title="Title" | Text that is prefixed to any search results | empty |
default="none" | Default text shown if no search hit | empty |
%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%NOTIFYTOPIC%
WebNotify
, renders as WebNotify
$TWiki::Plugins::VERSION
number, also indicating the version of the TWikiFuncModule
%PLUGINVERSION{}%
1.025
%PLUGINVERSION{"name"}%
%PLUGINVERSION{"DefaultPlugin"}%
expands to 1.021
%PUBURL%
http://pyqplayer.sourceforge.net/pub
%PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH%
/pub
%REMOTE_ADDR%
127.0.0.1
%REMOTE_PORT%
44526
%REMOTE_USER%
%REVINFO%
r1.1 - 14 Aug 2004 - 08:01 - TWikiGuest
%REVINFO{"format"}%
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 |
Variable: | Unit: | Example |
---|---|---|
$web | Name of web | Current web |
$topic | Topic name | Current topic |
$rev | Revison number. Prefix r1. to get the usual r1.5 format | 5 |
$date | Revision date | 11 Jul 2004 |
$username | Login username of revision | jsmith |
$wikiname | WikiName of revision | JohnSmith |
$wikiusername | WikiName with Main web prefix | Main.JohnSmith |
%REVINFO{"$date - $wikiusername" rev="1.1"}%
returns revision info of first revision
%SCRIPTURL%
http://pyqplayer.sourceforge.net/cgi-bin/bin
%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%
which expands to http://pyqplayer.sourceforge.net/cgi-bin/bin/viewauth/TWiki/TWikiVariablesNtoZ
%SCRIPTURLPATH%
/cgi-bin/bin
.pl
or .cgi
%SCRIPTSUFFIX%
%SEARCH{"text" ...}%
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" | Wiki web to search: A web, a list of webs separated by comma, or all webs. [2] | 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 |
reverse="on" | Reverse the direction of the search | Ascending search |
casesensitive="on" | Case sensitive search | Ignore case |
nosummary="on" | Show topic title only | Show topic summary |
bookview="on" | BookView search, e.g. show complete topic text | 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 |
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 |
separator=", " | Line separator between hits | Newline "$n" |
%SEARCH{"wiki" web="Main" scope="topic"}%
%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%
(displays results in a table with header - details)
%TABLE{}%
variable just before the %SEARCH{}%
to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
web="all"
search if you define a NOSEARCHALL=on
variable in its WebPreferences
%SERVERTIME%
03 May 2025 - 02:05
%GMTIME%
%SERVERTIME{"format"}%
%SERVERTIME{"$hou:$min"}%
expands to 02:05
%SPACEDTOPIC%
TWiki%20*Variables%20*Nto%20*Z
%STOPINCLUDE%
variable. A normal view of the topic shows everyting exept the %STARTINCLUDE%
variable itself.
%STARTINCLUDE%
%STATISTICSTOPIC%
WebStatistics
, renders as WebStatistics
%STOPINCLUDE%
variable itself.
%STOPINCLUDE%
%TOC%
%TOC{"SomeTopic" ...}%
"---++ 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
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 |
%TOC{depth="2"}%
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
%TOPIC%
TWikiVariablesNtoZ
, renders as TWikiVariablesNtoZ
$name
variable gets expanded to the topic name; the $web
variable gets expanded to the name of the web.
%TOPICLIST{"format" ...}%
Parameter: | Description: | Default: |
---|---|---|
"format" | Format of one line, may include $name and $web variables | "$name" |
format="format" | (Alternative to above) | "$name" |
separator=", " | line separator | "\n" (new line) |
web="Name" | Name of web | Current web |
%TOPICLIST{" * $web.$name"}%
creates a bullet list of all topics
%TOPICLIST{separator=", "}%
creates a comma separated list of all topics
%TOPICLIST{" <option>$name</option>"}%
creates an option list (for drop down menus)
%TWIKIWEB%
TWiki
%URLPARAM{"name"}%
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, like a double quote into " . This is needed if text is put into an HTML form field | no encoding |
encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | no encoding |
multiple="on" multiple="[[$item]]" | If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" | first element |
separator=", " | Separator between multiple selections. Only relevant if multiple is specified | "\n" (new line) |
%URLPARAM{"skin"}%
returns print
for a .../view/TWiki/TWikiVariablesNtoZ?skin=print
URL. Test this:
jsmith
, WIKINAME like JohnSmith
and WIKIUSERNAME like Main.JohnSmith
. A user is a TWikiGuest in case the topic is not authenticated
%USERNAME%
guest
%VAR{"NAME" web="Web"}%
%WEBBGCOLOR%
of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%
, which expands to #FFEFA6
%WEB%
TWiki
NOSEARCHALL=on
preference variable. The "format"
defines the format of one web item. The $name
variable gets expanded to the name of the web, $qname
gets expanded to double quoted name, $marker
to marker
where web matches selection
.
%WEBLIST{"format" ...}%
Parameter: | Description: | Default: |
---|---|---|
"format" | Format of one line, may include $name variable | "$name" |
format="format" | (Alternative to above) | "$name" |
separator=", " | line separator | "\n" (new line) |
webs="public" | comma sep list of Web, public expands to all non-hidden | "public" |
marker="selected" | Text for $marker where item matches selection , otherwise equals "" | "selected" |
selection="%WEB%" | Current value to be selected in list | section="%WEB%" |
%WEBLIST{" * [[$name.WebHome]]"}%
creates a bullet list of all webs.
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}%
Dropdown of all public Webs + Trash Web, current Web highlighted.
%WEBPREFSTOPIC%
WebPreferences
, renders as WebPreferences
%WIKIHOMEURL%
http://your.domain.com/twiki
%WIKINAME%
TWikiGuest
%WIKIPREFSTOPIC%
TWikiPreferences
, renders as TWikiPreferences
%WIKITOOLNAME%
TWiki
%WIKIUSERNAME%
Main.TWikiGuest
, renders as TWikiGuest
%WIKIUSERSTOPIC%
TWikiUsers
, with Main prefix renders as TWikiUsers
%WIKIVERSION%
01 Sep 2004 $Rev: 1742 $
Note: Above text is included from TWikiVariablesAtoM and TWikiVariablesNtoZ
Additional variables are defined in the preferences topics:
Variable: | Level: | What: | Expands to: | ||
---|---|---|---|---|---|
%ALLOWTOPICCHANGE% |
(any topic) | List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl) | |||
%ALLOWTOPICRENAME% |
(any topic) | List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl) | TWikiAdminGroup | ||
%ALLOWWEBCHANGE% |
WL | List of users and groups who are allowed to change topics in the TWiki web. (More in TWikiAccessControl) | |||
%ALLOWWEBRENAME% |
WL | List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl) | |||
%ATTACHLINKBOX% |
SL , UL | Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: |
|||
%DENYTOPICCHANGE% |
(any topic) | List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl) | %DENYTOPICCHANGE% | ||
%DENYTOPICRENAME% |
(any topic) | List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl) | %DENYTOPICRENAME% | ||
%DENYWEBCHANGE% |
WL | List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl) | |||
%DENYWEBRENAME% |
WL | List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl) | |||
%DONTNOTIFYCHECKBOX% |
SL , UL | Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked" , or unchecked if empty. Value is: |
|||
%EDITBOXHEIGHT% |
SL , UL | Vertical size of edit box, is 17 |
17 | ||
%EDITBOXWIDTH% |
SL , UL | Horizontal size of edit box, is 70 |
70 | ||
%EDITBOXSTYLE% |
SL , UL | Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99% |
width: 99% | ||
%FINALPREFERENCES% |
SL , WL | List of preferences that are not allowed to be overridden by next level preferences | ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME | ||
%HTTP_EQUIV_ON_EDIT% |
SL , UL | http-equiv meta tags for edit script. | |||
%HTTP_EQUIV_ON_PREVIEW% |
SL , UL | http-equiv meta tags for preview script. | |||
%HTTP_EQUIV_ON_VIEW% |
SL | http-equiv meta tags for view, rdiff, attach, search* scripts. | |||
%NEWTOPICBGCOLOR% |
SL , UL | Background color of non existing topic. ( UL needs authentication for topic views ) | #FFFFCE | ||
%NEWTOPICFONTCOLOR% |
SL , UL | Font color of non existing topic. ( UL needs authentication for topic views ) | #0000FF | ||
%NOSEARCHALL% |
WL | Exclude web from a web="all" search (set variable to on for hidden webs) |
|||
%RELEASEEDITLOCKCHECKBOX% |
SL , UL | Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked" , or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: |
|||
%WEBBGCOLOR% |
WL | Background color of web | #FFD8AA | ||
%WEBCOPYRIGHT% |
SL , WL | Copyright notice (bottom right corner of topics) | Copyright © 1999-2025 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback
|
||
%WEBTOPICLIST% |
WL | Common links of web (second line of topics) | Welcome | Register | Changes | Topics | Index | Search | Go | ||
%WIKIWEBLIST% |
SL | List of TWiki webs (in upper right corner of topics) | Main | TWiki | Sandbox | ||
%WIKIWEBMASTER% |
SL | Webmaster email address (sender of email notifications) , is dkessler@operamail.com | dkessler@operamail.com |
Note: There are some more useful variables defined in the TWikiPreferences like %BR%
for line break, colors like %RED%
for colored text and small icons like %H%
for a Help icon.
Set VARIABLENAME = value
Set VARIABLENAME = value
Example: Create a custom logo variable the TWiki web
- To place a logo anywhere in a web by typing
%MYLOGO%
, define the Variable on the web's WebPreferences page, and upload a logo file, ex:mylogo.gif
. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex:LogoTopic
:
Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
-- TWiki:Main.PeterThoeny - 14 Aug 2004
-- TWiki:Main.MikeMannix - 12 May 2002
Additional topic data, program-generated or from TWikiForms, is stored in META
variable name/value pairs
TWikiMetaData uses META
variables to store topic data that's separate from the main free-form content. This includes program-generated info like FileAttachment and topic movement data, and user-defined TWikiForms info. Use META
variables to format and display Meta Data.
%META:<type>{key1="value1" key2="value2" ...}%
name
, this appears first for easier searching (note the order of the variables themselves is defined).
\n
(new line) is represented in values by %_N_
and "
(double-quotes) by %_Q_%
.
Example of Format%META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}% text of the topic %META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="JohnTalintyre" 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"}%
The current version of Meta Data is 1.0, with support for the following variables.
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 |
This is optional, exists if topic has ever been moved. If a topic is moved more than once, only the most recent META:TOPICMOVED meta variable exists in the topic, older ones are to be found in the rcs history.
%META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"}%
Key | Comment |
---|---|
from | Full name, i.e., web.topic |
to | Full name, i.e., web.topic |
by | Who did it, is the REMOTE_USER, not WikiName |
date | integer, unix time, seconds since start 1970 |
Notes:
Key | Comment |
---|---|
name | The topic from which this was created, WebHome if done from Go , othewise topic where ? or form used. Normally just topic, but is full web.topic format if parent is in a different Web. Renaming a Web will then only break a few of these references or they can be scanned and fixed. |
Key | Comment |
---|---|
name | Name of file, no path. Must be unique within topic |
version | Same as RCS revision |
path | Full path file was loaded from |
size | In bytes |
date | integer, unix time, seconds since start 1970 |
user | the REMOTE_USER, not WikiName |
comment | As supplied when file uploaded |
attr | h if hidden, optional |
Extra fields that are added if an attachment is moved:
Key | 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 |
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 |
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 |
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:
diff
function output appears in a logical order
The recommended sequence is:
META:TOPICINFO
META:TOPICPARENT
(optional)
META:TOPICMOVED
(optional)
META:FILEATTACHMENT
(0 or more entries)
META:FORM
(optional)
META:FIELD
(0 or more entries; FORM required)
When viewing a topic the Raw 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
Meta Data is rendered with the %META% variable. This is mostly used in the view
, preview
and edit
scripts.
Note: Rendering meta data is currently not supported in topic text. As a workaround, use FormattedSearch on the current topic only to render form fields.
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 " > " . |
At present, there is no Meta Data support for Plugins. However, the format is readily extendable and the Meta.pm
code that supports the format needs only minor alteration.
-- TWiki:Main.JohnTalintyre - 29 Aug 2001
-- TWiki:Main.MikeMannix - 03 Dec 2001
-- TWiki:Main.PeterThoeny - 15 Aug 2004
Form-based input in topics, with name/value pairs stored as Meta Data variables; choose one of multiple forms per web & topic
By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, a single form appears in edit mode, and the contents are rendered as a table when viewed on the display page. You can define unlimited forms per web. For each topic, you can select a template if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.
Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables
A Form Template is simply a page containing your form, defined as a table where each row is one form field.
Input type | Type field | Size field | Value field |
---|---|---|---|
One or more checkboxes | checkbox | number of checkboxes per line | comma list of checkbox labels |
One or more checkboxes, plus Set and Clear buttons | checkbox+buttons | (same) | (same) |
Read-only label text | label | 1 | (unused) |
One or more radio buttons | radio | number of radio buttons per line | comma list of checkbox labels |
Drop-down menu or scrollable box | select | 1 for drop down, 2 and up for scrollable box | comma list of options |
A one-line text field | text | text box width in number of characters | (unused) |
A text box; size is 40x10 (columns x rows) | textarea | columns x rows, e.g. 40x6 | (unused) |
YourForm
, ExpenseReport
, InfoCategory
, RecordReview
, whatever you need.
Name
, Type
, Size
, Values
, and Tooltip message
(see sample below).
Example:WebForm
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |
| 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 TopicClassification select 1 NoDisclosure, PublicSupported, PublicFAQ blah blah... OperatingSystem checkbox 3 OsHPUX, OsLinux, OsSolaris, OsWin blah blah... OsVersion text 16 blah blah...
Forms can also be defined by using form templates that retrieve field values from one or more separate topics:
FormTemplate
topic defines the Form, ex: YourFormTemplate
.
Example: WebFormTemplate
- WebFormTemplate main definition:
Name Type Size Values Tooltip message TopicClassification select 1 blah blah... OperatingSystem checkbox 3 blah blah... OsVersion text 16 blah blah...
Leave the
Values
field blank.
- TopicClassification field value definition:
Name Type Tooltip message NoDisclosure option blah blah... PublicSupported option blah blah... PublicFAQ option blah blah...
[[...]]
links can be used to force a link (at present, the [[...][...]]
format is not supported).
Tooltip message
column is used as a tooltip for the field name (only if field name is a WikiName) - you only see the tooltip In edit.
WebTopicEditTemplate
, with field=value
, or, for checkboxes, field=1
.
Forms are enabled on a per web basis. The WEBFORMS
variable in WebPreferences is optional and defines a list of possible form templates. Example:
WEBFORMS
enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS
, or the No form option.
WebTopicEditTemplate
topic in a web and adding a form to it. Initial Form values can be set there.
formtemplate
parameter in the URL. Initial values can then be provided in the URLs or as form values:
name
, ex: ?BugPriority=1
namevalue=1
, ex: ?ColorRed=1
.
WEBFORMS
variable defines alternative forms that can be selected by pressing Change in edit mode.
SubmitExpenseReport
topic where you can create new expense reports, a SubmitVacationRequest
topic, and so on. These can specify the required template topic with its associated form.
The form topic name, fields and values are stored as TWikiMetaData - the order of the field/value pairs is the same as in the template.
SEARCH
and METASEARCH
variables in TWikiVariables, and TWiki Formatted Search for various options.
The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.
Form Templates | Category Tables |
---|---|
defined in topics | defined in templates |
many forms per web | one table per web |
saved as Meta Data | saved as HTML |
Change & Add Form buttons | UseCategory radio button |
On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl
. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS
. If missing, pages will display, but attempting to edit results in an error message.
The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.
NOTE: If things aren't working correctly, there may be useful entries in
data/warning.txt
.
{3 spaces}* Set
statements:
| *Name*|*Type*|*Size*|*Value*|*Tooltip message*|*Attributes*|
| WEBTOPICLIST |textarea| | | List of topics of the %WEB% web |S|
| SITEMAPLIST |select |3| on, | list this web in the Site Map |S|
| SITEMAPWHAT |textarea| | | short web summary |S|
| WEBBGCOLOR |text |8| | Web specific background color |S|
Set WEBFORMS
line
textarea
stuff, and set as you like
Notes:
If it isn't working, double check that the S
attribute has been specified (S for Setting).
If you change the form, the changes will not take affect until you edit and save the preferences' topics again.
Using the TWiki:Plugins.EditTablePlugin on WebPreferencesForm makes adding new prefedrences a breeze.
A possibly unwanted side effect for using forms for the SKINS setting in their personal user topic: because the User Preferences are final you can't have different skins for different webs as the user's setting always wins. A workaround is to simply omit SKIN in the form.
Another example, this one using EditTablePlugin, source:
%EDITTABLE{ header="|*Name*|*Type*|*Size*|*Values*|*Tooltip message*|*Attributes*|" format="|text,20|text,20|text,20|text,20|text,20|text,1|" }%
Result (after some editing):
-- TWiki:Main.JohnTalintyre - 16 Aug 2001
-- TWiki:Main.MikeMannix - 05 Jan 2002
-- TWiki:Main.PeterThoeny - 25 Apr 2004
-- TWiki:Main.MattWilkie - 27 Jul 2004
Plug-in enhanced feature add-ons, with a Plugin API for developers
You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you:
Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the TWiki:Plugins web.
TWiki comes with a set of Plugins as part of the standard installation.
TWiki:Plugins
expands to TWiki:Plugins on TWiki.org. You can edit the predefined set of of Wiki-related sites, and add your own
:-)
for :cool:
for "$SUM( $ABOVE() )"
to tables located in TWiki topics.
Each TWikiPlugin comes with full documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing.
Most Plugins can be installed in three easy steps, with no programming skills required:
Special Requests: Some Plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, templates. In these cases, detailed instructions are in the Plugin documentation.
Each Plugin has a standard release page, located in the TWiki:Plugins web at TWiki.org. In addition to the documentation topic (SomePlugin
), there's a separate development page.
Dev
(SomePluginDev
).
To test new Plugins on your installation before making them public, you may want to use one of these two approaches:
twiki/bin
and twiki/lib
directories for the Test version, and adjust the paths in the new lib/TWiki.cfg
. The following directories are shared: twiki/data
, twiki/templates
and twiki/pub
.
DISABLEDPLUGINS
variable in TWikiPreferences. Redefine the DISABLEDPLUGINS
variable in the Sandbox
web and do the testing there.
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 performance of the system depends on the number of Plugins installed and on the Plugin implementation. Some Plugins impose no measurable performance decrease, some do. For example, outsidePREHandler
is an expensive callback function, or a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). It is recommended to measure the performance with and without a new Plugin. Example for Unix:
time wget -qO /dev/null http://pyqplayer.sourceforge.net/cgi-bin/bin/view/TWiki/AbcPlugin
In case you need to install an "expensive" Plugin and you need its functionality only in one web you can place the Plugin topic into that web. TWiki will initialize the Plugin only if the Plugin topic is found (which won't be the case for other webs.)
When you finish installing a Plugin, you should be able to read the user instructions and go. In fact, 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.
Installed Plugins can be toggled on or off, site-wide or by web, through TWikiPreferences and individual WebPreferences:
lib/TWiki/Plugins
directory are activated automatically unless disabled by the DISABLEDPLUGINS
Preferences variable in TWikiPreferences. You can optionally list the installed Plugins in the INSTALLEDPLUGINS
Preferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the TWiki web for the Plugin topics. Settings in TWikiPreferences are:
Set INSTALLEDPLUGINS = DefaultPlugin, ...
Set DISABLEDPLUGINS = EmptyPlugin, ...
Plugin execution order in TWiki is determined by searching Plugin topics in a specific sequence: First, full web.topicname
name, if specified in INSTALLEDPLUGINS
; next, the TWiki web is searched; and finally, the current web.
Plugin-specific settings are done in individual Plugin topics. Two settings are standard for each Plugin:
Set SHORTDESCRIPTION = Blah blah woof woof.
data/debug.txt
. Set to 0=off or 1=on:
Set DEBUG = 0
%<pluginname>_<var>%
, ex: %DEFAULTPLUGIN_SHORTDESCRIPTION%
shows the description of the DefaultPlugin.
Plugin status variables let you list all active Plugins wherever needed. There are two list formats:
%ACTIVATEDPLUGINS%
variable lists activated Plugins by name. (This variable is displayed in TWikiPreferences for debugging use.)
%PLUGINDESCRIPTIONS%
variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the %<plugin>_SHORTDESCRIPTION%
Preferences variables of individual topics and is shown in TextFormattingRules.
DEMO: Automatically List Active Plugins Using VariablesUsing
%ACTIVATEDPLUGINS%
:
On this TWiki site, the active Plugins are: DefaultPlugin, SpreadSheetPlugin, CommentPlugin, EditTablePlugin, InterwikiPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin.Using
%
:PLUGINDESCRIPTIONS%
You can use any of these active TWiki Plugins:
- DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated
*_text_*
as bold italic text.- SpreadSheetPlugin: Add spreadsheet calculation like
"$SUM( $ABOVE() )"
to tables located in TWiki topics.- CommentPlugin: Allows users to quickly post comments to a page without an edit/preview/save cycle.
- EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
- InterwikiPlugin: Link
ExternalSite:Page
text to external sites based on aliases defined in the InterWikis topic- RenderListPlugin: Render bullet lists in a variety of formats
- SlideShowPlugin: Create web based presentations based on topics with headings.
- SmiliesPlugin: Render smilies as icons, like
:-)
foror
:cool:
for![]()
- TablePlugin: Control attributes of tables and sorting of table columns
The Application Programming Interface (API) for TWikiPlugins provides the specifications for hooking into the core TWiki code from your external Perl Plugin module. The Plugin API is new to the Production version of TWiki with the 01-Sep-2001 release.
The TWikiFuncModule (lib/TWiki/Func.pm
) implements ALL official Plugin functions. Plugins should ONLY use functions published in this module.
If you use functions not 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.
In addition to TWiki core functions, Plugins can use predefined hooks, or call backs, listed in the lib/TWiki/Plugins/EmptyPlugin.pm
module.
DISABLE_
from the function name.
outsidePREHandler
and insidePREHandler
are particularly expensive.
Most Plugins use either the commonTagsHandler
or startRenderingHandler
for rendering tasks:
commonTagsHandler:
Use it to expand %XYZPLUGIN%
and %XYZPLUGIN{...}%
variables
startRenderingHandler:
Use it for your own rendering rules or to overload TWiki's internal rendering like [[links]]
TWiki:Codev/StepByStepRenderingOrder helps you decide which rendering handler to use.
eval
block like:eval { require IPC::Run }
return "<font color=\"red\">SamplePlugin: Can't load required modules ($@)</font>" if $@;
To eliminate the incompatibility problems bound to arise from active open Plugin development, a Plugin versioning system is provided for automatic compatibility checking.
$VERSION='0.000'
variable, beginning at 1.000
.
initPlugin
handler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
initPlugin
handler).
$TWiki::Plugins::VERSION
in the TWiki::Plugins
module contains the TWiki Plugin API version, currently 1.025.
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.
A basic TWiki Plugin consists of two elements:
MyFirstPlugin.pm
MyFirstPlugin.txt
The Perl module can be a block of code that connects with TWiki alone, or it can include other elements, like other Perl modules (including other Plugins), graphics, TWiki templates, external applications (ex: a Java applet), or just about anything else it can call.
In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the 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.
Copy file lib/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();
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:
MyFirstPlugin
, press enter and create the new topic
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.>"
- 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>
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.>"
A minimum Plugin release consists of a Perl module with a WikiName that ends in Plugin
, ex: MyFirstPlugin.pm
, and a documentation page with the same name(MyFirstPlugin.txt
).
lib/TWiki/Plugins/MyFirstPlugin.pm
data/TWiki/MyFirstPlugin.txt
pub/TWiki/MyFirstPlugin/uparrow.gif
[a required graphic]
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
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 in these steps:
MyFirstPlugin
MyFirstPlugin.zip
Dev
, ex: MyFirstPluginDev
. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.)
Thank you very much for sharing your Plugin with the TWiki community
Plugins sometimes need to store data. This can be Plugin internal data like cache data, or generated data for the browser like images. The following is a recommendation where to store the data.
In case the Plugin generates data just for internal use, or data which is not specific to a topic, store it in the Plugin's attachment directory.
pubdir/Installweb/FooBarPlugin
Installweb
refers to the name of the web where the Plugin is installed
%PUBURL%/Installweb/FooBarPlugin
_any_name.ext
getPubDir()
to get the attachment root directory
getUrlHost()
and getPubUrlPath()
to build the URL in case you create content for the browser
$installWeb
to get the name of the web where the Plugin is installed
In case the Plugin generates data which is specific to a topic, store it in the topic's attachment directory.
pubdir/Webname/TopicName
%PUBURL%/Webname/TopicName
_FooBarPlugin_any_name.ext
getPubDir()
to get the attachment root directory
getUrlHost()
and getPubUrlPath()
to build the URL in case you create content for the browser
Example code to build the file name:
sub _make_filename { my ( $web, $topic, $name ) = @_; # Create web directory "pub/$web" if needed my $dir = TWiki::Func::getPubDir() . "/$web"; unless( -e "$dir" ) { umask( 002 ); mkdir( $dir, 0775 ); } # Create topic directory "pub/$web/$topic" if needed $dir .= "/$topic"; unless( -e "$dir" ) { umask( 002 ); mkdir( $dir, 0775 ); } return "$dir/_FooBarPlugin_$name"; }
-- TWiki:Main/PeterThoeny - 14 Aug 2004
-- TWiki:Main/AndreaSterbini - 29 May 2001
-- TWiki:Main/MikeMannix - 03 Dec 2001
Browser-based rename, move, and delete for individual topics
You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hidden Trash
web.
[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:
Trash
to delete a topic.
[Rename/Move]
: the topic will be renamed and links to the topic updated as requested.
[Rename/Move]
.
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.
Deleted topics are moved to a special Trash
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.
Trash
directory is all that's required for maintenance, it's possible to grant Trash
admin privileges to multiple users, while strictly limiting server access.
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: "}%
<pre>
and <verbatim>
are honoured - no changes are made to text within these areas.
Referring topics are found using the %SEARCH% variable - see the template searchrenameview.tmpl
. First, matching topics in the current web are listed - matches are to topic
. Next, all webs (including the current one) are listed that match web.topic
. Because %SEARCH% is used, webs marked in WebPreferences as NOSEARCHALL
will not show up in the search for references to the topic
being changed.
Changed references are kept are as short as possible, ex: topic
is used in preference to web.topic
.
User permissions affect the Rename function in various ways. To rename a topic, you need both ALLOWTOPICCHANGE
and ALLOWTOPICRENAME
permission for that topic. To alter referring topics, you need change permission. See TWikiAccessControl for information on setting up access permissions.
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:
Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall.
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 that search
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.
[[Old Topic]] => [[NewTopic][Old Topic]] [[old topic]] => [[NewTopic][old topic]] [[old t opic]] => not changed [[OldTopic]] => [[NewTopic]]
-- TWiki:Main.MikeMannix - 27 Dec 2001
Adding webs is a web based operation; renaming and deleting webs are manual operations done directly on the server
A TWikiSite is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
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. All topics in the _default 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 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.
Notes:
WEBBGCOLOR
, SITEMAPLIST
, SITEMAPWHAT
, SITEMAPUSETO
and NOSEARCHALL
. These variables are used to dynamically generate the SiteMap
WIKIWEBLIST
. This must be done by hand
UPPER
or UPPERlower
. A side effect of this is that if you do use a wiki name, %WEB%
must be written as <nop>%WEB%
or else it will try to link to a non-existing topic of that name
Renaming or deleting a web requires direct access to the installation files on the host server. There are currently no browser-based equivalents of the Rename/move/delete topic tools for working with webs.
Oldwebname.
, including the dot so you'll find references like Oldwebname.SomeTopic
Newwebname.SomeTopic
or better yet, to %MAINWEB%.SomeTopic
WIKIWEBLIST
variable
twiki/data
and rename or remove the web directory
twiki/templates
and rename or remove the web directory if present
twiki/pub
and rename or remove the web directory if present
If you plan to rename the Main web, remember that TWiki stores user and group topics in %MAINWEB%
, default named Main
. That means, every WikiName signature - Main.SomeUserName
- points to it and would need updating (unless the variable, %MAINWEB%.SomeUserName
, is used throughout).
-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.PeterThoeny - 07 Apr 2002
-- TWiki:Main.GrantBow - 16 Jan 2003
Annotated directory and file listings, for the 01-Sep-2004 TWiki production release.
Interested Users and Site Administrators can find out in simple terms what each part of TWiki actually does. Adventurous Adminstrators with server access to files (via telnet, ssh or ftp) can also figure out where to look to make minor modifications, like changing hardcode text or color. Software Developers can get an at-a-glance overview of TWiki code architecture.
You can rename the root TWiki directory - twiki
- to whatever you like by changing it in the TWiki.cfg
configuration file. However, to keep the current installation and future upgrades simple, you should leave the five main subdirectories intact:
Directory: | Files: | Used for: |
---|---|---|
twiki | list | Start-up info |
twiki/bin | list | Perl scripts |
twiki/lib | list | Configuration file, main library, Perl system modules, Plugins directory |
twiki/pub | list | Public files (eg: images) and FileAttachments and their RCS histories |
twiki/data | list | Individual topics (page content) and their RCS histories |
twiki/templates | list | HTML templates, used by TWiki scripts |
A rundown of the individual files included in the current distribution, organized by TWiki root directories.
twiki
Application info and the current reference documentation. Full file list:
File | Used for |
---|---|
index.html | Links to launch TWiki after install and for files in this directory |
license.txt | GNU General Public License and TWiki-specific info |
readme.txt | General TWiki start-up info with relevant URLs |
TWikiDocumentation.html | All documentation packaged as a single page |
TWikiHistory.html | TWiki development timeline: versions, features, developers |
TwikiUpgrade | TWiki upgrade script (Beta state) |
twiki/bin
Perl CGI scripts. Full file list:
File: | Used for: |
---|---|
.htaccess.txt | Authentication. Rename to .htaccess and customize if used |
attach | Shows the attach file page (FileAttachment) |
changes | a simple WebChanges query |
edit | Edit a topic |
geturl | Fetch URL data |
installpasswd | Install new password by admin |
mailnotify | Script called by cron job to notify users of changes |
manage | Manage script to create new webs |
oops | Shows an OK or oops dialog |
passwd | Reset and change password |
preview | Preview topic after edit |
rdiff | See differences of topics |
rdiffauth | Copy of rdiff script (ideally a link). The .htaccess file sets this as requiring authorisation |
register | Register new users |
rename | Rename/move topics and move attachments |
save | Saves a topic, called by preview |
search | Displays search results |
setlib.cfg | Location of the TWiki libraries. Customize if needed |
statistics | Create statistics topic |
testenv | Test CGI environment variables |
upload | Does file upload (FileAttachment) |
view | View a topic (the script) |
viewauth | Copy of view script (ideally a link). The .htaccess file sets this as requiring authorisation |
viewfile | View a file attachment |
twiki/lib
The new lib/TWiki/Plugins
directories contain configuration, library and function files, and TWikiPlugins. Full file list:
File: | Used for: |
---|---|
TWiki.cfg | Main configuration, used by TWiki.pm |
TWiki.pm | Main TWiki library |
Algorithm/Diff.pm | Diff library |
Text/Diff.pm | Diff library, used by TwikiUpgrade script |
TWiki/Access.pm | Access control |
TWiki/Attach.pm | Attachment handling |
TWiki/Form.pm | Form handling |
TWiki/Func.pm | Public functions that Plugins may use |
TWiki/Meta.pm | Meta data in topics |
TWiki/Net.pm | SMTP mail handling |
TWiki/Plugins.pm | Plugin handling |
TWiki/Plugins/CommentPlugin.pm | Plugin handling a comment box |
TWiki/Plugins/CommentPlugin/Attrs.pm | Supporting module for Comment Plugin |
TWiki/Plugins/CommentPlugin/Comment.pm | Supporting module for Comment Plugin |
TWiki/Plugins/CommentPlugin/Templates.pm | Supporting module for Comment Plugin |
TWiki/Plugins/DefaultPlugin.pm | Handles some legacy rules |
TWiki/Plugins/EditTablePlugin.pm | Plugin to edit tables |
TWiki/Plugins/EmptyPlugin.pm | Empty plugin, use to create your own |
TWiki/Plugins/InterwikiPlugin.pm | Use aliases as links for predefined URLs |
TWiki/Plugins/RenderListPlugin.pm | Plugin to render lists as nice trees |
TWiki/Plugins/SlideShowPlugin.pm | Plugin turning headings into slides |
TWiki/Plugins/SmiliesPlugin.pm | Plugin rendering smilies like :-) |
TWiki/Plugins/SpreadSheetPlugin.pm | Plugin resolving spreadsheet formulae |
TWiki/Plugins/TablePlugin.pm | Plugin to render tables nicely |
TWiki/Prefs.pm | Preferences handling |
TWiki/Render.pm | TWiki markup to HTML rendering |
TWiki/Search.pm | Search engine, used by TWiki.pm |
TWiki/Store.pm | Back-end storage, *.txt text file and *.txt,v RCS repository file handling |
TWiki/Store/RcsFile.pm | Generic file handling code, a class |
TWiki/Store/RcsWrap.pm | Wrappers around RCS executables, a class that inherits from RcsFile |
TWiki/Store/RcsLite.pm | A Perl RCS implemention, a class that inherits from RcsFile |
TWiki/UI.pm | User interface handling |
TWiki/UI/Changes.pm | Functionality of changes script |
TWiki/UI/Edit.pm | Functionality of edit script |
TWiki/UI/Manage.pm | Functionality of manage script |
TWiki/UI/Oops.pm | Functionality of oops script |
TWiki/UI/Preview.pm | Functionality of preview script |
TWiki/UI/RDiff.pm | Functionality of rdiff script |
TWiki/UI/Save.pm | Functionality of save script |
TWiki/UI/Search.pm | Functionality of search script |
TWiki/UI/Statistics.pm | Functionality of statistics script |
TWiki/UI/Upload.pm | Functionality of upload script |
TWiki/UI/View.pm | Functionality of view script |
TWiki/UI/Viewfile.pm | Functionality of viewfile script |
TWiki/Upgrade/TWikiCfg.pm | Supporting module of TwikiUpgrade script |
TWiki/Upgrade/UpdateTopics.pm | Supporting module of TwikiUpgrade script |
TWiki/Upgrade/UpdateTopicsManualSymlinks.pm | Supporting module of TwikiUpgrade script |
TWiki/User.pm | Abstraction package to allow plugable user authentication systems |
TWiki/User/HtPasswdUser.pm | Apache Htpasswd file implementation (the default) |
TWiki/User/NoPasswdUser.pm | simple, no users authentication (totally wiki) |
twiki/pub
The pub
directory stores topic-related files, including images used by TWiki and FileAttachments. Attachments are stored in subdirectories created with the related topic name. You can also upload files directly for and link manually (but not through Attach
) Partial file list:
File: | Used for: |
---|---|
favicon.ico | ICO file |
wikiHome.gif | GIF file |
icn/_filetypes.txt | Lookup table to translate file extension to file type |
icn/bat.gif | GIF file for file type |
icn/bmp.gif | GIF file for file type |
... | ... |
TWiki/FileAttachment/Sample.txt | TEXT file: sample |
TWiki/FileAttachment/Smile.gif | GIF image: sample |
TWiki/FileAttachment/Smile.gif,v | RCS repository for GIF file |
TWiki/PreviewBackground/blankltgraybg.gif | GIF image |
TWiki/PreviewBackground/blankwhitebg.gif | GIF image |
TWiki/PreviewBackground/previewbg.gif | GIF image: Preview view background |
TWiki/PreviewBackground/preview2bg.gif | GIF image: Alternate preview view background |
TWiki/TWikiLogos/twikiRobot121x54.gif | GIF image: TWiki logo |
... | ... |
TWiki/TWikiTemplates/testscreen.gif | GIF image: Screen shot |
TWiki/WabiSabi/wabisabi.gif | GIF image: illustration |
twiki/data
TWiki topics: data stored as individual text files and rendered by TWiki for display as regular Web pages. Each active web has its own subdirectory. The TWiki distribution includes a number of start-up webs - Main
, TWiki
, and Sandbox
- with documentation and demo content, a Trash
web for browser-based, recoverable topic deletion, and a _default
directory containing a core topic set required to start a new web. Partial file list:
File: | Used for: |
---|---|
.htpasswd | Basic Authentication (htaccess) users file with username and encrypted password pairs |
debug.txt | Program-generated messages useful for debugging |
mime.types | Recognized file formats |
warning.txt | Diagnostic messages for identifying problems |
_default/.changes | Per web record of topic changes |
_default/.mailnotify | Per web timestamp of most recent email notification |
_default/WebChanges.txt | Display most recent topic changes in web |
_default/WebChanges.txt,v | Revisions history (RCS) |
_default/WebHome.txt | Default web home page |
_default/WebHome.txt,v | Revisions history (RCS) |
_default/WebIndex.txt | Lists all topics in a web |
_default/WebIndex.txt,v | Revisions history (RCS) |
_default/WebLeftBar.txt | Left navigation bar for PatternSkin |
_default/WebLeftBar.txt,v | Revisions history (RCS) |
_default/WebNotify.txt | Subscribe/unsubscribe to web changes email alert |
_default/WebNotify.txt,v | Revisions history (RCS) |
_default/WebPreferences.txt | Per web Preference Settings |
_default/WebPreferences.txt,v | Revisions history (RCS) |
_default/WebSearch.txt | Per web search options |
_default/WebSearch.txt,v | Revisions history (RCS) |
_default/WebStatistics.txt | Generates web usage statistics |
_default/WebStatistics.txt,v | Revisions history (RCS) |
_default/WebTopicList.txt | Lists all topics in a web in compact format |
_default/WebTopicList.txt,v | Revisions history (RCS) |
... | ... |
twiki/templates
Templates and skins used to control appearance of topics rendered as Web pages. Partial file list:
File: | Used for: |
---|---|
attach.tmpl | Attachment (FileAttachments) control screen |
attachagain.tmpl | Attachment control screen for updating an existing attachment |
attachnew.tmpl | Attachment control screen for adding a new attachment |
attachtables.tmpl | Macros for definition of attachment tables |
changeform.tmpl | Control screen to change the form in edit mode |
changes.tmpl | Displays list of recently changed topics |
edit.iejs.tmpl | Edit window with IE-specific JavaScript |
edit.tmpl | Main edit window |
mailnotify.tmpl | Email notification |
moveattachment.tmpl | Move attachment control screen |
oopsaccesschange.tmpl | Error message |
oopsaccessgroup.tmpl | Error message |
oopsaccessmanage.tmpl | Error message |
oopsaccessrename.tmpl | Error message |
oopsaccessview.tmpl | Error message |
oopsattachnotopic.tmpl | Error message |
oopsauth.tmpl | Error message |
oopsbadcharset.tmpl | Error message |
oopsbadpwformat.tmpl | Error message |
oopschangepasswd.tmpl | Error message |
oopscreatenewtopic.tmpl | Error message |
oopsempty.tmpl | Error message |
oopslocked.tmpl | Error message |
oopslockedrename.tmpl | Error message |
oopsmanage.tmpl | Error message |
oopsmissing.tmpl | Error message |
oopsmngcreateweb.tmpl | Error message |
oopsmore.tmpl | More topic actions message |
oopsmoveerr.tmpl | Error message |
oopsnoformdef.tmpl | Error message |
oopsnotwikiuser.tmpl | Error message |
oopsnoweb.tmpl | Error message |
oopspreview.tmpl | Error message |
oopsregemail.tmpl | Error message |
oopsregexist.tmpl | Error message |
oopsregpasswd.tmpl | Error message |
oopsregrequ.tmpl | Error message |
oopsregthanks.tmpl | Error message |
oopsregwiki.tmpl | Error message |
oopsremoveuserdone.tmpl | Error message |
oopsrenameerr.tmpl | Error message |
oopsrenamenotwikiword.tmpl | Error message |
oopsresetpasswd.tmpl | Error message |
oopsrev.tmpl | Error message |
oopssave.tmpl | Error message |
oopssaveerr.tmpl | Error message |
oopssendmailerr.tmpl | Error message |
oopstopicexists.tmpl | Error message |
oopsupload.tmpl | Error message |
oopsuploadlimit.tmpl | Error message |
oopswrongpassword.tmpl | Error message |
preview.tmpl | Preview Changes screen |
rdiff.tmpl | Displays text changes before & after Diffs |
registernotify.tmpl | Registration notification |
rename.tmpl | Rename/move control screen (choose web & new topic tile |
renamebase.tmpl | Used by other rename templates |
renameconfirm.tmpl | Confirms a pre-specified rename, ex: undoing a rename |
renamedelete.tmpl | Confirms a delete |
renamerefs.tmpl | Display if rename done, but some references not changed (topics were locked) |
search.tmpl | Search screen |
searchbookview.tmpl | Search results with full topic content |
searchformat.tmpl | Search screen for formatted search |
searchmeta.tmpl | Search screen |
searchrenameview.tmpl | Used by rename to list references to topic being renamed |
twiki.tmpl | Master template: definitions are used by other templates |
view.plain.tmpl | Skin for bare bone topic view without header/footer but with HTML head and body tags |
view.print.tmpl | Skin for printable topic view with a simple header/footer |
view.rss.tmpl | Skin for topic view in RDF XML format |
view.text.tmpl | Skin for topic text only, without HTML head and body tags, and no form and attachments |
view.tmpl | Main topic view - the standard regular Web page |
The following partial directory listings from a Linux installation show typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution.
twiki twiki
- will probably be your domain or login name, eg: yourdomain yourdomain
and can't be changed; same for nobody nobody
files further down. Also, in the bin
directory, scripts might need a .cgi
(sometimes .pl
) extension.
Directory twiki/bin
:
drwxrwxr-x 2 twiki twiki 4096 May 9 00:08 . drwxrwxr-x 5 twiki twiki 4096 Nov 18 2002 .. -rw-rw-r-- 1 twiki twiki 3145 Jul 25 00:31 .htaccess.txt -rwxrwxr-x 1 twiki twiki 1459 May 28 23:51 attach -rwxrwxr-x 1 twiki twiki 1721 May 28 23:51 changes -rwxrwxr-x 1 twiki twiki 1994 May 28 23:51 edit -rwxrwxr-x 1 twiki twiki 1878 May 28 23:51 geturl -rwxrwxr-x 1 twiki twiki 6689 May 28 23:51 installpasswd -rwxrwxr-x 1 twiki twiki 7313 May 28 23:51 mailnotify -rwxrwxr-x 1 twiki twiki 3557 Jul 25 15:00 manage -rwxrwxr-x 1 twiki twiki 1448 May 28 23:51 oops -rwxrwxr-x 1 twiki twiki 4062 May 28 23:51 passwd -rwxrwxr-x 1 twiki twiki 1506 May 28 23:51 preview -rwxrwxr-x 2 twiki twiki 1490 May 28 23:51 rdiff -rwxrwxr-x 2 twiki twiki 1490 May 28 23:51 rdiffauth -rwxrwxr-x 1 twiki twiki 7635 May 28 23:51 register -rwxrwxr-x 1 twiki twiki 1774 May 28 23:51 rename -rwxrwxr-x 1 twiki twiki 1654 Jul 25 00:31 save -rwxrwxr-x 1 twiki twiki 1728 May 28 23:51 search -rw-rw-r-- 1 twiki twiki 2131 Aug 7 21:13 setlib.cfg -rwxrwxr-x 1 twiki twiki 2596 May 28 23:51 statistics -rwxrwxr-x 1 twiki twiki 39926 Jul 25 15:00 testenv -rwxrwxr-x 1 twiki twiki 1478 May 28 23:51 upload -rwxrwxr-x 2 twiki twiki 1689 May 28 23:51 view -rwxrwxr-x 2 twiki twiki 1689 May 28 23:51 viewauth -rwxrwxr-x 1 twiki twiki 1438 May 28 23:51 viewfile
Directory twiki/templates/
:
drwxrwxr-x 2 twiki twiki 4096 Aug 7 19:09 . drwxrwxr-x 4 twiki twiki 4096 Aug 7 21:13 .. -rw-rw-r-- 1 twiki users 2077 Aug 13 22:21 attachagain.pattern.tmpl -rw-rw-r-- 1 twiki users 1650 Aug 13 22:21 attachagain.tmpl -rw-rw-r-- 1 twiki twiki 2556 Jul 27 10:47 attach.dragon.tmpl -rw-rw-r-- 1 twiki users 567 Jul 28 19:52 attachnew.pattern.tmpl -rw-rw-r-- 1 twiki users 470 Jul 28 19:52 attachnew.tmpl -rw-rw-r-- 1 twiki users 2855 Aug 8 03:40 attach.pattern.tmpl -rw-rw-r-- 1 twiki users 1991 Aug 3 13:09 attachtables.pattern.tmpl -rw-rw-r-- 1 twiki users 1869 Jul 27 22:03 attachtables.tmpl -rw-rw-r-- 1 twiki users 2355 Jul 28 19:52 attach.tmpl -rw-rw-r-- 1 twiki twiki 1324 Jul 27 10:47 changeform.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1441 Aug 6 11:47 changeform.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1032 Jul 28 19:52 changeform.tmpl -rw-rw-r-- 1 twiki twiki 1870 Jul 27 10:47 changes.dragon.tmpl -rw-rw-r-- 1 twiki twiki 433 Jul 31 12:39 changes.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1196 May 28 23:51 changes.tmpl -rw-rw-r-- 1 twiki twiki 35 May 21 03:56 comments.tmpl -rw-rw-r-- 1 twiki twiki 526 Jul 27 10:47 dragoncssvars.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1645 Jul 31 00:57 dragonmenu.dragon.tmpl -rw-rw-r-- 1 twiki twiki 4207 Jul 27 10:47 edit.dragon.tmpl -rw-rw-r-- 1 twiki twiki 12608 Jul 28 19:52 edit.iejs.tmpl -rw-rw-r-- 1 twiki twiki 4904 Aug 7 17:48 edit.pattern.tmpl -rw-rw-r-- 1 twiki twiki 3975 Aug 8 03:40 edit.tmpl -rw-rw-r-- 1 twiki twiki 993 May 28 23:51 mailnotify.tmpl -rw-rw-r-- 1 twiki twiki 1640 Jul 27 10:47 moveattachment.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1968 Aug 7 17:48 moveattachment.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1342 Jul 28 19:52 moveattachment.tmpl -rw-rw-r-- 1 twiki twiki 571 May 28 23:51 oopsaccesschange.tmpl -rw-rw-r-- 1 twiki twiki 587 May 28 23:51 oopsaccessgroup.tmpl -rw-rw-r-- 1 twiki twiki 597 Aug 2 11:10 oopsaccessmanage.tmpl -rw-rw-r-- 1 twiki twiki 572 May 28 23:51 oopsaccessrename.tmpl -rw-rw-r-- 1 twiki twiki 574 May 28 23:51 oopsaccessview.tmpl -rw-rw-r-- 1 twiki twiki 571 Aug 2 11:10 oopsattachnotopic.tmpl -rw-rw-r-- 1 twiki twiki 998 May 28 23:51 oopsauth.tmpl -rw-rw-r-- 1 twiki twiki 646 May 28 23:51 oopsbadcharset.tmpl -rw-rw-r-- 1 twiki twiki 406 May 28 23:51 oopsbadpwformat.tmpl -rw-rw-r-- 1 twiki twiki 345 May 28 23:51 oopschangepasswd.tmpl -rw-rw-r-- 1 twiki twiki 382 May 28 23:51 oopscreatenewtopic.tmpl -rw-rw-r-- 1 twiki twiki 627 Jul 7 23:11 oopsempty.tmpl -rw-rw-r-- 1 twiki twiki 927 Aug 3 13:09 oopslocked.pattern.tmpl -rw-rw-r-- 1 twiki twiki 612 Aug 2 11:10 oopslockedrename.pattern.tmpl -rw-rw-r-- 1 twiki twiki 596 Aug 2 11:10 oopslockedrename.tmpl -rw-rw-r-- 1 twiki twiki 910 Aug 3 13:09 oopslocked.tmpl -rw-rw-r-- 1 twiki twiki 679 May 28 23:51 oopsmanage.tmpl -rw-rw-r-- 1 twiki twiki 329 May 28 23:51 oopsmissing.tmpl -rw-rw-r-- 1 twiki twiki 2353 May 28 23:51 oopsmngcreateweb.tmpl -rw-rw-r-- 1 twiki twiki 2987 Aug 3 13:09 oopsmore.tmpl -rw-rw-r-- 1 twiki twiki 418 May 28 23:51 oopsmoveerr.tmpl -rw-rw-r-- 1 twiki twiki 1133 May 28 23:51 oopsnoformdef.tmpl -rw-rw-r-- 1 twiki twiki 521 May 28 23:51 oopsnotwikiuser.tmpl -rw-rw-r-- 1 twiki twiki 1516 Jul 28 19:52 oopsnoweb.tmpl -rw-rw-r-- 1 twiki twiki 394 May 28 23:51 oopspreview.tmpl -rw-rw-r-- 1 twiki twiki 341 May 28 23:51 oopsregemail.tmpl -rw-rw-r-- 1 twiki twiki 411 May 28 23:51 oopsregerr.tmpl -rw-rw-r-- 1 twiki twiki 476 May 28 23:51 oopsregexist.tmpl -rw-rw-r-- 1 twiki twiki 346 May 28 23:51 oopsregpasswd.tmpl -rw-rw-r-- 1 twiki twiki 357 May 28 23:51 oopsregrequ.tmpl -rw-rw-r-- 1 twiki twiki 541 May 28 23:51 oopsregthanks.tmpl -rw-rw-r-- 1 twiki twiki 680 May 28 23:51 oopsregwiki.tmpl -rw-rw-r-- 1 twiki twiki 587 May 28 23:51 oopsremoveuserdone.tmpl -rw-rw-r-- 1 twiki twiki 503 May 28 23:51 oopsrenameerr.tmpl -rw-rw-r-- 1 twiki twiki 434 May 28 23:51 oopsrenamenotwikiword.tmpl -rw-rw-r-- 1 twiki twiki 507 May 28 23:51 oopsresetpasswd.tmpl -rw-rw-r-- 1 twiki twiki 962 Jul 28 19:52 oopsrev.tmpl -rw-rw-r-- 1 twiki twiki 483 May 28 23:51 oopssaveerr.tmpl -rw-rw-r-- 1 twiki twiki 777 Jul 7 23:11 oopssave.tmpl -rw-rw-r-- 1 twiki twiki 466 May 28 23:51 oopssendmailerr.tmpl -rw-rw-r-- 1 twiki twiki 385 May 28 23:51 oopstopicexists.tmpl -rw-rw-r-- 1 twiki twiki 344 May 28 23:51 oopsuploadlimit.tmpl -rw-rw-r-- 1 twiki twiki 343 May 28 23:51 oopsupload.tmpl -rw-rw-r-- 1 twiki twiki 365 May 28 23:51 oopswrongpassword.tmpl -rw-rw-r-- 1 twiki twiki 3590 Jul 27 10:47 preview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 2855 Aug 6 11:47 preview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2253 Aug 8 03:40 preview.tmpl -rw-rw-r-- 1 twiki twiki 1739 Jul 27 10:47 rdiff.dragon.tmpl -rw-rw-r-- 1 twiki users 1529 Aug 13 22:21 rdiff.pattern.tmpl -rw-rw-r-- 1 twiki users 1299 May 28 23:51 rdiff.tmpl -rw-rw-r-- 1 twiki twiki 1159 Jul 31 12:39 registernotify.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1160 May 28 23:51 registernotify.tmpl -rw-rw-r-- 1 twiki twiki 2561 Jul 27 10:47 renamebase.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3363 Aug 8 03:40 renamebase.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2279 Jul 28 20:54 renamebase.tmpl -rw-rw-r-- 1 twiki twiki 718 Jul 31 12:39 renameconfirm.pattern.tmpl -rw-rw-r-- 1 twiki twiki 570 Jul 28 19:52 renameconfirm.tmpl -rw-rw-r-- 1 twiki twiki 1046 Jul 31 12:39 renamedelete.pattern.tmpl -rw-rw-r-- 1 twiki twiki 932 Jul 28 19:52 renamedelete.tmpl -rw-rw-r-- 1 twiki twiki 1147 Jul 31 12:39 rename.pattern.tmpl -rw-rw-r-- 1 twiki twiki 766 Jul 28 19:52 renamerefs.pattern.tmpl -rw-rw-r-- 1 twiki twiki 616 Jul 28 19:52 renamerefs.tmpl -rw-rw-r-- 1 twiki twiki 1041 Jul 28 19:52 rename.tmpl -rw-rw-r-- 1 twiki twiki 1397 Jul 27 10:47 searchbookview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 723 Jul 31 12:39 searchbookview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1230 May 28 23:51 searchbookview.tmpl -rw-rw-r-- 1 twiki twiki 1705 Jul 27 10:47 search.dragon.tmpl -rw-rw-r-- 1 twiki twiki 722 Jul 27 10:47 searchformat.dragon.tmpl -rw-rw-r-- 1 twiki twiki 157 Jul 31 12:39 searchformat.pattern.tmpl -rw-rw-r-- 1 twiki twiki 529 May 28 23:51 searchformat.tmpl -rw-rw-r-- 1 twiki twiki 149 Jul 7 23:03 searchmeta.pattern.tmpl -rw-rw-r-- 1 twiki twiki 149 May 28 23:51 searchmeta.tmpl -rw-rw-r-- 1 twiki twiki 1638 Aug 7 17:48 search.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1892 Jul 27 10:47 searchrenameview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1208 Aug 3 13:09 searchrenameview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1615 May 28 23:51 searchrenameview.tmpl -rw-rw-r-- 1 twiki twiki 1364 May 28 23:51 search.tmpl -rw-rw-r-- 1 twiki twiki 3836 Jul 27 10:47 twiki.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3175 Aug 7 17:48 twiki.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2798 Jul 27 22:57 twiki.tmpl -rw-rw-r-- 1 twiki twiki 1324 Jul 27 10:47 view.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3577 Aug 8 03:40 view.pattern.tmpl -rw-rw-r-- 1 twiki twiki 425 May 28 23:51 view.plain.tmpl -rw-rw-r-- 1 twiki twiki 1056 Jul 31 12:39 view.print.pattern.tmpl -rw-rw-r-- 1 twiki twiki 845 May 28 23:51 view.print.tmpl -rw-rw-r-- 1 twiki twiki 300 May 28 23:51 view.rss.tmpl -rw-rw-r-- 1 twiki twiki 8 May 28 23:51 view.text.tmpl -rw-rw-r-- 1 twiki twiki 1281 Jul 31 12:39 view.tmpl
Directory twiki/data/
:
drwxrwxr-x 7 nobody twiki 4096 Aug 7 21:13 . drwxrwxr-x 4 twiki twiki 4096 Aug 7 21:13 .. -rw-rw-rw- 1 twiki twiki 0 Feb 1 2003 debug.txt drwxrwxr-x 2 nobody twiki 4096 Jul 16 00:36 _default -rw-rw-r-- 1 twiki twiki 25 Dec 16 2003 .htpasswd.txt -rw-rw-r-- 1 nobody nobody 11811 Aug 13 23:10 log200408.txt drwxrwxr-x 2 nobody twiki 4096 Aug 4 21:03 Main -rw-rw-r-- 1 twiki twiki 3419 Aug 13 2001 mime.types drwxrwxr-x 2 nobody twiki 4096 Aug 7 21:03 Sandbox drwxrwxr-x 2 nobody twiki 4096 Jul 20 18:15 Trash drwxrwxr-x 2 nobody twiki 12288 Aug 13 23:10 TWiki -rw-rw-rw- 1 twiki twiki 0 Aug 7 18:03 warning.txt
Partial file list for twiki/data/Main
:
.txt,v
.
drwxrwxr-x 2 nobody twiki 4096 Aug 4 21:03 . drwxrwxr-x 7 nobody twiki 4096 Aug 7 21:13 .. -rw-rw-rw- 1 twiki twiki 3743 Aug 4 21:03 .changes -rw-rw-rw- 1 twiki twiki 9 Oct 25 2001 .mailnotify -rw-r--r-- 1 nobody nobody 518 Dec 16 2003 TWikiAdminGroup.txt -r--r--r-- 1 nobody nobody 2453 Dec 16 2003 TWikiAdminGroup.txt,v -rw-r--r-- 1 nobody nobody 1668 Aug 4 21:03 TWikiGroups.txt -r--r--r-- 1 nobody nobody 3421 Aug 4 21:03 TWikiGroups.txt,v -rw-r--r-- 1 nobody nobody 686 Dec 13 2000 TWikiGuest.txt -rw-r--r-- 1 nobody nobody 1995 Dec 13 2000 TWikiGuest.txt,v -rw-r--r-- 1 nobody nobody 319 Dec 20 2003 TWikiPreferences.txt -r--r--r-- 1 nobody nobody 508 Dec 20 2003 TWikiPreferences.txt,v -rw-r--r-- 1 nobody nobody 1812 Feb 20 13:54 TWikiUsers.txt -r--r--r-- 1 nobody nobody 9222 Feb 20 13:54 TWikiUsers.txt,v -rw-r--r-- 1 nobody nobody 119 Jan 11 2003 TWikiVariables.txt -r--r--r-- 1 nobody nobody 742 Jan 11 2003 TWikiVariables.txt,v -rw-r--r-- 1 nobody nobody 124 Aug 16 2001 WebChanges.txt -r--r--r-- 1 nobody nobody 526 Aug 16 2001 WebChanges.txt,v -rw-r--r-- 1 nobody nobody 1842 Feb 1 2003 WebHome.txt -r--r--r-- 1 nobody nobody 11862 Feb 1 2003 WebHome.txt,v -rw-r--r-- 1 nobody nobody 176 Nov 24 2001 WebIndex.txt -r--r--r-- 1 nobody nobody 483 Nov 24 2001 WebIndex.txt,v -rw-r--r-- 1 nobody nobody 922 Feb 3 2003 WebNotify.txt -r--r--r-- 1 nobody nobody 4303 Feb 3 2003 WebNotify.txt,v -rw-r--r-- 1 nobody nobody 3738 Dec 25 2003 WebPreferences.txt -r--r--r-- 1 nobody nobody 10697 Dec 25 2003 WebPreferences.txt,v -rw-r--r-- 1 nobody nobody 416 Jan 30 2003 WebRss.txt -r--r--r-- 1 nobody nobody 605 Jan 30 2003 WebRss.txt,v -rw-r--r-- 1 nobody nobody 164 Jan 18 2004 WebSearchAdvanced.txt -r--r--r-- 1 nobody nobody 353 Jan 18 2004 WebSearchAdvanced.txt,v -rw-r--r-- 1 nobody nobody 158 Aug 7 2001 WebSearch.txt -r--r--r-- 1 nobody nobody 18332 Aug 7 2001 WebSearch.txt,v -rw-r--r-- 1 nobody nobody 825 Jul 16 00:32 WebStatistics.txt -r--r--r-- 1 nobody nobody 4226 Jul 16 00:32 WebStatistics.txt,v -rw-r--r-- 1 nobody nobody 182 Nov 24 2001 WebTopicList.txt -r--r--r-- 1 nobody nobody 371 Nov 24 2001 WebTopicList.txt,v
Directory twiki/pub/
:
drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 . drwxrwxr-x 3 twiki twiki 4096 Nov 18 12:31 .. drwxrwxr-x 2 nobody nobody 4096 Apr 7 2002 Main drwxrwxr-x 2 nobody nobody 4096 Apr 20 2002 Sandbox drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 TWiki drwxrwxr-x 2 nobody nobody 4096 Dec 3 2001 Trash -rw-rw-r-- 1 twiki twiki 1078 Jan 14 2000 favicon.ico drwxrwxr-x 2 twiki twiki 4096 Nov 18 12:31 icn -rw-rw-r-- 1 twiki twiki 2877 Jun 7 1999 wikiHome.gif
Partial file list for twiki/pub/icn/
:
drwxrwxr-x 2 twiki twiki 4096 Nov 18 12:31 . drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 .. -rw-rw-r-- 1 twiki twiki 801 Mar 26 1999 _filetypes.txt -rw-rw-r-- 1 twiki twiki 143 Mar 9 1999 bat.gif -rw-rw-r-- 1 twiki twiki 926 Mar 9 1999 bmp.gif -rw-rw-r-- 1 twiki twiki 141 Mar 25 1999 c.gif -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 dll.gif -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gif
Directory twiki/pub/TWiki
:
drwxrwx--x 8 nobody nobody 4096 Nov 18 12:31 . drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 .. drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 FileAttachment drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 PreviewBackground drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiDocGraphics drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiLogos drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiTemplates drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 WabiSabi
Directory twiki/pub/TWiki/FileAttachment
:
drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 . drwxrwx--x 8 nobody nobody 4096 Nov 18 12:31 .. -rw-rw-r-- 1 nobody nobody 30 Jul 22 1999 Sample.txt -rw-rw-r-- 1 nobody nobody 94 Jun 7 1999 Smile.gif -r--r--r-- 1 nobody nobody 81 Aug 15 10:14 Smile.gif,v
-- TWiki:Main.PeterThoeny - 29 Aug 2004
-- TWiki:Main.MikeMannix - 16 May 2002
-- TWiki:Main.ArthurClemens - 08 Aug 2004
Project hosting provided by: | Donations welcome:![]() |