Backlinks to Macros in System Web

#### Results from System web retrieved at 04:13 (Local)

AccessControl
Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...
BeginnersStartHere This is a short introduction to Foswiki. A short introduction to Foswiki Use the slideshow navigation buttons on the bottom right of the page...
CalendarPlugin
Calendar Plugin The CalendarPlugin handles the macro %CALENDAR% that inserts a monthly calendar in the page. Multiple topics can be specified as the source of the...
CommandAndCGIScripts
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...
CommentPlugin
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
CommentPluginTemplate
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...
CompleteDocumentation
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
DataForms
Data Forms Structured data, how to set up and work with data forms. Overview Next to freeform topic contents, each topic can store additional data in name/value ...
DefaultPreferences
CLASSE Wiki 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...
DeveloperDocumentationCategory
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
DevelopingPlugins
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 ...
DocumentGraphics
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: %I...
EditRowPlugin
EditRowPlugin @import url(/System/EditRowPlugin/erp.uncompressed.css); Features: 1 You can edit one row, or even one cell at a time, instead of having to edit ...
EditTablePlugin
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...
EditingShorthand
Editing Shorthand Formatting Command: You write: You get: Paragraphs: Blank lines will create new paragraphs. 1st paragraph 2nd paragraph 1st paragraph 2nd ...
FileAttachment
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. Att...
FlexFormPlugin
FlexFormPlugin This plugin leverages the internal capabilities to render an interface for .DataForms and adds insights to the acutal DataForm definition itself ...
FormatTokens
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and If...
FormattedSearch
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...
FullCalendarPlugin
Full Calendar Plugin Adam Shaw has produced a great Web 2.0 Calendar UI, the jQuery FullCalendar Plugin. This Foswiki plugin provides the backend calendar managem...
GlossaryOfTerms
Glossary of Terms Glossary of Foswiki specific terminology. $Attachment: Any type of file that is uploaded via browser and attached to a topic, where it can b... IfStatements 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 ... IncludeTopicsAndWebPages Include Topics and Web Pages Using %INCLUDE{...}% Macro Embed topics, or subsections of topics, or other web pages. The %INCLUDE{...}% macro embeds the content of... InstallationGuide Installation Guide This guide describes the steps for installing Foswiki using Apache as the web server, on Linux. This guide describes the specific steps for ins... InstantEnhancements Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura... InterwikiPlugin Interwiki Plugin The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the .InterWikis topic. This plugin is inspired by ... JQueryButton JQueryButton %JQPLUGINS{"button" format=" Homepage:$homepage Author(s): $author Version:$version " }% This is a simple way to render nice butto...
JQueryCodingStandards
JQueryPlugin
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
JQueryPopUpWindow
JQueryPopUpWindow %JQPLUGINS{"popupwindow" format=" Homepage: $homepage Author(s):$author Version: $version " }% Open a page in a new window. M... JQueryTabpane JQueryTabpane Plugin Info %JQPLUGINS{"tabpane" format=" Homepage:$homepage Author(s): $author Version:$version " }% Summary This implements ...
MacrosQuickReference
Macros Quick Reference See Macros for a detailed description of how to use Macros Predefined Macros %SEARCH{ "1" type="query" topic="Var*" we...
MainFeatures
What makes Foswiki .... the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ...
ManagingTopics
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 ...
ManagingWebs
Managing Webs Browser based rename, move, copy, and delete for individual webs %ADDTOZONE{"head" text=" #createWeb .col1 {float:left; width:30%; margin:0 3% 0...
MathJaxPlugin
MathJaxPlugin Usage Examples Maxwell's Equations %MATHMODE{ \nabla \times \vec{\mathbf{B}} \, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} = \frac...
#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 st...
NatEditWordHelpText
NatEditWordHelpText Help text for the NatEditPlugin editor * * * * * * * B = Bold * I = Bold * _ = Underline * = Strike * l...
ObjectPlugin
ObjectPlugin The object is to use foswiki topics to store lots of objects (chunks of structured data) that can be searched, filtered and manipulated. The intentio...
OriginalDocumentGraphics
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: ...
PageCaching
Page Caching How to get the best from HTML Caching. By default, Foswiki pages are delivered to the browser using HTML, which is regenerated from the data stored i...
PatternSkin
Pattern skin Select a theme to change the look, or tune the entire appearance with CSS or templates. Browse available themes You may quickly change the appearanc...
Plugins
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. ...
PreferenceSettings
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *...
PublishedAPI
Name First Foswiki Version Comment Foswiki::Func 1.1.5 Main API. Foswiki::Attrs 1.1.5 Parameter passing for custom macros Foswiki::Request ...
QuerySearch
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 q...
ReferenceManual
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
ReleaseHistory
Appendix A: Foswiki Development Time line The complete timeline of Foswiki Releases. Foswiki was forked from TWiki 4.2.4 and released with significant improvments...
ReleaseNotes01x00
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 pro...
ReleaseNotes01x01
Foswiki Release 1.1.10 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use ...
ReleaseNotes02x00
Foswiki Release 2.0.3 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
ReleaseNotes02x01
Foswiki Release 2.1.6 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for professional use i...
RenderListPlugin
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
SearchPatternCookbook
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...
SiteTools
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...
SkinTemplateTokens
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...
SkinTemplates
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded...
Skins
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 ...
SlideShowPlugin
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...
SmiliesPlugin
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 : ( . Th...
Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to CLASSE Wiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. The... StandardColors The 216 Standard Colors This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 ... TablePlugin Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting... TemplateTopics #TemplateTopics Template topics Foswiki uses several types of templates. Template topics are topics that define the default text for new topics. (If you are look... TinyMCEFrequentlyAskedQuestions 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 t... TinyMCEPlugin 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... TinyMCEQuickHelp TinyMCE Editor Help Summary * Normal Normal text style * Heading 1 6 Headings; 1 is largest * On save, content in this HTML editor is automatical... TipTopic018 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.... TopicInteractionPlugin TopicInteractionPlugin This plugin redesigns the way how users interact with topics and attachments in various ways: * improved attachment handling * improv... TopicMarkupLanguage What is Topic Markup Language (TML)? The special text format used in Foswiki topics to simplify topic text. Foswiki lets you work using a WYSIWYG editor, which fo... TopicsAndWebs Topics What are Topics and Webs? #SystemWebFigure Figure: depiction of , ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the web... TwistyPlugin 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: ... UserAuthentication User Authentication Controlling who can access your site Overview Authentication, or "login", is the process by which a user lets Foswiki know who they are. Know... UserSetting User Settings preference settings customizable by users Some of the preference settings are explicitly intended to be customized by users, though a default is p... UsersGuide 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 Examples * %ACTIVATEDPLUGINS% expands to Related PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION VarADDTOHEAD ADDTOHEAD deprecated, use ADDTOZONE instead This macro is deprecated. Please use VarADDTOZONE instead. It effecively is a shortcut for %ADDTOZONE{"head" ...}% VarADDTOZONE ADDTOZONE add content to a named zone on the page Parameters Parameter Description Default "zone" comma separated list of the names of zones th... VarALLVARIABLES ALLVARIABLES list of currently defined macros Expands to a table showing all defined macros in the current context Deprecated 2009 04 29 in favour of SHOWPREF... VarATTACHURL 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... VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic Shorthand for PUBURLPATH with path set to the current topic. Otherwise supports all the same paramet... VarAUTHREALM AUTHREALM authentication realm String defined as the {AuthRealm} expert option in configure Security And Authentication tab, =Login sub tab.. This is used in cert... 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 INCLUDE. This is the... 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 %WEB% in case there... VarBUTTON BUTTON renders a nice button Parameters Parameter Description Default "text" text to be put on this button value text t... VarCALC CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such... VarCALCULATE CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar... VarCOMMENT COMMENT insert an edit box into the topic to easily add comments. Parameters * The following standard attributes are recognized Name Descriptio... VarCOVER COVER current skin cover Extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, the skin search path becomes... VarDATE DATE signature format date Examples * %DATE% expands to == * Date format defined as {DefaultDateFormat} in configure When used in a template topic, thi... VarDISPLAYTIME DISPLAYTIME display formatted time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers... VarEDITTABLE #VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * ... VarENCODE ENCODE encode characters in a string Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or se... VarENDCOLOR 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 ... VarENDINCLUDE ENDINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining text. A normal view... VarENDSECTION 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... VarENDTAB ENDTAB ending marker for a tab of a tabpane This closes a previously opened TAB. Related TAB, TABPANE, ENDTAB, JQueryPlugin, JQueryTabpane VarENDTABPANE ENDTABPANE ending tag for tabpane widget This closes a previously opened TABPANE. Related TAB, ENDTAB, TABPANE, JQueryPlugin, JQueryTabpane VarENDTWISTY ENDTWISTY complements an opening TWISTY tag to close a twisty Closes an open twisty Related VarENDTWISTYTOGGLE ENDTWISTYTOGGLE Twisty closure Will end the most inner unclosed Twisty Toggle section, using the proper tag Examples %ENDTWISTYTOGGLE% Related VarENV ENV inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is ... VarEXAMPLETAG EXAMPLETAG example macro tag The %EXAMPLETAG% variable is handled by the ExamplePlugin Parameters Parameter Description Default "..." Unnamed p... VarEXPAND EXPAND expand macros in a string as if they were used in another topic The viewer must have VIEW access to topictoexpandin for this to work. All the standard form... VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI... VarFORMAT FORMAT format a list of objects Parameters Parameter Description Default "one, two, three" The list to be expanded into the format. R... VarFORMFIELD FORMFIELD renders a field in the form attached to some topic Parameters Parameter Description Default "name" The name of a Data form ... VarGMTIME GMTIME formatted Greenwich Mean Time (UTC) Parameters Parameter Description Default "format" format$day $month$year $hour:$min %GMTI...
VarGROUPINFO
GROUPINFO retrieve details about a group Parameters Parameter Description Default "groupname" Optional name of group format ...
VarGROUPS
GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups. * The macro is intended to...
VarHISTORY
HISTORY control attributes of tables and sorting of table columns The %HISTORY{}% macro is handled by the HistoryPlugin Parameters Parameter ...
VarHOMETOPIC
HOMETOPIC home topic in each web Examples * %HOMETOPIC% expands to ==, renders as Related NOTIFYTOPIC, STATISTICSTOPIC, TOPIC
VarHTTP
HTTP get HTTP headers * Called with the name of an HTTP request header field, returns its value. Capitalization and the use of hyphens versus underscores are n...
VarHTTPHOST
HTTP_HOST environment variable Examples * %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 to determine wh...
VarICON
ICON small documentation graphic or icon of common attachment types Generates a small graphic image from the set attached to . Images typically have a 16x16...
VarICONURL
ICONURL URL of small documentation graphic or icon Generates the full URL of a image, which Foswiki renders as an image. The related %ICON{"name"}% generat...
VarICONURLPATH
ICONURLPATH URL path of small documentation graphic or icon Generates the relative URL path of a image, typically used in an HTML img tag. Specify image na...
VarIF
IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...
VarIMAGEGALLERY
#VarIMAGEGALLERY IMAGEGALLERY{"topic" options...} render an image gallery * The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin. * Syn...
VarINCLUDE
INCLUDE include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation (Including a topic) Parameters Parameter: Des...
VarINCLUDINGTOPIC
INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as %TOPIC% in case there is no include. If a...
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. If a topic is used ...
VarJQICON
JQICON render an image Renders an icon image as found on an icon search path. The icon search path is configured Extensions tab, JQueryPlugin sub tab in {JQueryP...
VarJQICONPATH
JQICONPATH render the urlpath to an image This is a shortcut for Examples * %JQICONPATH{"tick"}% expands to == Related JQICON, ICONURL, JQueryPlugin...
VarJQPLUGINS
JQPLUGINS display a summary of available plugins Parameters Parameter Description Default "plugins" this is a regular expression that...
VarJQREQUIRE
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...
VarJQTHEME
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... VarKINOSEARCH KINOSEARCH tag If the KinoSearchPlugin is enabled, you will be able to use the KINOSEARCH tag to search indexed topics and attachments: * %KINOSEARCH{'Search S... 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} is enabl... 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 user interface. T... VarLANGUAGES LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is available. Parameters ... VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload the system le... VarLOGIN LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty string "}%... VarLOGOUT LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ... VarMAINWEB MAINWEB deprecated 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 language ... 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 etc.).... 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. Param... VarNONCE NONCE generate a nonce (developers only) DEVELOPERS ONLY This macro is used to generate a 'nonce', a unique key that identifies the source of a request in order t... VarNOP NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros... VarNOTIFYTOPIC NOTIFYTOPIC name of the notify topic Examples * %NOTIFYTOPIC% expands to ==, renders as Related HOMETOPIC, STATISTICSTOPIC, TOPIC VarPERLDEPENDENCYREPORT PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co... VarPHOTOGALLERY PHOTOGALLERY render photo gallery from attachments The %PHOTOGALLERY% macro is handled by the PhotoGalleryPlugin. Parameters Parameter Description Defaul... VarPLUGINDESCRIPTIONS PLUGINDESCRIPTIONS list of plugin descriptions Examples * %PLUGINDESCRIPTIONS% expands to Related ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API Use %PLUGINVERSION{"name"}% to get the version of a specific plugin Examples * %PLUG... VarPOPUPWINDOW POPUPWINDOW opens a topic or url in a new window Parameters Parameter Description Default "topic" topic="topic" topic="web.topic" T... VarPUBURL 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 ... VarPUBURLPATH PUBURLPATH generate a relative URL for an attachment Generate a relative URL for an attachment, or for a web or topic within the attachment database. Parameters ... VarQUERY QUERY get the value of meta data Uses the query syntax described in QuerySearch to get information about meta data from one specified topic. * supports formatt... VarQUERYPARAMS QUERYPARAMS show parameters to the query Expands the parameters to the query that was used to display the page. Parameters Parameter: Description:... 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 page. For exa... VarREMOTEADDR REMOTE_ADDR environment variable Examples * %REMOTE_ADDR% expands to == Related ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER VarREMOTEPORT REMOTE_PORT environment variable Examples * %REMOTE_PORT% expands to Related ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER VarREMOTEUSER REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ... VarRENDERLIST RENDERLIST render bullet lists in a variety of formats The %RENDERLIST% macro is handled by the RenderListPlugin Examples * Engineering * Tech Pub... VarRENDERZONE RENDERZONE render the content of a zone Rendersa zone. See ADDTOZONE for an explanation of zones. Parameters Parameter Description Default ... VarREVARG REVARG rev=n parameter of current request %REVARG% If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten... VarREVINFO REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date$wikiusername"}% Examples * %REVINFO% expands to =...
VarREVTITLE
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...
VarSCRIPTNAME
SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) Examples * %SCRIPTN...
VarSCRIPTSUFFIX
SCRIPTSUFFIX script suffix * Some CLASSE Wiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands...
VarSCRIPTURL
SCRIPTURL URL of script(s) Expands to the URL of a script, or the base URL of all scripts Parameters Parameter Description Default "$script" ... VarSCRIPTURLPATH SCRIPTURLPATH URL path of script(s) Expands to the base URL of scripts, without protocol or host Parameters Parameter Description Default "$s...
VarSEARCH
SEARCH search content Inline search, shows a search result embedded in a topic Parameters Parameter Description Default: "text" search...
VarSERVERINFORMATION
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
VarSERVERTIME
SERVERTIME formatted server time Same format parameters as VarGMTIME GMTIME% , but displaying the server time instead of UTC. Examples * %SERVERTIME% els...
VarSESSIONID
SESSIONID unique ID for this session Examples * %SESSIONID% expands to == Related UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE...
VarSESSIONVAR
SESSIONVAR name of CGI and session variable that stores the session ID Examples * %SESSIONVAR% expands to Related UserAuthentication, AUTHREALM, SESSIONID,...
VarSESSIONVARIABLE
SESSION_VARIABLE get, set or clear a session variable Parameters Parameter Description "name" name of variable set value to set it to ...
VarSET
SET set a preference setting during runtime A preference setting created via a %SET macro is usable by the topic containing the %SET statement, and in any other t...
VarSHOWPREFERENCE
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
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 using the URL parame...
VarSLIDESHOWEND
SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin
VarSLIDESHOWSTART
SLIDESHOWSTART convert a topic with headings into a slideshow Handled by the SlideShowPlugin Parameters Parameter Description template optional n...
VarSPACEDTOPIC
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for bac...
VarSPACEOUT
SPACEOUT renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit or a capital letter, and afte...
VarSTARTINCLUDE
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the next %ENDINCLUDE% macro, or...
VarSTARTSECTION
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 ...
VarSTATISTICSTOPIC
STATISTICSTOPIC name of statistics topic Examples * %STATISTICSTOPIC% expands to ==, renders as Related HOMETOPIC, NOTIFYTOPIC, TOPIC
VarSTOPINCLUDE
STOPINCLUDE Alias for ENDINCLUDE Related INCLUDE, STARTINCLUDE
VarSTOPSECTION
STOPSECTION Alias for ENDSECTION Related ENDSECTION, STARTSECTION
VarSYSTEMWEB
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
VarTAB
TAB tab inside a tabpane widget Defines a tab inside a TABPANE area; must be closed using ENDTAB. Parameters Parameter Description Default ...
VarTABLE
TABLE control attributes of tables and sorting of table columns The %TABLE{}% macro is handled by the TablePlugin Attributes for tables Parameter ...
VarTABPANE
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: ...
VarTOC
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 included top...
VarTOPICLIST
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 ... VarTWIKIWEB TWIKIWEB synonym for SYSTEMWEB Deprecated. Use %SYSTEMWEB% instead VarTWISTY TWISTY generate content block with interactive visibility controls This renders the button as well as the toggled content section contained within this and the cl... VarTWISTYBUTTON TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. Parameters All parameters... VarTWISTYHIDE TWISTYHIDE Hide/close link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ... VarTWISTYSHOW TWISTYSHOW Show/open link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ... VarTWISTYTOGGLE TWISTYTOGGLE Twisty Toggle contents section Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYT... VarURLPARAM URLPARAM get URL or HTTP POST parameter value Returns the value of the named parameter in the URL or HTTP POST request. Parameters Parameter: Desc... VarUSERINFO USERINFO retrieve details about a user Parameters Parameter Description "name" WikiName or login username. May be a group. current user ... VarUSERNAME USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au... VarUSERSWEB USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to... VarVAR VAR get a preference value from another web Parameters Parameter Description "name" name of preference to retrieve web name of web to r... 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 the web w... VarWEBLIST WEBLIST index of all webs Generate a list of webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the fo... VarWEBPREFSTOPIC WEBPREFSTOPIC name of web preferences topic Examples * %WEBPREFSTOPIC% expands to ==, renders as Related HOMETOPIC, WIKIPREFSTOPIC, VAR VarWIKIAGENTEMAIL WIKIAGENTEMAIL From: email address in emails sent by Foswiki. Examples * %WIKIAGENTEMAIL% expands to == Related WIKIAGENTNAME, WIKIWEBMASTER, WIKIWEBMASTERNA... VarWIKIAGENTNAME WIKIAGENTNAME From: Name used in emails sent by CLASSE Wiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNA... VarWIKIHOMEURL WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK... VarWIKINAME 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... VarWIKIPREFSTOPIC WIKIPREFSTOPIC name of site wide preferences topic Examples * %WIKIPREFSTOPIC% expands to ==, renders as Related HOMETOPIC, WEBPREFSTOPIC VarWIKITOOLNAME WIKITOOLNAME name of your site Examples * %WIKITOOLNAME% expands to CLASSE Wiki Related WIKIHOMEURL, WIKIVERSION VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your CLASSE Wiki home page This macro is an alias for the USE... VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registered users Examples * %WIKIUSERSTOPIC% expands to == * with prefix renders as . Related WIKIUSERNAME VarWIKIVERSION WIKIVERSION the version of the installed Foswiki engine Examples * %WIKIVERSION% expands to == Related PLUGINVERSION, WIKITOOLNAME VarWIKIWEBMASTER WIKIWEBMASTER feedback email address for site Examples * %WIKIWEBMASTER% expands to == Related WIKIWEBMASTERNAME VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site Examples * %WIKIWEBMASTERNAME% expands to == Related WIKIWEBMASTER WebAtomBase ATOM News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribe in We... WebHome This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ... WebLeftBarExample " warn="off"}% * ** * * * * * * * %IF{"istopic ''" then=" *$percntICON{\"statistics\"}$percnt$percntMAKETEXT{\"St...
WebPreferencesHelp
Tools " hidelink="$percntICON{help}$percnt "}% Related Topics * . , site level preferences * list of user topics. User topics can have option...