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 ...
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...
System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform...
#TemplateTopics Template topics Foswiki uses several types of templates. Template topics are topics that define the default text for new topics. (If you are look...
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...
Text Editor A text editor is different from a WYSIWYG editor because it doesn't do display formatting like bold type, or mixed font styles, sizes and colors. ...
Time Specifications Date/time formats recognised and generated by Foswiki. For all strings the time is optional. * 31 Dec 2001 23:59 * 2001/12/31 23:59:59...
What is Topic Markup Language (TML)? The special text format used in Foswiki topics to simplify topic text. Foswiki lets you work using a WYSIWYG editor, which fo...
Topics What are Topics and Webs? #SystemWebFigure Figure: depiction of , ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the web...
20 Minute Tutorial This step by step, hands on tutorial gets you up to speed with all the Foswiki basics… 1. Get set… Open two browser windows, so that you...
Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki to Foswiki 2.x. This upgrade procedure is used to upgrade a to a new major v...
User Authentication Controlling who can access your site Overview Authentication, or "login", is the process by which a user lets Foswiki know who they are. Know...
%MAKETEXT{"Your username is a sequence of alphanumeric characters and underscores that uniquely identifies you to the system. The exact format of the username dep...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
Using HTML When, and how, to use HTML in topics. You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is...
ADDTOHEAD deprecated, use ADDTOZONE instead This macro is deprecated. Please use VarADDTOZONE instead. It effecively is a shortcut for %ADDTOZONE{"head" ...}%
ALLVARIABLES list of currently defined macros Expands to a table showing all defined macros in the current context Deprecated 2009 04 29 in favour of SHOWPREF...
ATTACHURL full URL for attachments in the current topic Shorthand for PUBURL, with path set to the current topic. Otherwise supports all the same parameters as PU...
ATTACHURLPATH path of the attachment URL of the current topic Shorthand for PUBURLPATH with path set to the current topic. Otherwise supports all the same paramet...
AUTHREALM authentication realm String defined as the {AuthRealm} expert option in configure Security And Authentication tab, =Login sub tab.. This is used in cert...
BASETOPIC base topic where an INCLUDE started The name of the topic where a single or nested INCLUDE started same as %TOPIC% if there is no INCLUDE. This is the...
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 %WEB% in case there...
COVER current skin cover Extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, the skin search path becomes...
DATE signature format date Examples * %DATE% expands to == * Date format defined as {DefaultDateFormat} in configure When used in a template topic, thi...
DISPLAYTIME display formatted time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers...
ENCODE encode characters in a string Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or se...
ENDCOLOR end colored text ENDCOLOR is one of the shortcut macros predefined in . It is used to terminate a colour change (revert back to the default colour). The ...
ENDINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining text. A normal view...
ENDSECTION marks the end of a named section within a topic If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If th...
ENV inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is ...
EXPAND expand macros in a string as if they were used in another topic The viewer must have VIEW access to topictoexpandin for this to work. All the standard form...
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups. * The macro is intended to...
HTTP get HTTP headers * Called with the name of an HTTP request header field, returns its value. Capitalization and the use of hyphens versus underscores are n...
HTTPS get HTTPS headers The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine wh...
ICON small documentation graphic or icon of common attachment types Generates a small graphic image from the set attached to . Images typically have a 16x16...
ICONURL URL of small documentation graphic or icon Generates the full URL of a image, which Foswiki renders as an image. The related %ICON{"name"}% generat...
ICONURLPATH URL path of small documentation graphic or icon Generates the relative URL path of a image, typically used in an HTML img tag. Specify image na...
IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...
INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as %TOPIC% in case there is no include. If a...
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. If a topic is used ...
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 {UseLocale} is enabl...
LANGUAGE language code for the current user Returns the language code for the current user. This is the language used by Foswiki to generate the user interface. T...
LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is available. Parameters ...
LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload the system le...
LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty string "}%...
LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ...
MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...
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 etc.)....
METASEARCH special search of meta data METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and QuerySearch. Param...
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...
NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros...
PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...
PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API Use %PLUGINVERSION{"name"}% to get the version of a specific plugin Examples * %PLUG...
PUBURL generate an URL for an attachment Generate an absolute URL for an attachment, or for a web or topic within the attachment database. Parameters ...
PUBURLPATH generate a relative URL for an attachment Generate a relative URL for an attachment, or for a web or topic within the attachment database. Parameters ...
QUERY get the value of meta data Uses the query syntax described in QuerySearch to get information about meta data from one specified topic. * supports formatt...
QUERYSTRING full, unprocessed string of parameters to this URL * String of all the URL parameters that were on the URL used to get to the current page. For exa...
REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...
REVARG rev=n parameter of current request %REVARG% If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten...
REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...
REVTITLE The requested revision as displayed in topic breadcrumbs If a topic revision is requested in the URL, it returns the printable revision of the current t...
SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) Examples * %SCRIPTN...
SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to ...
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
SERVERTIME formatted server time Same format parameters as VarGMTIME GMTIME% , but displaying the server time instead of UTC. Examples * %SERVERTIME% els...
SESSIONID unique ID for this session Examples * %SESSIONID% expands to == Related UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE...
SESSIONVAR name of CGI and session variable that stores the session ID Examples * %SESSIONVAR% expands to Related UserAuthentication, AUTHREALM, SESSIONID,...
SET set a preference setting during runtime A preference setting created via a %SET macro is usable by the topic containing the %SET statement, and in any other t...
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
SKIN current skin %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. The SKIN setting can be overridden using the URL parame...
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for bac...
SPACEOUT renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit or a capital letter, and afte...
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the next %ENDINCLUDE% macro, or...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. Sections may be given a name to ...
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
TOC table of contents Shows a Table of Contents that is generated automatically based on headings of a topic. Headings in TopicMarkupLanguage (" text") and HTML ...
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 included top...
TOPICLIST topic index of a web List of all topics in a web. The "format" defines the format of one topic item. It may include formatting tokens: The $topic token ...
USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...
USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to...
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 the web w...
WEBLIST index of all webs Generate a list of webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the fo...
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
WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...
WIKINAME your Wiki username The WikiName is the same as %USERNAME% if not defined in the . topic. This macro is an alias for the USERINFO macro with a fixed forma...
WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your Foswiki home page This macro is an alias for the USERINF...
What is WYSIWYG? WYSIWYG is an acronym for for "What You See Is What You Get". Foswiki allows you to edit content using a WYSIWYG editor. This editor lets you edi...
ATOM News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribe in We...
This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...
" hidelink=" #9660; " linkclass="foswikiButton" remember="on"}% About the Web changes notification service Each Foswiki web has an automatic e mail notification ...
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...
%IF{ "$'URLPARAM{tab}'='search' OR $'URLPARAM{tab}'='' AND NOT $TAB='advanced'" then="$percentINCLUDE{$quotWebSearch$quot section=$quotsearch$quot}$percent" }%...
** Wiki admins Please replace all web's WebTopicCreator topic contents with this text: All WebTopicCreator topics on this site: %SEARCH{ "WebTopicCreator" ...
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. General concept and idea of wikis What is a wiki? "A wiki is a page or collection of We...
. %MAKETEXT{"Your name is also a potentially valid _1 .WikiWord WikiWord when used within a topic. However the home pages of registered users on this site ...
Online help for new users of Foswiki when editing a page. If there's some formatting that your contributors use often, you can customize this for your site's part...
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are used to refer to topics. WikiWords refer to topics...
JQGridPlugin jqGrid is an Ajax enabled JavaScript control that provides solutions for representing and manipulating tabular data on the web. Since the grid is a c...
RedDotPlugin This plugin renders a clickable red dot (.) to ease the edit access to a page. The red dot will only be visible if the current wikiuser has write acc...
JQueryMenuSkin A functional skin that provides a customisable menu navigation system based on the JQuery Superfish plugin. Overview JQueryMenuSkin is a simple JQ...
Beautifier Plugin Related topics: dp.SyntaxHighlighter Introduction Use the %CODE% and %ENDCODE% macros to enclose fragments of code in your topic that you wi...
#VarCODE CODE{ } format and highlight syntax for displaying code fragments * The %CODE% macro and its companion %ENDCODE% macro are provided by the .Be...
#VarENDCODE ENDCODE end a code fragment * The %ENDCODE% macro and its companion %CODE% macro are provided by the .BeautifierPlugin and are used togethe...