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 si...
Access Control Restricting read and write access to topics and webs, by users and groups Access Control allows you restrict access to single topics and entire web...
Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF 8 ...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
Backup Restore Plugin Beta Version Overview This is a solution to backup, restore and upgrade TWiki sites. It can be used via browser and on the command line. ...
BeginnersStartHere This is a short introduction to Foswiki. A short introduction to Foswiki Use the slideshow navigation buttons on the bottom right of the page...
Behaviour Javascript Framework Contrib Introduction This contrib packages the third party Behaviour Javascript event library, available from http://bennolan.com/...
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...
CGI and Command Line Scripts Programs on the server performing actions such as rendering, saving and renaming topics. These scripts are located in the bin and too...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
CompareRevisionsAddOn Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the compariso...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEna...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
Foswiki Contribs Extensions to Foswiki that are not .plugins Overview The term "Contrib" is used to refer to any package that is not just a simple plugin. F...
Add Ons Deprecated name for the System.Contribs type of extension. Some older extensions will still be named as an AddOn. Overview An add on runs separately...
Data Forms Structured data, how to set up and work with data forms. Overview Next to freeform topic contents, each topic can store additional data in name/value ...
Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this site. * Note:* This topic should be regarded as rea...
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
Developing Plugins The usual way Foswiki is extended is by writing a Plugin. Plugins extend Foswiki by providing functions that 'listen' to events in the Foswiki ...
EditRowPlugin @import url(/System/EditRowPlugin/erp.uncompressed.css); Features: 1 You can edit one row, or even one cell at a time, instead of having to edit ...
Edit Table Plugin Simply add an Edit table button to an existing table by writing %EDITTABLE{}% directly above the table. This can be added to tables that are...
Empty Plugin Learn how to create your own plugin in .DevelopingPlugins. Documentation for Plugin API is in PerlDoc for EmptyPlugin.pm. Note that EmptyPlugin is d...
Some questions to answer: * Perhaps the plugin is installed, but did you remember to enable it in configure? * Did the installer mention any missing depende...
Foswiki Server Information This topic lists the detailed server execution environment. As this is sensitive information, it is only available to users with acces...
Frequently Asked Questions This is a real FAQ, and also a demo of an easily implemented knowledge base solution. You may view the code for the topic creator or ra...
Glossary of Terms Glossary of Foswiki specific terminology. $ Attachment: Any type of file that is uploaded via browser and attached to a topic, where it can b...
Google Analytics Plugin Adds Google Analytics javascript code to specified pages. %TWISTY{ mode="div" class="twikiNotification" showlink=" #9658; Changes in versi...
Headlines Plugin Description This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news. Note: Syndic8.com ( h...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
IconService The IconService functions as a central definition and delivery method for all sorts of icons: image icons as well as font icons. Different kinds of i...
Installation Guide This guide describes the steps for installing Foswiki using Apache as the web server, on Linux. This guide describes the specific steps for ins...
Installation Guide Part 2 Post Installation Configuration and Tuning Once you have Foswiki installed and running, you can perform one or more of the following s...
Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
Inter Wiki Link Rules (or Links to other Sites) This topic lists all aliases needed to map inter wiki links to external wikis/sites. Whenever you write ExternalSi...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
JEditableContrib This add on packages up the jQuery "JEditable" plugin from Miko Tuupala. This excellent little plugin gives you edit in place capability with man...
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks....
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read...
JsonRpcContrib Summary This package implements a JSON RPC 2.0 protocol to interface with Foswiki and its plugins. In contrast to the normal REST interface of Fo...
Macros Special text strings expand on the fly to display information, or trigger a function. Macros are text strings in one of three basic forms: %MACRONAME{ pa...
What makes Foswiki .... the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ...
Natural Edit Plugin Description The NatEdit is an wiki editor that helps in learning the TML Language by providing a GUI. By design, this is not a wysiwyg editor...
Documentation Graphics and Filetype icons This is the Foswiki icon library. The graphics can be used in topics and by web applications. Usage Default notation: ...
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...
See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, Tec...
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *...
PreferencesPlugin Allows editing of preferences using fields predefined in a .DataForms. However, the edit fields are inlined in the text, similar to how tables a...
Pub Link Fixup Plugin This plugin performs pub link fixup of the generated HTML page. If Foswiki is configured with a non utf 8 {Store}{Encoding}, then links to ...
QuerySearch Pattern Cookbook This topic provides tips on the usage of QuerySearch. Pattern 1: Show recent changes without user pages We have everything in the Ma...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
Appendix A: Foswiki Development Time line The complete timeline of Foswiki Releases. Foswiki was forked from TWiki 4.2.4 and released with significant improvments...
Foswiki Release 1.0.10 08 Sep 2010 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for pro...
Foswiki Release 1.1.10 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use ...
Foswiki Release 2.0.3 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
Foswiki Release 2.1.6 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
Foswiki Skins Skins overlay regular templates to give different looks and feels to Foswiki screens. Overview Foswiki uses skin templates as the basis of all ...
Slide Show Plugin Introduction There is already a de facto standard for presentations, so why this plugin? This plugin makes sense for organizations that already...
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 : ( . Th...
TWiki Source Code Packages This documentation is automatically generated from the pod, so it always matches the running code This package doesn't smell This pa...
Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Foswiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They ca...
Subscribe Plugin Example (only works if plugin is installed, and you are logged in you are: and you are not .WikiGuest): This version is designed for use w...
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 an...
Package TWiki::AccessControlException Exception used raise an access control violation. This exception has the following fields: * web the web which was bein...
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...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
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 plug...
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 b...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiEnhance...
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 s...
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 a...
Package TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that TWiki plugins can use to interact wi...
TWiki Glossary Simple glossary of TWiki terms Term Definition Attachment: Any type of file that is uploaded via browser and attached to a topic, where i...
Appendix A: TWiki Development Time line #HelsinkiRelease TWiki Release 5.0 (Helsinki) released on 2010 05 29 2010 10 10 New Features and Enhancements of TWiki ...
TWiki Installation Guide The following is installation instructions for the TWiki 5.0 production release on an Apache web server on Linux. Visit TWiki:TWiki.Insta...
Package TWiki::LoginManager 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 ...
Package TWiki::Merge Support for merging strings StaticMethod merge2 ($arev,$a,$brev,$b,$sep,$session,$info) * $arev rev for $a (string) * $a first ('o...
Package TWiki::Meta All TWiki topics have data (text) and meta data (information about the topic). Meta data includes information such as file attachments, form f...
TWikiNetSkin Introduction The TWikiNetSkin is functional and clean and has corporate appeal. It is the default skin provided with Twiki, Inc. products, designed ...
TWikiNetSkin Plugin Helps TWikiNetSkin to render tables and h2 headers. This plugin is only enabled if the skin is set to twikinet. Syntax Rules (none) Plugin S...
Package TWiki::OopsException Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser ...
TWiki Plugins Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You can add plugins to extend TWiki functionality,...
Package TWiki::Plugins This module defines the singleton object that handles Plugins loading, initialization and execution. This class uses Chain of Responsibilit...
Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this TWikiSite. _ NOTE:_ Don't edit this topic, changes...
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 pr...
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 c...
TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki Enterprise Collaborat...
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 info...
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 TWikiReleaseNotes04x00 ...
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 TWik...
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...
Release Notes of TWiki 5.0.1 (Helsinki), 2010 10 10 Introduction TWiki 5.0.0 released on 2010 05 29 is a major release introducing usability enhancements, featur...
TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki scripts are located in...
TWiki Skin Browser You can try out the TWikiSkins currently installed on this system: /System/TWikiSkinBrowser?skin=$pattern(.*\ Base Name\: ^\ \ *(\w).) pr...
TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. Overview TWiki uses TWikiTemplates files as the basis of all the ...
Package TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the "real" store provider which is hidden b...
Package TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. It is the base class of implementations of stor...
TWiki System Requirements Server and client requirements Low client and server base requirements are core features that keep TWiki widely deployable, particularly...
SlideShowPlugin for presentations Use the SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful for or...
Add New TWiki Tip Of The Day There are Custom Tips maintained on your local Foswiki installation, Official TWiki Tips maintained on the TWiki.org web site, and Pl...
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 to...
TWiki Upgrade Guide This guide covers upgrading from a previous version of TWiki (such as TWiki 4.3) to TWiki 5.0 Overview TWiki 5.0.0 is a major release introdu...
TWikiUserMappingContrib Introduction The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an extern...
TWiki Variables Special text strings expand on the fly to display user data or system info TWikiVariables are text strings %VARIABLE% or %VARIABLE{ parameter="v...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
Tag me Plugin Plugin to tag wiki content collectively in order to find content by tags and to get a meaningful page ranking. Introduction The larger a wiki gets,...
TWiki Text Formatting Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created...
TinyMCEPlugin This is an integration of the fast and highly functional TinyMCE WYSIWYG editor. It supports a wide range of browsers, including Firefox, IE, Safari...
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when conte...
TopMenuSkin The TopMenuSkin adds pulldown menus to the PatternSkin. Screen Shot Tob Bar and Menu Structure This skin is sponsored by: * TopMenuSkinTopBar t...
What is Topic Markup Language (TML)? The special text format used in Foswiki topics to simplify topic text. Foswiki lets you work using a WYSIWYG editor, which fo...
TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...
TwistyContrib Introduction This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections. TwistyContrib i...
TwistyPlugin A "twisty" is an interface toggle control to show and hide content. TwistyPlugin gives you several options to control the appearance of a twisty: ...
UpdatesPlugin Checks Foswiki.org for updates This plugin is used to keep administrators informed of updates to their installed extensions via a pop up message at ...
Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki to Foswiki 2.x. This upgrade procedure is used to upgrade a to a new major v...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
JQREQUIRE enable a plugin on the current page This macro will load a list of plugins to be added to the current page. Use JQPLUGINS to display the list of av...
PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API Use %PLUGINVERSION{"name"}% to get the version of a specific plugin Examples * %PLUG...
ATOM News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribe in We...
RSS News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribe in...
Wysiwyg Plugin Support for the integration of WYSIWYG (What You See Is What You Get) editors. On its own, the only thing this plugin gives you is a stand alone HT...