TWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code TWiki::AccessControlException Exception...
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 System Requirements Server and client requirements Low client and server base requirements are core features that keep TWiki widely deployable, particularly...
HEADLINES{`url`} show RSS and ATOM feeds in TWiki pages The % HEADLINES{`url` variable is handled by the HeadlinesPlugin. Syntax: % HEADLINES{ `http:...
FORMFIELD{`fieldname`} render a field in the form attached to some topic Syntax: % FORMFIELD{`fieldname` Supported parameters: Parameter: Description...
TWiki Documentation Graphics and File Type Icons This is the TWiki Documentation Graphics library. The graphics can be used in topics and by web applications. All...
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...
SetGetPlugin Introduction Use % SET{ to store a JSON object or arbitrary text in a named variable, and reuse it with % GET{ later on within the topic or an included...
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...
Search Attachments in 1 Web .attName { padding left: 38px; text indent: 38px; } .attComment { font size:80%; color:gray; } Attachment name: Show all...
Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default...
TWiki Access Control Restricting read and write access to topics and webs, by Users and groups TWiki Access Control allows you restrict access to single topics and...
Managing a Large Site There is no limitation with the number of webs and users a TWiki site can have. But there are several considerationgs needed to run a site having...
Behaviour Javascript Framework Contrib Introduction This contrib packages the third party Behaviour Javascript event library, available from http://bennolan.com...
Wysiwyg Plugin Support for the integration of WYSIWYG (What You See Is What You Get) editors. On its own, the only thing this plugin gives you is a stand alone HTML...
TWikiNetSkin Plugin Helps TWikiNetSkin to render tables and h2 headers. This plugin is only enabled if the skin is set to twikinet . Syntax Rules (none) Plugin...
The Smilies Plugin : ) Introduction Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile :<nop...
Watchlist Plugin Introduction The WatchlistPlugin adds watchlist feature to TWiki topics. Topics of interest can be watched and unwatched. A user can see recent changes...
PreferencesPlugin Introduction Allows editing of preferences using fields predefined in a .TWikiForms. However, the edit fields are inlined in the text, similar...
Comment Plugin The Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, CommentPluginExamples...
Backup Restore Plugin Beta Version Overview This is a solution to backup, restore, and upgrade TWiki sites. It can be used via the browser and on the command line...
WIKIPREFSTOPIC name of site wide preferences topic Syntax: % WIKIPREFSTOPIC% Expands to: , renders as Category: AdministrationVariables, SystemInformationVari...
SESSION VARIABLE get, set or clear a session variable Session variables are stored in a personal `persistent memory space` that is not lost until the web browser...
NOP template text not to be expanded in instantiated topics Syntax: % NOP% In normal topic text, expands to nop , which prevents expansion of adjacent...
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 Dashboard Add On Introduction A dashboard comes into play when users need to get an overview of their work and want to navigate quickly to relevant places....
Read only and mirror web support Scope This topic describes how to set up read only webs. A read only web can be mirrored from another site. But how to mirror a web...
TWiki Logos The official TWiki logo is a big `T` in a speech bubble conveying `working together`, and has a `collaborate with TWiki` tag line. TWiki.org Logo Artwork...
TWiki Upgrade Guide This guide covers upgrading from a previous version of TWiki (such as TWiki 5.1) to TWiki 6.0 Overview TWiki 6.0.0 is a major release that has...
Package TWiki::Mdrepo ClassMethod new ($session) Construct a Mdrepo module. It`s a caller`s responsibility to guarantee all of the followings defined: $TWiki...
Package TWiki::Store::SearchAlgorithms::PurePerl Pure perl implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)...
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::OopsException Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser...
Package TWiki::Configure::Load This module consists of just a single subroutine readConfig . It allows to safely modify configuration variables for one single...
Package TWiki::Engine The engine class is a singleton that implements details about TWiki`s execution mode. This is the base class and implements basic behavior....
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::LoginManager The package is also a Factory for login managers and also the base class for all login managers. On its own, an object of this class is...
Package TWiki::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description...
TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up with...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default is...
Scroll Box Add on Introduction Use this add on to create nice looking text scroll boxes, logo rolls and boxes with images that get replaced in regular intervals....
GROUPS a formatted list of groups Expands to a formatted list of user groups in your TWiki. The variable is intended to be used in .TWikiGroups, to allow a group...
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...
RAQUO right double angle quote This variable is typically used in breadcrumbs. Syntax: % RAQUO% Expands to: Type: Preference variable TWikiRenderingShortcut...
LAQUO left double angle quote This variable is typically used in breadcrumbs. Syntax: % LAQUO% Expands to: Type: Preference variable TWikiRenderingShortcut...
NBSP non breaking space The WYSIWYG editor tends to change nbsp; into normal space. Use this variable where non breaking space needs to be retained, such as...
Query Search Query searches help you search the contents of forms attached to your topics, as well as the values of other meta data attached to the topic. Using query...
Static Method A StaticMethod is a method in a package that can be called without reference to an object of the package type. For example, package Telecoms StaticMethod...
NOTIFYTOPIC name of the notify topic Note: Each web has a notify topic Syntax: % NOTIFYTOPIC% Expands to: , renders as Category: SystemInformationVariabl...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiEnhancementRequests...
Include Topics and Web Pages Using % INCLUDE{... Variable Use the % INCLUDE{... variable to embed the content of another topic or web page inside a TWiki topic...
ATOM News Feeds Find out What`s New There are several ways to find out what`s new in each TWiki web: 1. Visit WebChanges to see recent changes 1. Subscribed...
Search Pattern Cookbook The Search function in TWiki is very powerful. Especially searches using a RegularExpression play an important part of tapping TWiki`s full...
TWiki Variables Search TWiki Variables Show all Category Categories: Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesWizard...
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...
Installed Plugins Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in...
Note: This topic does not exist The topic 1 you are trying to access does not exist, yet. Do you wish to navigate quickly to a similar topic? Similar topics...
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...
BUBBLESIG show bubble box and user signature with profile picture icon Syntax: % BUBBLESIG{WikiName or % BUBBLESIG{WikiName YYYY MM DD The parameter...
HTTPS get HTTPS headers The same as % HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine...
Making webs autonomous Motivation On a large TWiki site having thousands of webs, each web should be as self service as possible so that TWiki administrators` work...
Copying Topics Browser based copy for individual topics Overview You can use browser based controls to copy a topic within the same web or to another web. The specified...
DATEPICKER{} pop up calendar to select a date for use in HTML forms The % DATEPICKER{ variable is handled by the DatePickerPlugin. Syntax: % DATEPICKER...
SITENAME the current site name Syntax: % SITENAME% Supported parameters: none Returns the current site name defined by {ReadOnlyAndMirrorWebs}{SiteName...
CONTENTMODE{web `WEB`} content mode Returns the content mode of the specified web. It`s either `local`, `read only`, `master`, or `slave`. Read ReadOnlyAndMirrorWebs...
WIKIVERSION the version of the installed TWiki engine Syntax: % WIKIVERSION% Expands to: Category: AdministrationVariables, SystemInformationVariables...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with % STARTSECTION{ and % ENDSECTION{ . Sections may be given...
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for...
SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % SESSIONVAR% Expand to: Category: DevelopmentVariables, SystemInformationVariables...
SCRIPTNAME name of current script The name of the current script is shown, including script suffix, if any (for example viewauth.cgi ) Syntax: % SCRIPTNAME...
QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: % QUERYPARAMS{... Parameters...
LOGOUTURL present a logout link Present a logout link, regardless of the state of login Syntax: % LOGOUTURL% Expand to: Category: LinkingAndNavigationVariables...
LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload the system level...
LOGINURL present a login link Present a login link, regardless of the state of login Syntax: % LOGINURL% Expand to: Category: LinkingAndNavigationVariables...
IF{`condition` ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax: % IF...
ICONURL{`name`} URL of small documentation graphic or icon Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related...
ICONURLPATH{`name`} URL path of small documentation graphic or icon Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify...
GRAY start gray colored text GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that 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...
ATTACHURLPATH path of the attachment URL of the current topic Syntax: % ATTACHURLPATH% Expands to: /twiki/pub/TWiki/VarATTACHURLPATH Category: AttachmentsAndFilesV...
ALLVARIABLES list of currently defined TWikiVariables Syntax: % ALLVARIABLES% Expands to: a table showing all defined TWikiVariables in the current context...
Allowing Web Creation by the User Mapping Manager Motivation There are cases where DENYROOTCHANGE, ALLOWROOTCHANGE, DENYWEBCHANGE, and ALLOWWEBCHANGE are not capable...
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...
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...
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...
This is a short introductory training course for TWiki beginners. A Taste of TWiki The basic function of TWiki is a Wiki (if that helps!) A Wiki is like a web site...
Color scheme settings for .PatternSkin Use this topic to change the color settings of .PatternSkin. When this topic is saved, the attachment theme colors.css will...
Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of an easily implemented knowledge base solution. To see how it`s done, view the source...
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A TWiki topic name always has a fixed...
FAQ: TWiki is distributed under the GPL (GNU General Public License). What is GPL? Answer: TWiki is distributed under the GNU General Public License, see TWikiDownload...
Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod...
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...
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...
Web Notification This is a subscription service to be automatically notified by e mail when topics change in this TWiki web. This is a convenient service, so...
NewsPlugin Introduction The News plugin implements a simple `Headlines` view, or summary, of a list of news or a weblog. Add a % NEWS% variable in a news...
Managing Topics Browser based rename, move, and delete for individual topics Overview You can use browser based controls to change a topic`s name, move it to another...
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...
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...
SlideShowPlugin for presentations Use the SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful for organizations...
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...
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...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good...
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...
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...
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...
TWiki Javascripts This topic contains JavasSript files that are included by TWiki templates, and may be used by skin templates and in topics. Set ALLOWTOPICCHANGE...
TWiki Contributor On a personal note, I would like to take this opportunity to express my sincere appreciation and thanks to all who contributed ideas, code, fixes...
Use the `Minor changes, don`t notify` checkbox when saving a page in case you only make a minor change to a topic and you do not want to inform everybody who is on...
Book View BookView is an option available from the advanced search topic. It allows you to display the result in `book view`, that is, the whole content of topics...
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...
TWiki Shorthand Basics If you can enter text, you`re ready for TWiki. With a few simple, intuitive TextFormattingRules, you`ll be able to use plain text to create...
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...
The name you log in with A login name is a sequence of alphanumeric characters and underscores. You cannot alter your LoginName: you have to get the administrator...
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::Store::RcsWrap This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Wrapper around...
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::Users::ApacheHtpasswdUser Password manager that uses Apache::HtPasswd to manage users and passwords. Subclass of TWiki::Users::Password . See documentation...
Package TWiki::Templates Support for the TWiki template language. The following tokens are supported by this language: % TMPL:P% Instantiates a previously defined...
Package TWiki::LoginManager::TemplateLogin This is a login manager that you can specify in the security setup section of configure. It provides users with a template...
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::Infix::Node Base class for node types generated by Infix::Parser. You don`t have to use it, but it may be useful. ClassMethod newNode ($o,@p)...
Package TWiki::I18N Support for strings translation and language detection. ClassMethod available languages Lists languages tags for languages available at TWiki...
Package TWiki::Attrs Class of attribute sets, designed for parsing and storing attribute values from a TWiki tag e.g. % TAG{`joe` fred `bad` joe `mad` An attribute...
Package TWiki::LoginManager::ApacheLogin This is login manager that you can specify in the security setup section of configure. It instructs TWiki to cooperate with...
TWiki Add Ons Add functionality to TWiki with extensions not based on the TWiki scripts. Overview An add on runs separately from the TWiki scripts, e.g. for data...
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....