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

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

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

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

Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPluginExamples ...

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

Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentationCategory ...

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

Petr Malát 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 ...

Developer Documentation Application Developer Topics Topics for normal users that want to develop Foswiki applications. Reference $ ReferenceManual : Documentation ...

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

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

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

Editing Shorthand Formatting Command: You write: You get: Paragraphs: Blank lines will create new paragraphs. 1st paragraph 2nd paragraph 1st paragraph 2nd paragraph ...

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

Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and IfStatements ...

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

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

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

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 Part 2 Return to or see the Complete Installation Guide on one page Beyond the basic installation Once you have Foswiki installed and running ...

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

JQueryButton %JQPLUGINS{"button" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a simple way to render nice buttons ...

JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks. ...

JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add ...

JQueryPopUpWindow %JQPLUGINS{"popupwindow" format=" Homepage: $homepage Author(s): $author Version: $version " }% Open a page in a new window. Macros ...

JQueryTabpane Plugin Info %JQPLUGINS{"tabpane" format=" Homepage: $homepage Author(s): $author Version: $version " }% Summary This implements an ...

This topic has been deprecated please see Macros instead.

What makes Foswiki the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively * 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 it ...

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

Documentation Graphics and Filetype icons This is the Foswiki icon library. The graphics can be used in topics and by web applications. Usage Default notation: ...

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

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

#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. A preference setting ...

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

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

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

Appendix A: Foswiki Development Time line Foswiki Release 1.1.7 01 Feb 2013 Foswiki 1.1.7 was built 01 Feb 2013. It is a release that fixes CVE 2012 6329 and CVE ...

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

Foswiki Release 1.1.7 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use in ...

Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generated ...

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

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

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

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

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

Slide Show Plugin Introduction There is already a de facto standard for presentations, so why this plugin? This plugin makes sense for organizations that already ...

Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Petr Malát topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They ...

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

Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting ...

#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topic ...

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

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

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

TinyMCE Editor Help Summary * Normal Normal text style * Heading 1 6 Headings; 1 is largest * On save, content in this HTML editor is automatically ...

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

Topics #SystemWebFigure Figure: depiction of WebHome, ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the System web #TopicDefinition ...

TwistyPlugin A "twisty" is an interface toggle control to show and hide content. TwistyPlugin gives you several options to control the appearance of a twisty: ...

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 Petr Malát know who they are. Authentication ...

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

%IF{ "istopic '.UserRegistration'" then="$percentINCLUDE{$quot.UserRegistration$quot NOREGISTRATION=$quot$quot}$percent" else="$percentINCLUDE{$quot.DefaultUserRegistration ...

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

User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...

#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS ...

#VarADDTOHEAD ADDTOHEAD This macro is deprecated. Please use VarADDTOZONE instead. It effecively is a shortcut for %ADDTOZONE{"head" ...}%

#VarADDTOZONE ADDTOZONE %ADDTOZONE{ "zone" ... }% Parameters: * "zone" optional, comma separated list of the names of zones that the content should be added ...

#VarALLVARIABLES ALLVARIABLES list of currently defined macros * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined macros in the current ...

#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can refer ...

#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBURL ...

#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} expert option in configure. This is used in certain password encodings, and in login ...

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

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

#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR ...

#VarBB2 BB2 level 2 bullet with line break * Line break and bullet, level 2. * Current value: BB2 = * Related: BR, BULLET, BB, BB3, BB4, VBAR

#VarBB3 BB3 level 3 bullet with line break * Line break and bullet, level 3. * Current value: BB3 = * Related: BR, BULLET, BB, BB2, BB4, VBAR

#VarBB4 BB4 level 4 bullet with line break * Line break and bullet, level 4. * Current value: BB4 = * Related: BR, BULLET, BB, BB2, BB3, VBAR

#VarBR BR line break * Current value: BR = * Related: BULLET, BB, BB2, BB3, BB4, CARET, VBAR

#VarBULLET BULLET bullet character * Current value: BULLET = * Related: BR, BB, BB2, BB3, BB4, CARET, VBAR

#VarCARET CARET caret symbol * The CARET macro is useful in TML tables. * Current value: CARET = * Related: BR, BULLET, BB, BB2, BB3, BB4, VBAR

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

#VarDATE DATE signature format date * Syntax: %DATE% * Expands to: == * Date format defined as {DefaultDateFormat} in configure When used in a template ...

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

#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * Syntax ...

#VarENCODE ENCODE{"string"} encodes a string * Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character ...

#VarENDCOLOR ENDCOLOR end colored text * ENDCOLOR is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...

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

#VarEXPAND EXPAND{"expression" scope="topictoexpandin" ...}% Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have ...

#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDPLUGINS ...

#VarFORMAT FORMAT{"list" format="" header="" footer="" separator=""} format a list of objects * Syntax: %FORMAT{"list"}% * Supported parameters: Parameter ...

#VarFORMFIELD FORMFIELD{"fieldname"} renders a field in the form attached to some topic * Syntax: %FORMFIELD{"fieldname"}% * Supported parameters: ...

#VarGMTIME GMTIME{"format"} formatted GM time * Syntax: %GMTIME% OR %GMTIME{"format"}% * %GMTIME% uses the default date format defined by the {DefaultDateFormat ...

#VarGROUPINFO GROUPINFO{"name"} retrieve details about a group * Syntax: %GROUPINFO% * Expands to: comma separated list of all groups * Syntax: %GROUPINFO ...

#VarGROUPS GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups in your Petr Mal ...

#VarH H help icon * Current value: H = * Related: I, ICON, M, N, P, Q, S, T, U, X, Y

#VarHISTORY HISTORY{ attributes } control attributes of tables and sorting of table columns * The %HISTORY{}% macro is handled by the HistoryPlugin * Syntax ...

#VarHOMETOPIC HOMETOPIC home topic in each web * Syntax: %HOMETOPIC% * Expands to: ==, renders as * Related: NOTIFYTOPIC, STATISTICSTOPIC, TOPIC

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

#VarHTTPHOST HTTP_HOST environment variable * Syntax: %HTTP_HOST% * Expands to: == * Related: ENV, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

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

#VarI I idea icon * Current value: I = * Related: H, ICON, M, N, P, Q, S, T, U, X, Y

#VarICON ICON{"name" alt="" default="name"} small documentation graphic or icon of common attachment types * Generates a small graphic image from the set attached ...

#VarICONURL ICONURL{"name" default="name"} URL of small documentation graphic or icon * Generates the full URL of a image, which Foswiki renders as an image ...

#VarICONURLPATH ICONURLPATH{"name" default="name"} URL path of small documentation graphic or icon * Generates the relative URL path of a image, typically used ...

#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syntax ...

#VarINCLUDE INCLUDE{"topic"} include other topic. * Syntax: %INCLUDE{"topic" ...}% (See also the URL form of %INCLUDE%) * Supported parameters: Parameter ...

#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in case ...

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

#VarJQPLUGINS JQPLUGINS{"plugins" ... } display a summary of available plugins * Parameters: Parameter: Description: Default: "plugins" ...

#VarLANG LANG the lang attribute of generated HTML pages * In templates the lang attribute is defined like this: * The value is read from configure setting ...

#VarLANGUAGE LANGUAGE current user's language * Returns the language code for the language used as the current user. This is the language actually used by Foswiki ...

#VarLANGUAGES LANGUAGES list available languages * List the languages available (as PO files). These are the languages in which the user interface is available ...

#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload ...

#VarLOGIN LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty ...

#VarLOGOUT LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty ...

#VarM M moved to... icon * Current value: M = * Related: H, I, ICON, N, P, Q, S, T, U, X, Y

#VarMAINWEB MAINWEB synonym for USERSWEB Deprecated. Please use %USERSWEB% instead.

#VarMAKETEXT MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected ...

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

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

#VarN N "new" icon * Current value: N = * Related: H, I, ICON, M, P, Q, S, T, U, X, Y

#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion ...

#VarNOTIFYTOPIC NOTIFYTOPIC name of the notify topic * Syntax: %NOTIFYTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, STATISTICSTOPIC, TOPIC ...

#VarP P pencil icon * Current value: P = * Related: H, I, ICON, M, N, Q, S, T, U, X, Y

#VarPLUGINDESCRIPTIONS PLUGINDESCRIPTIONS list of plugin descriptions * Syntax: %PLUGINDESCRIPTIONS% * Expands to: * Related: ACTIVATEDPLUGINS, FAILEDPLUGINS ...

#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specific ...

#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %PUBURL ...

#VarPUBURLPATH PUBURLPATH the base URL path of attachments * Syntax: %PUBURLPATH% * Expands to: == * Related: ATTACHURL, ATTACHURLPATH, PUBURL, SCRIPTURL ...

#VarQ Q question icon * Current value: Q = * Related: H, I, ICON, M, N, P, S, T, U, X, Y

#VarQUERY QUERY get the value of meta data * Uses the query syntax described in QuerySearch to get information about meta data. * supports formatted access ...

#VarQUERYPARAMS QUERYPARAMS show paramaters to the query * Expands the parameters to the query that was used to display the page. * Syntax: %QUERYPARAMS{ ...

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

#VarREMOTEADDR REMOTE_ADDR environment variable * Syntax: %REMOTE_ADDR% * Expands to: == * Related: ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER

#VarREMOTEPORT REMOTE_PORT environment variable * Syntax: %REMOTE_PORT% * Expands to: * Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER

#VarREMOTEUSER REMOTE_USER environment variable * Syntax: %REMOTE_USER% * Expands to: * Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, WIKINAME ...

#VarRENDERZONE RENDERZONE See ADDTOZONE for an explanation of zones. Parameters: * "zone" required, name of the zone. * format="..." optional, format string ...

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

#VarREVINFO REVINFO revision information of current topic * Syntax: %REVINFO% * %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername ...

#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested in ...

#VarS S red star icon * Current value: S = * Related: H, I, ICON, M, N, P, Q, T, U, X, Y

#VarSCRIPTNAME SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) * Syntax ...

#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Petr Malát installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTSUFFIX ...

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

#VarSEARCH SEARCH{"text"} search content * Inline search, shows a search result embedded in a topic * Syntax: %SEARCH{"text" ...}% * Supported parameters ...

#VarSERVERTIME SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME% OR %SERVERTIME{"format"}% * %SERVERTIME ...

#VarSESSIONID SESSIONID unique ID for this session * Syntax: %SESSIONID% * Expand to: == * Related: UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT ...

#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: UserAuthentication ...

#VarSESSIONVARIABLE SESSION_VARIABLE get, set or clear a session variable * Syntax: %SESSION_VARIABLE{"name"}% * Syntax: %SESSION_VARIABLE{"name" set="value ...

#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all preferences ...

#VarSKIN SKIN current skin * %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. * The SKIN setting can be overridden ...

#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated * The current topic name with added URL encoded spaces, for use in regular expressions ...

#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places * Inserts spaces after lower case letters that are followed by a digit ...

#VarSTARTINCLUDE STARTINCLUDE start position of topic text if included * If present in included topic, start to include text from this location up to the end ...

#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Sections ...

#VarSTATISTICSTOPIC STATISTICSTOPIC name of statistics topic * Syntax: %STATISTICSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, NOTIFYTOPIC ...

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

#VarSYSTEMWEB SYSTEMWEB name of documentation web * The web containing all documentation and default preference settings * Syntax: %SYSTEMWEB% * Expands ...

#VarT T tip icon * Current value: T = * Related: H, I, ICON, M, N, P, Q, S, U, X, Y

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

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

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

#VarTOPICURL TOPICURL shortcut to viewing the current topic * This macro always expands to an url pointing to the current base topic. * Current value: TOPICURL ...

#VarTWIKIWEB TWIKIWEB synonym for SYSTEMWEB Deprecated. Use %SYSTEMWEB% instead

#VarTWISTY TWISTY This renders the button as well as the toggled content section contained within this and the closing ENDTWISTY tag. Usage: %TWISTY{ ... }% Toggable ...

#VarTWISTYHIDE TWISTYHIDE Hide/close link * Syntax: %TWISTYHIDE{id="myid" ... }% * Supported parameters: Parameter Value Description Remark ...

#VarTWISTYSHOW TWISTYSHOW Show/open link * Syntax: %TWISTYSHOW{id="myid" ... }% * Supported parameters: Parameter Value Description Remark ...

#VarU U "updated" icon * Current value: U = * Related: H, I, ICON, M, N, P, Q, S, T, X, Y

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

#VarUSERNAME USERNAME your login username * Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like ...

#VarUSERSWEB USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. * Syntax: %USERSWEB ...

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

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

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

#VarWEBPREFSTOPIC WEBPREFSTOPIC name of web preferences topic * Syntax: %WEBPREFSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, WIKIPREFSTOPIC ...

#VarWIKIHOMEURL WIKIHOMEURL site home URL * Syntax %WIKIHOMEURL% * Expands to == * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar ...

#VarWIKINAME WIKINAME your Wiki username * The WikiName is the same as %USERNAME% if not defined in the . topic * Syntax: %WIKINAME% * Expands to: == ...

#VarWIKIPREFSTOPIC WIKIPREFSTOPIC name of site wide preferences topic * Syntax: %WIKIPREFSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC ...

#VarWIKITOOLNAME WIKITOOLNAME name of your site * Syntax: %WIKITOOLNAME% * Expands to: Petr Malát * Related: WIKIHOMEURL, WIKIVERSION

#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Petr Malát home page * Syntax ...

#VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registered users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * Related ...

#VarWIKIVERSION WIKIVERSION the version of the installed Foswiki engine * Syntax: %WIKIVERSION% * Expands to: == * Related: PLUGINVERSION, WIKITOOLNAME ...

#VarWIKIWEBMASTER WIKIWEBMASTER feedback email address for site * Syntax: %WIKIWEBMASTER% * Expands to: == * Related: WIKIWEBMASTERNAME

#VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site * Syntax: %WIKIWEBMASTERNAME% * Expands to: == * Related: WIKIWEBMASTER ...

#VarX X warning icon * Current value: X = * Related: H, I, ICON, M, N, P, Q, S, T, U, Y

#VarY Y "yes" icon * Current value: Y = * Related: H, I, ICON, M, N, P, Q, S, T, U, X

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

" warn="off"}% * ** * * * * * * * * * * * BeginnersStartHere * TextFormattingRules * Macros * ...

Tools " hidelink="$percntICON{help}$percnt "}% Related Topics * . , site level preferences * list of user topics. User topics can have optional ...

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

* User Tools * * * * * * * * User Documentation * System.BeginnersStartHere ...

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

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

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

Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE can ...