Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
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...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
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...
ModPerlEngineContrib Overview This is a runtime engine component from Foswiki Standalone architecture. mod_perl is the Perl API to the Apache web server. It perm...
PlainFileStoreContrib This is a full implementation of a Foswiki store that uses nothing more sophisticated than plain files and directories In the Foswiki spirit...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
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...
CompareRevisionsAddOn Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the compariso...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
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...
Release Notes 2.1.x Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use in ...
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...
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: ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
Mailer Contrib Allows users to "subscribe" to regularly scheduled emails containing either: * A report on changes to all topics that have changed within a part...
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...
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 ...
PerlDoc See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, T...
This answer assumes you have basic knowledge about Data Forms. Using the steps below, you will create: 1 A form definition 1 A topic creation (HTML) form to...
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 e...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
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...
SkinTemplateViewTemplate is a Skin Template So should not be viewed directly. Use to see the Template source. ** Skin Templates Set VIEW_TEMPLATE=SkinTemplateVie...
%{ FAQ topic templates This skin template is used to view FAQ questions and answers. It overrides the content portion of the default view template, and removes t...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. %BUTTON{ "" icon="fa book" target="/System/CompleteDo...
SiteChanges %IF{"context isadmin" then='$percntT$percnt This topic can be resource intensive on a large site with a large public web. The Foswiki:Extensions.SolrP...
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...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
Bulk Registration Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. Unlike normal registratio...
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 inst...
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...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEna...
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...
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 ...
Documentation Graphics and Filetype icons This is a Foswiki icon library. The graphics can be used in topics and by web applications. Usage Default notation: %I...
Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...
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...
FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons...
Formatted Search Customize the display of search results. The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. U...
HomePagePlugin Usage This plugin makes the Default frontpage configurable 1 any time a user goes to they will be shown the topic configured by the Foswiki...
IF statements The %IF% macro gives you the ability to test for macro values, URL parameters, access permissions, topic existence and more. Syntax In the example ...
Include Topics and Web Pages Using %INCLUDE{...}% Macro Embed topics, or subsections of topics, or other web pages. The %INCLUDE{...}% macro embeds the content of...
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...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks....
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...
Managing Topics Browser based rename, move, copy, and delete for individual topics Overview You can use browser based controls to change a name of a topic, move ...
Manage Users Register users on your Foswiki site; change/reset/install passwords; remove user accounts Some of the features below may be disabled, depending on ...
#MetaData Meta data Additional data, Foswiki generated or from forms, may be embedded in the topic text using META: macros Overview The default store engines st...
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: ...
Pattern skin Select a theme to change the look, or tune the entire appearance with CSS or templates. Browse available themes You may quickly change the appearanc...
.PatternSkin CSS Cookbook Questions and answers on how to customize the default look of Foswiki for your own needs, using style sheets. For configuring page eleme...
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 exa...
PatternSkinCssCookbook Recipe: EditTable style Cookbook example to illustrate control over EditTable edit styles. 1 EditTable uses a monospace font in edit mod...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL...
PatternSkinCssCookbook Recipe: Hide action buttons This recipe shows how to hide the action buttons for unauthorised and/or guest users: (Edit, Attach ...) Note t...
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: * Set USERSTYLEURL = //PatternSkinCssCookbookNoLeftBar/hideleftbar...
PatternSkinCssCookbook Recipe: Hide the top bar This recipe shows how to hide the top bar. This line loads the extra style definition: * Set USERSTYLEURL=/noto...
PatternSkinCssCookbook Recipe: Sidebar background color To see if the background color really extends beyond the body, we make the body contents longer than the s...
System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
PatternSkin horizontal navigation example Include main navigation with: This is done automatically in the templates by setting in the .SitePreferences: * #Set ...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre...
Foswiki Plugins Extensions that use a simple API to talk to Foswiki Overview You can add plugins to extend Foswiki functionality without altering the core code. ...
#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...
Foswiki brand material The official Foswiki logo and derivatives are attached to this page. Logo artwork Logo customization The logo can be changed by redefinin...
Query Search Query searches help you search the contents of forms attached to your topics, as well as the values of other meta data attached to the topic. Using q...
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...
RCSStoreContrib Foswiki 2.0 and later only This is the modern implementation of the classic Foswiki RCS based store. It has been moved into a contrib as other sto...
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 ...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded...
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...
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 p...
System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
#TemplateTopics Template topics Foswiki uses several types of templates. Template topics are topics that define the default text for new topics. (If you are look...
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...
Linking to a file attachment A link to a file attachment may be created in a few different ways: 1 If using the WYSIWYG editor (TinyMCEPlugin), use the attach ...
Escaping Foswiki rendering Use the verbatim tag to surround code excerpts and other formatted text with = verbatim = and = /verbatim = tags. For Example: verbati...
Server side include To include the contents of a web page or Foswiki topic, use %INCLUDE{"page"}%. Examples: This example requires {INCLUDE}{AllowURLs} enabled in...
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spa...
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $...
Tips Contrib Package Displays a rotating "Tip of the Day" to help familiarize new users with Foswiki features. Includes an application for creating custom tips fo...
TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...
Topics What are Topics and Webs? #SystemWebFigure Figure: depiction of , ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the web...
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 Authentication Controlling who can access your site Overview Authentication, or "login", is the process by which a user lets Foswiki know who they are. Know...
User Registration components This topic contains the pieces that are assembled into the UserRegistration page. There is no need to modify this topic. If a sectio...
User Settings preference settings customizable by users Some of the preference settings are explicitly intended to be customized by users, though a default is p...
#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * ...
ENCODE encode characters in a string Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or se...
EXPAND expand macros in a string as if they were used in another topic The viewer must have VIEW access to topictoexpandin for this to work. All the standard form...
IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...
JQICONPATH render the url path to an image icon This is a shortcut for: Note that this macro only makes sense for image icons, those that refer to a single image ...
MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...
METASEARCH special search of meta data METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and QuerySearch. Param...
QUERY get the value of meta data Uses the query syntax described in QuerySearch to get information about meta data from one specified topic. * supports formatt...
REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
TABPANE tabpane widget This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this: ...
TOC table of contents Shows a Table of Contents that is generated automatically based on headings of a topic. Headings in TopicMarkupLanguage (" text") and HTML ...
TOPICLIST topic index of a web List of all topics in a web. The "format" defines the format of one topic item. It may include formatting tokens: The $topic token ...
WEBLIST index of all webs Generate a list of webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the fo...
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...
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are used to refer to topics. WikiWords refer to topics...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...
Page Caching How to get the best from HTML Caching. By default, Foswiki pages are delivered to the browser using HTML, which is regenerated from the data stored i...
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...
TWISTY generate content block with interactive visibility controls This renders the button as well as the toggled content section contained within this and the cl...
TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. Parameters All parameters...
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...
FastCGI Engine Contrib Permits Foswiki to be executed with FastCGI Overview FastCGI is a technology to deliver dynamic web content. It differs from CGI cause it ...
Administrator Skills Assumptions Several skills (i.e. knowing how to do something) are needed to set up and maintain a Foswiki installation. Remember that several...
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. Att...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
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...
SET set a preference setting during runtime A preference setting created via %SET{}% will only be usable in the topic where it has been found by the parser, simil...
Templates for CommentPlugin See CommentPlugin: Customisation for help. While this topic can be viewed as a topic, it is used by the CommentPlugin as a template fi...
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...
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...
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
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...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...