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...
A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMapp...
Administrator Skills Assumptions Note: If you aren't already fairly well skilled in Linux/Unix/Windows, Apache, and so on, consider using a version in a pre packa...
Attachment List Plugin Displays a formattable list of topic attachments from any topic anywhere in a topic. View permissions are honored: if the user is not a...
AutoCompletePlugin This plugin allows you to create an autocomplete input field based on Yahoo's User Interface Library. This plugin originally implemented Arthur...
AutoTemplatePlugin %IF{"context 'AutoViewTemplatePluginEnabled' and context 'AutoTemplatePluginEnabled'" then=" WARNING: You have enabled both AutoTemp...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
This is a short introduction to Foswiki. What is a Wiki? The basic function of Foswiki is a Wiki (if that helps!) A Wiki is like a web site, except that you can ...
BreadCrumbsPlugin Description This plugin helps you to locate where you are, and shows you how you can escape from there using breadcrumbs navigation. Two types ...
CalDAVPlugin This plugin provides a link between a remote CalDAV server and the CalendarPlugin. CalDAV is a protocol used by many calendaring applications, two of...
Calendar Plugin The CalendarPlugin handles the macro %CALENDAR% that inserts a monthly calendar in the page. Multiple topics can be specified as the source of the...
ClassificationPlugin Description ClassificationPlugin is a taxonomy and folksonomy extension for Foswiki that allows you to manage knowledge assets stored in yo...
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...
Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the comparison is done with the rend...
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. Foswik...
Add Ons Add functionality with extensions not based on the Foswiki scripts. Overview An add on runs separately from the Foswiki scripts, e.g. for data import, ex...
DBCacheContrib Reusable code that caches Foswiki topics, and provides fast searches of the content. Summary of Contents This module supports fast structured quer...
DBCachePlugin Description This is a lightweight frontend to the DBCacheContrib. The provided macros DBQUERY and DBCALL can be used as a replacement for SEARCH an...
DBConnectorPlugin Enables you to use simple methods to store and read data for topics. The Editor is included in the plugin use it right away Introduction This...
Data Forms This page introduces structured data, and explains how to set up and work with data forms. Overview Next to freeform topic contents, each topic can st...
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 Application Developer Topics Topics for normal users that want to develop Foswiki applications. Reference $ ReferenceManual : Doc...
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. Plugin Preferences Plugin preferences should be set using configure, as described in .Dev...
ExtendedWebListPlugin Description The current built in WEBLIST macro does not have the capability of only showing subwebs within the current top level web. This ...
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...
Footnote Plugin Support for footnotes in foswiki topics. Syntax Rules Write {{ note text }} anywhere in a topic. This will be replaced with a link to the note at...
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 Term Definition Attachment Any type of file that is uploaded via browser and attached to a topic, where it can be viewed and downloade...
GluePlugin Description This plugin will help you to write readable markup (TopicMarkup, HMTL, …) by allowing tags and arguments to be formatted on multiple lin...
History Plugin Shows a complete history of a topic. The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using Patte...
ImageGalleryPlugin Description This plugin helps you in viewing pictures that are attached to a topic in a nice thumbnail gallery. Clicking on a thumbnail zooms...
ImagePlugin Use this plugin to control the display and alignment of images using an easy syntax and support for server side resizing and thumbnailing. There are a...
Installation Guide Part 2 Return to or see the Complete Installation Guide on one page Beyond the basic installation Once you have Foswiki installed and run...
This site is running Foswiki version * * "}%, Release , Foswiki API version * Installed Plugins 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 Site 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...
JQDataTablesPlugin Overview This plugin implements a widget to enhance normal HTML tables with extra navigation features such as sorting, filtering and paginatin...
JQGridPlugin jqGrid is an Ajax enabled JavaScript control that provides solutions for representing and manipulating tabular data on the web. Since the grid is a c...
JQTwistyContrib JQTwistyContrib is a lightweight twisty plugin implementing a subset of the features provided by .TwistyPlugin, but using javascript only. This co...
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...
JSTreeContrib This add on packages up the jQuery "jsTree" plugin to give you poserful support for display and manipulation of n ary tree data. See http://www.jstr...
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...
ListyPlugin This plugin implements an interactive list manager. A "Listy" is a collection of text or links that can be maintained easily using modal dialogs, drag...
Macros Special text strings expand on the fly to display user data or system info Macros are text strings in one of two forms: These usually expand into content w...
What makes Foswiki the ideal collaboration tool? Foswiki is… Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively * ...
Media Plugin . Uses the OBJECT html tag to embed arbitrary content into a page, with a particular bent towards media: common media formats are detected and some "...
MetaDataPlugin This plugin allows to store data sets to Foswiki topics. Foswiki itself is a structured wiki already using .DataForms which are attached a topic. ...
MoreFormfieldsPlugin Description This plugin implements a set of additional special purpose formfields to be used in DataForm definitions. To make use of these f...
MultiLingualPlugin This plugin enables you to create wiki content in multiple languages. While Foswiki normally supports over 20 languages to internationalize its...
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...
The Natural Skin NatSkin improves your Foswiki experience by bringing together some of the most useful features from different plugins in a consistent way. NatSki...
NatSkinFAQ The documentation of NatSkin is crap. I'm lost! If you need help, there are a couple of options: * Create a support request on Foswiki:Support/WebH...
The Natural Skin Plugin Description This is the supplemental plugin for the NatSkin. Its main purpose is to supply "skin states" to control different styles and ...
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: ...
Page Caching By default, Foswiki pages are delivered to the browser using HTML, which is regenerated from the data stored in Foswiki each time the page is reques...
Pattern Skin Elements Some intro text. Text. Heading 1 text Heading 2 text Heading 3 text Heading 4 text Heading 5 text Heading 6 text A very very very ver...
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...
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 ...
PublishPlugin Generates a static view of a web, as HTML files on disc, or as a PDF, or as a zip or tgz archive file, or by uploading directly to an FTP server. Or...
This is a template topic for use with PublishPlugin. It illustrates how to set up a topic in a web to simplify publishing. To use it, take a copy of the raw text ...
Interface for Plugin and Contrib Developers See .DevelopingPlugins for more information. Package First Published Comment Foswiki::Func 1.1.5 Main AP...
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...
Redirect Plugin I typically use this to make easy to type shortforms/acronyms of topic names. For example: * Actual content appears under Main.LightweightDirect...
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 Foswiki Release 2.0.3 15 Nov 2015 Foswiki 2.0.3 was built on 15 Nov 2015. It is a release that contains 17 fixes and ...
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...
RenderFormPlugin The RenderFormPlugin handles the tag %RENDERFORM{...}%. The tag will be replaced by a form that is defined and looks like .DataForms. It helps yo...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
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...
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...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
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,...
Text Formatting Working in Foswiki 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 aut...
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...
TopicClassificationAddOn Topic Classification Add On TopicClassificationAddOn (aka TCAO) helps you organize the content in your wiki by classifying topics acco...
Topic Create Plugin This Plugin allows you to automatically create topics or attach files at topic save time. This is typically used by Foswiki applications to c...
Topic Data helper plugin Helper plugin for collecting, filtering and sorting data objects, to be used by other plugins. This plugin is used by Foswiki:Extensions/...
TopicInteractionPlugin This plugin redesigns the way how users interact with topics and attachments in various ways: * improved attachment handling * improv...
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...
TopicSpecificNavigationPlugin This plugins introduces a new navigation type for each topic: It should be used to place things like related links, further readups ...
Tree Plugin Syntax Rules %TREEVIEW{}% displays topic children in a hierarchical tree %TREE{}% synonym of %TREEVIEW{}% Samples See the following page for sample...
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 or TWiki (such as Cairo or TWiki4.0) to Foswiki 1.1 (References to Cairo are...
UploadPlugin This plugin provides a more flexible interface to upload one or more files to a topic. Using standard means, only one file can be uploaded at the sam...
A List of User Documentation $ AccessKeys : Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer sof...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, F...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDP...
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...
#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specif...
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. Subscribed in W...
WebLinkPlugin This plugin allows to render a link to a web. While linking to a topic is quite essential to wikis, linking to a web as an object of the wiki isn't ...
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 Web...
WikiWorkbenchContrib Introduction The WikiWorkbench standardizes writing, deploying and using wiki applications on Foswiki. It builds on the core concepts of sta...
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...