Empty Plugin Learn how to create your own plugin in .DevelopingPlugins. Plugin Preferences Plugin preferences should be set using configure, as described in .Dev...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all pr...
#VarSUBSCRIBE SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCR...
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...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEna...
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...
%{ ========================================= Create new topic template This template uses parts from System.WebCreateNewTopicComponents. ===============...
#VarREVARG REVARG rev=n URL revision parameter of current topic * Syntax: %REVARG% * %REVARG% If a topic revision is requested in the URL, it returns th...
#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested i...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks....
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...
#VarTABLE TABLE{ attributes } control attributes of tables and sorting of table columns * The %TABLE{}% macro is handled by the TablePlugin * Syntax: %TA...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
%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...
#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, ...
Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. Web Go to Description %SEARCH{ "'1'" topic="" we...
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
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 ...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar bloc...
#VarHISTORY HISTORY{ attributes } control attributes of tables and sorting of table columns * The %HISTORY{}% macro is handled by the HistoryPlugin * Syn...
#VarQUERYPARAMS QUERYPARAMS show paramaters to the query * Expands the parameters to the query that was used to display the page. * Syntax: %QUERYPARAMS{...
#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 SystemFoswiki Web This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most peo...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Se...
#VarSLIDESHOWSTART SLIDESHOWSTART convert a topic with headings into a slideshow * The %SLIDESHOWSTART% macro is handled by the SlideShowPlugin * Syntax:...
#VarTWISTY TWISTY This renders the button as well as the toggled content section contained within this and the closing ENDTWISTY tag. Usage: %TWISTY{ ... }% Togg...
#VarRENDERZONE RENDERZONE See ADDTOZONE for an explanation of zones. Parameters: * "zone" required, name of the zone. * format="..." optional, format strin...
#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...
#VarTWISTYBUTTON TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. * Sup...
#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...
#VarRENDERLIST RENDERLIST render bullet lists in a variety of formats * The %RENDERLIST% macro is handled by the RenderListPlugin * Syntax: %RENDERLIST% ...
#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...
#VarTABPANE TABPANE{...} tabpane widget * This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane n...
#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...
#VarJQICON JQICON{"name" ...} render an image * This renders an icon image as found on an icon search path. The icon search path is configured in {JQueryPl...
#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...
#VarENDTWISTYTOGGLE ENDTWISTYTOGGLE The Twisty closure * Syntax: %ENDTWISTYTOGGLE% * Will end the most inner unclosed Twisty Toggle section, using the p...
#VarCOMMENT COMMENT{ attributes } insert an edit box into the topic to easily add comments. * A %COMMENT% without parameters shows a simple text box. * T...
#VarSLIDESHOWEND SLIDESHOWEND end slideshow * The %SLIDESHOWEND% macro is handled by the SlideShowPlugin * Syntax: %SLIDESHOWEND% * Example: See SLIDE...
#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topi...
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 ...
#VarJQREQUIRE JQREQUIRE{"plugin, plugin, ... "} enable a plugin on the current page * This macro will load a list of plugins to be added to the current page...
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 ...
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...
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 ...
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...
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...
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More ...
#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...
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...
#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...
#VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site * Syntax: %WIKIWEBMASTERNAME% * Expands to: == * Related: WIKIWEBMASTER...
#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 ...
FamFamFamSilkCompanion2Icons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. Introducing the ...
* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. *...
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...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...
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...
#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...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology * Book: The W...
#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can r...
#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...