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...
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...
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....
SpreadSheetPlugin Testing Use this topic to verify proper operation of the SpreadSheetPlugin in your environment. For developers: This topic is included by TestCaseAutoSpreadSheetPlu...
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...
Package TWiki::Mdrepo ClassMethod new ($session) Construct a Mdrepo module. It`s a caller`s responsibility to guarantee all of the followings defined: $TWiki...
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...
RAQUO right double angle quote This variable is typically used in breadcrumbs. Syntax: % RAQUO% 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...
SITESTATISTICSTOPIC name of site statistics topic Note: The site statistics topic is assumed to be in the web. Syntax: % SITESTATISTICSTOPIC% Expands...
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...
TWikiDashboardAddOn #187; TWiki Dashboard Banner Images You can use these banner images for your own dashboards. If you use your own image, attach it directly to your...
Notes: Do not edit this topic, it is updated automatically. TWikiSiteTools explains how to enable automatic updates of the statistics pages. Related...
MDREPO retrieve data from metadata repository Attention: This variable works only if MetadataRepository is in use. Otherwise, it always returns a zero length...
SetGetPlugin Introduction Use % SET{ to store arbitrary text in a named variable, and reuse it with % GET{ later on within the topic or an included topics. By...
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...
SITENAME the current site name Syntax: % SITENAME% Supported parameters: none Returns the current site name defined by {ReadOnlyAndMirrorWebs}{SiteName...
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...
ENDBG end background color section ENDBG is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
WIKILOGOURL site logo home URL Syntax: % WIKILOGOURL% Expands to: Defined in: TWikiPreferences, default % SCRIPTURLPATH{`view`/% USERSWEB%/% HOMETOPIC...
WIKILOGOALT site logo tooltip message Syntax: % WIKILOGOALT% Expands to: Defined in: TWikiPreferences Category: AdministrationVariables, SystemInformationVar...
JQENDTABPANE end a JQuery tab pane This variable is handled by the JQueryPlugin. For description see JQTABPANE Syntax: % JQTABPANE% % JQTAB{`Tab 1 ......
DASHBOARD build a dashboard with banner and boxes Use this variable to quickly create dashboards for intranet home, team homepages, project homepages and knowledge...
TWikiNetSkin The TWikiNetSkin is functional and clean and has corporate appeal. It is the default skin provided with Twiki, Inc. products, designed by van Berkel....
TWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code This package doesn`t smell This package...
TOC{`Topic`} table of contents Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ( ` text`...
TOC table of contents of current topic Table of Contents. Shows a TOC that is generated automatically based on headings of the current topic. Headings in WikiSyntax...
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...
TWiki Forms Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database applications...
Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default...
The official TWiki site is twiki.org Welcome to the TWiki Web The place to learn about TWiki features and perform TWiki system maintenance. This site is running...
ENCODE{`string`} encodes a string to HTML entities Encode `special` characters to HTML numeric entities. Encoded characters are: all non printable ASCII...
TWiki Formatted Search Inline search feature allows flexible formatting of search result The default output format of a % SEARCH{... is a table consisting of topic...
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...
RSS 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...
TWikiUserMappingContrib The User Mapping Manager interface provides services for mapping between a `user identity` as used when talking to an external authentication...
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...
EDITACTION Selects an edit template EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard...
TWiki is a Web based collaboration platform A TWiki site is an easy to use, full featured open communications environment: people anywhere on the Web...
Package TWiki TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system...
Settings for WysiwygPlugin that are common to most editor integrations The global TWiki Variable WYSIWYG EXCLUDE can be set to make the plugin sensitive to what...
Package TWiki::Meta All TWiki topics have data (text) and meta data (information about the topic). Meta data includes information such as file attachments, form...
TWiki Javascripts This topic contains javascript files that are included by TWiki templates, and may be used by skin templates and in topics. Related Topics: TWikiTemplates...
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::Compatibility Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won`t be needed. StaticMethod...
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::Attach A singleton object of this class is used to deal with attachments to topics. ClassMethod new ($session) Constructor. ObjectMethod finish...
Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod...
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::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 Monitoring package. Instrument the code like this: use Monitor; Monitor::MARK(`Description of event`); Monitor::MARK(`Another event`); or, to monitor all...
Package head1 NAME CGI::Session::Serialize::json serializer for CGI::Session head1 DESCRIPTION This library can be used by CGI::Session to serialize session data...
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::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...
Package TWiki::AggregateIterator combine multiple iterators new(\@list, $unique) Create a new iterator over the given list of iterators. The list is not damaged...
Package TWiki::I18N Support for strings translation and language detection. ClassMethod available languages Lists languages tags for languages available at TWiki...
Package TWiki::AccessControlException Exception used raise an access control violation. This exception has the following fields: web the web which was being...
Package TWiki::ListIterator Iterator over a list new(\@list) Create a new iterator over the given list. Designed primarily for operations over fully defined lists...
Package TWiki::Store::QueryAlgorithms::BruteForce Default brute force query algorithm Has some basic optimisation: it hoists regular expressions out of the query...
Package TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) attach command handler. This method is designed to be...
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...
TwistyPlugin A `twisty` is an interface toggle control to show and hide content. TwistyPlugin gives you several options to control the appearance of a twisty...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology and TWiki Book...
Color scheme settings for TWikiNetSkin Set SKIN twikinet,pattern Usage Step 1 Let .TWikiNetSkin point to the custom made colors style sheet. In .TWikiPreferences...
COMMENT{ attributes } insert an edit box into the topic to easily add comments. A % COMMENT% without parameters shows a simple text box. The following...
LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload the system level...
CALC{`formula`} add spreadsheet calculations to tables and outside tables The % CALC{`formula` variable is handled by the SpreadSheetPlugin. There are around...
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...
TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up with...
TWiki Release 4.1.2 (Edinburgh), 06:29:10 02 September 2009 Note: This is the release note for the previous major release version 4.1.X. This note and the TWikiReleaseNotes04x...
TOPIC name of current topic % TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic...
WEB name of current web % WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web...
ENV{`varname`} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment...
Package TWiki::I18N::Extract Support translatable strings extraction from TWiki topics and templates. Depends on Locale::Maketext::Extract (part of CPAN::Locale:...
Package StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension e.g. .zip, .tgz. .tar, etc...
TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored embedded in the topic text using META: tags Overview By default, TWiki...
TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. Overview TWiki uses TWikiTemplates files as the basis of all the...
TWiki Tips Of the Day Include This Page randomly picks a Tip of the day to display. The includes the part between the horizontal rules. TWiki Tip of the Day See...
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...
Note: This topic does not exist The topic 1 you are trying to access does not exist, yet. Did you spell the 1 correctly? Remember, a 1 is case sensitive...
AQUA start aqua colored text AQUA 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...
ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic...
GRAY start gray colored text GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
OLIVE start olive green colored text OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
ORANGE start orange colored text ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
RED start red colored text RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
SILVER start silver colored text SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
TOPICURL shortcut to viewing the current topic This variable always expands to an url pointing to the current base topic. Type: Preference variable TWikiRenderingShortcut...
GREEN start green colored text GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
CSS elements in PatternSkin This page is a reference for all CSS classes used in PatternSkin. PatternSkin uses 4 stylesheets: layout.css: positioning of block...
PatternSkinCssCookbook Recipe: Center the page with a border This recipe shows how to put a border around the page, while centering the page horizontally. The example...
TWiki Text Formatting Working in TWiki is as easy as typing in text. You don`t need to know HTML, though you can use it if you prefer. Links to topics are created...
Using HTML You can use most HTML tags in TWiki topics without a problem. This is useful where you want to add some content that is formatted in a way that is not supported...
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....
`Create New Topic` page has moved Continue to create the new page TWiki admins Please replace all web`s WebTopicCreator topic contents with this text: All WebTopicCreator...
Language selection dropdown To be included where a language selection is needed, for instance in the top bar or left bar. Note: this dropdown is only shown if localization...
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...
TWiki Tips TWiki Tips are tips and hints contributed by TWiki users. Use this form to search for tips. You can contribute new tips here. Search (perl regular expression...
Like Save but does not e mail people on the WebNotify notification list same effect as checking `Minor changes, don`t notify`. Related Topics: UserDocumentationCategory...
Reset Password Remember your password? Use 1 instead. Otherwise, use this form to get a new one e mailed to you. you must have at least one valid registered...
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 defaultColour...
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...
Features requested, planned or under construction are listed at the TWiki development home TWiki:Codev.WebHome Related Topics TWikiHistory has a list of added...
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...
ALLVARIABLES list of currently defined TWikiVariables Syntax: % ALLVARIABLES% Expands to: a table showing all defined TWikiVariables in the current context...
DISPLAYTIME{`format`} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format...
FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS Related...
HTTP get HTTP headers Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant...
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...
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...
INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as % TOPIC% in case there is no include...
LANGUAGE current user`s language Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization...
LANGUAGES list available TWiki languages List the languages available (as PO files) to TWiki. Those are the languages in which TWiki`s user interface is...
META displays meta data Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta data (attachments, forms...
SESSIONID unique ID for this session Syntax: % SESSIONID% Expand to: Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION...
USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith...
Web Changes Notification Service Each TWiki web has an automatic e mail notification service that sends you an e mail with links to all of the topics modified since...
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 you do not have...
FAQ: Everybody can edit any page, this is scary. Doesn`t that lead to chaos? Answer: TWiki is one of many WikiWikiClones, the first one was built by Ward Cunningham...
This page provides online help for new users of TWiki when editing a page. If there`s some formatting that your contributors use often, you can customize this for...
Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF 8 support for URLs...
Plain Skin The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any markup...
Print Skin The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin, may introduce their own print skin. This skin is...
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...
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...
Keyword search Interactive search is a 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 bulleted lists in a variety of different ways. Use % RENDERLIST{ parameters before any bulleted list. More...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write % COMMENT{ attributes...
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...