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...
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::UI::ChangeForm Service functions used by the UI packages ClassMethod generate ($session,$theWeb,$theTopic,$editaction) Generate the page that supports...
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...
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...
LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload the system level...
LIME start lime colored text LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
LAQUO left double angle quote This variable is typically used in breadcrumbs. Syntax: % LAQUO% Expands to: Type: Preference variable TWikiRenderingShortcut...
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...
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...
INCLUDINGWEB web that includes current topic The web name of the topic that includes the current topic same as % WEB% if there is no INCLUDE. Syntax...
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...
INCLUDE{`page`} include other topic or web page Merges the content of a specified page into the current one before rendering. Syntax: % INCLUDE{`page`...
IF{`condition` ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax: % IF...
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...
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...
ICON{`name`} small documentation graphic or icon of common attachment types Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics....
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...
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...
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...
GREEN start green colored text GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
GRAY start gray colored text GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS Category...
ENV{`varname`} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment...
ENTITY{string} encode a string to HTML entities Encode `special` characters to HTML entities. Useful to encode text properly for HTML input fields. Encoded...
ENDSECTION{`name`} marks the end of a named section within a topic Syntax: % ENDSECTION{`name` Syntax: % ENDSECTION{type `include` Syntax: % ENDSECTION...
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...
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...
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...
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: /wiki/pub/TWiki/VarATTACHURLPATH Category: AttachmentsAndFilesVa...
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...
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...
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...
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...
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 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...
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...
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...
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...
TWiki Plugins Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You can add plugins to extend TWiki functionality...
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 Javascripts This topic contains JavasSript files that are included by TWiki templates, and may be used by skin templates and in topics. Set ALLOWTOPICCHANGE...
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 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 Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiEnhancementRequests...
Site Documentation Graphics Site specific documentation graphics are defined in this topic. Add your own graphic images here, they will survive a TWiki system update...
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 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 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...
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...
Subweb and topic names conflicts, view URLs, and links If your TWiki installation has the hierarchical webs feature turned on, you face subtle issues about subweb...
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...
Welcome to TWiki. This page assumes that you are a new user to TWiki, and that you`ve never heard of Wiki before. Here are the most important pages you should...
TWiki Site Statistics NOTE: This is a template topic, do not change. Update the site statistics. Monthly Site Statistics Data Month WebsTotal WebsViewed...
FAQ: What happens if two of us try to edit the same topic simultaneously? Answer: TWiki allows multiple simultaneous edits of the same topic, and then merges the...
Search Results Pagination When a % SEARCH{... returns many results, you may want to paginate the results. Overview You can achieve search results pagination by...
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...
Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default...
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...
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...
Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are similar...
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...
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...
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...
Background Image for Preview Preview looks like the real page, but the links lead to an oops dialog warning users of not yet saved topics. In addition, a background...
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...
Peter Thoeny TWiki Enterprise consultant, Founder and BDFL of TWiki and TWiki.org, inventor of structured wikis, co author of for Dummies book, speaker. See home page...
Parameterized Variables (Macros) It is possible to pass parameters to TWiki variables. This is called a macro in a programming language. To define a parameterized...
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...
Object Method An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example: package Telecoms ClassMethod...
Metadata Repository Motivation If you have hundreds or thousands of webs on a TWiki site, web metadata stored in a data repository is useful. It can...
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...
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...
Main Features of TWiki Any web browser: Edit existing pages or create new pages by using any web browser. There is no need to upload pages. Edit link...
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...
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...
Jump Box The Jump Box at the top or sidebar of each page is a hidden gem for quick navigation in a large TWiki. 1. Quick Jump: Enter a topic name to quickly jump...
Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged...
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...
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...
INCLUDE a topic in the raw When a topic is included, normally TWiki variables in the included topic are expanded in the context of the inlcluded topic. But if raw...
IF Statements The % IF% construct gives TWiki the power to include content in topics based on the value of simple expressions. % IF{`CONDITION` then `THEN` else...
Hierarchical Navigation Navigation block that displays the current topic, its parent and children (if any). This is intended to be included in other topics, for...
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...
Formatting Tokens TWiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and IfStatements...
Normally, if you make subsequent edits within a one hour period (configuration item {ReplaceIfEditedAgainWithin} ), TWiki will fold together your changes. This...
Each FileAttachment in a Topic has an attribute string. At present only the hidden attribute is supported. If the attribute includes h then the attachment is considered...
FAQ: Why does the topic revision not increase when I edit a topic? Answer: The same topic revision will be used when you save a topic again within a certain time...
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...
FAQ: How do I delete or rename a file attachment? Answer: You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from...
FAQ: How do I delete or rename a topic? Answer: These two questions are answered together because often when you think you want to delete a page, more often it makes...
Custom User/Group Notations Your TWiki site may be depending on a web user authentication mechanism provided in your environment. And your users are well accustomed...
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...
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...
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...
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...
Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF 8 support for URLs...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG EXCLUDE...
USERREPORT show user reports with profile pictures Show various user reports documented in UserReports Syntax: % USERREPORT{ action `...` ... Overview...
BUBBLESIG show bubble box and user signature with profile picture icon Syntax: % BUBBLESIG{WikiName or % BUBBLESIG{WikiName YYYY MM DD The parameter...
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...
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...
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...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default is...