Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki to Foswiki 2.x. This upgrade procedure is used to upgrade a to a new major v...
%IF{"context isadmin AND NOT istopic '.UserRegistration'" then=' Tailoring instructions: You are currently viewing the default registration page without local tai...
ATTACHURL full URL for attachments in the current topic Shorthand for PUBURL, with path set to the current topic. Otherwise supports all the same parameters as PU...
CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such...
#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * ...
ENDCOLOR end colored text ENDCOLOR is one of the shortcut macros predefined in . It is used to terminate a colour change (revert back to the default colour). The ...
ENDSECTION marks the end of a named section within a topic If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If th...
JQREQUIRE enable a plugin on the current page This macro will load a list of plugins to be added to the current page. Use JQPLUGINS to display the list of av...
JQTHEME switch jQuery UI theme Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to foswiki. Use configure to cha...
LANG the language specified by the server locale This macro is used to generate the lang (and xml:lang) attribute in generated HTML pages. If {UseLocale} is enabl...
PUBURL generate an URL for an attachment Generate an absolute URL for an attachment, or for a web or topic within the attachment database. Parameters ...
REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...
REVTITLE The requested revision as displayed in topic breadcrumbs If a topic revision is requested in the URL, it returns the printable revision of the current t...
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. Sections may be given a name to ...
SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCRIBE{...}% or si...
TABPANE tabpane widget This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this: ...
TOPIC name of current topic * %TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included top...
TOPICLIST topic index of a web List of all topics in a web. The "format" defines the format of one topic item. It may include formatting tokens: The $topic token ...
USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to...
WEB name of current web * %WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web w...
WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...
WIKINAME your Wiki username The WikiName is the same as %USERNAME% if not defined in the . topic. This macro is an alias for the USERINFO macro with a fixed forma...
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...
%{ ========================================= Create new topic template This template uses parts from .WebCreateNewTopicComponents. =====================...
This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar bloc...
" hidelink=" #9660; " linkclass="foswikiButton" remember="on"}% About the Web changes notification service Each Foswiki web has an automatic e mail notification ...
%IF{ "$'URLPARAM{tab}'='search' OR $'URLPARAM{tab}'='' AND NOT $TAB='advanced'" then="$percentINCLUDE{$quotWebSearch$quot section=$quotsearch$quot}$percent" }%...
Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...
Appendix C: CSS Listing of CSS class names emitted from Foswiki core code and standard extensions. With Foswiki 2.0 a number of classes have been deprecated. Thes...
Bulk Registration Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. Unlike normal registratio...
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...
Templates for CommentPlugin See CommentPlugin: Customisation for help. While this topic can be viewed as a topic, it is used by the CommentPlugin as a template fi...
Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
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. F...
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
Empty Plugin Learn how to create your own plugin in .DevelopingPlugins. Documentation for Plugin API is in PerlDoc for EmptyPlugin.pm. Note that EmptyPlugin is d...
* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. *...
These two questions are answered together because often when you think you want to delete a page, more often it makes sense to rename the page to contain more con...
You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. Delete moves an attachment to th...
The same topic revision will be used when you save a topic again within a certain time frame (one hour by default, configurable with the configuration setting {Re...
FamFamFamSilkGeoSilkIcons Mark James created a great set of 1,022 silky smooth 16x16 true colour icons in PNG format, aptly named Silk Icons. GeoSilk icon set by...
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, y...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and If...
Formatted Search Customize the display of search results. The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. U...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
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 ...
Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is se...
MailerContribPlugin This is a 'mini' plugin that provides a rest handler for invoking the mail notification process via an HTTP request (e.g. from the browser). I...
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 ...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL...
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: * Set USERSTYLEURL = //PatternSkinCssCookbookNoLeftBar/hideleftbar...
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
PatternSkin horizontal navigation example Include main navigation with: This is done automatically in the templates by setting in the .SitePreferences: * #Set ...
Plain Skin The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any marku...
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *...
PreferencesPlugin Allows editing of preferences using fields predefined in a .DataForms. However, the edit fields are inlined in the text, similar to how tables a...
Project Contributor Foswiki is a development of the Foswiki community. Foswiki is based on TWiki , which was originally written by Peter Thoeny, who based his wor...
Foswiki brand material The official Foswiki logo and derivatives are attached to this page. Logo artwork Logo customization The logo can be changed by redefinin...