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...

A List of Wiki Administrator Documentation List of documents relevant for the installer and administrator of the Foswiki installation

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...

Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...

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...

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...

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...

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...

Change registered email address %IF{ "context passwords_modifyable" then="$percentINCLUDE{\"ChangeEmailAddress\" section=\"secretEmailEnabled\"}$percent" el...

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...

Reference Manual () This page contains all documentation topics as one long, complete reference sheet. %BUTTON{ "" icon="fa book" target="/System/CompleteDo...

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...

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...

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...

* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. *...

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...

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...

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...

Foswiki is distributed under the Gnu General Public License, and sources are freely available. When you download an official Foswiki package from https://foswiki....

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...

Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, ...

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...

FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons...

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...

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...

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...

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 ...

Collaboration Tips A short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. #SignAndDate * If a dis...

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...

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...

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...

Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ...

Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...

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...

JQueryRating %JQPLUGINS{"rating" format=" Homepage: $homepage Author(s): $author Version: $version " }% The Star Rating Plugin is a plugin for th...

JQueryStars %JQPLUGINS{"stars" format=" Homepage: $homepage Author(s): $author Version: $version " }% Flexible and non obstructive star rating. T...

Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is se...

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...

Macros Quick Reference See Macros for a detailed description of how to use Macros Predefined Macros %SEARCH{ "1" type="query" topic="Var*" we...

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 ...

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 ...

Managing Webs Browser based rename, move, copy, and delete for individual webs %ADDTOZONE{"head" text=" #createWeb .col1 {float:left; width:30%; margin:0 3% 0...

#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...

An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example: package Telecoms ClassMethod new() Ob...

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...

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...

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...

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...

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: *...

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...

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...

Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...

Regular Expressions Regular expressions (REs), unlike simple text queries, allow you to search for text which matches a particular pattern. Introduction REs are ...

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...

%IF{ "{EnableEmail} AND context passwords_modifyable" then="$percentINCLUDE{\"ResetPassword\" section=\"resetPassword\"}$percent" else="" }% * * Ch...

Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...

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...

Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. %SEARCH{ "1" topic="" web="all" type="query" not...

SitePermissions Permissions settings of the webs on this Foswiki site Web Sitemap VIEW CHANGE RENAME * * Listed DENY ALLOW DENY ALLOW ...

Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...

Skin Browser You can try out the Skins currently installed on this system: %SEARCH{ "1" topic="*Skin" scope="topic" web=",TWiki" type="que...

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 ...

The 216 Standard Colors This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 ...

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...

Text Editor A text editor is different from a WYSIWYG editor because it doesn't do display formatting like bold type, or mixed font styles, sizes and colors. ...

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...

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...

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...

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...

A List of User Documentation Documentation mainly useful to end users

User Form This is a maintenance topic, used by the Wiki administrator. Data form definition of user topics Name Type Size Values Description ...

%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 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...

A List of User Tools List of tools the user may need for setting and resetting passwords, changing email address etc.

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 ...

Using HTML When, and how, to use HTML in topics. You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is...

What is WYSIWYG? WYSIWYG is an acronym for for "What You See Is What You Get". Foswiki allows you to edit content using a WYSIWYG editor. This editor lets you edi...

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...

%{ ========================================= Create new topic template This template uses parts from .WebCreateNewTopicComponents. =====================...

This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...

" warn="off"}% * ** * * * * * * * %IF{"istopic ''" then=" * $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"St...

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...

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...

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...

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...

* You are currently in the web. The color code for this web is this background, so you know where you are. * If you are not familiar with the Foswiki collabor...