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 ...
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...
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...
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...
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...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. %BUTTON{ "" icon="fa book" target="/System/CompleteDo...
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...
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 ...
CLASSE Wiki 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...
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 ...
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...
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...
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...
FlexFormPlugin Description This plugin leverages the internal capabilities to render an interface for .DataForms and adds insights to the acutal DataForm defin...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and If...
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...
Full Calendar Plugin Adam Shaw has produced a great Web 2.0 Calendar UI, the jQuery FullCalendar Plugin. This Foswiki plugin provides the backend calendar managem...
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...
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...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
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...
What makes Foswiki .... the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ...
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 ...
#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...
ObjectPlugin The object is to use foswiki topics to store lots of objects (chunks of structured data) that can be searched, filtered and manipulated. The intentio...
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 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...
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...
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: *...
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...
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...
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 ...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
RenderPlugin Description This plugin implements a couple of REST handlers to feetch content from a Foswiki backend. This can either be returned as plain content ...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...
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...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
#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...
TinyMCE FAQs Frequently Asked Questions of the TinyMCEPlugin integration. Q: The editor takes over the standard edit screen. That's OK, but how do I get access t...
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...
Inline search To embed a search in a topic, use the %SEARCH{ parameters }% macro. The search macro is used by many Foswiki based applications. More Information....
TopicInteractionPlugin Description This plugin redesigns the way how users interact with topics and attachments in various ways: * improved attachment handlin...
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...
Topics What are Topics and Webs? #SystemWebFigure Figure: depiction of , ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the 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: ...
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 Settings preference settings customizable by users Some of the preference settings are explicitly intended to be customized by users, though a default is p...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
ADDTOHEAD deprecated, use ADDTOZONE instead This macro is deprecated. Please use VarADDTOZONE instead. It effecively is a shortcut for %ADDTOZONE{"head" ...}%
ALLVARIABLES list of currently defined macros Expands to a table showing all defined macros in the current context Deprecated 2009 04 29 in favour of SHOWPREF...
ATTACHURL full URL for attachments in the current topic Shorthand for PUBURL, with path set to the current topic. Otherwise supports all the same parameters as PU...
ATTACHURLPATH path of the attachment URL of the current topic Shorthand for PUBURLPATH with path set to the current topic. Otherwise supports all the same paramet...
AUTHREALM authentication realm String defined as the {AuthRealm} expert option in configure Security And Authentication tab, =Login sub tab.. This is used in cert...
BASETOPIC base topic where an INCLUDE started The name of the topic where a single or nested INCLUDE started same as %TOPIC% if there is no INCLUDE. This is the...
BASEWEB base web where an INCLUDE started The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there...
CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such...
CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar...
COVER current skin cover Extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, the skin search path becomes...
DATE signature format date Examples * %DATE% expands to == * Date format defined as {DefaultDateFormat} in configure When used in a template topic, thi...
DISPLAYTIME display formatted time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers...
#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...
ENDCOLOR end colored text ENDCOLOR is one of the shortcut macros predefined in . It is used to terminate a colour change (revert back to the default colour). The ...
ENDINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining text. A normal view...
ENDSECTION marks the end of a named section within a topic If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If th...
ENV inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is ...
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...
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups. * The macro is intended to...
HTTP get HTTP headers * Called with the name of an HTTP request header field, returns its value. Capitalization and the use of hyphens versus underscores are n...
HTTPS get HTTPS headers The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine wh...
ICON small documentation graphic or icon of common attachment types Generates a small graphic image from the set attached to . Images typically have a 16x16...
ICONURL URL of small documentation graphic or icon Generates the full URL of a image, which Foswiki renders as an image. The related %ICON{"name"}% generat...
ICONURLPATH URL path of small documentation graphic or icon Generates the relative URL path of a image, typically used in an HTML img tag. Specify image na...
IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...
#VarIMAGEGALLERY IMAGEGALLERY{"topic" options...} render an image gallery * The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin. * Syn...
INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as %TOPIC% in case there is no include. If a...
INCLUDINGWEB web that includes current topic The web name of the topic that includes the current topic same as %WEB% if there is no INCLUDE. If a topic is used ...
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...
KINOSEARCH tag If the KinoSearchPlugin is enabled, you will be able to use the KINOSEARCH tag to search indexed topics and attachments: * %KINOSEARCH{'Search S...
LANG the language specified by the server locale This macro is used to generate the lang (and xml:lang) attribute in generated HTML pages. If {UseLocale} is enabl...
LANGUAGE language code for the current user Returns the language code for the current user. This is the language used by Foswiki to generate the user interface. T...
LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is available. Parameters ...
LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload the system le...
LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty string "}%...
LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ...
MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...
META displays meta data Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta data (attachments, forms etc.)....
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...
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...
NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros...
PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...
PHOTOGALLERY render photo gallery from attachments The %PHOTOGALLERY% macro is handled by the PhotoGalleryPlugin. Parameters Parameter Description Defaul...
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...
PUBURL generate an URL for an attachment Generate an absolute URL for an attachment, or for a web or topic within the attachment database. Parameters ...
PUBURLPATH generate a relative URL for an attachment Generate a relative URL for an attachment, or for a web or topic within the attachment database. Parameters ...
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...
QUERYSTRING full, unprocessed string of parameters to this URL * String of all the URL parameters that were on the URL used to get to the current page. For exa...
REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...
REVARG rev=n parameter of current request %REVARG% If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten...
REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...
REVTITLE The requested revision as displayed in topic breadcrumbs If a topic revision is requested in the URL, it returns the printable revision of the current t...
SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) Examples * %SCRIPTN...
SCRIPTSUFFIX script suffix * Some CLASSE Wiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands...
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
SERVERTIME formatted server time Same format parameters as VarGMTIME GMTIME% , but displaying the server time instead of UTC. Examples * %SERVERTIME% els...
SESSIONID unique ID for this session Examples * %SESSIONID% expands to == Related UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE...
SESSIONVAR name of CGI and session variable that stores the session ID Examples * %SESSIONVAR% expands to Related UserAuthentication, AUTHREALM, SESSIONID,...
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...
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
SKIN current skin %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. The SKIN setting can be overridden using the URL parame...
SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for bac...
SPACEOUT renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit or a capital letter, and afte...
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the next %ENDINCLUDE% macro, or...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. Sections may be given a name to ...
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
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 ...
TOPIC name of current topic * %TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included top...
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 ...
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...
USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...
USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to...
WEB name of current web * %WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web w...
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...
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 CLASSE Wiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNA...
WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...
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 CLASSE Wiki home page This macro is an alias for the USE...
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...
This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...
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...
. %MAKETEXT{"Your name is also a potentially valid _1 .WikiWord WikiWord when used within a topic. However the home pages of registered users on this site ...
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...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...