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...
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...
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...
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...
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,...
Tag me Plugin AJAX helper This topic contains INCLUDE sections. See TagMePlugin for instructions. %FORMATLIST{ "" format="$1$n" split="\s*,\s*" header=" " fo...
Tag me: Change Requests Note: * Renaming and deleting of tags is ususally done by users that have received permissions to do this. Permissions are set in TagM...
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 ...
Pending Registrations Template Tailoring instructions: The contents of the Pending Registrations report can be modified to report any fields collected on a custo...
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...
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
Black List Plugin Description This is a simple utility to keep black sheep away from a public Foswiki site. The site can be protected against excessive page acce...
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...
Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }...
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, ...
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...
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...
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...
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...
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...
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...
Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ...
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...
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...
Tips Tips are tips and hints contributed by users. Use this form to search for tips. You can contribute new tips here. Search (perl regular expression): " decode...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Test this theme Choose column ' selected='selected' "}% Column right No column Hide theme Store theme...
Pub Link Fixup Plugin This plugin performs pub link fixup of the generated HTML page. If Foswiki is configured with a non utf 8 {Store}{Encoding}, then links to ...
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...
FamFamFamFlagIcons 'Flags' are 247 icons in GIF and PNG formats representing most countries in the world as small pixel icons. These flag icons are available ...
FamFamFamFoswikiExtras So far built by Foswiki:Main.SvenDowideit based on the Silk ones above, except for 1 the XML icon which comes from http://commons.wiki...
FamFamFamMiniIcons "Mini" is a set of 144 GIF icons available for free use for any purpose. Source These Icons come from http://www.famfamfam.com/lab/icons/mini/...
FamFamFamMintIcons "Mint" icons are a small set of tiny PNG web icons, loosely based on Shaun Inman's Mint statistics software. Released on the same day as the p...
FamFamFamSilkCompanion1Icons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. Damien Guard's se...
FamFamFamSilkCompanion2Icons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. GeoSilk icon set...
FamFamFamSilkGeoSilkIcons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. GeoSilk icon set by...
FamFamFamSilkIcons Silk is a smooth, free icon set, containing over 700 16 by 16 pixel icons in strokably soft PNG format. Containing a large variety of icons, y...
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is se...
CSS elements in PatternSkin This page is a reference for all CSS classes used in PatternSkin. PatternSkin uses 4 stylesheets: * layout.css: positioning of bloc...
PatternSkin theme: Foswiki release 1.1.5 Use this theme if you have created a theme or sub skin that relies on the styling of PatternSkin around release 1.1.5 or ...
PatternSkin theme: 2009 Test this theme Choose column ' selected='selected' "}% Column left (default) Column right No column Small left column Choose v...
Plain Skin The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any marku...
Background Image for Preview Preview looks like the real page, but the links lead to an oops dialog warning users of not yet saved topics. In addition, a backgrou...
Print Skin The print skin, used for printable pages with a small footer. Other skins, such as PatternSkin, may introduce their own print skin. This skin is part o...
Appendix C: CSS Listing of CSS class names emitted from Foswiki core code and standard extensions. With Foswiki 2.0 a number of classes have been deprecated. Thes...
Re parenting a topic The breadcrumbs ( Contribs TipsContrib TipsOfTheDay , for example) of any topic is constructed automatically in Foswiki by foll...
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Default settings: (nev...
Edit tables with EditRowPlugin EditRowPlugin allows you to edit tables using edit fields and drop down boxes. Tables have an button if preceeded by an %EDITTAB...
Tips Of The Day These are all tips of the day. They are located in the web (official distribution tips) and web (custom tips). Custom (local) tips Total: Cus...
Add New Tip Of The Day There are Custom Tips maintained on your local Foswiki installation, Official Tips distributed with the Tips Contrib, and Plugin Tips maint...
AntiWikiSpamPlugin Stop your wiki getting spammed This plugin attempts to reduce the instance of Wiki Spam by using the MoinMoin AntiSpamGlobalSolution regex's. ...
What is an ACRONYM? Linking topics using acronyms. An acronym is an abbreviation that is typically made up of the first letter or letters of a phrase. An acronym ...
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 ...
Country list List of countries used in the UserForm . To use this list in Foswiki applications, see the country SEARCH example in SearchPatternCookbook . ...
You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. Delete moves an attachment to th...
%{ ========================================= Create new topic template This template uses parts from .WebCreateNewTopicComponents. =====================...
These two questions are answered together because often when you think you want to delete a page, more often it makes sense to rename the page to contain more con...
The same topic revision will be used when you save a topic again within a certain time frame (one hour by default, configurable with the configuration setting {Re...
That is often an indication that Foswiki can't find the egrep and fgrep commands on your system. Check the {Store}{EgrepCmd} and {Store}{FgrepCmd} settings in con...
Foswiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening u...
A set of pages of information that are open and free for anyone to edit as they wish. They are stored in a server and managed using some software. The system crea...
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...
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...
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...
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 ...
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
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...
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 ...
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 ...
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" }% ...
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.)....
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...
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...
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...
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 Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to ...
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,...
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...
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...