#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all preferences ...
#VarEXPAND EXPAND{"expression" scope="topictoexpandin" ...}% Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have ...
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 in ...
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 of ...
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 markup ...
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 ...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTEMWEB ...
TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authentication ...
TinyMCE Editor Help Summary * Normal Normal text style * Heading 1 6 Headings; 1 is largest * On save, content in this HTML editor is automatically ...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE can ...
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 ...
The Smilies Plugin : ) Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile : ) or a frown : ( . This ...
PreferencesPlugin Allows editing of preferences using fields predefined in a .DataForms. However, the edit fields are inlined in the text, similar to how tables are ...
Color scheme settings for .PatternSkin Use this topic to change the color settings of .PatternSkin. When this topic is saved, the attachment my_colors.css will be ...
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). It ...
Mailer Contrib Allows users to "subscribe" to regularly scheduled emails containing either: * A report on changes to all topics that have changed within a particular ...
JQueryPopUpWindow %JQPLUGINS{"popupwindow" format=" Homepage: $homepage Author(s): $author Version: $version " }% Open a page in a new window. Macros ...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCalendarContrib ...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read ...
FamFamFamMintIcons "Mint" icons are a small set of tiny PNG web icons, loosely based on Shaun Inman's Mint statistics software. Released on the same day as the product ...
FamFamFamMiniIcons "Mini" is a set of 144 GIF icons available for free use for any purpose. The flag icon filenames follow the ISO 3166 1 alpha 2 country codes. ...
FamFamFamFoswikiExtras So far built by Foswiki:Main.SvenDowideit based on the Silk ones above, except for 1 the XML icon which comes from http://commons.wikimedia ...
Empty Plugin Learn how to create your own plugin in .DevelopingPlugins. Plugin Preferences Plugin preferences should be set using configure, as described in .DevelopingPlugins ...
PatchFoswikiContrib Usage This extension allows you to "hotfix" urgent issues on your Foswiki system. It has been tested on Foswiki 1.1.0 and beyond. It does not ...
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 enhancements ...
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 running ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add ...
JQueryShrinkUrls %JQPLUGINS{"shrinkurls" format=" Homepage: $homepage Author(s): $author Version: $version " }% Shrinks all urls in a given container ...
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically populate ...
WARNING! THIS TOPIC IS GENERATED BY System.ChecklistPlugin PLUGIN. DO NOT EDIT THIS TOPIC (except table data)! Back to the checklist topic ChecklistPlugin. *context ...
%{ ========================================= Create new topic template This template uses parts from System.WebCreateNewTopicComponents. =============== ...
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 very ...
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. A preference setting ...
WebLinkPlugin This plugin allows to render a link to a web. While linking to a topic is quite essential to wikis, linking to a web as an object of the wiki isn't that ...
#VarNRIMAGES NRIMAGES{"topic"} returns the number of images attachted to a (list of) topics * The %NRIMAGES{"topic"}% macro is handled by the ImageGalleryPlugin ...
#VarIMAGEGALLERY IMAGEGALLERY{"topic" options...} render an image gallery * The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin. * Syntax ...
Under normal circumstances, there should be no need to rebuild your .WikiUsers topic. Sometimes, the .WikiUsers topic maintained by .TopicUserMappingContrib may not ...
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 ...
JQueryScrollTo %JQPLUGINS{"scrollto" format=" Homepage: $homepage Author(s): $author Version: $version " }% With this plugin, you will easily scroll ...
Interface for Plugin and Contrib Developers See .DevelopingPlugins for more information. Package First Published Comment Foswiki::Func 1.1.5 Main API ...
#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested in ...
#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 ...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: Include meta navigation with: Include sections %INCLUDE{ "PatternSkinThemeFatWillyNavigation ...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activity ...
Macros Special text strings expand on the fly to display user data or system info Macros are text strings in one of two forms: These usually expand into content when ...
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded ...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they are ...
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. Authentication ...
Installation Guide Part 1 This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server ...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks. ...
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 ...
FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons ...
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 ...
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 ...
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 want ...
#VarTABLE TABLE{ attributes } control attributes of tables and sorting of table columns * The %TABLE{}% macro is handled by the TablePlugin * Syntax: %TABLE ...
Pattern skin Pattern skin provides a CSS based default look and feel flexible and W3C compliant. Its layout and color scheme are designed to provide a nice, clean ...
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 ...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generated ...
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: ...
%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 $wikiusername ...
%{ Include the default view templates from your current SKIN and COVER paths }%%{ Override the content template DEFinition. This normally just contains , but ...
Query Search Query searches help you search the contents of forms attached to your topics, as well as the values of other meta data attached to the topic. Using query ...
#VarMETA META displays meta data Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta data (attachments, forms ...
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 ...
Compare Revisions Add On Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the comparison ...
Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. Web Go to Description %SEARCH{ "'1'" topic="" web ...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEnabled ...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Test this theme Choose column ' selected='selected' "}% Column right No column Hide theme Store theme ...
See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, Technical ...
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First Read ...
.PatternSkin CSS Cookbook Questions and answers on how to customize the default look of Foswiki for your own needs, using style sheets. For configuring page elements ...
Manage Users Register users on your Foswiki site; change/reset/install passwords; remove user accounts Some of the features below may be disabled, depending on your ...
Tips Contrib Package Displays a rotating "Tip of the Day" to help familiarize new users with Foswiki features. Includes an application for creating custom tips for ...
History Plugin Shows a complete history of a topic. The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin ...
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 ...
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attach ...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPluginExamples ...
Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Foswiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They can ...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by UseMod ...
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 internationalised ...
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 ...
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 ...
CSS elements in PatternSkin This page is a reference for all CSS classes used in PatternSkin. PatternSkin uses 4 stylesheets: * layout.css: positioning of block ...
#VarADDTOZONE ADDTOZONE %ADDTOZONE{ "zone" ... }% Parameters: * "zone" optional, comma separated list of the names of zones that the content should be added ...
Page Caching By default, Foswiki pages are delivered to the browser using HTML, which is regenerated from the data stored in Foswiki each time the page is requested ...
#VarGROUPINFO GROUPINFO{"name"} retrieve details about a group * Syntax: %GROUPINFO% * Expands to: comma separated list of all groups * Syntax: %GROUPINFO ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar block ...
PatternSkin horizontal navigation example Include main navigation with: Include meta navigation with: Include sections %INCLUDE{ "PatternSkinHorizontalNavigationExample ...
#VarWIKIHOMEURL WIKIHOMEURL site home URL * Syntax %WIKIHOMEURL% * Expands to == * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar ...
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 ...
#VarHISTORY HISTORY{ attributes } control attributes of tables and sorting of table columns * The %HISTORY{}% macro is handled by the HistoryPlugin * Syntax ...
#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 ...
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 ...
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 control ...
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 raw ...
Formatted Search Customize the display of search results. The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. Use ...
Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this site. * Note:* This topic should be regarded as read ...
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 ...
#VarQUERYPARAMS QUERYPARAMS show paramaters to the query * Expands the parameters to the query that was used to display the page. * Syntax: %QUERYPARAMS{ ...
#VarFORMAT FORMAT{"list" format="" header="" footer="" separator=""} format a list of objects * Syntax: %FORMAT{"list"}% * Supported parameters: Parameter ...
#VarEXAMPLETAG EXAMPLETAG example variable * The %EXAMPLETAG{}% variable is handled by the ExamplePlugin * Syntax: %EXAMPLETAG{"text" format="..."}% * ...
Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki or TWiki (such as Cairo or TWiki4.0) to Foswiki 1.1 (References to Cairo are ...
JQueryFocus %JQPLUGINS{"focus" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin sets the focus on a form input field ...
#VarJQTHEME JQTHEME{"name" ...} switch jQuery UI theme * Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to ...
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 ...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in case ...
Welcome to the System Web This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the ...
JQueryButton %JQPLUGINS{"button" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a simple way to render nice buttons ...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Sections ...
Foswiki System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platforms ...
#VarSLIDESHOWSTART SLIDESHOWSTART convert a topic with headings into a slideshow * The %SLIDESHOWSTART% macro is handled by the SlideShowPlugin * Syntax: ...
A List of Wiki Administrator Documentation $ AccessControl : Restricting read and write access to topics and webs, by users and groups $ TopicUserMappingContrib ...
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, export ...
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= ...
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 The ...
PatternSkin theme: 2009 Test this theme Choose column ' selected='selected' "}% Column left (default) Column right No column Small left column Choose variant ...
#VarENCODE ENCODE{"string"} encodes a string * Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character ...
#VarTWISTY TWISTY This renders the button as well as the toggled content section contained within this and the closing ENDTWISTY tag. Usage: %TWISTY{ ... }% Toggable ...
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 work ...
What makes Foswiki the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively * If ...
Foswiki is distributed under the Gnu General Public License. You can get the sources in several ways: * Official releases may be downloaded from http://foswiki ...
JQueryLiveQuery %JQPLUGINS{"livequery" format=" Homepage: $homepage Author(s): $author Version: $version " }% How to use it Live Query utilizes the ...
#VarRENDERZONE RENDERZONE See ADDTOZONE for an explanation of zones. Parameters: * "zone" required, name of the zone. * format="..." optional, format string ...
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is set ...
#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 ...
#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 ...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated * The current topic name with added URL encoded spaces, for use in regular expressions ...
#VarINCLUDE INCLUDE{"topic"} include other topic. * Syntax: %INCLUDE{"topic" ...}% (See also the URL form of %INCLUDE%) * Supported parameters: Parameter ...
#VarENDCOLOR ENDCOLOR end colored text * ENDCOLOR is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that 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 ...
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 ...
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 ...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and IfStatements ...
#VarTWISTYBUTTON TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. * Supported ...
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 localization ...
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A Foswiki topic name always has a fixed ...
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 ...
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 ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Foswiki home page * Syntax: ...
#VarWIKINAME WIKINAME your Wiki username * The WikiName is the same as %USERNAME% if not defined in the . topic * Syntax: %WIKINAME% * Expands to: == ...
#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 ...
#VarUSERNAME USERNAME your login username * Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like ...
#VarUSERINFO USERINFO{"name"} retrieve details about a user * Syntax: %USERINFO% * Expands to: (comma separated list of the username, wikiusername, and emails ...
#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: ...
#VarTOPICURL TOPICURL shortcut to viewing the current topic * This macro always expands to an url pointing to the current base topic. * Current value: TOPICURL ...
#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 ...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places * Inserts spaces after lower case letters that are followed by a digit ...
#VarSERVERTIME SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME% OR %SERVERTIME{"format"}% * %SERVERTIME ...
#VarSCRIPTURLPATH SCRIPTURLPATH{"script"} URL path of script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL * Syntax ...
#VarSCRIPTURL SCRIPTURL{"script"} URL of script * Syntax: %SCRIPTURL% OR %SCRIPTURL{"script"}% * %SCRIPTURL% returns the base URL of scripts expands to ...
#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 ...
#VarQUERY QUERY get the value of meta data * Uses the query syntax described in QuerySearch to get information about meta data. * supports formatted access ...
#VarRENDERLIST RENDERLIST render bullet lists in a variety of formats * The %RENDERLIST% macro is handled by the RenderListPlugin * Syntax: %RENDERLIST% ...
#VarTABPANE TABPANE{...} tabpane widget * This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally ...
#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion ...
#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 ...
#VarMAKETEXT MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected ...
#VarLOGOUT LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty ...
#VarLOGIN LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty ...
#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 {UseLocale ...
#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 {JQueryPlugin ...
#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 ...
#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syntax ...
#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 ...
#VarGMTIME GMTIME{"format"} formatted GM time * Syntax: %GMTIME% OR %GMTIME{"format"}% * %GMTIME% uses the default date format defined by the {DefaultDateFormat ...
#VarEDITACTION EDITACTION Selects an edit template * The EDITACTION preference setting lets you define the use of an editaction template instead of the standard ...
#VarDISPLAYTIME DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in ...
#VarDATE DATE signature format date * Syntax: %DATE% * Expands to: == * Date format defined as {DefaultDateFormat} in configure When used in a template ...
#VarCALC CALC{"formula"} add spreadsheet calculations to tables and outside tables * The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are ...
#VarENDTWISTYTOGGLE ENDTWISTYTOGGLE The Twisty closure * Syntax: %ENDTWISTYTOGGLE% * Will end the most inner unclosed Twisty Toggle section, using the proper ...
#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * Syntax ...
#VarSLIDESHOWEND SLIDESHOWEND end slideshow * The %SLIDESHOWEND% macro is handled by the SlideShowPlugin * Syntax: %SLIDESHOWEND% * Example: See SLIDESHOWSTART ...
#VarCOMMENT COMMENT{ attributes } insert an edit box into the topic to easily add comments. * A %COMMENT% without parameters shows a simple text box. * The ...
#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} expert option in configure. This is used in certain password encodings, and in login ...
Using HTML You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is formatted in a way that is not supported ...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
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 registering ...
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 Form Help %IF{"$ BASEWEB=''" then="%IF{"istopic '.UserFormHelp'" then="This is the default user form. You have also created a customized copy at .UserForm ...
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 ...
Topics #SystemWebFigure Figure: depiction of WebHome, ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the System web #TopicDefinition ...
#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topic ...
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, $FIND ...
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 standing ...
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 ...
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 for ...
Some questions to answer: * Perhaps the plugin is installed, but did you remember to enable it in configure? * Did the installer mention any missing dependencies ...
JQueryFluidFont %JQPLUGINS{"fluidfont" format=" Homepage: $homepage Author(s): $author Version: $version " }% Recompute the font size of an element ...
#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 ...
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 ...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encouraged ...
Wiki culture, concepts and principles General concept and idea of wikis What is a wiki? "A wiki is a page or collection of Web pages designed to enable anyone who ...
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 ...
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 ...
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 ...
Collaboration Tips Following you will find a short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. ...
" hidelink=" #9660; " linkclass="foswikiButton" remember="on"}% About the Web changes notification service Each Foswiki web has an automatic e mail notification service ...
PatternSkinCssCookbook Recipe: Sidebar background color To see if the background color really extends beyond the body, we make the body contents longer than the sidebar ...
PatternSkinCssCookbook Recipe: Hide the top bar This recipe shows how to hide the top bar. This line loads the extra style definition: * Set USERSTYLEURL=/notopbar ...
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: * Set USERSTYLEURL = //PatternSkinCssCookbookNoLeftBar/hideleftbar ...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL ...
PatternSkinCssCookbook Recipe: EditTable style Cookbook example to illustrate control over EditTable edit styles. 1 EditTable uses a monospace font in edit mode ...
PatternSkinCssCookbook Recipe: Center the page with a border This recipe shows how to put a border around the page, while centering the page horizontally. The example ...
PatternSkinCssCookbook Recipe: Center the page This recipe shows how center the page horizontally and vertically. This line loads the extra style definition: * ...
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: ...
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 registration ...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfortunately ...
Logos The official Foswiki logo is attached to this page. Logo Artwork Logo Customization The logo can be changed by redefining the WIKILOGOIMG preference setting ...
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. ...
Hierarchical Navigation Navigation block that displays the current topic, its parent and children (if any). This is intended to be included in other topics, for example ...
This answer assumes you have basic knowledge about Data Forms. Using the steps below, you will create: 1 A form definition 1 A topic creation (HTML) form to ...
A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new object instances ...
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More Information ...
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when content ...
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $TIME ...
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 %EDITTABLE ...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enables ...
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spanning ...
Revision control In Foswiki, assuming appropriate AccessControls, anyone can change anything but those changes are logged. There is a complete audit trail with record ...
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 layout ...
Breadcrumb The breadcrumb of a topic shows you page hierarchy. It is constructed using a topic's parent setting; for example, the breadcrumb on this page looks like ...
File attachments Files can be attached to any topic. The action of attaching a file to a topic is similar to attaching a file to an e mail use the Attach link in ...
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Site level settings: ...
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 ...
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 ...
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 ...
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 !! to ...
Re parenting a topic The breadcrumbs ( Contribs TipsContrib TipsOfTheDay , for example) of any topic is constructed automatically in Foswiki by following ...
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 notified ...
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 looks ...
WebChanges to see recent activity Each Foswiki web has a WebChanges topic that lists recent activity from all editors of the web. This can be useful when looking for ...
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 the ...
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 creates ...
Foswiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening unless ...
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 configure ...
Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, and ...
%{ Include the default edit templates from your current SKIN and COVER paths }%%{ Define the formtop container to display the form }%%{ Define the formbottom ...
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 {ReplaceIfEditedAgainWithin ...
You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. The soft delete moves an attachment ...
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 context ...
#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 ...
#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 ...
Glossary of Terms Term Definition Attachment Any type of file that is uploaded via browser and attached to a topic, where it can be viewed and downloaded ...
RSS News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribe in WebNotify ...
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 ...
Tip Of The Day Administration Adminstrative Pages TipsOfTheDay Aggregated List of All Tips, from and . TipsOfTheDayAddNew Add A New Tip TipsOfTheDayInclude ...
Add New Tip Of The Day There are Custom Tips maintained on your local Foswiki installation, Official Tips distributed with the Tips Contrib, and Plugin Tips maintained ...
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 ...
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 not ...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write %COMMENT{ attributes ...
Control table attributes with TablePlugin The TablePlugin gives extra control of table display: * Allows sorting * Changing table properties like border width ...
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 frown ...
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. ...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good browsing ...
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. See ...
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with = noautolink = and = /noautolink = tags. Each tag ...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wiki ...
#VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registered users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * Related ...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentationCategory ...
An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example: package Telecoms ClassMethod new() ObjectMethod ...
The name you log in with A login name is a sequence of alphanumeric characters and underscores. You cannot alter your LoginName: you have to get the administrator ...
#VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site * Syntax: %WIKIWEBMASTERNAME% * Expands to: == * Related: WIKIWEBMASTER ...
JQueryForm %JQPLUGINS{"form" format=" Homepage: $homepage Author(s): $author Version: $version " }% The jQuery Form Plugin allows you to easily and ...
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 background ...
Go Box The box at the top or sidebar of each page, also called Jump box. Enter a topic name to quickly jump to the topic, for example: * WebNotify to jump to WebNotify ...
Regular Expressions Introduction Regular expressions (REs), unlike simple queries, allow you to search for text which matches a particular pattern. REs are similar ...
This site is running Foswiki version * * "}%, Release , Foswiki API version * Installed Plugins Here is a list of the plugins currently installed and enabled ...
Country list List of countries used in the UserForm . To use this list in Foswiki applications, see the country SEARCH example in SearchPatternCookbook . Name ...
Force new revision option Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), Foswiki will fold together ...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: UserAuthentication ...
#VarICONURLPATH ICONURLPATH{"name" default="name"} URL path of small documentation graphic or icon * Generates the relative URL path of a image, typically used ...
#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 ...
#VarICON ICON{"name" alt="" default="name"} small documentation graphic or icon of common attachment types * Generates a small graphic image from the set attached ...
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. Foswiki ...
JQueryMaskedInput %JQPLUGINS{"maskedinput" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a masked input plugin for ...
JQueryGradient %JQPLUGINS{"gradient" format=" Homepage: $homepage Author(s): $author Version: $version " }% Adds a gradient to the background of an ...
JQueryFarbtastic %JQPLUGINS{"farbtastic" format=" Homepage: $homepage Author(s): $author Version: $version " }% Farbtastic is a jQuery plug in that ...
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 Silk ...
JQuerySupersubs %JQPLUGINS{"supersubs" format=" Homepage: $homepage Author(s): $author Version: $version " }% This is a companion plugin to superfish ...
JQueryMigrate %JQPLUGINS{"migrate" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin can be used to detect and restore ...
#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. ...
* 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 collaboration ...
Foswiki is a Wiki Wiki clone and has its root in JOS Wiki via TWiki . * Foswiki's home is at http://foswiki.org/ * Foswiki takes a lot of ideas from Ward Cunningham ...
** 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 ...
Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Koren ...
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 ...
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 ...
Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentationCategory ...
* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. * ...
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 WebNotify ...
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 ...
Access Keys What are access keys? Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without having ...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simple ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDPLUGINS ...
#VarALLVARIABLES ALLVARIABLES list of currently defined macros * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined macros in the current ...
Web Site Tools * (More options in WebSearch) * WebChanges: Display recent changes to the web * WebIndex: List all topics in alphabetical order. See ...
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 ...
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 defaultColour ...
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 ...
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 attachment ...
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 ...
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 packaged ...
FamFamFamSilkIcons Silk is a smooth, free icon set, containing over 700 16 by 16 pixel icons in strokably soft PNG format. Containing a large variety of icons, you ...
FamFamFamSilkCompanion1Icons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. Damien Guard's set ...
#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 ...
#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 ...
#VarWIKIVERSION WIKIVERSION the version of the installed Foswiki engine * Syntax: %WIKIVERSION% * Expands to: == * Related: PLUGINVERSION, WIKITOOLNAME ...
#VarWEBPREFSTOPIC WEBPREFSTOPIC name of web preferences topic * Syntax: %WEBPREFSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, WIKIPREFSTOPIC ...
#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 ...
#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 ...
#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 ...
#VarUSERSWEB USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. * Syntax: %USERSWEB ...
#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 ...
#VarSYSTEMWEB SYSTEMWEB name of documentation web * The web containing all documentation and default preference settings * Syntax: %SYSTEMWEB% * Expands ...
#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 ...
#VarSTATISTICSTOPIC STATISTICSTOPIC name of statistics topic * Syntax: %STATISTICSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, NOTIFYTOPIC ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTSUFFIX ...
#VarSCRIPTNAME SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) * Syntax ...
#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %PUBURL ...
#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specific ...
#VarNOTIFYTOPIC NOTIFYTOPIC name of the notify topic * Syntax: %NOTIFYTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, STATISTICSTOPIC, TOPIC ...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload ...
#VarLANGUAGES LANGUAGES list available languages * List the languages available (as PO files). These are the languages in which the user interface is available ...
#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 the ...
#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 ...
#VarENV ENV{"varname"} inspect the value of an environment variable * Returns the current value of the environment variable in the CGI (Common Gateway Interface ...
#VarENDSECTION ENDSECTION{"name"} marks the end of a named section within a topic * Syntax: %ENDSECTION{"name"}% * Syntax: %ENDSECTION{type="include"}% ...
#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR ...
#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBURL ...
#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can refer ...
#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS ...
Copyright � by the contributing authors. All material on this site is the property of the contributing authors. Ideas, requests, problems regarding Foswiki? Send feedback