TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authentication ...
#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all preferences ...
This is a short introduction to Foswiki. What is a Wiki? The basic function of Foswiki is a Wiki (if that helps!) A Wiki is like a web site, except that you can edit ...
#VarEXPAND EXPAND{"expression" scope="topictoexpandin" ...}% Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have ...
PatchFoswikiContrib Usage This extension allows you to "hotfix" urgent issues on your Foswiki system. It has been tested on Foswiki 1.1.0 and beyond. It does not ...
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 in ...
Tips Contrib Package Displays a rotating "Tip of the Day" to help familiarize new users with Foswiki features. Includes an application for creating custom tips for ...
Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Foswiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They can ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add ...
%IF{ "$'URLPARAM{tab}'='search' OR $'URLPARAM{tab}'='' AND NOT $TAB='advanced'" then="$percentINCLUDE{$quotWebSearch$quot section=$quotsearch$quot}$percent" }% ...
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically populate ...
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 ...
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 ...
History Plugin Shows a complete history of a topic. The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin ...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read ...
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/ ...
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 HTML ...
Mailer Contrib Allows users to "subscribe" to regularly scheduled emails containing either: * A report on changes to all topics that have changed within a particular ...
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 set ...
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 ...
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, you ...
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 product ...
Escaping Foswiki rendering Use the verbatim tag to surround code excerpts and other formatted text with = verbatim = and = /verbatim = tags. For Example: verbatim ...
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Default settings: (never ...
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 maintained ...
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: Custom ...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by UseMod ...
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 ...
SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin
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 {JQueryPlugin ...
JQICONPATH render the urlpath to an image This is a shortcut for Examples * %JQICONPATH{"tick"}% expands to == Related JQICON, ICONURL, JQueryPlugin ...
CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such ...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCalendarContrib ...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTEMWEB ...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEnabled ...
Control table attributes with TablePlugin The TablePlugin gives extra control of table display: * Allows sorting * Changing table properties like border width ...
%{ ========================================= Create new topic template This template uses parts from System.WebCreateNewTopicComponents. =============== ...
#VarREVARG REVARG rev=n URL revision parameter of current topic * Syntax: %REVARG% * %REVARG% If a topic revision is requested in the URL, it returns the ...
#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested in ...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activity ...
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 when ...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they are ...
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded ...
Installation Guide Part 1 This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server ...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks. ...
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 query ...
#VarMETA 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 ...
Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. Web Go to Description %SEARCH{ "'1'" topic="" web ...
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, Technical ...
.PatternSkin CSS Cookbook Questions and answers on how to customize the default look of Foswiki for your own needs, using style sheets. For configuring page elements ...
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 your ...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of internationalised ...
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 ...
#VarADDTOZONE ADDTOZONE %ADDTOZONE{ "zone" ... }% Parameters: * "zone" optional, comma separated list of the names of zones that the content should be added ...
Page Caching By default, Foswiki pages are delivered to the browser using HTML, which is regenerated from the data stored in Foswiki each time the page is requested ...
#VarGROUPINFO GROUPINFO{"name"} retrieve details about a group * Syntax: %GROUPINFO% * Expands to: comma separated list of all groups * Syntax: %GROUPINFO ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar block ...
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 to ...
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. Use ...
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 read ...
#VarFORMAT FORMAT{"list" format="" header="" footer="" separator=""} format a list of objects * Syntax: %FORMAT{"list"}% * Supported parameters: Parameter ...
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 ...
JQueryFocus %JQPLUGINS{"focus" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin sets the focus on a form input field ...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in case ...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Sections ...
A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMappingContrib ...
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 ...
JQueryLiveQuery %JQPLUGINS{"livequery" format=" Homepage: $homepage Author(s): $author Version: $version " }% How to use it Live Query utilizes the ...
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is set ...
Text Formatting Working in Foswiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically ...
#VarTOC TOC{"Topic"} table of contents * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ...
#VarQUERYSTRING 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 ...
Wiki name Your name, usually your first and last name connected without a space. For example, Tim Berners Lee's WikiName is TimBernersLee. Your name is also a potentially ...
#VarQUERY QUERY get the value of meta data * Uses the query syntax described in QuerySearch to get information about meta data. * supports formatted access ...
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 fixed ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Foswiki home page * Syntax: ...
#VarSERVERTIME SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME% OR %SERVERTIME{"format"}% * %SERVERTIME ...
#VarSCRIPTURLPATH SCRIPTURLPATH{"script"} URL path of script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL * Syntax ...
#VarMAKETEXT MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected ...
#VarINCLUDINGWEB 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 ...
#VarGMTIME GMTIME{"format"} formatted GM time * Syntax: %GMTIME% OR %GMTIME{"format"}% * %GMTIME% uses the default date format defined by the {DefaultDateFormat ...
#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} expert option in configure. This is used in certain password encodings, and in login ...
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 supported ...
User Settings preference settings customizable by users Some of the preference settings are explicitly intended to be customized by users, though a default is provided ...
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 ...
#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topic ...
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. Attachments ...
Wiki culture, concepts and principles General concept and idea of wikis What is a wiki? "A wiki is a page or collection of Web pages designed to enable anyone who ...
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 example ...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL ...
PatternSkinCssCookbook Recipe: Sidebar background color To see if the background color really extends beyond the body, we make the body contents longer than the sidebar ...
PatternSkinCssCookbook Recipe: Center the page This recipe shows how center the page horizontally and vertically. This line loads the extra style definition: * ...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfortunately ...
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 ...
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 instances ...
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 example ...
WebChanges to see recent activity Each Foswiki web has a WebChanges topic that lists recent activity from all editors of the web. This can be useful when looking for ...
Breadcrumb The breadcrumb of a topic shows you page hierarchy. It is constructed using a topic's parent setting; for example, the breadcrumb on this page looks like ...
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More Information ...
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $TIME ...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enables ...
File attachments Files can be attached to any topic. The action of attaching a file to a topic is similar to attaching a file to an e mail use the Attach link in ...
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spanning ...
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 attachment ...
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 downloaded ...
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 WebNotify ...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good browsing ...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wiki ...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentationCategory ...
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() ObjectMethod ...
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 ...
#VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site * Syntax: %WIKIWEBMASTERNAME% * Expands to: == * Related: WIKIWEBMASTER ...
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 WebNotify ...
This site is running Foswiki version * * "}%, Release , Foswiki API version * Installed Plugins Here is a list of the plugins currently installed and enabled ...
Country list List of countries used in the UserForm . To use this list in Foswiki applications, see the country SEARCH example in SearchPatternCookbook . Name ...
#VarICONURLPATH ICONURLPATH{"name" default="name"} URL path of small documentation graphic or icon * Generates the relative URL path of a image, typically used ...
JQueryGradient %JQPLUGINS{"gradient" format=" Homepage: $homepage Author(s): $author Version: $version " }% Adds a gradient to the background of an ...
Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentationCategory ...
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 having ...
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 ...
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 Cunningham ...
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 ...
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 ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDPLUGINS ...
#VarALLVARIABLES ALLVARIABLES list of currently defined macros * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined macros in the current ...
Template Web Purpose Template webs were created to act as templates in creating webs. It is now possible to create webs via the .ManagingWebs topic. In the not ...
Statistics documentation The following section namely the help text and the statistics table headings is included into each topic. If you want to tailor the ...
#VarBASETOPIC 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 ...
#VarWEB 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 ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTSUFFIX ...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included * If present in included topic, stop to include text at this location and ignore the remaining ...
#VarLANGUAGES LANGUAGES list available languages * List the languages available (as PO files). These are the languages in which the user interface is available ...
#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR ...
#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBURL ...
#VarVBAR VBAR vertical bar * The vertical bar macro can be used in TML tables. * Current value: VBAR = * Related: BR, BULLET, BB, BB2, BB3, BB4, CARET ...