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 ...
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 ...
AccessStatsPlugin The !AccessStatsPlugin provide statistics by parsing the Apache access log files. It gives the hit count for attachments or topics. One can also ...
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 ...
FAQ: How can I create a simple TWiki Form based application? Answer: 1 Create a TWiki Form and define fields (see TWikiForms for details) 1 Add the form in ...
#EncodeURLsUTF8 # Appendix B: Encode URLs With UTF8 Use internationalised characters within !WikiWords and attachment names This topic addresses implemented UTF ...
BeautifierPlugin This plugin allows you to have code fragments automatically formatted and highlighted. It depends on the library written by Mike Jewell. Syntax ...
!Behaviour Javascript framework Contrib This contrib packages the third party Behaviour Javascript event library, available from http://bennolan.com/behaviour/. ...
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 ...
Calendar Plugin (version 1.020) The CalendarPlugin handles the tag %CALENDAR% that inserts a monthly calendar in the page. Multiple topics can be specified as the ...
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 the traditional TWiki skin, as seen in previous TWiki versions. Skin Info Description: Bare bone and functional, for any ...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. WARNING: TWiki 4 only. If you want to use this plugin ...
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 ...
Controls Plugin This plugin creates controls that can be used to define HTML forms from possible values defined in a topic. TWikiForms allow possible values for a ...
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 ...
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 ...
Edit Contrib Package Provides subroutines useful in writing plugins that edit and save parts of topics. Summary of Contents This contrib provides subroutines that ...
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 ...
EmbedFlashPlugin Embeds an Adobe Flash file. Example If this plugin is installed you will see a Flash movie here: General syntax All options: %EMBEDFLASH{ filename ...
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 ...
# 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 the hidden attribute is supported. If the attribute includes h then the attachment is considered ...
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 Inline search feature allows flexible formatting of search result The default output format of a %SEARCH{...}% is a table consisting of ...
Generate PDF Add On Generate PDF from TWiki pages. This is a substantial re write of the TWiki:Codev.PrintUsingPDF pdf script. It essentially accomplishes the same ...
This page defines the headers and footers for documents generated by .GenPDFAddOn. See the HtmlDoc documentation for more info. If you want an image in the headers ...
This page serves as the title page for documents created with .GenPDFAddOn. The content between the horizontal rules will be printed on the title page of the PDF document ...
GluePlugin Description This plugin will help you to write readable TWikiML by allowing tags and arguments to be formatted on multiple lines. This is done by removing ...
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, also called Jump box. Enter a topic name to quickly jump to the topic, for example: WebNotify to jump to ...
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 ...
Hide/Unhide Attachments You can hide/unhide file attachments in normal topic view. In the FileAttachment table, click on an action link, enable the Hide ...
HideInEditModePlugin This is a plugin that you can use to hide one or two blocsk of text in the edit page, so that the text cannot be edited or changed unless the ...
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 ...
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 ...
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 ...
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 ...
JSCalendarContrib JSCalendar, packaged for use by plugins, skins and add ons. Summary of Contents This module packages the JSCalendar Javascript in a form suitable ...
JSPopupPlugin TWiki Plugin JSPopupPlugin allows you to show dynamic content in a virtual popup. Good for status messages, or to show detailed information without causing ...
!KupuContrib The integration uses the TWiki:Plugins.WysiwygPlugin to translate text to and from a format that Kupu can edit. Caveat : KupuContrib is designed for ...
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 ...
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 ...
MailerContrib Add on to the TWiki kernel that allows users to "subscribe" to regularly scheduled e mails containing either: A report on changes to all topics ...
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 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 ...
# Manage Users Register users on your TWiki site; change/reset/install passwords; remove user accounts Authentication and Access Control TWikiUserAuthentication ...
# Managing Webs Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite is divided into webs; each one represents one subject, one ...
MathModePlugin Description This plugin allows you to include mathematics in a TWiki page, with a format very similar to LaTeX. The external program latex2html ...
ManagingTopics can be used to move a topic from one Web to another. One specialised use of this is DeleteWeb. Related Topics: UserDocumentationCategory
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 provides a CSS based default look and feel for TWiki flexible and W3C compliant. Its layout and color scheme are designed to provide a ...
Color scheme settings for .PatternSkin Appearance: text colors, background colors, border colors. Use this topic to change the color settings of .PatternSkin. When ...
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 ...
.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 ...
PatternSkinCssCookbook Recipe: Center the page This recipe shows how center the page horizontally and vertically. This line loads the extra style definition: ...
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 ...
PatternSkinCssCookbook Recipe: EditTable style Cookbook example to illustrate control over !EditTable edit styles. 1 !EditTable uses a monospace font in edit ...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: Set USERSTYLEURL ...
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: Set USERSTYLEURL /hideleftbar.css You can write this line in .TWikiPreferences ...
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 ...
.PatternSkin Customization Questions and answers on configuring page elements. For styling your TWiki, see PatternSkinCssCookbook. First Read: How to modify !PatternSkin ...
NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled TWiki maintenance. h1 header with link Intro ...
PatternSkin Javascripts This topic contains javascript files that are included by PatternSkin templates and !PatternSkin topics (.WebLeftBar, .WebTopBar). Related ...
PhotoarchivePlugin PhotoarchivePlugin is a nice plugin to show your photo archive or album in different views. You can add a description to each picture and define ...
Plain Skin The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. For example, TWiki uses this skin for ...
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 lead 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. Other skins, such as PatternSkin, may introduce their own print skin. This skin is ...
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 ...
RecursiveRenderPlugin This plugin adds the ability to tell the TWiki renderer to render a portion of a page as if it were a page all to itself. Syntax Rules There ...
Redirect Plugin This plugin allows one to produce TWiki topics that automatically redirect to other TWiki topics or URLs. I typically use this to make easy to type ...
Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are similar ...
Render List Plugin Render bullet lists in a variety of formats Syntax Rules RENDERLIST Variable Place a %RENDERLIST{ parameters }% before any bullet list ...
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 ...
Sectional Edit Plugin Discussion of this plugin can be found in SectionalEditPluginDev. This plugin allows the user to break a topic into sections which can be edited ...
Signature Plugin This plugin supports a simple tag which appears as a button with the label given by the SIGNATURELABEL setting. When clicked, it is replaced by ...
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 ...
most recent topic changes in webs Last Modified Web.Topic Last Editor %SEARCH{ "." type "regex" nosearch "on" nototal "on" limit "" web "" excludetopic ...
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 This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 #0000CC #0000FF #003300 #003333 #003366 ...
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 ...
Subscribe Add On This AddOn adds a "Subscribe Topic" button next to the Edit, Attach, Printable buttons. When clicked it will add a user and the topic to the WebNotify ...
# 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 ...
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 ...
# 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 ...
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 ...
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. StaticMethod ...
Package TWiki::Configure::Load Purpose This module consists of just a single subroutine readConfig . It allows to safely modify configuration variables for one ...
Package StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension e.g. .zip, .tgz. .tar, etc ...
# 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 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 ...
# Appendix C: 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 ...
TWiki Documentation Graphics and Filetype icons This is the TWiki icon library. The graphics can be used in topics and by web applications. Usage Default notation ...
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 an easily implemented knowledge base solution. To see how it's done, view the source ...
Package TWiki::Form Object representing a single form definition. ClassMethod new ($session,$web,$form,$def) $web default web to recover form from, if ...
# 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 ...
Package TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that Plugins can use to interact with the ...
# Appendix A: TWiki Development Timeline #EdinburghRelease TWiki Release 4.1 (Edinburgh), 16 Jan 2022 New Features and Enhancements of TWiki Release 4.1 ...
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 The following is installation instructions for the TWiki 4.1 production release on an Apache web server on Linux. Visit TWiki:TWiki.InstallingTWiki ...
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 ...
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 ...
#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 ...