What is an ACRONYM? An acronym is an abbreviation that is typically made up of the first letter or letters of a phrase. A very familiar example would be WWW stan...

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

Access Keys What are access keys? Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without ha...

A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMapp...

Administrator Skills Assumptions Note: If you aren't already fairly well skilled in Linux/Unix/Windows, Apache, and so on, consider using a version in a pre packa...

Admin tools * Documentation: Reference Manual * Site Tools : Configure, , InterWikis, Macros, Doc Graphics, Installed Plugins report * Manage Users...

Appendix C: CSS Listing of CSS class names emitted from Foswiki core code and standard extensions. Who should read this document? Skin builders and others who wa...

#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of inte...

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

See System.WikiWord

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. Related Topics: UserDocumentationCategory, AdminDocumentati...

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

Add Ons Add functionality with extensions not based on the Foswiki scripts. Overview An add on runs separately from the Foswiki scripts, e.g. for data import, ex...

Data Forms This page introduces structured data, and explains how to set up and work with data forms. Overview Next to freeform topic contents, each topic can st...

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 Application Developer Topics Topics for normal users that want to develop Foswiki applications. Reference $ ReferenceManual : Doc...

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

Use the "Minor changes, don't notify" checkbox in preview in case you only make a minor change to a topic and you do not want to inform everybody who is on the We...

* 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. The soft delete moves an attachm...

Foswiki is distributed under the Gnu General Public License. You can get the sources in several ways: * Official releases may be downloaded from http://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 configure item {ReplaceIfEdit...

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 {RCS}{EgrepCmd} and {RCS}{FgrepCmd} settings in configu...

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

Force new revision option Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), Foswiki will fold toget...

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

Glossary of Terms Term Definition Attachment Any type of file that is uploaded via browser and attached to a topic, where it can be viewed and downloade...

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 Following you will find a short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. ...

Hide/Unhide Attachments You can hide/unhide file attachments in normal topic view. * In the FileAttachment table, click on an action link, * enable the Hide...

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 The %INCLUDE{...}% macro embeds the content of the specified topic at the place where the INCLUDE is used....

Installation Guide This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server. *...

Installation Guide Part 1 This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web serve...

Installation Guide Part 2 Return to or see the Complete Installation Guide on one page Beyond the basic installation Once you have Foswiki installed and run...

This site is running Foswiki version * * "}%, Release , Foswiki API version * Installed Plugins 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...

The name you log in with A login name is a sequence of alphanumeric characters and underscores. You cannot alter your LoginName: you have to get the administrator...

Macros Special text strings expand on the fly to display user data or system info Macros are text strings in one of two forms: These usually expand into content w...

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 %ADDTOZONE{"head" text=" #createWeb .col1 {float:left; width:30%; margin:0 3% 0 0;} #createWeb .col2 {float:left; width:66%;} #createWeb...

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

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

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 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. A preference setti...

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

Logos The official Foswiki logo is attached to this page. Logo Artwork Logo Customization The logo can be changed by redefining the WIKILOGOIMG preference sett...

Interface for Plugin and Contrib Developers See .DevelopingPlugins for more information. Package First Published Comment Foswiki::Func 1.1.5 Main AP...

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

Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentation...

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 Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are simil...

Appendix A: Foswiki Development Time line Foswiki Release 1.1.9 19 Nov 2013 Foswiki 1.1.9 was built 18 Nov 2013. It is a release that contains 43 fixes and 4 e...

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.9 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...

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

*

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

Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. Web Go to Description %SEARCH{ "'1'" topic="" we...

Permissions settings of the webs on this Foswiki site Web Sitemap VIEW CHANGE RENAME * * Listed DENY ALLOW 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 ...

Foswiki System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser ...

TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...

Text Editor A text editor, or text processor, handles plain text only, different from a word processor because it doesn't do display formatting like bold type, or...

Time Specifications Foswiki recognises the following formats for date/time strings. For all strings the time is optional. * 31 Dec 2001 23:59 * 2001/12/31...

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 #SystemWebFigure Figure: depiction of WebHome, ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the System web #TopicDef...

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 or TWiki (such as Cairo or TWiki4.0) to Foswiki 1.1 (References to Cairo are...

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

A List of User Documentation $ AccessKeys : Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer sof...

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

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

%IF{"context isadmin AND NOT istopic '.UserRegistration'" then=' Tailoring instructions: You are currently viewing the default registration page without local tai...

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 You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is formatted in a way that is not suppor...

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

Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Ko...

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

Welcome to the System Web This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, th...

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

Wiki links topics automatically when you use WikiWord notation.

Foswiki is a Wiki Wiki clone and has its root in JOS Wiki via TWiki . * Foswiki's home is at http://foswiki.org/ * Foswiki takes a lot of ideas from Ward Cu...

What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A Foswiki topic name always has a fix...

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