FAQ: What does the `T` in TWiki stand for? Answer: TWiki is short for TakeFive Wiki, the name of the company where its founder Peter Thoeny worked. Peter first...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate . WebLeftBarPersonalTemplate is a topic template to create a personal left bar block...
FAQ: So what is this WikiWiki thing exactly? Answer: A set of pages of information that are open and free for anyone to edit as they wish. They are stored in...
You are currently in the web. The color code for this web is this background, so you know where you are. If you are not familiar with the TWiki collaboration...
ENDCOLUMNS end a responsive multi column page layout Write % TWOCOLUMNS% ...text... % ENDCOLUMNS% to get a page layout with two columns . See TWOCOLUMNS...
ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic...
ENDBG end background color section ENDBG is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
ENCODE{string} encode a string to URL entities, HTML entities, CSV format, and more Encode `special` characters in a string to HTML numeric entities, URL entities...
EDITTABLE{ attributes } edit TWiki tables using edit fields and other input fields The % EDITTABLE{ variable is handled by the EditTablePlugin Syntax...
EDITFORMFIELD{`fieldname` form ``} render an input field specified in a form template topic Use this to create HTML forms that update TWikiForms, such as a...
EDITFORM{} render a TWiki form for edit Show an HTML form to update the TWiki form data of a topic. Syntax to update a TWiki form: % EDITFORM{topic `.....
EDITACTION select an edit template EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit...
DISPLAYTIME{`format`} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure, default...
DATEPICKER{} pop up calendar to select a date for use in HTML forms The % DATEPICKER{ variable is handled by the DatePickerPlugin. Syntax: % DATEPICKER...
DASHBOARD build a dashboard with banner and boxes Use this variable to quickly create dashboards for intranet home, team homepages, project homepages and knowledge...
CONTENTMODE{web `WEB`} content mode Returns the content mode of the specified web. It`s either `local`, `read only`, `master`, or `slave`. Read ReadOnlyAndMirrorWebs...
COMMENT{ attributes } insert an edit box into the topic to easily add comments. A % COMMENT% without parameters shows a simple text box. A % COMMENT...
COLORPICKER{} color picker for use in HTML forms for TWiki applications The % COLORPICKER{ variable is handled by the ColorPickerPlugin. Syntax: % COLORPICKER...
CHILDREN find children of a topic Find direct children of a topic, as defined by the parent child relationship between topics. To find children recursively...
CALCULATE{`formula`} handle spreadsheet calculations outside tables The % CALCULATE{formula variable is handled by the SpreadSheetPlugin. Over 100 functions...
CALC{`formula`} add spreadsheet calculations to tables The % CALC{formula variable is handled by the SpreadSheetPlugin. Over 100 functions are available, such...
BULLET bullet sign Bullet sign, useful to create a bullet list in a TWiki table, such as % BULLET% One % BB% Two % BB% Three Type: Preference variable...
BUBBLESIG show bubble box and user signature with profile picture icon Syntax: % BUBBLESIG{WikiName or % BUBBLESIG{WikiName YYYY MM DD The parameter...
BROWN start brown colored text BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
BLUE start blue colored text BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
BLACK start black colored text BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
BASEWEB base web where an INCLUDE started The web name where the includes started, e.g. the web of the first topic of nested includes. Same as % WEB% in case...
BASETOPIC base topic where an INCLUDE started The name of the topic where a single or nested INCLUDE started same as % TOPIC% if there is no INCLUDE....
AUTHREALM authentication realm String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login templates as part of the login...
ATTACHURLPATH path of the attachment URL of the current topic Syntax: % ATTACHURLPATH% Expands to: /twiki/pub/TWiki/VarATTACHURLPATH Category: AttachmentsAndFilesV...
ATTACHURL full URL for attachments in the current topic Syntax: % ATTACHURL% Expands to: https://barricklab.org/twiki/pub/TWiki/VarATTACHURL Example...
AQUA start aqua colored text AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
ALLVARIABLES list of currently defined TWikiVariables Syntax: % ALLVARIABLES% Expands to: a table showing all defined TWikiVariables in the current context...
ADDTOHEAD add HTML to the HTML head section of the current page Useful for TWiki applications to add custom CSS or JavaScript to the HTML head section of a topic...
ACTIVATEDPLUGINS list of currently activated plugins Syntax: % ACTIVATEDPLUGINS% Expands to: Category: AdministrationVariables, DevelopmentVariables...
Using multiple disks for DataDir and PubDir Motivation A TWiki site may reach a point where a single disk drive cannot house all files. Having PubDir on a different...
Using HTML, CSS and JavaScript You can use most HTML tags in TWiki topics without a problem. This is useful where you want to add some content that is formatted in...
User Subwebs TWiki provides each user with their own topic having their information and configuration. You may want to provide each user with a subweb Main/FirstLast...
TWiki User Reports This page contains user reports you can use in TWiki application. Create appealing TWiki applications in a no time! Reports are of format % USERREPORT...
User Masquerading Preface This topic describes how to configure your TWiki site for user masquerading. There are cases where it`s handy to access TWiki on behalf...
User Form Note: This is a maintenance topic, used by the TWiki administrator. This form defines the form of the user profile pages of registered TWiki users listed...
Bookmarks Application Page This page contains several parts that are used by user bookmark pages. Bookmark pages reside in the web and are named wikiname Bookmarks...
TwistyPlugin Introduction The TwistyPlugin gives you several options to control the appearance of a twisty: use link text or buttons position an icon...
TwistyContrib Introduction This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections. TwistyContrib...
Default Web Top Menu of TopMenuSkin This topic defines the default menu structure of a web. It is used by the TopMenuSkin in case the WebTopMenu topic is missing in...
TopMenuSkin The TopMenuSkin adds pulldown menus to the PatternSkin. Screenshot Tob Bar and Menu Structure TopMenuSkinTopBar top bar with menu bar, logo and...
Tips Contrib Package Displays a rotating `TWiki Tip of the Day` to help familiarize new users with TWiki features. Includes an application for creating custom tips...
TinyMCEPlugin Introduction This is an integration of the fast and highly functional WYSIWYG editor. It supports a wide range of browsers such as Firefox, IE, Safari...
TinyMCE FAQs Frequently Asked Questions of the TinyMCEPlugin integration. Q: How can I disable the WYSIWYG editor? A: There are several ways to disable the WYSIWYG...
TWiki Text Formatting These instructions are for contributors who prefer to use the Raw Edit over the default WYSIWYG editor. Working in TWiki is as easy as typing...
Text Formatting FAQ This topics lists frequently asked questions on text formatting. Text formatting applies to people who edit TWiki pages in raw edit mode . TextFormattingRules...
Text Editor A text editor, or text processor, handles plain text only, different from a word processor because it doesn`t do display formatting like bold type, or...
Template Web Purpose Template webs contain a set of default topics and act as templates when creating a new web. Names of template webs begin with an underscore...
Tag me Plugin Plugin to tag wiki content collectively or authoritatively in order to make it easier to find content and to get a meaningful page ranking. Introduction...
Tag me: Change Requests Note: Creating, renaming, and deleting of tags is ususally done by users that have received permissions to do this. Permissions are...
TWiki Variables Search TWiki Variables Show all Category Categories: Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesWizard...
TWiki Variables Quickstart TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example...
TWiki Variables Category Body This is a system topic used by TWikiVariablesSearch categories. TWiki Variables Search Category: Categories: Related Topics...
TWiki Variables Special text strings expand on the fly to display dynamic content, such as user data or system info TWikiVariables are text strings % VARIABLE...
List of TWiki Users Below is a list of users with accounts. If you want to edit topics or see protected areas of the site then you can get added to the list by...
Package TWiki::Users::TWikiUserMapping The User mapping is the process by which TWiki maps from a username (a login name) to a wikiname and back. It is also where...
Package TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class...
Package TWiki::Users::HtPasswdUser Support for htpasswd and htdigest format password files. Subclass of TWiki::Users::Password . See documentation of that class...
Package TWiki::Users This package provides services for the lookup and manipulation of login and wiki names of users, and their authentication. It is a Facade that...
Package TWiki::Users::BaseUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where...
Package TWiki::Users::ApacheHtpasswdUser Password manager that uses Apache::HtPasswd to manage users and passwords. Subclass of TWiki::Users::Password . See documentation...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default is...
Package TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMapping...
TWikiUserMappingContrib Introduction The User Mapping Manager interface provides services for mapping between a `user identity` as used when talking to an external...
TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or `logging in`, is the process by which a user...
TWiki Upgrade Guide This guide covers upgrading from a previous version of TWiki (such as TWiki 5.1) to TWiki 6.1 Overview TWiki 6.1.0 is a minor release that brings...
Package TWiki::UI::View UI delegate for view function StaticMethod view ($session) view command handler. This method is designed to be invoked via the UI::run...
Package TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) attach command handler. This method is designed to be...
Package TWiki::UI::Statistics Statistics extraction and presentation StaticMethod statistics ($session) statistics command handler. This method is designed to...
Package TWiki::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description...
Package TWiki::UI::Save UI delegate for save function StaticMethod save ($session) Command handler for save command. This method is designed to be invoked via...
Package TWiki::UI::Register User registration handling. StaticMethod register cgi ($session) register command handler. This method is designed to be invoked...
Package TWiki::UI::RDiff UI functions for diffing. StaticMethod diff ($session,$web,$topic,$query) diff command handler. This method is designed to be invoked...
Package TWiki::UI::Oops UI delegate for oops function StaticMethod oops cgi ($session) oops command handler. This method is designed to be invoked via the UI...
Package TWiki::UI::Manage UI functions for web, topic and user management StaticMethod manage ($session) manage command handler. This method is designed to be...
Package TWiki::UI::Edit Edit command handler StaticMethod edit ($session) Edit command handler. This method is designed to be invoked via the UI::run method...
Package TWiki::UI Coordinator of execution flow and service functions used by the UI packages StaticMethod handleRequest ($req) $res Main coordinator of request...
Package TWiki::UI::Copy UI delegate for copy function StaticMethod copy ($session) copy command handler. This method is designed to be invoked via the UI::run...
Package TWiki::UI::ChangeForm Service functions used by the UI packages ClassMethod generate ($session,$theWeb,$theTopic,$editaction) Generate the page that supports...
20 Minute TWiki Tutorial This step by step, hands on tutorial gets you up to speed with all the TWikiSite basics, in mere minutes ... 1. Get set... Open two browser...
TWiki Topics The basic building block of a TWiki site is called a topic , identified by a unique, hopefully descriptive, WikiWord title. It may seem easier just...
TWiki Tips Of the Day Include This Page randomly picks a Tip of the day to display. The of the TWiki and Sandbox web include the part between the horizontal rules...
Add New TWiki Tip Of The Day There are Custom Tips maintained on your local TWiki installation, Official TWiki Tips maintained on the TWiki.org web site, and...
TWiki Tips Of The Day These are all tips of the day. They are located in the web (official TWiki tips) and web (custom tips). Total: tips See also: TWiki Tips...
TWiki Tips TWiki Tips are tips and hints contributed by TWiki users. Use this form to search for tips. You can contribute new tips. See also: TWiki Tips Of The...
RSS news feed of topic changes You can use an RSS news reader to find out what is new in a TWiki web. This complements WebChanges that shows recent changes in...
Keyword search Interactive search uses keyword search by default. For example, to search for all topics that contain `SOAP`, `WSDL`, a literal `web service`, but not...
Custom rendered bullets The RenderListPlugin can render bullet lists in a variety of different ways, for example to show org charts or a directory tree. Use % RENDERLIST...
SlideShowPlugin for presentations Use the SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful for organizations...
SpreadSheetPlugin for dynamic content The SpreadSheetPlugin offers 100 functions. Functions are evaluated at page view time. A formula can be placed anywhere in a...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/save cycle. Write % COMMENT{ attributes or simply...
Control table attributes with TablePlugin The TablePlugin gives extra control over table display: Allows sorting Changing table properties like border width...
Edit tables with EditTablePlugin The EditTablePlugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an Edit button if...
SmiliesPlugin emoticons Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile #058; ) : ) or a frown...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enables...
Commenting with hidden text To hide some text within a TWiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example...
Inline search To embed a search in a topic, use the % SEARCH{ parameters TWiki Variable. The search variable is used by many TWiki applications. Related Topics...
Revision control TWiki has `soft security` anyone can change anything, but changes are logged. There is a complete audit trail: Version Date of last revision...
TWiki Skins Skins overlay regular templates with alternate header/footer layouts. You can use Skins to change the look of a TWiki topic, for example, the layout of...
Breadcrumb The breadcrumb of a topic shows you the page hierarchy. It is constructed using a topic`s parent setting. See More Tips... Contributors: TWiki:Main...
File attachments One can attach files to any topic. The action of attaching a file to a topic is similar to attaching a file to an e mail. The link to attach a file...
Preferences settings TWiki has these levels of preferences settings: 1 System level settings: Site name, proxy settings, access control, skin 1 Site...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good...
Server side include To include the contents of a web page or TWiki topic, use % INCLUDE{`page` . Examples: % INCLUDE{`http://www.google.com/` % INCLUDE...
Disabling individual WikiWords Prevent a WikiWord from being linked by prefixing it with an exclamation point. Example: To escape SunOs write SunOs to get SunOs...
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with noautolink and /noautolink tags. See More...
Escaping TWiki rendering Use the verbatim tag to surround code excerpts and other formatted text with verbatim and /verbatim tags. Example: verbatim Header...
Linking to a file attachment One can create a link to a file attachment using one of the following TWikiVariables, % ATTACHURL% or % PUBURL% . % ATTACHURL% is...
Creating a Table of Contents The TWiki variable % TOC% will automatically create a table of contents for a topic based on the headings of the topic. To exclude a...
Re parenting a topic The breadcrumb displayed with a particular TWiki topic is constructed with a topic`s parent . The footer of each page has a link called More...
E mail alert of topic changes Subscribing to WebNotify will enable TWiki to send you details of changes made on topics in a certain web. You can choose to be notified...
WebChanges to see recent activity Each TWiki web has a WebChanges topic that lists recent activity from all editors of the web. This page can be useful when looking...
The Jump Box as a browser The JumpBox is not only a tool to allow you to jump from page to page, you can use it to search for documents. If you do not know the entire...
Package TWiki::Templates Support for the TWiki template language. The following tokens are supported by this language: % TMPL:P% Instantiates a previously defined...
TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates are plain text with embedded template directives...
TWiki System Requirements Server and client requirements Low client and server base requirements are core features that keep TWiki widely deployable, particularly...
Package TWiki::Store::SearchAlgorithms::PurePerl Pure perl implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)...
Package TWiki::Store::RcsWrap This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Wrapper around...
Package TWiki::Store::RcsLite This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Simple replacement...
Package TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. It is the base class of implementations of stores...
Package TWiki::Store::QueryAlgorithms::BruteForce Default brute force query algorithm Has some basic optimisation: it hoists regular expressions out of the query...
Package TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the `real` store provider which is hidden behind...
TWiki Skins A skin overlays regular templates to provide specific look and feel to TWiki screens. Overview TWiki uses TWikiTemplates files as the basis of all the...
TWiki Skin Browser You can try out the TWikiSkins currently installed on this system: .skinstable td {border top:2px solid #444; padding:0.75em 0.5em;} Tip: Additional...
TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up with...
TWiki Site TWiki is a Web based collaboration platform A TWiki site is an easy to use, full featured open communications environment: people anywhere...
TWiki Sheet Plugin Introduction The TWiki Sheet Plugin turns a TWiki table into a spreadsheet that can be modified right in the browser. TWiki Sheet looks and feels...
Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod...
TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki scripts are located in...
Package TWiki::Sandbox This object provides an interface to the outside world. All calls to system functions, or handling of file names, should be brokered by this...
Rendering Shortcuts Easy ways to save some typing Some TWiki preferences variables are just shortcuts for convenience, to either save typing or to easily allow line...
Package TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish...
Release Notes of TWiki 6.1.0 (Kampala), 2018 07 16 Introduction TWiki is an enterprise collaboration platform and application platform. TWiki has been downloaded...
Release Notes of TWiki 6.0.2 (Jerusalem), 2015 11 29 Introduction TWiki is an enterprise collaboration platform and application platform. TWiki has been downloaded...
Release Notes of TWiki 5.1.4 (Istanbul), 2013 02 16 Introduction TWiki is an enterprise collaboration platform and application platform. TWiki has been downloaded...
Release Notes of TWiki 5.0.2 rc1 (Helsinki), 2011 04 21 Introduction TWiki 5.0.0 released on 2010 05 29 is a major release introducing usability enhancements, feature...
Release Notes of TWiki 4.3.2 (Georgetown), 2009 09 02 Note: This is the release note for the previous major release version 4.3.X. This note, TWikiReleaseNotes04x...
TWiki Release 4.2.4 (Freetown), 2008 12 06 Note: This is the release note for the previous major release version 4.2.X. This note, TWikiReleaseNotes04x00 and...
TWiki Release 4.1.2 (Edinburgh), 2007 03 03 Note: This is the release note for the previous major release version 4.1.X. This note and the TWikiReleaseNotes04x...
TWiki Release 4.0 (Dakar) Note: This is the release note for the previous major release version 4.0.X. It is included with 4.1.X because it contains valuable information...
TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki Enterprise Collaboration...
Package TWiki::Query A Query object is a representation of a query over the TWiki database. Fields are given by name, and values by strings or numbers. Strings should...
Package TWiki::Query::HoistREs Static functions to extract regular expressions from queries. The REs can be used in caching stores that use the TWiki standard inline...
Package TWiki::Prefs::PrefsCache The PrefsCache package holds a cache of topics that have been read in, using the TopicPrefs class. These functions manage that cache...
Package TWiki::Prefs::Parser This Prefs internal class is used to parse Set and Local statements from arbitrary text, and extract settings from meta objects....
Package TWiki::Prefs The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences...