JsonRpcContrib Summary This package implements a JSON RPC 2.0 protocol to interface with Foswiki and its plugins. In contrast to the normal REST interface of Fo...
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...
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...
TABPANE tabpane widget This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this: ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks....
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...
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...
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...
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 ...
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 ...
ModPerlEngineContrib Overview This is a runtime engine component from Foswiki Standalone architecture. mod_perl is the Perl API to the Apache web server. It perm...
Subscribe Plugin Example (only works if plugin is installed, and you are logged in you are: and you are not .WikiGuest): This version is designed for use w...
SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCRIBE{...}% or si...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
Mailer Contrib Allows users to "subscribe" to regularly scheduled emails containing either: * A report on changes to all topics that have changed within a part...
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...
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 ...
Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read...
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...
PlainFileStoreContrib This is a full implementation of a Foswiki store that uses nothing more sophisticated than plain files and directories In the Foswiki spirit...
TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...
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 HT...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...
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...
Foswiki Release 2.1.3 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
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...
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...
PatternSkin horizontal navigation example Include main navigation with: This is done automatically in the templates by setting in the .SitePreferences: * #Set ...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre...
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 ...
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...
System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...
.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 eleme...
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
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
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...
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...
Perl dependencies for Foswiki and Extensions This topic lists the dependencies required by the Foswiki core and installed extensions. It is designed to help admin...
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...
%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...
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...
Templates for CommentPlugin See CommentPlugin: Customisation for help. While this topic can be viewed as a topic, it is used by the CommentPlugin as a template fi...
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...
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 ...
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...
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...
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: EditTable style Cookbook example to illustrate control over EditTable edit styles. 1 EditTable uses a monospace font in edit mod...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL...
PatternSkinCssCookbook Recipe: Hide action buttons This recipe shows how to hide the action buttons for unauthorised and/or guest users: (Edit, Attach ...) Note t...
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: * Set USERSTYLEURL = //PatternSkinCssCookbookNoLeftBar/hideleftbar...
PatternSkinCssCookbook Recipe: Hide the top bar This recipe shows how to hide the top bar. This line loads the extra style definition: * Set USERSTYLEURL=/noto...
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...
%{ ========================================= Create new topic template This template uses parts from .WebCreateNewTopicComponents. =====================...
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...
PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...
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 %SET will only be usable on the topic where it has been found by the parser, similar ...
CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar...
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...
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 ...
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...
%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...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
MailerContribPlugin This is a 'mini' plugin that provides a rest handler for invoking the mail notification process via an HTTP request (e.g. from the browser). I...
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...
HomePagePlugin Usage This plugin makes the Default frontpage configurable 1 any time a user goes to they will be shown the topic configured by the Foswiki...
Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar bloc...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...
User Form Help %IF{"$ BASEWEB=''" then="%IF{"istopic '.UserFormHelp'" then="This is the default user form. You have also created a customized copy at .UserForm ...
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 ...
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...
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...
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...
#VarEXPAND EXPAND{"expression" scope="topictoexpandin" ...}% Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have...
#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all pr...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
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...
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 ...
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. A preference setti...
Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }...
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...
Interface for Plugin and Contrib Developers See .DevelopingPlugins for more information. Package First Published Comment Foswiki::Func 1.1.5 Main AP...
#VarREVARG REVARG rev=n URL revision parameter of current topic * Syntax: %REVARG% * %REVARG% If a topic revision is requested in the URL, it returns th...
#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested i...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...
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...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they 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...
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...
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...
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...
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...
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...
%IF{ "$'URLPARAM{tab}'='search' OR $'URLPARAM{tab}'='' AND NOT $TAB='advanced'" then="$percentINCLUDE{$quotWebSearch$quot section=$quotsearch$quot}$percent" }%...
#VarREVINFO REVINFO revision information of current topic * Syntax: %REVINFO% * %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiuserna...
%{ Include the default view templates from your current SKIN and COVER paths }%%{ Override the content template DEFinition. This normally just contains , ...
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...
#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, ...
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 ...
Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. Web Go to Description %SEARCH{ "'1'" topic="" we...
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...
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 fo...
Installation Guide This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server. *...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of inte...
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...
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 ...
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 reques...
#VarADDTOZONE ADDTOZONE %ADDTOZONE{ "zone" ... }% Parameters: * "zone" optional, comma separated list of the names of zones that the content should be add...
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...
#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...
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...
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...
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...
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...
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...
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 ...
#VarQUERYPARAMS QUERYPARAMS show paramaters to the query * Expands the parameters to the query that was used to display the page. * Syntax: %QUERYPARAMS{...
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...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in cas...
Welcome to the System Web This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, th...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Se...
Foswiki System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser ...
A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMapp...
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...
Tips Of The Day These are all tips of the day. They are located in the web (official distribution tips) and web (custom tips). Total: tips See also: Tips Of T...
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): " topic=...
#VarENCODE ENCODE{"string"} encodes a string * Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative ...
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...
What makes Foswiki the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively * ...
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...
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is se...
#VarRENDERZONE RENDERZONE See ADDTOZONE for an explanation of zones. Parameters: * "zone" required, name of the zone. * format="..." optional, format strin...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and If...
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 ...
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. ...
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 aut...
#VarENDCOLOR ENDCOLOR end colored text * ENDCOLOR is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that t...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated * The current topic name with added URL encoded spaces, for use in regular express...
#VarSTARTINCLUDE STARTINCLUDE start position of topic text if included * If present in included topic, start to include text from this location up to the en...
#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...
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...
#VarQUERY QUERY get the value of meta data * Uses the query syntax described in QuerySearch to get information about meta data. * supports formatted a...
#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 cu...
#VarSCRIPTURL SCRIPTURL{"script"} URL of script * Syntax: %SCRIPTURL% OR %SCRIPTURL{"script"}% * %SCRIPTURL% returns the base URL of scripts expands to...
#VarSCRIPTURLPATH SCRIPTURLPATH{"script"} URL path of script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL * Synt...
#VarSERVERTIME SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME% OR %SERVERTIME{"format"}% * %SER...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places * Inserts spaces after lower case letters that are followed by a digi...
#VarTOPICLIST TOPICLIST{"format"} topic index of a web * List of all topics in a web. The "format" defines the format of one topic item. It may include form...
#VarTOPICURL TOPICURL shortcut to viewing the current topic * This macro always expands to an url pointing to the current base topic. * Current value: TO...
#VarURLPARAM URLPARAM{"name"} get URL or HTTP POST parameter value * Returns the value of the named parameter in the URL or HTTP POST request. * Syntax: ...
#VarUSERINFO USERINFO{"name"} retrieve details about a user * Syntax: %USERINFO% * Expands to: (comma separated list of the username, wikiusername, and ...
#VarUSERNAME USERNAME your login username * Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME l...
#VarWEBLIST WEBLIST{"format"} index of all webs * List of all webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The ...
#VarWIKINAME WIKINAME your Wiki username * The WikiName is the same as %USERNAME% if not defined in the . topic * Syntax: %WIKINAME% * Expands to: == ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Foswiki home page * Syntax: ...
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 po...
Shorthand Basics If you can enter text, you're ready for Foswiki. With a few simple rules, you'll be able to use plain text to create well styled postings, instan...
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...
#VarLANG LANG the language specified by the server locale This macro is used to generate the lang (and xml:lang) attribute in generated HTML pages. If {UseLoca...
#VarLOGIN LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an emp...
#VarLOGOUT LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an emp...
#VarMAKETEXT MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's se...
#VarMETASEARCH METASEARCH special search of meta data METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and Q...
#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion...
#VarGMTIME GMTIME{"format"} formatted GM time * Syntax: %GMTIME% OR %GMTIME{"format"}% * %GMTIME% uses the default date format defined by the {DefaultDat...
#VarHTTP HTTP get HTTP headers * Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores a...
#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syn...
#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 INC...
#VarCALC CALC{"formula"} add spreadsheet calculations to tables and outside tables * The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There ...
#VarDISPLAYTIME DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in...
#VarEDITACTION EDITACTION Selects an edit template * The EDITACTION preference setting lets you define the use of an editaction template instead of the stan...
#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} expert option in configure. This is used in certain password encodings, and in ...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
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...
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...
#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topi...
Tips Of the Day Include This Page randomly picks a Tip of the day to display. The includes the part between the horizontal rules. Tip of the Day ))$SET(pos, $FI...
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...
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...
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...
This page provides 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 ...
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...
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...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
Collaboration Tips Following you will find a short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. ...
Shortcuts Easy ways to save some typing Some macros are just shortcuts for longer sequences of characters, to either save typing or to easily allow line breaks in...
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...
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...
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 w...
" hidelink=" #9660; " linkclass="foswikiButton" remember="on"}% About the Web changes notification service Each Foswiki web has an automatic e mail notification ...
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: ...
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...
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...
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 ...
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....
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...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...
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...
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 ...
Raw Text link At the bottom of each page among the action links (assuming use of the default PatternSkin), there is a View wiki text link which shows how a topic ...
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...
Escaping Foswiki rendering Use the verbatim tag to surround code excerpts and other formatted text with = verbatim = and = /verbatim = tags. Each tag must be on a...
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...
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Site level settings: ...
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 i...
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 l...
Foswiki Skins Skins overlay regular templates with alternate layouts (and styles). You can use Skins to change the look of a Foswiki topic, for example, the layo...
Revision control In Foswiki, assuming appropriate AccessControls, anyone can change anything but those changes are logged. There is a complete audit trail with r...
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spa...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enab...
Edit tables with EditTablePlugin EditTablePlugin allows you to edit tables using edit fields and drop down boxes. Tables have an button if preceeded by an %EDI...
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $...
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when conte...
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More ...
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...
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...
%{ Include the default edit templates from your current SKIN and COVER paths }%%{ Define the formtop container to display the form }%%{ Define the formbot...
Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, ...
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...
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...
#VarCOVER COVER current skin cover * %COVER% extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, th...
#VarSKIN SKIN current skin * %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. * The SKIN setting can be overridde...
Developer Documentation Application Developer Topics Topics for normal users that want to develop Foswiki applications. Reference $ ReferenceManual : Doc...
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...
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. Subscribed in W...
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 Web...
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with = noautolink = and = /noautolink = tags. Each ...
Disabling individual WikiWords Prevent a WikiWord from being linked by prefixing it with an exclamation point. Example: To escape SunOs write SunOs to get SunOs. ...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good bro...
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....
SmiliesPlugin emoticons Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile #058; ) : ) or a frow...
Control table attributes with TablePlugin The TablePlugin gives extra control of table display: * Allows sorting * Changing table properties like border wid...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write %COMMENT{ attributes ...
Keyword search Interactive search is a keyword search by default. For example, to search for all topics that contain "SOAP", "WSDL", a literal "web service", but ...
RSS news feed of topic changes You can use an RSS news reader to find out what is new in a Foswiki web. This complements WebChanges that shows recent changes in a...
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...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
#VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registered users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * ...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
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...
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 ...
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...
Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are simil...
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 . ...
Force new revision option Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), Foswiki will fold toget...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: UserAuthenticati...
#VarICON ICON{"name" alt="" default="name"} small documentation graphic or icon of common attachment types * Generates a small graphic image from the set at...
#VarICONURL ICONURL{"name" default="name"} URL of small documentation graphic or icon * Generates the full URL of a image, which Foswiki renders as an imag...
#VarICONURLPATH ICONURLPATH{"name" default="name"} URL path of small documentation graphic or icon * Generates the relative URL path of a image, typically ...
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...
#VarGROUPS GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups in your Foswiki....
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...
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...
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. *...
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...
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...
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...
** Wiki admins Please replace all web's WebTopicCreator topic contents with this text: All WebTopicCreator topics on this site: /$web/$topic?t= Edit $web.$topic...
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...
* 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...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDP...
#VarALLVARIABLES ALLVARIABLES list of currently defined macros * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined macros in the curre...
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...
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...
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...
A StaticMethod is a method in a package that can be called without reference to an object of the package type. For example, package Telecoms StaticMethod defaul...
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...
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...
#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 n...
#VarBASEWEB 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...
#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, F...
#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can r...
#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBUR...
#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR...
#VarENDSECTION ENDSECTION{"name"} marks the end of a named section within a topic * Syntax: %ENDSECTION{"name"}% * Syntax: %ENDSECTION{type="include"}% ...
#VarENV ENV{"varname"} inspect the value of an environment variable * Returns the current value of the environment variable in the CGI (Common Gateway Inter...
#VarHTTPS 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 us...
#VarLANGUAGE LANGUAGE language code for the current user * Returns the language code for the current user. This is the language used by Foswiki to generate ...
#VarLANGUAGES LANGUAGES list available languages * List the languages available (as PO files). These are the languages in which the user interface is a...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences ...
#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specif...
#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %P...
#VarSCRIPTNAME SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) * ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTS...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included * If present in included topic, stop to include text at this location and ignore the rema...
#VarSYSTEMWEB SYSTEMWEB name of documentation web * The web containing all documentation and default preference settings * Syntax: %SYSTEMWEB% * Expan...
#VarTOPIC 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...
#VarUSERSWEB USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. * Syntax: %USERSW...
#VarVAR VAR{"NAME" web="Web"} get a preference value from another web * Syntax: %VAR{"NAME" web="Web"}% * Example: To get %WEBBGCOLOR% of the web write...
#VarVBAR VBAR vertical bar * The vertical bar macro can be used in TML tables. * Current value: VBAR = * Related: BR, BULLET, BB, BB2, BB3, BB4, CARE...