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...
NatEditHelpText Help text for the NatEditPlugin editor About the editor This edit interface is available in two different modes: (1) WYSIWYG (what you see is what...
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 ...
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...
JQTHEME switch jQuery UI theme Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to foswiki. Use configure to cha...
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: ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
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....
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 ...
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...
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...
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...
Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
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 ...
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: ...
CacheContrib Description This package is used by other extensions in need of caching services. This specific cache stores data for a short period time, e.g. one ...
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 ...
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...
GridLayoutPlugin Description GridLayoutPlugin implements a 12er grid system for flexible layouts. A grid is a set of HTML div elements that are styled in a way ...
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...
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...
JQRCodeContrib QR code generator This plugin lets you generate QR codes of arbitrary content. Simply surround a text fragment with a DIV element of class qrcode. ...
QRCodePlugin Description This plugin lets you generate QR codes in your wiki apps. You simply feed it a string and it will render the QR image for it. You type: ...
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...
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...
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 ...
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...
LdapContrib Introduction This package offers basic LDAP services for Foswiki and offers authentication of wiki users by binding to an LDAP server as well as inco...
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...
TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...
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...
SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCRIBE{...}% or si...
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...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
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...
PlainFileStoreContrib This is a full implementation of a Foswiki store that uses nothing more sophisticated than plain files and directories In the Foswiki spirit...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...
History of Foswiki Appendix A: Foswiki Development Time line Foswiki Release 2.1.4 31 May 2017 Foswiki 2.1.4 was built on 31 May 2017. It is a release that co...
Foswiki Release 2.1.4 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform...
Installation Guide This guide describes the steps for installing Foswiki, with specific steps for installations on Linux with the Apache web server. If you would ...
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...
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...
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...
USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...
WIKINAME your Wiki username The WikiName is the same as %USERNAME% if not defined in the . topic. This macro is an alias for the USERINFO macro with a fixed forma...
WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your Foswiki home page This macro is an alias for the USERINF...
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded...
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 ...
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...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
SiteChanges Recent changes %IF{"context isadmin" then=' This topic can be resource intensive on a large site with a large public web. The Foswiki:Extensions.SolrP...
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...
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...
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...
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...
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...
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 loc...
Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...
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 ...
Pending Registrations Template Tailoring instructions: The contents of the Pending Registrations report can be modified to report any fields collected on a custo...
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...
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...
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...
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...
System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...
.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...
WIKIAGENTEMAIL From: email address in emails sent by Foswiki. Examples * %WIKIAGENTEMAIL% expands to == Related WIKIAGENTNAME, WIKIWEBMASTER, WIKIWEBMASTERNA...
WIKIAGENTNAME From: Name used in emails sent by Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
#VarIMAGEGALLERY IMAGEGALLERY{"topic" options...} render an image gallery * The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin. * Syn...
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...
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...
Welcome to Foswiki Welcome to Foswiki! This site is a meeting place to work on common interests. Anyone can contribute using any web browser. Foswiki looks like a...
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...
Perl dependencies for Foswiki and Extensions This topic lists the dependencies required by the Foswiki core and installed extensions. It is designed to help admin...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }...
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...
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 ...
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...
Foswiki is distributed under the Gnu General Public License, and sources are freely available. When you download an official Foswiki package from https://foswiki....
Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, ...
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...
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...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
What makes Foswiki .... the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ...
Project Contributor Foswiki is a development of the Foswiki community. Foswiki is based on TWiki , which was originally written by Peter Thoeny, who based his wor...
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...
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 ...
Search Help Search basics By default a search looks into topic titles, topic texts and form fields in the current web. Extend your search to "all public webs" to...
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 ...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
NONCE generate a nonce (developers only) DEVELOPERS ONLY This macro is used to generate a 'nonce', a unique key that identifies the source of a request in order t...
This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...
Wiki culture, concepts and principles General concept and idea of wikis. General concept and idea of wikis What is a wiki? "A wiki is a page or collection of We...
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...
FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons...
%IF{"context isadmin AND NOT istopic '.UserRegistration'" then=' Tailoring instructions: You are currently viewing the default registration page without local tai...
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...
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...
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...
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 ...
This topic is included from the WebLeftBarExample and other WebLeftBar topics, to provide a dynamic list of webs accessible to the current user. Webs meeting the ...
Foswiki Server Information This topic lists the detailed server execution environment. As this is sensitive information, it is only available to users with acces...