WorkflowPlugin /Flow.gif Introduction TWiki benefits from the fact that every user can modify a topic instantly without restrictions. However sometimes you want...
Wabi Sabi Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard...
VotePlugin Introduction This plugin can be used to build an online voting system, or poll . There are two ways to vote for an item: select : vote for...
bin/view/~jsmith redirected to bin/view/JaneSmith You can go to a user`s topic by ~loginname instead of /FirstLast. More specifically, if you open http://twiki...
WIKIUSERSTOPIC name of topic listing all registers users Syntax: % WIKIUSERSTOPIC% Expands to: , with prefix renders as . Category: SystemInformationVariables...
WIKILOGOALT site logo tooltip message Syntax: % WIKILOGOALT% Expands to: Defined in: TWikiPreferences Category: AdministrationVariables, SystemInformationVar...
TOPICURL shortcut to viewing the current topic This variable always expands to an url pointing to the current base topic. Type: Preference variable TWikiRenderingShortcut...
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...
SLIDESHOWSTART convert a topic with headings into a slideshow The % SLIDESHOWSTART% variable is handled by the SlideShowPlugin Syntax: % SLIDESHOWSTART...
SET{`name` value `...`} set a variable Set a named variable that can be retrieved later with % GET{ . No output is shown, e.g. % SET{ resolves to an empty...
REDBG start red colored background section REDBG is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut...
RED start red colored text RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
MAROON start maroon colored text MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
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...
HEADLINES{`url`} show RSS and ATOM feeds in TWiki pages The % HEADLINES{`url` variable is handled by the HeadlinesPlugin. Syntax: % HEADLINES{ `http:...
ENDSECTION{`name`} marks the end of a named section within a topic Syntax: % ENDSECTION{`name` Syntax: % ENDSECTION{type `include` Syntax: % ENDSECTION...
DRAWING vector drawing editor and clickable maps for diagrams and workflows The % DRAWING{ variable is handled by the TWikiDrawPlugin. Syntax: % DRAWING...
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...
CALCULATE{`formula`} handle spreadsheet calculations outside tables The % CALCULATE{formula variable is handled by the SpreadSheetPlugin. Over 100 functions...
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...
Tree Plugin Useful for dynamic site maps and threads. Syntax Rules % TREEVIEW{ displays topic children in a hierarchical tree % TREE{ synonym of % TREEVIEW...
Topic Data Helper Plugin This plugin is intended for plugin authors. This plugin is used by TWiki:Plugins.AttachmentListPlugin and TWiki:Plugins.FormFieldListPlugin...
TimeTablePlugin The TimeTablePlugin handles the tag % TIMETABLE% and creates a weekly timetable. The timetable is rendered with HTML tables and should...
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...
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...
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::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...
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...
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...
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 Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up with...
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::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::Form::Select getDefaultValue() $value The default for a select is always the empty string, as there is no way in TWiki form definitions to indicate...
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...
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...
Package TWiki::Configure::UIs::EXTEND StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension...
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...
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...
FAQ: I`ve problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it`s the same problem. Answer: That is an indication...
Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are similar...
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...
PreferencesPlugin Introduction Allows editing of preferences using fields predefined in a .TWikiForms. However, the edit fields are inlined in the text, similar...
Page Rendering Process Overview of how TWiki works To achieve a goal in TWiki either by making use of existing features or implementing new features, good understanding...
Orphans Plugin Introduction This Plugin assists in the management of topics within a TWiki web by locating orphaned topics (topics that have no parent, or their parent...
MovedSkin Overview Sometimes a TWiki site is migrated to a new location with a new URL. For convenience users visiting the old site should find the new site. When...
Find orphaned Topics This page lets you search for topics in a web that are not referenced by any other topic. You can also search to find out how many references...
JQuery Plugin Description This plugin packages the popular jQuery and jQuery UI JavaScript libraries. jQuery is a fast, small, and feature rich JavaScript...
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...
HolidaylistPlugin The HolidaylistPlugin handles the tag % HOLIDAYLIST% that inserts a vacation list on the current page. Smilies are used to indicate if a person...
Formatting Tokens TWiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and IfStatements...
Empty TWiki Plugin Introduction This is an empty plugin. Use it as a template to build your own .TWikiPlugins. This plugin does nothing, but is ready to be extended...
Directed Graph Plugin Introduction Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. Automatic graph...
Chart Plugin Tests This page attempts to demonstrate/test many of the possible combinations of various parameters of the ChartPlugin. There are too many combinations...
Change E mail Address This form is used to change your registered e mail addresses. Your registered e mails are used by TWiki for sending you e mails, including notifications...
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...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG EXCLUDE...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology and TWiki Presentation...
WEBPREFSTOPIC name of web preferences topic Syntax: % WEBPREFSTOPIC% Expands to: , renders as Category: AdministrationVariables, SystemInformationVariables...
USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith...
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`...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with % STARTSECTION{ and % ENDSECTION{ . Sections may be given...
SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % SESSIONVAR% Expand to: Category: DevelopmentVariables, SystemInformationVariables...
NAVY start navy blue colored text NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
MDREPO retrieve data from metadata repository Attention: This variable works only if MetadataRepository is in use. Otherwise, it always returns a zero length...
INCLUDE{`page`} include other topic or web page Merges the content of a specified page into the current one before rendering. Syntax: % INCLUDE{`page`...
ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic...
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...
CONTENTMODE{web `WEB`} content mode Returns the content mode of the specified web. It`s either `local`, `read only`, `master`, or `slave`. Read ReadOnlyAndMirrorWebs...
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...
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....
AQUA start aqua colored text AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
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...
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...
Tag me Plugin Plugin to tag wiki content collectively in order to find content by tags and to get a meaningful page ranking. Introduction Overview The larger a wiki...
TWikiUserMappingContrib Introduction The User Mapping Manager interface provides services for mapping between a `user identity` as used when talking to an external...
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::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description...
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::ChangeForm Service functions used by the UI packages ClassMethod generate ($session,$theWeb,$theTopic,$editaction) Generate the page that supports...
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...
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...
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::Store::QueryAlgorithms::BruteForce Default brute force query algorithm Has some basic optimisation: it hoists regular expressions out of the query...
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::Prefs::Parser This Prefs internal class is used to parse Set and Local statements from arbitrary text, and extract settings from meta objects....
Appendix A: TWiki Development Time line TWiki Release 6.0 (Jerusalem) released on 2013 10 14 New Features and Enhancements of TWiki Release 6.0 Bug Fixes...
TWiki Enhancement Requests The TWiki community is looking forward to getting feedback from the actual TWiki user base. You can help make TWiki a better product by...
FAQ: I would like to install TWiki on my server. Can I get the source? Answer: TWiki is distributed under the GnuGeneralPublicLicense. You can get the source from...
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....
Appendix C: TWiki CSS Listing of CSS class names emitted from TWiki core code and standard plugins. Who should read this document? Most HTML elements generated...
TWiki Contribs Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the functionality of TWiki, typically used by plugins...
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::AccessControlException Exception used raise an access control violation. This exception has the following fields: web the web which was being...
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...
Syntax Highlighting Plugin Introduction The Syntax Highlighting Plugin is used to emphasize the rendering of your wiki text according to several languages. It currently...
SpreadSheetPlugin Testing Use this topic to verify proper operation of the SpreadSheetPlugin in your environment. For developers: This topic is included by TestCaseAutoSpreadSheetPlu...
Slide Show Plugin Introduction There is already a defacto standard for presentations, why this plugin? This plugin makes sense for organizations that do already have...
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....
Rename, Move or Delete this Web Note: The 1 web cannot be renamed. See also: ManagingWebs icon:move Rename/move/delete web... , looking for references...
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...
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...
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...
Pattern Skin . For use in corporate or perhaps in personal websites it should be fairly easy to tune the looks or even create a PatternSkin based new skin. Screenshot...
Managing Webs Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite is divided into webs; each one represents one workspace, one...
LdapNgPlugin Introduction This plugin provides an interface to query an LDAP directory and display the results in a TWiki topic. It is a complete rewrite of...
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...
JS Calendar Contrib Deprecation Notice and Migration This JSCalendar based DHTML pop up calendar is now repackaged as DatePickerPlugin. Simply installing the TWiki...
Overview of directed graph editing Caution dot syntax is not compatible with versions of TWiki:Extensions.WysiwygPlugin prior to 28 June 2009. It is recommended...
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...
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...
FilterPlugin Description This plugin allows to substitute and extract information from content by using regular expressions. There are three different types...
Color Picker Plugin Introduction This TWiki plugin packages the color picker, which is a jQuery plugin developed by Steven Wittens of Acko.net. The package adds a...
Class Method A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new...
Chart Plugin This plugin helps you visualize data in TWiki tables as charts, using a default linear scale or an optional semi logarithmic scale. Introduction Six...
FAQ: How can I create a simple TWiki Forms based application? Answer: TWiki applications help automate workflows you have at the workplace. TWiki has a built in database...
Administrator Skills Assumptions Note: If you aren`t already fairly well skilled in Linux/Unix/Windows system administration, Apache webserver configuration, and...
Recent changes in web: more... Web Changes Box on the Right Side This box is included in the of every web, except for the TWiki documentation web. To...