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

A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMappingContrib ...

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

Admin tools * Documentation: Reference Manual * Site Tools : Configure, , InterWikis, Macros, Doc Graphics, Installed Plugins report * Manage Users ...

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

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

AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attach ...

This is a short introductory training course for Foswiki beginners. What is a Wiki? The basic function of Foswiki is a Wiki (if that helps!) A Wiki is like a web ...

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

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

Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, Sandbox.CommentPluginExamples ...

Compare Revisions Add On This add on compares the renderd HTML output of two revisions and shows the differences broken down to the word by word level if necessary ...

CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEnabled ...

Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentationCategory ...

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

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

DBCacheContrib Reusable code that caches Foswiki topics, and provides fast searches of the content. Summary of Contents This module supports fast structured queries ...

DBCachePlugin Description This is a lightweight frontend to the DBCacheContrib. The provided macros DBQUERY and DBCALL can be used as a replacement for SEARCH and ...

Data Forms Data forms allow you to add structured data to topics. The data stored in the form fields can be used to search and filter topics. The combination of structured ...

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

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

Developer Documentation Application Developer Topics Topics for normal users that want to develop Foswiki applications. Reference $ ReferenceManual : Documentation ...

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

EditRowPlugin Features: 1 You can edit one row, or even one cell at a time, instead of having to edit the entire table. 1 Supports footer rows. 1 Supports ...

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

ExtendedWebListPlugin Description The current built in WEBLIST macro does not have the capability of only showing subwebs within the current top level web. This plugin ...

Some questions to answer: * Perhaps the plugin is installed, but did you remember to enable it in configure? * Did the installer mention any missing dependencies ...

FilterPlugin Description This plugin allows to substitute and extract information from content by using regular expressions. There are three different types of new ...

Footnote Plugin Support for footnotes in foswiki topics. Syntax Rules Write (1) anywhere in a topic. This will be replaced with a link to the note at ...

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

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

GluePlugin Description Powered by WikiRing Consultants This plugin will help you to write readable markup (TopicMarkup, HMTL, ...) by allowing tags ...

History Plugin This plugin shows a complete or partial history of a document. The output can arbitrarily be formatted. An example for a Wikipedia like history is included ...

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 This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server. If you ...

This site is running Foswiki version *, Plugin API version * Installed Plugins Here is a list of the plugins currently installed and enabled in the configuration ...

Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are 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 by UseMod ...

JEditableContrib This add on packages up the jQuery "JEditable" plugin from Miko Tuupala. This excellent little plugin gives you edit in place capability with many ...

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

JQTwistyContrib JQTwistyContrib is a lightweight twisty plugin implementing a subset of the features provided by .TwistyPlugin, but using javascript only. This comes ...

JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically populate ...

JQueryAutocomplete %JQPLUGINS{"autocomplete" format=" Homepage: $homepage Author(s): $author Version: $version " }% Warning: This plugin is deprecated ...

JQueryBgiframe %JQPLUGINS{"bgiframe" format=" Homepage: $homepage Author(s): $author Version: $version " }% A jQuery plugin that helps ease the pain ...

JQueryBlockUI %JQPLUGINS{"blockui" format=" Homepage: $homepage Author(s): $author Version: $version " }% The jQuery BlockUI Plugin lets you simulate ...

