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 ...
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...
AntiWikiSpamPlugin Stop your wiki getting spammed This plugin attempts to reduce the instance of Wiki Spam by using the MoinMoin AntiSpamGlobalSolution regex's. ...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
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 ...
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 ...
%{ Include the default edit templates from your current SKIN and COVER paths }%%{ Define the formtop container to display the form }%%{ Define the formbot...
Both users and groups can be hidden from common view and made visible only to the admin or to selected users and groups. You do this the same way as you access co...
Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...
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...
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...
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 ...
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...
Collaboration Tips A short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. #SignAndDate * If a dis...
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...
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...
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....
#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...
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...
NewUserPlugin Description This plugin is of use in those cases where users are registered and authenticated externally, for example using LDAP. So users are not ...
Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }...
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...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Test this theme Choose column ' selected='selected' "}% Column right No column Hide theme Store theme...
See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, Tec...
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...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
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...
Site Statistics Introduction Statistics of visits to pages in a web can be generated manually or automatically, on a per web basis. Statistics are compiled as 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...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
Time Specifications Date/time formats recognised and generated by Foswiki. For all strings the time is optional. * 31 Dec 2001 23:59 * 2001/12/31 23:59:59...
The Go Box as a browser The go box (also called jump box) allows you to jump from page to page and search for documents. If you do not know the entire name of th...
E mail alert of topic changes Subscribing to WebNotify will enable Foswiki to send you details of changes made on topics in a certain web. You can choose to be no...
Re parenting a topic The breadcrumbs ( Contribs TipsContrib TipsOfTheDay , for example) of any topic is constructed automatically in Foswiki by foll...
Creating a Table of Contents %TOC% automatically creates a table of contents based on the headings present in the topic. To exclude a heading from a %TOC% add !! ...
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 ...
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...
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....
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when conte...
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 ...
%MAKETEXT{"Your username is a sequence of alphanumeric characters and underscores that uniquely identifies you to the system. The exact format of the username dep...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
List of Foswiki users Below is a list of users with accounts. If you want to edit topics or see protected areas of the site then you can get added to the list by ...
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...
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...
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 ...
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...
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...
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...
JQICON render an image Renders an icon image as found on an icon search path. The icon search path is configured Extensions tab, JQueryPlugin sub tab in {JQueryP...
JQICONPATH render the urlpath to an image This is a shortcut for Examples * %JQICONPATH{"tick"}% expands to == Related JQICON, ICONURL, JQueryPlugin...
LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ...
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...
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
SET set a preference setting during runtime A preference setting created via a %SET macro is usable by the topic containing the %SET statement, and in any other t...
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...
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...
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
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...
USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...
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...
WIKIAGENTNAME From: Name used in emails sent by Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME
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...
Online help for new users of Foswiki when editing a page. If there's some formatting that your contributors use often, you can customize this for your site's part...
Group Member Toggle This topic implements a button that will turn Admin status on or off for the current user (!), by adding or removing the user from the AdminGr...
BookView is an option available for the SEARCH macro. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of...
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...
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...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
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...
Country list List of countries used in the UserForm . To use this list in Foswiki applications, see the country SEARCH example in SearchPatternCookbook . ...
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...
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...
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, ...
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...
FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons...
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 ...
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...
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...
Each FileAttachment in a Topic can have additional attributes. At present only the H (hidden) attribute is supported. If this attribute is set then the attachme...
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...
Go Box The box at the top or sidebar of each page, also called Jump box. Enter a topic name to quickly jump to the topic, for example: * WebNotify to jump to ...
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...
Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
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...
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...
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: Sidebar background color To see if the background color really extends beyond the body, we make the body contents longer than the s...
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...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre...
Pending Registrations Template Tailoring instructions: The contents of the Pending Registrations report can be modified to report any fields collected on a custo...
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...
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 ...
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...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...
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...
System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform...
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...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good bro...
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Default settings: (nev...
Revision control In Foswiki, assuming appropriate AccessControls, anyone can change anything but those changes are logged. There is a complete audit trail with r...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write %COMMENT{ attributes ...
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...
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...
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...
20 Minute Tutorial This step by step, hands on tutorial gets you up to speed with all the Foswiki basics... 1. Get set... Open two browser windows, so that you...