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 ...

Slide template for ATasteOfTWiki presentation Slide of Copyright by the contributing authors td {padding ...

Access Keys What are access keys? Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without having ...

A List of TWiki Administrator Documentation

Administrator Skills Assumptions For each of these, the requirement is either pre existing knowledge/skill, or the willingness to spend significant time (i.e. from ...

Admin tools Manage whole TWiki site from one screen. Users: Register, NewUserTemplate, UserForm, ResetPassword, ChangePassword, MaintenanceGuide Site Tools ...

FAQ: How can I create a simple TWiki Form based application? Answer: 1 Create a TWiki Form and define fields (TWikiForms) 1 Add the form in the list of Web Forms ...

#EncodeURLsUTF8 # Appendix C: Encode URLs With UTF8 This page addresses implemented UTF 8 support for URLs only. The overall plan for UTF 8 support for TWiki is ...

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 is shown instead ...

Bulk Registration The .TWikiAdminGroup can use BulkRegistration to register (i.e. create logins and UserTopics) for a group of people quickly. Create a table in the ...

See TWiki.WikiWord Related Topics: UserDocumentationCategory

List of all Category topics

Forgotten your password? Then use ResetPassword instead. .TWikiUsers has a full list of user names. Your .LoginName: Old password: New ...

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 object instances ...

Classic Skin The classic TWiki skin is a bare bone and functional skin, supporting any browser, and has a minimum of graphics This is not really a skin. It is the ...

Comment Plugin This plugin allows users to quickly post comments to a page without an edit/preview/save cycle. ( Discussion in TWiki:Plugins/CommentPluginDev ) ...

Templates for CommentPlugin See .CommentPlugin#Customisation for help. While this topic can be viewed as a TWiki topic, it is used by the CommentPlugin as a template ...

TWiki 'Dakar' Release 'Dakar' is the first major release of the TWiki collaboration environment in over a year. The focus of this release has been on refactoring the ...

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 ...

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 ...

A List of TWiki Developer Documentation

Use the "Minor changes, don't notify" checkbox in preview in case you only make a minor change to a topic and you do not want to inform everybody who is on the WebNotify ...

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 ...

Edit Table Plugin This plugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an Edit table button if preceeded by an %EDITTABLE ...

Empty TWiki Plugin This is an empty plugin you can use as a template to build your own .TWikiPlugins. This plugin does nothing, but is ready to be used. To create ...

(just an example illustrating how to create a new topic based on a specific template topic. TWikiTemplates has more)

# 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 ...

Each FileAttachment in a Topic has an attribute string. At present only only the hidden attribute is supported. If the attribute includes h then the attachment ...

Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin ), TWiki will fold together your changes. This is ...

# TWiki Formatted Search Results Inline search feature allows flexible formatting of search result The %SEARCH{...}% variable documented in TWikiVariables has ...

FAQ: TWiki has a GPL (GNU General Public License). What is GPL? Answer: TWiki is distributed under the GNU General Public License, see TWikiDownload. GPL is one of ...

Go Box The box at the top or sidebar of each page. Enter a topic name to quickly jump to the topic, for example: WebNotify to jump to WebNotify in the current ...

GoodStyle Collaboration Tips TWiki has a very simple text formatting shorthand . In any case, you won't go wrong if you simply: start each line without spaces ...

Headlines Plugin This plugin displays RSS feeds from news sites. Use it to build news portals that show headline news. Note: Syndic8.com ( http://www.syndic8.com ...

Hide/Unhide Attachments You can hide/unhide file attachments. In the FileAttachment table, click on an action link, enable the Hide file checkbox, then ...

Icon Sets With Icon Sets every skin may have its own set of graphics/icons. For this a topic is assigned to be the "icon topic" (by setting the variable %ICONTOPIC ...

The %IF construct gives TWiki the power to include content in topics based on the value of simple expressions. %IF{"CONDITION" then "THEN" else "ELSE"}% In the example ...

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 ...

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 ...

Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged ...

Inter Wiki Link Rules (or Links to other Sites) This topic lists all aliases needed to map Inter Site links to external wikis/sites. Whenever you write ExternalSite ...

Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired ...

Mishoo JSCalendar, packaged for use by plugins, skins and add ons. Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for ...

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 ...

This module is an add on to the TWiki kernel that supports e mail notification of changes. Summary of Contents bin/mailnotify The main part of the mailer module ...

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: To ...

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 ...

Manage Users Register users on your TWiki site; change/reset/install passwords; remove user accounts Authentication and Access Control TWikiUserAuthentication ...

# Managing Webs Adding webs is a web based operation; renaming and deleting webs are manual operations done directly on the server Overview A TWikiSite is divided ...

ManagingTopics can be used to move a topic from one Web to another. One specialised use of this is DeleteWeb. Related Topics: UserDocumentationCategory

: Set LINKTOOLTIPINFO off Set EDITBOXWIDTH 70 Set EDITBOXHEIGHT 22 Set EDITBOXSTYLE width: 99 ...

An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example: package Telecoms ClassMethod new() ObjectMethod ...

Pattern skin PatternSkin is developed to provide a CSS based default look and feel for TWiki flexible and W3C compliant. Its layout and color scheme are designed ...

CSS elements in !PatternSkin This page is a reference for all CSS classes used in PatternSkin. !PatternSkin uses 3 stylesheets: layout.css: positioning of block ...

.PatternSkin CSS Cookbook This topic describes how to customize the default look of TWiki for your own needs by changing the default style sheets. Introduction !PatternSkin ...

PatternSkinCssCookbook: Center the page Cookbook example how to center the page (left bar hidden). Set USERSTYLEURL /centerpage.css

PatternSkinCssCookbook: Font variation Cookbook example with other fonts and font colors. Set USERSTYLEURL /fonts.css

Set USERSTYLEURL /notopbar.css Add dynamic variable: .patternLeftBar { background image:url("/TWiki//logo.gif"); } .patternLeftBar { background image:url("/TWiki/ ...

.PatternSkin Customization How can I change the web logo? By default the logo at the top left of each web points to the image with name logo.gif that is attached ...

Peter Thoeny was the orginator of TWiki and continues as a TWiki:Codev/CoreTeam member and a .TWikiContributor. See home page at TWiki:Main/PeterThoeny

Plain Skin The plain skin can be used to get the rendered topic text without any page decoration. This skin is part of every TWiki distribution. Skin Info Description ...

PreferencesPlugin Allows editing of preferences using fields predefined in a .TWikiForms. However, the edit fields are inlined in the text, similar to how tables are ...

Background Image for Preview Preview looks like the real page, but the links leed to an oops dialog warning users of not yet saved topics. In addition, a background ...

Print Skin The print skin, useful to print pages with a small header and footer. This skin is part of every TWiki distribution. Skin Info Description: The print ...

Like Save but does not email people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentationCategory ...

Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are similar ...

Rename or move this web: Rename/move web... , looking for references in all public webs . Delete a web by moving it to a Trash web. Related Topics: ...

Render List Plugin Render bullet lists in a variety of formats Syntax Rules RENDERLIST Variable Place a %RENDERLIST{ parameters }% before any bullet list ...

Reset password If you didn't forget your password, use ChangePassword to change it to a new one. Otherwise, use this form to get a new one emailed to you. Your LoginName ...

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 ...

Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default ...

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 ...

FAQ: What happens if two of us try to edit the same topic simultaneously? Answer: The second person gets a warning that the topic is currently being edited by another ...

most recent topic changes in webs Last Modified Web.Topic Last Editor %SEARCH{ "." regex "on" nosearch "on" nototal "on" limit "" web "" excludetopic ...

TWiki Site Map Web TWiki Site Map Use to... You can use color coding by web for identification and reference. This table is updated ...

Live view of the permissions settings on this TWiki Installation Web Sitemap VIEW CHANGE RENAME ^ Listed DENY ALLOW DENY ...

## Site Usage Statistics You can automatically generate usage statistics for all webs. To enable this: Make sure {Log}{view} , {Log}{save} , and {Log}{upload ...

Slide Show Plugin This Plugin converts a topic with headings into a slide show. Introduction There is already a defacto standard for presentations, why this Plugin ...

The Smilies Plugin : ) Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile : ) or a frown : ( . This ...

TWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code TWiki::AccessControlException Exception ...

TWiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to TWiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They can ...

The 216 Standard Colors #000000 #000033 #000066 #000099 #0000CC #0000FF #003300 #003333 #003366 #003399 #0033CC #0033FF #006600 #006633 #006666 ...

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 know ...

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 ...

TWiki 'Dakar' This is a beta release of TWiki 'Dakar'. The full version information is 7338 See TWiki.DakarReleaseNotes for full release information. See http: ...

# TWiki Access Control Restricting read and write access to topics and webs, by Users and groups TWikiAccessControl allows you restrict access to single topics and ...

Package TWiki::AccessControlException extends Error Exception used raise an access control violation. ClassMethod new ($mode,$user,$web,$topic,$reason) ...

Package TWiki::Access A singleton object of this class manages the access control database. ClassMethod new () Construct a new singleton object to manage the permissions ...

Package TWiki::Attach A singleton object of this class is used to deal with attachments to topics. ClassMethod new ($session) Constructor ObjectMethod renderMetaData ...

Package TWiki::Attrs Class of attribute sets, designed for parsing and storing attribute values from a TWiki tag e.g. An attribute set is a map containing an entry ...

Note: This feature has been replaced by: TWikiForms Related Topics: AdminDocumentationCategory

Package TWiki::Client::ApacheLogin extends TWiki::Client This is login manager that you can specify in the security setup section of configure. It instructs TWiki ...

Package TWiki::Client The package is also a Factory for login managers and also the base class for all login managers. On it's own, an object of this class is used ...

Package TWiki::Client::TemplateLogin This is a login manager that you can specify in the security setup section of configure. It provides users with a template based ...

Package TWiki::Compatibility Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won't be needed. end sub ...

TWiki Contributor A big Thank you to everyone who contributed ideas, code, fixes, documentation and anything else to the TWiki project. Note: Please contact us ...

# TWiki CSS Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release. Who should read this document? Most html elements ...

TWiki Documentation Graphics and Filetype icons This is the TWiki icon library. The graphics can be used in topics and by web applications. Usage There are several ...

TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Doubleclick anywhere to return to the top of the page ...

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 ...

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 ...

Please bring your enhancement requests to TWiki:Codev.FeatureEnhancementRequest Related Topics: TWikiHistory has a list of added features in TWiki. TWikiPlannedFeatures ...

Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . ...

FAQ: Answer: Back to: TWikiFAQ

Package TWiki::Form Object representing a single form definition. ClassMethod new ($session,$web,$form) $web default web to recover form from, if $form ...

# TWiki Forms Structured data (key value pairs) attached to topics, according to a specification given in another topic Overview When forms are enabled for a web ...

Package TWiki::Func This module defines official functions that Plugins can use to interact with the TWiki engine and content. Refer to lib/TWiki/Plugins/EmptyPlugin ...

# TWiki Glossary Simple glossary of TWiki terms Term Definition Attachment: Any type of file that is uploaded via browser and attached to a topic ...

# TWiki Development Timeline Dakar Release Details of DakarRelease can be found in DakarReleaseNotes 01 Sep 2004 Release (Cairo) Details of New Features and Enhancements ...

Package TWiki::I18N Support for strings translation and language detection. ClassMethod available languages Lists languages tags for languages available at TWiki ...

Package TWiki::I18N::Extract Support translatable strings extraction from TWiki topics and templates. Depends on Locale::Maketext::Extract (part of CPAN::Locale: ...

Package TWiki::If Support for the conditions in %IF{} statements. Basically a simple stack based parser for infix expressions that generates a parse tree that can ...

TWiki Installation Guide Installation instructions for the TWiki Dakar production release Please review the AdminSkillsAssumptions before you install TWiki. TWiki ...

TWiki Javascripts This topic contains javascript files that are included by TWiki templates. Related Topics: TWikiTemplates, TWikiSkins Set ALLOWTOPICCHANGE ...

TWiki Logos The official TWiki logo is a big "T" in a speech bubble convenying "working together", and has a "collaborate with TWiki" tag line. TWiki.org Logo Artwork ...

Package TWiki::Merge Support for 3 way merging of strings. Similar to Merge.pm, except that: a) it's considers the ancestor revision of the string, and b) it ...

Package TWiki::Merge Support for merging strings StaticMethod insDelMerge ($a,$b,$sep,$session,$info) Perform a merge of two versions of the same text, using HTML ...

#TWikiMetaData # TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored in META variable name/value pairs Overview TWikiMetaData ...

Package TWiki::Meta Meta data handling. A meta data object is a hash of different types of meta data (keyed on the type, such as 'FIELD' and 'TOPICINFO'). Each entry ...

Package TWiki::Net Object that brokers access to network resources. ObjectMethod getUrl ($theHost,$thePort,$theUrl,$theUser,$thePass,$theHeader) $text Get the ...

Package TWiki::OopsException extends Error Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect ...

Features requested, planned or under construction are listed at the TWiki development home TWiki:Codev.WebHome Related Topics TWikiHistory has a list of added ...

Package ClassMethod new ($session,$name,$module) $session TWiki object $name name of the plugin e.g. MyPlugin $module (options) name ...

# TWiki Plugins Plug in enhanced feature add ons, with a Plugin API for developers Overview You can add Plugins to extend TWiki functionality, without altering ...

Package TWiki::Plugins This module defines the singleton object that handles Plugins loading, initialization and execution. This class uses Chain of Responsibility ...

Package TWiki::Plurals Handle conversion of plural topic names to singular form. StaticMethod singularForm ($web,$pluralForm) $singularForm Try to singularise ...

TWiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this TWikiSite. This topic should be regarded as read only ...

Name Type Size Value Tooltip message Attributes WEBBGCOLOR text 20 #FFD8AA HTML Color S FAVICON text 30 /TWiki/WebPreferences/favicon ...

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 ...

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::PrefsCache The PrefsCache package holds a cache of topics that have been read in, using the TopicPrefs class. These functions manage that cache ...

TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki advanced online collaboration ...

function capitalise(name) { var sIn name; var sOut ''; var chgUpper true; for ( var i 0; i 'a') (ch 'A') (ch ...

Package TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer with initial state ...

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 ...

TWiki CGI Scripts TWiki uses a set of scripts in the bin directory. This topic describes the interfaces to some of those scripts. All the scripts can be called from ...

Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. StaticMethod ...

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 or on ...

# TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWikiSiteTools include utilities for navigating, searching and keeping up with ...

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;} Note: TWikiSkins ...

# TWiki Skins Skins overlay regular templates with alternate header/footer layouts; topic text is not affected Overview Skins are customized TWikiTemplates files ...

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 ...

Package TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. Base class of implementations of stores that manipulate ...

Package TWiki::Store::RcsLite extends TWiki::Store::RcsFile This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile ...

Package TWiki::Store::RcsWrap extends TWiki::Store::RcsFile This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile ...

# TWiki System Requirements Server and client requirements Low client and server requirements are core features that keep TWiki widely deployable, particularly across ...

# TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview There are three types of template: Master Templates ...

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::Time Time handling functions. StaticMethod parseTime ($szDate) $iSecs Convert string date/time to seconds since epoch. $sDate date/time ...

The Go Box as a browser The go box (also called jump box) is not only a tool to allow you to jump from page to page, you can use the Go Box to search for documents ...

WebChanges to see recent activity Each TWiki web has a WebChanges topic that lists recent activity from all editors of the web. This page can be useful when looking ...

Raw Text link At the bottom of the page next to Edit and Attach , there is a Raw Text link that allows one to easily see how the TWiki topic looks in its raw ...

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 ...

Re parenting a topic The breadcrumb displayed with a particular TWiki topic is constructed with a topic's Parent . On the footer to each page there is a link called ...

Creating a Table of Contents The TWikiVariables %TOC% will automatically create a table of contents for a topic based off the headers of the topic. To exclude a ...

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 the ...

Escaping TWiki rendering Use the verbatim tag to surround code excerpts and other formatted text with verbatim and /verbatim tags. Each tag must be on a line ...

Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with noautolink and /noautolink tags. Each tag ...

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 ...

Server side include To include the contents of a web page or TWiki topic, use %INCLUDE{"page"}% . Examples: %INCLUDE{"http://www.google.com/"}% %INCLUDE ...

WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of !WikiWords creates a good browsing ...

Preference settings TWiki has four levels of preferences settings: 1 Site level settings: Site name, proxy settings, access control, skin 1 Web level settings ...