JQueryButton %JQPLUGINS{"button" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a simple way to render nice buttons ...

JQueryChili %JQPLUGINS{"chili" format=" Homepage: $homepage Author(s): $author Version: $version " }% Chili is the jQuery code highlighter plugin ...

JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks. ...

JQueryCookie %JQPLUGINS{"cookie" format=" Homepage: $homepage Author(s): $author Version: $version " }% Easy cookie handling using jQuery. Usage ...

JQueryCorner %JQPLUGINS{"corner" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin adds cross browser support for ...

JQueryCycle %JQPLUGINS{"cycle" format=" Homepage: $homepage Author(s): $author Version: $version " }% The jQuery Cycle Plugin is a lightweight slideshow ...

JQueryDebug %JQPLUGINS{"debug" format=" Homepage: $homepage Author(s): $author Version: $version " }% Simple jQuery logger / debugger using firebug ...

JQueryEasing %JQPLUGINS{"easing" format=" Homepage: $homepage Author(s): $author Version: $version " }% Uses the built in easing capabilities added ...

JQueryEmpty %JQPLUGINS{"empty" format=" Homepage: $homepage Author(s): $author Version: $version " }% Template plugin for jQuery plugins integrated ...

JQueryFarbtastic %JQPLUGINS{"farbtastic" format=" Homepage: $homepage Author(s): $author Version: $version " }% Farbtastic is a jQuery plug in that ...

JQueryFluidFont %JQPLUGINS{"fluidfont" format=" Homepage: $homepage Author(s): $author Version: $version " }% Recompute the font size of an element ...

JQueryFocus %JQPLUGINS{"focus" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin sets the focus on a form input field ...

JQueryForm %JQPLUGINS{"form" format=" Homepage: $homepage Author(s): $author Version: $version " }% The jQuery Form Plugin allows you to easily and ...

JQueryFoswiki %JQPLUGINS{"foswiki" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is plugin takes care of loading the ...

JQueryGradient %JQPLUGINS{"gradient" format=" Homepage: $homepage Author(s): $author Version: $version " }% Adds a gradient to the background of an ...

JQueryHoverIntent %JQPLUGINS{"hoverintent" format=" Homepage: $homepage Author(s): $author Version: $version " }% hoverIntent is similar to jQuery ...

JQueryInnerFade %JQPLUGINS{"innerfade" format=" Homepage: $homepage Author(s): $author Version: $version " }% InnerFade is a small plugin for the ...

JQueryLiveQuery %JQPLUGINS{"livequery" format=" Homepage: $homepage Author(s): $author Version: $version " }% How to use it Live Query utilizes the ...

JQueryLoader %JQPLUGINS{"loader" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin allows to delay rendering parts ...

JQueryLocalScroll %JQPLUGINS{"localscroll" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin will animate a regular ...

JQueryMaskedInput %JQPLUGINS{"maskedinput" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a masked input plugin for ...

JQueryMasonry %JQPLUGINS{"masonry" format=" Homepage: $homepage Author(s): $author Version: $version " }% Masonry is a layout plugin for jQuery. Think ...

JQueryMedia %JQPLUGINS{"media" format=" Homepage: $homepage Author(s): $author Version: $version " }% jQuery Media Plugin for converting elements ...

JQueryMetadata %JQPLUGINS{"metadata" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin is capable of extracting metadata ...

JQueryMigrate %JQPLUGINS{"migrate" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin can be used to detect and restore ...

JQueryPNotify %JQPLUGINS{"pnotify" format=" Homepage: $homepage Author(s): $author Version: $version " }% Full featured plugin to show temporary ...

JQueryPlaceholder %JQPLUGINS{"placeholder" format=" Homepage: $homepage Author(s): $author Version: $version " }% Creates a 'hint' or 'example' text ...

JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add ...

JQueryPopUpWindow %JQPLUGINS{"popupwindow" format=" Homepage: $homepage Author(s): $author Version: $version " }% Open a page in a new window. Macros ...

JQueryQueryObject %JQPLUGINS{"queryobject" format=" Homepage: $homepage Author(s): $author Version: $version " }% This extension creates a singleton ...

JQueryRating %JQPLUGINS{"rating" format=" Homepage: $homepage Author(s): $author Version: $version " }% The Star Rating Plugin is a plugin for the ...

JQueryScrollTo %JQPLUGINS{"scrollto" format=" Homepage: $homepage Author(s): $author Version: $version " }% With this plugin, you will easily scroll ...

JQuerySerialScroll %JQPLUGINS{"serialscroll" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin allows you to easily ...

JQueryShake %JQPLUGINS{"shake" format=" Homepage: $homepage Author(s): $author Version: $version " }% Warning: This plugin is deprecated. The shake ...

JQueryShrinkUrls %JQPLUGINS{"shrinkurls" format=" Homepage: $homepage Author(s): $author Version: $version " }% Shrinks all urls in a given container ...

JQuerySimpleModal %JQPLUGINS{"simplemodal" format=" Homepage: $homepage Author(s): $author Version: $version " }% SimpleModal is a lightweight jQuery ...

JQuerySlimbox %JQPLUGINS{"slimbox" format=" Homepage: $homepage Author(s): $author Version: $version " }% Show images in a lightbox. Slimbox 2 is ...

JQuerySuperfish %JQPLUGINS{"superfish" format=" Homepage: $homepage Author(s): $author Version: $version " }% Superfish is an enhanced Suckerfish ...

JQuerySupersubs %JQPLUGINS{"supersubs" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a companion plugin to superfish ...

JQueryTabpane Plugin Info %JQPLUGINS{"tabpane" format=" Homepage: $homepage Author(s): $author Version: $version " }% Summary This implements an ...

JQueryTextboxList %JQPLUGINS{"textboxlist" format=" Homepage: $homepage Author(s): $author Version: $version " }% Description Turns a text input ...

JQueryTmpl %JQPLUGINS{"tmpl" format=" Homepage: $homepage Author(s): $author Version: $version " }% jQuery templates contain markup with binding expressions ...

JQueryTooltip %JQPLUGINS{"tooltip" format=" Homepage: $homepage Author(s): $author Version: $version " }% Display a customized tooltip instead of ...

JQueryTreeview %JQPLUGINS{"treeview" format=" Homepage: $homepage Author(s): $author Version: $version " }% Lightweight and flexible transformation ...

JQueryUI %JQPLUGINS{"ui" format=" Homepage: $homepage Author(s): $author Version: $version " }% Widget collection for jQuery. This is the official ...

JQueryUIAutocomplete %JQPLUGINS{"ui::autocomplete" format=" Homepage: $homepage Author(s): $author Version: $version " }% Autocomplete, when added ...

JQueryUIDialog Summary %JQPLUGINS{"ui::dialog" format=" Homepage: $homepage Author(s): $author Version: $version " }% A dialog is a floating window ...

JQueryUITooltip Summary %JQPLUGINS{"ui::tooltip" format=" Homepage: $homepage Author(s): $author Version: $version " }% Usage To load the library ...

JQueryValidate %JQPLUGINS{"validate" format=" Homepage: $homepage Author(s): $author Version: $version " }% Very powerful client side form validation ...

JQueryWikiWord %JQPLUGINS{"wikiword" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin allows to create a WikiWord ...

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

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

What makes Foswiki the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively * If ...

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

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

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

NatEditWordHelpText Help text for the NatEditPlugin editor * * * * * * * B = Bold * I = Bold * _ = Underline * = Strike * ...

The Natural Skin NatSkin improves your Foswiki experience by bringing together some of the most useful features from different plugins in a consistent way. NatSkin ...

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

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

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 Foswiki maintenance. This is a notification. Normal ...

%IF{ "''=''" then="No module was specified. Check Developing plugins and Developer's Bible for more information." }% " level="1"}%

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

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

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

Redirect Plugin I typically use this to make easy to type shortforms/acronyms of topic names. For example: * Actual content appears under Main.LightweightDirectoryAccessProtocol ...

Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wiki ...

Appendix A: Foswiki Development Time line Foswiki Release 1.1.2 10 Nov 2010 Foswiki 1.1.2 was built 10 Nov 2010. It is a release that fixes some very important ...

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

Foswiki Release 1.1.2 10 Nov 2010 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional ...

RenderFormPlugin The RenderFormPlugin handles the tag %RENDERFORM{...}%. The tag will be replaced by a form that is defined and looks like .DataForms. It helps you ...

Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generated ...

RenderPlugin Description Powered by WikiRing Consultants This plugin implements three simple REST handlers to get content from Foswiki. For example ...

SiteMenu Definition of site wide horizontal menu Implementation %IF{"'' ingroup 'AdminGroup'" then="$percntINCLUDE{\".SiteMenu\" section=\"adminmenu ...

Slide Show Plugin Introduction There is already a defacto standard for presentations, why this plugin? This plugin makes sense for organizations that do already have ...

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

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

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

TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTEMWEB ...

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

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

TinyMCE Editor Help Summary * Normal Normal text style * Heading 1 6 Headings; 1 is largest * On save, content in this HTML editor is automatically ...

SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when content ...

TopicClassificationAddOn Topic Classification Add On TopicClassificationAddOn (aka TCAO) helps you organize the content in your wiki by classifying topics according ...

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

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

TopicInteractionPlugin This plugin redesigns the way how users interact with topics and attachments in various ways: * improved attachment handling * improved ...

Tree Browser Plugin Renders a bulleted or numbered list as a collapsible/expandable tree of nodes. Acknowledgment This plugin leverages the dTree JavaScript tree ...

Tree Plugin Syntax Rules %TREEVIEW{}% displays topic children in a hierarchical tree %TREE{}% synonym of %TREEVIEW{}% Parameter Description Default web ...

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

Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki or TWiki (such as Cairo or TWiki4.0) to Foswiki 1.0 (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 same ...

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

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

#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDPLUGINS ...

#VarJQPLUGINS JQPLUGINS{"plugins" ... } display a summary of available plugins * Parameters: Parameter: Description: Default: "plugins" ...

#VarJQREQUIRE JQREQUIRE{"plugin, plugin, ... "} enable a plugin on the current page * This macro will load a list of plugins to be added to the current page ...

#VarPLUGINDESCRIPTIONS PLUGINDESCRIPTIONS list of plugin descriptions * Syntax: %PLUGINDESCRIPTIONS% * Expands to: * Related: ACTIVATEDPLUGINS, FAILEDPLUGINS ...

#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specific ...

#VarTABLE TABLE{ attributes } control attributes of tables and sorting of table columns * The %TABLE{}% macro is handled by the TablePlugin * Syntax: %TABLE ...

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

" warn="off"}% * ** * * * * * * * * * * * BeginnersStartHere * TextFormattingRules * Macros ...

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

WikiWorkbenchContrib Introduction The WikiWorkbench standardizes writing, deploying and using wiki applications on Foswiki. It builds on the core concepts of standard ...

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