PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: Set USERSTYLEURL...
PatternSkinCssCookbook Recipe: Center the page This recipe shows how center the page horizontally and vertically. This line loads the extra style definition:...
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...
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...
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...
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...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate . WebLeftBarPersonalTemplate is a topic template to create a personal left bar block...
OLIVE start olive green colored text OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
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...
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...
EDITTABLE{ attributes } edit TWiki tables using edit fields and other input fields The % EDITTABLE{ variable is handled by the EditTablePlugin Syntax...
AQUA start aqua colored text AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
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...
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...
h1 header with link Intro text. Normal text. Normal text. Normal text. Normal text. Normal text. Normal text. Normal text. Normal text. Normal text. Normal text...
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...
File Attachments Each topic can have one or more files of any type attached to it by using the Attach screen to upload (or download) files from your local PC. Attachments...
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...
Wiki Notation TWiki links topics automatically when you use WikiWord notation. Related topics: WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiEditingShorthand...
YELLOW start yellow colored text YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
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...
ENDSECTION{`name`} marks the end of a named section within a topic Syntax: % ENDSECTION{`name` Syntax: % ENDSECTION{type `include` Syntax: % ENDSECTION...
ENDBG end background color section ENDBG is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
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...
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...
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 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...
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...
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...
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...
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...
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...
WIKIWEBMASTER email address of the administrator % WIKIWEBMASTER% expands to the email address of the administrator of . Syntax: % WIKIWEBMASTER% , expands...
WIKILOGOURL site logo home URL Syntax: % WIKILOGOURL% Expands to: Defined in: TWikiPreferences, default % SCRIPTURLPATH{`view`/% USERSWEB%/% HOMETOPIC...
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...
PURPLE start purple colored text PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
JQENDTAB end a JQuery tab within a tab pane This variable is handled by the JQueryPlugin. For description see JQTABPANE Syntax: % JQTABPANE% % JQTAB{`Tab...
ENTITY{string} encode a string to HTML entities Encode `special` characters to HTML entities. Useful to encode text properly for HTML input fields. Encoded...
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 `.....
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...
BLUE start blue colored text BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
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...
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...
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...
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::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description...
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...
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...
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...
Package TWiki::Net::HTTPResponse Fakeup of HTTP::Response for use when LWP is not available. Only implements a small subset of the HTTP::Response methods: code...
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...
Package TWiki::I18N Support for strings translation and language detection. ClassMethod available languages Lists languages tags for languages available at TWiki...
Package TWiki::Form::ListFieldDefinition Form field definitions that accept lists of values in the field definition. This is different to being multi valued, which...
Package TWiki::AggregateIterator combine multiple iterators new(\@list, $unique) Create a new iterator over the given list of iterators. The list is not damaged...
TWiki Site Statistics NOTE: This is a template topic, do not change. Update the site statistics. Monthly Site Statistics Data Month WebsTotal WebsViewed...
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...
PatternSkinCssCookbook Recipe: Hide the top bar This recipe shows how to hide the top bar and to put the logo in the left bar. This line loads the extra style definition...
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...
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...
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...
Normally, if you make subsequent edits within a one hour period (configuration item {ReplaceIfEditedAgainWithin} ), TWiki will fold together your changes. This...
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...
Bulk Registration Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. Unlike normal registration...
Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF 8 support for URLs...
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: Everybody can edit any page, this is scary. Doesn`t that lead to chaos? Answer: TWiki is one of many engines, the first one was built by Ward Cunningham. Collaborating...
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...
TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or `logging in`, is the process by which a user...
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...
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)...
PatternSkin Customization Guidelines how to create and customize page templates of the .PatternSkin. For styling your TWiki using stylesheets, see PatternSkinCssCookbook...
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...
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...
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...
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...
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...
WIKIWEBMASTERNAME name of the administrator % WIKIWEBMASTERNAME% expands to the name of the administrator of . Syntax: % WIKIWEBMASTERNAME% , expands...
WHITE start white colored text WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
SITENAME the current site name Syntax: % SITENAME% Supported parameters: none Returns the current site name defined by {ReadOnlyAndMirrorWebs}{SiteName...
SCRIPTURLPATH{`script`} URL path of TWiki script As % SCRIPTURL{`script` , but doesn`t include the protocol and host part of the URL Like % SCRIPTURL{...
PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API Syntax: % PLUGINVERSION{`name` to get the version of a specific plugin Example:...
JQTABPANE start a JQuery tab pane Create nice looking horizontal tab panes in TWiki topics. Write a sequence of % JQTAB{`...` and % JQENDTAB% pairs, and enclose...
JQTAB start a JQuery tab within a tab pane This variable is handled by the JQueryPlugin. For description see JQTABPANE Syntax: % JQTABPANE% % JQTAB{`Tab...
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...
HEADLINES{`url`} show RSS and ATOM feeds in TWiki pages The % HEADLINES{`url` variable is handled by the HeadlinesPlugin. Syntax: % HEADLINES{ `http:...
TWiki Variables Category Body This is a system topic used by TWikiVariablesSearch categories. TWiki Variables Search Category: Categories: Related Topics...
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::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::UI::ChangeForm Service functions used by the UI packages ClassMethod generate ($session,$theWeb,$theTopic,$editaction) Generate the page that supports...
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...
SlideShowPlugin for presentations Use the SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful for organizations...
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...
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...
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 TWiki is a Web based collaboration platform A TWiki site is an easy to use, full featured open communications environment: people anywhere...
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....
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...
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...
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...
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::Configure::ImgTool This class is a singleton that offers URLs for the images (logos, warning, info) used during configuration when neither pub...
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...
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...
Peter Thoeny TWiki Enterprise Consultant, Founder and BDFL of TWiki and TWiki.org, inventor of structured wikis, co author of for Dummies book, speaker, HDR Photographer...
Personal Preferences Help Below help text gets included by user profile pages instantiated from NewUserTemplate or .NewUserTemplate (if exists) TWiki has...
.PatternSkin CSS Cookbook Questions and answers on how to customize the default look of TWiki for your own needs, using style sheets. For configuring page elements...
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...
Search Attachments in 1 Web .attName { padding left: 38px; text indent: 38px; } .attComment { font size:80%; color:gray; } Attachment name: Show all...
WIKIPREFSTOPIC name of site wide preferences topic Syntax: % WIKIPREFSTOPIC% Expands to: , renders as Category: AdministrationVariables, SystemInformationVari...
USERSWEB name of users web The web containing individual user topics, .TWikiGroups, and customized site wide preferences. Syntax: % USERSWEB% Expands...
THREECOLUMNS responsive three column page layout Write % THREECOLUMNS% ...text... % ENDCOLUMNS% to get a page layout with three columns . The layout is responsive...
NOP template text not to be expanded in instantiated topics Syntax: % NOP% In normal topic text, expands to nop , which prevents expansion of adjacent...
LAQUO left double angle quote This variable is typically used in breadcrumbs. Syntax: % LAQUO% Expands to: Type: Preference variable TWikiRenderingShortcut...
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...
FORM{} render a TWiki form for view Show a table containing data of a TWiki form attached to a topic Syntax: % FORM{topic `...` formfields `...` ......
CALCULATE{`formula`} handle spreadsheet calculations outside tables The % CALCULATE{formula variable is handled by the SpreadSheetPlugin. Over 100 functions...
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...
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...
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::Manage UI functions for web, topic and user management StaticMethod manage ($session) manage command handler. This method is designed to be...