wiki.in.tum.de Technische Universität München Default English Deutsch
You are here: Foswiki>System Web>WebChanges (17 Nov 2015, ProjectContributor)

# 1000 recent changes in System Web retrieved at 16:49 (GMT)

JSTreeContrib
JSTreeContrib This add on packages up the jQuery "jsTree" plugin to give you poserful support for display and manipulation of n ary tree data. See http://www.jstr...
JQSelect2Contrib
JQSelect2Contrib %JQPLUGINS{"select2" format=" Homepage: $homepage Author(s):$author Version: $version " }% This extension adds support for the ... TagCloudPlugin TagCloudPlugin Description This plugin helps rendering tag clouds. From Wikipedia:Tag_cloud A Tag Cloud is a text based depiction of tags across a body of conten... MaterialIcons MaterialIcons Usage As an icon font material icons may be accessed via the JQICON macro. To do so you need to register the material icons font to the IconServi... by micha CacheContrib CacheContrib Description This package is used by other extensions in need of caching services. This specific cache stores data for a short period time, e.g. one ... by micha VarENDTABPANE ENDTABPANE ending tag for tabpane widget This closes a previously opened TABPANE. Related TAB, ENDTAB, TABPANE, JQueryPlugin, JQueryTabpane VarJQICON JQICON render an image Renders an icon made availabe by the IconService. Parameters Parameter Description Default "name" name of the icon to displa... VarJQICONPATH JQICONPATH render the url path to an image icon This is a shortcut for: Note that this macro only makes sense for image icons, those that refer to a single image ... 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...
VarPOPUPWINDOW
POPUPWINDOW opens a topic or url in a new window Parameters Parameter Description Default "topic" topic="topic" topic="web.topic" T...
VarTAB
TAB tab inside a tabpane widget Defines a tab inside a TABPANE area; must be closed using ENDTAB. Parameters Parameter Description Default ...
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: ...
JQuerySerialScroll
JQuerySerialScroll %JQPLUGINS{"serialscroll" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin allows you to eas... JQueryShake JQueryShake %JQPLUGINS{"shake" format=" Homepage:$homepage Author(s): $author Version:$version " }% Warning: This plugin is deprecated. The sha...
JQueryShrinkUrls
JQueryShrinkUrls %JQPLUGINS{"shrinkurls" format=" Homepage: $homepage Author(s):$author Version: $version " }% Shrinks all urls in a given conta... JQuerySimpleModal JQuerySimpleModal %JQPLUGINS{"simplemodal" format=" Homepage:$homepage Author(s): $author Version:$version " }% SimpleModal is a lightweight jQ...
JQuerySlimbox
JQuerySlimbox %JQPLUGINS{"slimbox" format=" Homepage: $homepage Author(s):$author Version: $version " }% Show images in a lightbox. Slimbox 2 is... JQueryStars JQueryStars %JQPLUGINS{"stars" format=" Homepage:$homepage Author(s): $author Version:$version " }% Flexible and non obstructive star rating. T...
JQuerySuperfish
JQuerySuperfish %JQPLUGINS{"superfish" format=" Homepage: $homepage Author(s):$author Version: $version " }% Superfish is an enhanced Suckerfish... JQuerySupersubs JQuerySupersubs %JQPLUGINS{"supersubs" format=" Homepage:$homepage Author(s): $author Version:$version " }% This is a companion plugin to super...
JQueryTabpane
JQueryTabpane Plugin Info %JQPLUGINS{"tabpane" format=" Homepage: $homepage Author(s):$author Version: $version " }% Summary This implements ... JQueryTextboxList JQueryTextboxList %JQPLUGINS{"textboxlist" format=" Homepage:$homepage Author(s): $author Version:$version " }% Description Turns a text input...
JQueryTmpl
JQueryTmpl %JQPLUGINS{"tmpl" format=" Homepage: $homepage Author(s):$author Version: $version " }% jQuery templates contain markup with binding ... JQueryTooltip JQueryTooltip %JQPLUGINS{"tooltip" format=" Homepage:$homepage Author(s): $author Version:$version " }% Display a customized tooltip instead of...
JQueryTreeview
JQueryTreeview %JQPLUGINS{"treeview" format=" Homepage: $homepage Author(s):$author Version: $version " }% Lightweight and flexible transformati... JQueryUI JQueryUI %JQPLUGINS{"ui" format=" Homepage:$homepage Author(s): $author Version:$version " }% Widget collection for jQuery. This is the officia...
JQueryUIAutocomplete
JQueryUIAutocomplete %JQPLUGINS{"ui::autocomplete" format=" Homepage: $homepage Author(s):$author Version: $version " }% Autocomplete, when adde... JQueryUIDialog JQueryUIDialog Summary %JQPLUGINS{"ui::dialog" format=" Homepage:$homepage Author(s): $author Version:$version " }% A dialog is a floating wi...
JQueryUITooltip
JQueryUITooltip Summary %JQPLUGINS{"ui::tooltip" format=" Homepage: $homepage Author(s):$author Version: $version " }% Usage To load the libr... JQueryValidate JQueryValidate %JQPLUGINS{"validate" format=" Homepage:$homepage Author(s): $author Version:$version " }% Very powerful client side form valida...
JQueryWikiWord
JQueryWikiWord %JQPLUGINS{"wikiword" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin allows to create a WikiWo... VarBUTTON BUTTON renders a nice button Parameters Parameter Description Default "text" text to be put on this button value text t... VarENDTAB ENDTAB ending marker for a tab of a tabpane This closes a previously opened TAB. Related TAB, TABPANE, ENDTAB, JQueryPlugin, JQueryTabpane 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...
JQueryQueryObject
JQueryQueryObject %JQPLUGINS{"queryobject" format=" Homepage: $homepage Author(s):$author Version: $version " }% This extension creates a single... JQueryRating JQueryRating %JQPLUGINS{"rating" format=" Homepage:$homepage Author(s): $author Version:$version " }% The Star Rating Plugin is a plugin for th...
JQueryRender
JQueryRender %JQPLUGINS{"render" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin brings modern template based ... JQueryScrollTo JQueryScrollTo %JQPLUGINS{"scrollto" format=" Homepage:$homepage Author(s): $author Version:$version " }% With this plugin, you will easily scr...
JQueryLoader %JQPLUGINS{"loader" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin allows to reload parts of a p... JQueryLocalScroll JQueryLocalScroll %JQPLUGINS{"localscroll" format=" Homepage:$homepage Author(s): $author Version:$version " }% This plugin will animate a regu...
JQueryMaskedInput %JQPLUGINS{"maskedinput" format=" Homepage: $homepage Author(s):$author Version: $version " }% This is a masked input plugin f... JQueryMasonry JQueryMasonry %JQPLUGINS{"masonry" format=" Homepage:$homepage Author(s): $author Version:$version " }% Masonry is a JavaScript grid layout lib...
JQueryMedia
JQueryMedia %JQPLUGINS{"media" format=" Homepage: $homepage Author(s):$author Version: $version " }% jQuery Media Plugin for converting elements... JQueryMetadata JQueryMetadata %JQPLUGINS{"metadata" format=" Homepage:$homepage Author(s): $author Version:$version " }% This plugin is capable of extracting ...
JQueryMigrate
JQueryMigrate %JQPLUGINS{"migrate" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin can be used to detect and r... JQueryPlaceholder JQueryPlaceholder %JQPLUGINS{"placeholder" format=" Homepage:$homepage Author(s): $author Version:$version " }% Creates a 'hint' or 'example' t...
JQueryPNotify
JQueryPNotify %JQPLUGINS{"pnotify" format=" Homepage: $homepage Author(s):$author Version: $version " }% Full featured plugin to show temporary... JQueryCycle JQueryCycle %JQPLUGINS{"cycle" format=" Homepage:$homepage Author(s): $author Version:$version " }% The jQuery Cycle Plugin is a lightweight sl...
JQueryDebug
JQueryDebug %JQPLUGINS{"debug" format=" Homepage: $homepage Author(s):$author Version: $version " }% Simple jQuery logger / debugger using fireb... JQueryEasing JQueryEasing %JQPLUGINS{"easing" format=" Homepage:$homepage Author(s): $author Version:$version " }% Uses the built in easing capabilities add...
JQueryEmpty
JQueryEmpty %JQPLUGINS{"empty" format=" Homepage: $homepage Author(s):$author Version: $version " }% Template plugin for jQuery plugins integrat... JQueryFarbtastic JQueryFarbtastic %JQPLUGINS{"farbtastic" format=" Homepage:$homepage Author(s): $author Version:$version " }% Farbtastic is a jQuery plug in th...
JQueryFluidFont
JQueryFluidFont %JQPLUGINS{"fluidfont" format=" Homepage: $homepage Author(s):$author Version: $version " }% Recompute the font size of an eleme... JQueryFocus JQueryFocus %JQPLUGINS{"focus" format=" Homepage:$homepage Author(s): $author Version:$version " }% This plugin sets the focus on a form input ...
JQueryFontAwesome
JQueryFontAwesome %JQPLUGINS{"fontawesome" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin adds support for th... JQueryForm JQueryForm %JQPLUGINS{"form" format=" Homepage:$homepage Author(s): $author Version:$version " }% The jQuery Form Plugin allows you to easily a...
JQueryFoswiki
JQueryFoswiki %JQPLUGINS{"foswiki" format=" Homepage: $homepage Author(s):$author Version: $version " }% This is plugin takes care of loading th... JQueryGradient JQueryGradient %JQPLUGINS{"gradient" format=" Homepage:$homepage Author(s): $author Version:$version " }% Adds a gradient to the background of ...
JQueryHoverIntent
JQueryHoverIntent %JQPLUGINS{"hoverintent" format=" Homepage: $homepage Author(s):$author Version: $version " }% hoverIntent is similar to jQuer... JQueryI18N JQueryI18N %JQPLUGINS{"i18n" format=" Homepage:$homepage Author(s): $author Version:$version " }% Summary This plugin tries to be the simplest...
JQueryInnerFade %JQPLUGINS{"innerfade" format=" Homepage: $homepage Author(s):$author Version: $version " }% InnerFade is a small plugin for the... JQueryLiveQuery JQueryLiveQuery %JQPLUGINS{"livequery" format=" Homepage:$homepage Author(s): $author Version:$version " }% How to use it Live Query utilizes ...
JQueryAjaxHelper
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...
JQueryAutocomplete
JQueryAutocomplete %JQPLUGINS{"autocomplete" format=" Homepage: $homepage Author(s):$author Version: $version " }% Warning: This plugin is depre... JQueryBgiframe JQueryBgiframe %JQPLUGINS{"bgiframe" format=" Homepage:$homepage Author(s): $author Version:$version " }% A jQuery plugin that helps ease the p...
JQueryBlockUI
JQueryBlockUI %JQPLUGINS{"blockui" format=" Homepage: $homepage Author(s):$author Version: $version " }% The jQuery BlockUI Plugin lets you simu... JQueryButton JQueryButton %JQPLUGINS{"button" format=" Homepage:$homepage Author(s): $author Version:$version " }% This is a simple way to render nice butto...
JQueryChili
JQueryChili %JQPLUGINS{"chili" format=" Homepage: $homepage Author(s):$author Version: $version " }% Chili is the jQuery code highlighter plugin... JQueryCodingStandards JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks…. JQueryCookie JQueryCookie %JQPLUGINS{"cookie" format=" Homepage:$homepage Author(s): $author Version:$version " }% Easy cookie handling using jQuery. Usage...
JQueryCorner
JQueryCorner %JQPLUGINS{"corner" format=" Homepage: $homepage Author(s):$author Version: $version " }% This plugin adds cross browser support fo... DiffPlugin DiffPlugin Description This plugin implements a way to display the difference between revisions of the same topic or between two distinct topics. This adds YADT... MimeIconPlugin MimeIconPlugin This plugin tries to map known mime types commonly found on the internet to an icon set. There are not many icon sets that have a got coverage of m... JQMomentContrib JQMomentContrib This package integrates the moment.js library into Foswiki. The full API documentation is available at http://momentjs.com/docs/ Example E... JQueryAnimate JQueryAnimate Summary %JQPLUGINS{"animate" format=" Homepage:$homepage Author(s): $author Version:$version " }% A cross browser library of CS...
JQueryView
JQueryView %JQPLUGINS{"view" format=" Homepage: $homepage Author(s):$author Version: version " }% This plugin adds JsViews functionality to the... ImagePlugin ImagePlugin Use this plugin to control the display and alignment of images using an easy syntax and support for server side resizing and thumbnailing. There are a... GridLayoutPlugin GridLayoutPlugin Description GridLayoutPlugin implements a 12er grid system for flexible layouts. A grid is a set of HTML div elements that are styled in a way ... FlexFormPlugin FlexFormPlugin This plugin leverages the internal capabilities to render an interface for .DataForms and adds insights to the acutal DataForm definition itself ... CopyContrib CopyContrib This extension can be used to copy topics and webs. It allows to select which parts of an item is to copied. Typical use cases are: 1 duplicate top... CaptchaPlugin CaptchaPlugin Description This plugin tries to prevent automated scripts from creating users and spam your wiki. It does so by requiring a simple test to ensure ... AutoTemplatePlugin AutoTemplatePlugin %IF{"context 'AutoViewTemplatePluginEnabled' and context 'AutoTemplatePluginEnabled'" then=" WARNING: You have enabled both AutoTemp... RenderPlugin RenderPlugin Description This plugin implements a couple of REST handlers to feetch content from a Foswiki backend. This can either be returned as plain content ... by micha JQDataTablesPlugin JQDataTablesPlugin Overview This plugin implements a widget to enhance normal HTML tables with extra navigation features such as sorting, filtering and paginatin... ListyPlugin ListyPlugin This plugin implements an interactive list manager. A "Listy" is a collection of text or links that can be maintained easily using modal dialogs, drag... DBCachePlugin DBCachePlugin Description This is a lightweight frontend to the DBCacheContrib. The provided macros DBQUERY and DBCALL can be used as a replacement for SEARCH an... JQTwistyContrib JQTwistyContrib JQTwistyContrib is a lightweight twisty plugin implementing a subset of the features provided by .TwistyPlugin, but using javascript only. This co... NatSkinPlugin The Natural Skin Plugin Description This is the supplemental plugin for the NatSkin. Its main purpose is to supply "skin states" to control different styles and ... WebFontsContrib WebFontsContrib This is a bundle of commonly used free web fonts to be used in your Foswiki skin. Each font comes with a handy font face definition that you may ... MetaDataPlugin MetaDataPlugin This plugin allows to store data sets to Foswiki topics. Foswiki itself is a structured wiki already using .DataForms which are attached a topic. ... IconService IconService The IconService functions as a central definition and delivery method for all sorts of icons: image icons as well as font icons. Different kinds of i... VarMIMEICON #VarMIMEICON MIMEICON{"filename"} return a meaningful icon for this filename * Syntax: %MIMEICON{"filename"}% * Supported parameters: Parameter ... TopicInteractionPlugin TopicInteractionPlugin Description This plugin redesigns the way how users interact with topics and attachments in various ways: * improved attachment handlin... DBCacheContrib DBCacheContrib Reusable code that caches Foswiki topics, and provides fast searches of the content. Summary of Contents This module supports fast structured quer... FilterPlugin FilterPlugin Description This plugin allows to substitute and extract information from content by using regular expressions. There are three different types of n... DefaultPreferences 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 rea... SecurityHeadersPlugin SecurityHeadersPlugin HTTP headers are included in every HTTP response from a web server. Setting the appropriate HTTP headers can reduce the risk of man in the m... MoreFormfieldsPlugin MoreFormfieldsPlugin Description This plugin implements a set of additional special purpose formfields to be used in DataForm definitions. To make use of these f... by micha ActionTrackerPlugin Action Tracker Plugin This plugin provides support for tracking actions embedded in topics. Actions captured this way can then be searched from any topic in the w... ActionTrackerPluginQBE Query by example action search Who: Notify: State: open late closed Within: days Web: Topic: Result: '"}... StringifierContrib StringifierContrib Description This extension serves as a helper to stringify documents in a way that they can be indexed by full text search engines such as Fos... WebTopBar wiki.in.tum.de Technische Universität München by FlorensWernerGa78bam MultiLingualPlugin MultiLingualPlugin This plugin enables you to create wiki content in multiple languages. While Foswiki normally supports over 20 languages to internationalize its... XSendFileContrib XSendFileContrib Introduction This package implements a more efficient way to send static files using a web application like Foswiki. A standard configuration of... GraphvizPlugin GraphvizPlugin GraphViz is a way of representing structural information as diagrams of abstract graphs and networks. Automatic graph drawing has many important ap... WebLinkPlugin 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 ... VarWEBLINK #VarWEBLINK WEBLINK * create a link to a web * Syntax: %WEBLINK{web="..." name="..."}% * Supported parameters: Parameter: Description: Defaul... FlexWebListExamples FlexWebListExamples These are some simple examples to show how to use the basic features of the FlexWebListPlugin. Please create some subwebs in the Sandbox web ... FlexWebListPlugin FlexWebListPlugin Description This is a replacement for Foswiki's standard WEBLIST variable. It is extended to improve the display of hierarchical web structures... TopicTitlePlugin TopicTitlePlugin Description This plugin implements a way to freely specify the title of a topic. The title is then used when rendering the link to the topic ins... WebPreferences System Web Preferences Appearance * Set WEBBGCOLOR = #FFFF00 * Set SITEMAPLIST = off * Set NOSEARCHALL = on * Set WEBSUMMARY = TOC settings *... LdapContrib LdapContrib Introduction This package offers basic LDAP services for Foswiki and offers authentication of wiki users by binding to an LDAP server as well as inco... 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... 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... 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... TopicUserMappingContrib TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat... NatEditPlugin Natural Edit Plugin Description The NatEdit is an wiki editor that helps in learning the TML Language by providing a GUI. By design, this is not a wysiwyg editor... PreferenceSettings #SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *... SystemRequirements System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform... Macros Macros Special text strings expand on the fly to display information, or trigger a function. Macros are text strings in one of three basic forms: %MACRONAME{ pa... 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 ... BreadCrumbsPlugin BreadCrumbsPlugin Description This plugin helps you to locate where you are, and shows you how you can escape from there using breadcrumbs navigation. Two types ... PublishPlugin PublishPlugin Generates a static view of a web, as HTML files on disc, or as a PDF, or as a zip or tgz archive file, or by uploading directly to an FTP server. Th... PublishWeb This is a template topic for use with PublishPlugin. It illustrates how to set up a topic in a web to simplify publishing. To use it, take a copy of the raw text ... TablePlugin Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting... CommentPlugin Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi... HistoryPlugin History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c... UpdatesPlugin UpdatesPlugin Checks Foswiki.org for updates This plugin is used to keep administrators informed of updates to their installed extensions via a pop up message at ... 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... RedDotPlugin RedDotPlugin This plugin renders a clickable red dot (.) to ease the edit access to a page. The red dot will only be visible if the current wikiuser has write acc... SendEmailPlugin Send Email Plugin . Usage 1 Create a form on the page that invokes the sendemail script 1 Add a "to" field and a submit button 1 Make sure to fill in al... SendEmailPluginTemplate From: To: CC: Subject: Auto Submitted: auto generated RatingContrib RatingContrib This is a rating widget that can support a "line of stars" style input field. Usage You can use the new rating type in form fields. The result of t... RedirectPlugin Redirect Plugin I typically use this to make easy to type shortforms/acronyms of topic names. For example: * Actual content appears under Main.LightweightDirect... VarVOTE #VarVOTE VOTE{ attributes } define a poll in a topic. * See VotePlugin for more information VotePlugin VotePlugin This plugin can be used to build an online voting system, or poll. There are two ways to vote for an item: * select: vote for a given choice from a ... KinoSearch Foswiki Search in all public webs current web Query Syntax * To search for a word, just put tha... KinoSearchContrib Kino Search Contrib KinoSearch is a Perl implementation of the Apache Lucene search engine (implemented in Java). This is the implementation of this indexed searc... KinoSearchPlugin KinoSearchPlugin __ Allows embedding a KinoSearch in any page with a custom format it will automatically update the index when saving, renaming or adding an attac... TipTopicForKinoSearch Kino Search Operators Kino Search allows you to use Google style operators to narrow down your search. For example, use the and operators to indicate required... UploadPlugin UploadPlugin This plugin provides a more flexible interface to upload one or more files to a topic. Using standard means, only one file can be uploaded at the sam... 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... RenderTableDataPlugin RenderTableDataPlugin Main features: * Pass a custom format to render the table data * Choose a subsection of the table to be rendered: row and column range... TopicTranslationsPlugin TopicTranslationsPlugin TopicTranslationsPlugin manages topics translations into several languages, by assigning suffixes to topic names corresponding to known la... BatchUploadPlugin Batch Upload Plugin Usage * Enable this plugin in LocalSite.cfg or configure Test: BatchUploadPlugin is enabled' else=' BatchUploadPlugin is not enabled. ... ExplicitNumberingPlugin ExplicitNumberingPlugin Use the 1, 1.1 etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Use #, ##, etc., to generate num... DpSyntaxHighlighterPlugin DpSyntaxHighlighterPlugin This plugin provides client side syntax highlighting using the SyntaxHighlighter by Alex Gorbatchev. JavaScript needs to be enabled on t... FormPlugin !" else=" !! Form Plugin"}% Lets you create simple and advanced web forms. Main features: * No html knowledge required to create forms * Add input fiel... BookmakerPlugin BookmakerPlugin The Bookmaker plugin provides support for interactive capture and sorting of ordered lists of topics. The lists are held in topics, and may be man... ExternalLinkPlugin External Link Plugin This plugin adds a visual indicator to external links, so users can distinguish outgoing links from site links. This will only work for force... MailerContrib Mailer Contrib Allows users to "subscribe" to regularly scheduled emails containing either: * A report on changes to all topics that have changed within a part... RCSStoreContrib RCSStoreContrib Foswiki 2.0 and later only This is the modern implementation of the classic Foswiki RCS based store. It has been moved into a contrib as other sto... VarTABLE TABLE control attributes of tables and sorting of table columns The %TABLE{}% macro is handled by the TablePlugin Attributes for tables Parameter ... FastCGIEngineContrib FastCGI Engine Contrib Permits Foswiki to be executed with FastCGI Overview FastCGI is a technology to deliver dynamic web content. It differs from CGI cause it ... ConfigurePlugin Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow... 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 ... JSCalendarContrib JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read... ModPerlEngineContrib ModPerlEngineContrib Overview This is a runtime engine component from Foswiki Standalone architecture. mod_perl is the Perl API to the Apache web server. It perm... PlainFileStoreContrib PlainFileStoreContrib This is a full implementation of a Foswiki store that uses nothing more sophisticated than plain files and directories In the Foswiki spirit... SubscribePlugin Subscribe Plugin Example (only works if plugin is installed, and you are logged in you are: and you are not .WikiGuest): This version is designed for use w... WysiwygPlugin Wysiwyg Plugin Support for the integration of WYSIWYG (What You See Is What You Get) editors. On its own, the only thing this plugin gives you is a stand alone HT... FAQViewTemplate %{ FAQ topic templates This skin template is used to view FAQ questions and answers. It overrides the content portion of the default view template, and removes t... VarREVINFO REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.rev $date$wikiusername"}% Examples * %REVINFO% expands 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...
ADDTOZONE add content to a named zone on the page Parameters Parameter Description Default "zone" comma separated list of the names of zones th...
VarRENDERZONE
RENDERZONE render the content of a zone Rendersa zone. See ADDTOZONE for an explanation of zones. Parameters Parameter Description Default ...
Administrator Skills Assumptions Several skills (i.e. knowing how to do something) are needed to set up and maintenance of a Foswiki installation. Remember that s...
Contribs
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...
Add Ons Deprecated name for the System.Contribs type of extension. Some older extensions will still be named as an AddOn. Overview An add on runs separately...
DeveloperDocumentationCategory
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
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...
InstallationGuidePart2
Installation Guide Part 2 Post Installation Configuration and Tuning Once you have Foswiki installed and running, you can perform one or more of the following s...
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. ...
ReferenceManual
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
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...
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 ...
VarWORKFLOW
#VarWOWRKFLOW WORKFLOW* macros associated with WorkflowPlugin All the following macros accept web and topic parameters: Parameter Meaning Default web...
WorkflowPlugin
WorkflowPlugin /Flow.gif Foswiki provides a flexible system of Access Control Lists that can be used to control who can modify a topic. Sometimes this isn't quite...
LexiconForm
LexiconForm Name:* *Type: Size: Values: Description: Attributes: String text 80 M English (en) text 80 German (de) tex...
WebCreateNewTopicComponents
WebCreateNewTopicComponents This topic is meant for developers. It contains INCLUDE sections to build a "create new topic" form. Usage Including the form (simpl...
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...
Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the comparison is done with the rend...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEna...
JsonRpcContrib
JsonRpcContrib Summary This package implements a JSON RPC 2.0 protocol to interface with Foswiki and its plugins. In contrast to the normal REST interface of Fo...
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...
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...
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...
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 ...
CompleteDocumentation
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
SiteChanges
SiteChanges Recent changes %IF{"context isadmin" then=' This topic can be resource intensive on a large site with a large public web. The Foswiki:Extensions.SolrP...
PatternSkinElements
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...
JEditableContrib
JEditableContrib This add on packages up the jQuery "JEditable" plugin from Miko Tuupala. This excellent little plugin gives you edit in place capability with man...
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...
JQSerialPagerContrib
JQSerialPagerContrib This is a jQuery plugin for Foswiki that implements a widget to handle long lists. It therefore splits the list and adds a pager so that it t...
PatternSkin horizontal navigation example Include main navigation with: This is done automatically in the templates by setting in the .SitePreferences: * #Set ...
PatternSkin Navigation Include main navigation with: Include sections "}% %IF{"istopic '.LeftBar'" then=" $n$percntINCLUDE{\".LeftBar\"}$percnt" }... PatternSkinThemeFatWillyNavigation PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre... SpreadSheetPlugin Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Foswiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They ca...
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...
LanguageSelector
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 loc...
Admin tools List of tools available to the Foswiki administrator * Documentation: Reference Manual * Site Tools : , InterWikis, Macros, Doc Graphics ...
ManagingUsers
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 ...
PendingRegistrationsTemplate
Pending Registrations Template Tailoring instructions: The contents of the Pending Registrations report can be modified to report any fields collected on a custo...
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...
StandardColors
The 216 Standard Colors This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 ...
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...
PatternSkinCssCookbookSidebarToggle
System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...
PatternSkinCssCookbook
.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 eleme...
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 Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME
EditingShorthand
Editing Shorthand Formatting Command: You write: You get: Paragraphs: Blank lines will create new paragraphs. 1st paragraph 2nd paragraph 1st paragraph 2nd ...
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...
PatternSkinCustomization
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
AttachContentPlugin
Attach Content Plugin Overview This plugin puts any text between a %STARTATTACH{"filename"}% and %ENDATTACH% into an attachment with the given filename. Pass fil...
PageOptimizerPlugin
PageOptimizerPlugin Description This plugin is used to clean up the html page foswiki renders by rewriting and/or removing code not required in html5. It also co...
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: ...
BulkRegistration
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...
WelcomeGuest
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...
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...
PerlDependencyReport
Perl dependencies for Foswiki and Extensions This topic lists the dependencies required by the Foswiki core and installed extensions. It is designed to help admin...
AutoViewTemplatePlugin
AutoViewTemplatePlugin Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
RenderListPlugin
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
WebLeftBarExample
" warn="off"}% * ** * * * * * * * %IF{"istopic ''" then=" * $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"St... ParentList Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }... VarSEARCH SEARCH search content Inline search, shows a search result embedded in a topic Parameters Parameter Description Default: "text" search... 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... BeginnersStartHere 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... 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 ... EmptyPlugin 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... FAQDownloadSources Foswiki is distributed under the Gnu General Public License, and sources are freely available. When you download an official Foswiki package from https://foswiki…. FAQGnuGeneralPublicLicense Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, ... 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... 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... InstantEnhancements Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura... MainFeatures What makes Foswiki …. the ideal collaboration tool? Foswiki is… Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ... PackageForm Name: Type: Size: Values: Tooltip message: Author text 60 Version text 60 Numerical version number e.g. 1.2 Release text 60 ... ProjectContributor 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... ProjectLogos 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... 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 ... SearchHelp 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... 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 ... VarINCLUDE INCLUDE include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation (Including a topic) Parameters Parameter: Des... 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... 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 ... WikiCulture Wiki culture, concepts and principles General concept and idea of wikis. General concept and idea of wikis What is a wiki? "A wiki is a page or collection of We... AccessControl 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 web... VarUSERINFO USERINFO retrieve details about a user Parameters Parameter Description "name" WikiName or login username. May be a group. current user ... FamFamFamContrib FamFamFamContrib Usage The icons are attached to the FamFamFamFlagIcons FamFamFamMiniIcons FamFamFamMintIcons FamFamFamSilkIcons FamFamFamSilkCompanion1Icons... UserRegistration %IF{"context isadmin AND NOT istopic '.UserRegistration'" then=' Tailoring instructions: You are currently viewing the default registration page without local tai... UserRegistrationParts User Registration components This topic contains the pieces that are assembled into the UserRegistration page. There is no need to modify this topic. If a sectio... FrequentlyAskedQuestions 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 ra... VarTOC TOC table of contents Shows a Table of Contents that is generated automatically based on headings of a topic. Headings in TopicMarkupLanguage (" text") and HTML ... WebLeftBarWebsList This topic is included from the WebLeftBarExample and other WebLeftBar topics, to provide a dynamic list of webs accessible to the current user. Webs meeting the ... FoswikiServerInformation Foswiki Server Information This topic lists the detailed server execution environment. As this is sensitive information, it is only available to users with acces... InstalledPlugins Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ... 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... QuerySearchPatternCookbook QuerySearch Pattern Cookbook This topic provides tips on the usage of QuerySearch. Pattern 1: Show recent changes without user pages We have everything in the Ma... ResetPassword %IF{ "{EnableEmail} AND context passwords_modifyable" then="$percentINCLUDE{\"ResetPassword\" section=\"resetPassword\"}$percent" else="" }% * * Ch... UserForm User Form This is a maintenance topic, used by the Wiki administrator. Data form definition of user topics Name Type Size Values *Tooltip messag... 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... WebChanges , "}% "}% %SEARCH{ "'1'" web="" type="query" nosearch="on" noheader="on" order="modified" pager="on" pagesize="" revers... WebIndex %SEARCH{ "'1'" scope="topic" type="query" nosearch="on" pager="on" pagesize="" }% WebLeftBarLogin %IF{ "context authenticated" then=""}% "}%" }%%IF{ "$ LOGOUT = ''" then="$percntLOGOUT$percnt" else="Logout"}%" }%%IF{ "$LOGIN = ” and not conte... WebPreferencesHelp Tools " hidelink="$percntICON{help}$percnt "}% Related Topics * . , site level preferences * list of user topics. User topics can have option... WebRssBase 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... WebSearch %IF{ "$'URLPARAM{tab}'='search' OR $'URLPARAM{tab}'='' AND NOT$TAB='advanced'" then="$percentINCLUDE{$quotWebSearch$quot section=$quotsearch$quot}$percent" }%...
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...
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...
TipsContrib
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 fo...
TipsOfTheDayInclude
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 ...
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...
DocumentViewerPlugin
Document Viewer Plugin The Document Viewer Plugin allows you to use presentations, spreadsheets, PDFs and other documents in Foswiki without any external dependen...
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...
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...
TipsTopics
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): " decode...
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...
PatternSkinThemeFatWilly
PatternSkin theme: Foswiki "Fat Willy" Site Skin Test this theme Choose column ' selected='selected' "}% Column right No column Hide theme Store theme...
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...
Pub Link Fixup Plugin This plugin performs pub link fixup of the generated HTML page. If Foswiki is configured with a non utf 8 {Store}{Encoding}, then links to ...
MacrosQuickReference
Macros Quick Reference See Macros for a detailed description of how to use Macros Predefined Macros %SEARCH{ "1" type="query" topic="Var*" we...
NatEditHelpText
NatEditHelpText Help text for the NatEditPlugin editor About the editor This edit interface is available in two different modes: (1) WYSIWYG (what you see is what...
NatEditWordHelpText
NatEditWordHelpText Help text for the NatEditPlugin editor * * * * * * * B = Bold * I = Bold * _ = Underline * = Strike * l...
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...
FamFamFamFlagIcons
FamFamFamFlagIcons 'Flags' are 247 icons in GIF and PNG formats representing most countries in the world as small pixel icons. These flag icons are available ...
FamFamFamFoswikiExtras
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.wiki...
FamFamFamMiniIcons
FamFamFamMiniIcons "Mini" is a set of 144 GIF icons available for free use for any purpose. Source These Icons come from http://www.famfamfam.com/lab/icons/mini/...
FamFamFamMintIcons
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 p...
FamFamFamSilkCompanion1Icons
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 se...
FamFamFamSilkCompanion2Icons
FamFamFamSilkCompanion2Icons 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...
FamFamFamSilkGeoSilkIcons
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
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...
JavascriptFiles
Javascript Foswiki will work without Javascript enabled in the browser: * When performing read only actions, Eg. view, rdiff * If {Validation}{Method} is se...
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: ...
PatternSkinCss
CSS elements in PatternSkin This page is a reference for all CSS classes used in PatternSkin. PatternSkin uses 4 stylesheets: * layout.css: positioning of bloc...
PatternSkinCssCookbookCenterPage
PatternSkinCssCookbook Recipe: Center the page This recipe shows how center the page horizontally and vertically. This line loads the extra style definition: *...
PatternSkinCssCookbookCenterPageBorder
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 exa...
PatternSkinCssCookbookEditTableStyle
PatternSkinCssCookbook Recipe: EditTable style Cookbook example to illustrate control over EditTable edit styles. 1 EditTable uses a monospace font in edit mod...
PatternSkinCssCookbookFonts
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: * Set USERSTYLEURL...
PatternSkinCssCookbookHideActions
PatternSkinCssCookbook Recipe: Hide action buttons This recipe shows how to hide the action buttons for unauthorised and/or guest users: (Edit, Attach …) Note t...
PatternSkinCssCookbookNoLeftBar
PatternSkinCssCookbook Recipe: Hide the left bar This line loads the extra style definition: * Set USERSTYLEURL = //PatternSkinCssCookbookNoLeftBar/hideleftbar...
PatternSkinCssCookbookNoTopBar
PatternSkinCssCookbook Recipe: Hide the top bar This recipe shows how to hide the top bar. This line loads the extra style definition: * Set USERSTYLEURL=/noto...
PatternSkinCssCookbookSidebarBackground
PatternSkinCssCookbook Recipe: Sidebar background color To see if the background color really extends beyond the body, we make the body contents longer than the s...
PatternSkinTheme
PatternSkin theme Default pattern skin theme. Test this theme Choose column ' selected='selected' "}% Column left (default) Column left, flexible width Column r...
PatternSkinTheme115
PatternSkin theme: Foswiki release 1.1.5 Use this theme if you have created a theme or sub skin that relies on the styling of PatternSkin around release 1.1.5 or ...
PatternSkinTheme2009
PatternSkin theme: 2009 Test this theme Choose column ' selected='selected' "}% Column left (default) Column right No column Small left column Choose v...
PlainSkin
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...
PreviewBackground
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 backgrou...
PrintSkin
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 o...
TopicsAndWebs
Topics What are Topics and Webs? #SystemWebFigure Figure: depiction of , ReferenceManual, ManagingTopics, ManagingWebs, MainFeatures topics contained in the web...
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...
FlexWebListTree
FlexWebListTree The fragment below can be used in a sidebar navigation to establish a folder like subweb navigation. This uses the jqTreeview widget of the Foswik...
TipsOfTheDay
Tips Of The Day These are all tips of the day. They are located in the web (official distribution tips) and web (custom tips). Custom (local) tips Total: Cus...
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 maint...
TipTopic005
Re parenting a topic The breadcrumbs ( Contribs TipsContrib TipsOfTheDay , for example) of any topic is constructed automatically in Foswiki by foll...
TipTopic007
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 ...
TipTopic008
Escaping Foswiki rendering Use the verbatim tag to surround code excerpts and other formatted text with = verbatim = and = /verbatim = tags. For Example: verbati...
TipTopic013
Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Default settings: (nev...
TipTopic022
Edit tables with EditRowPlugin EditRowPlugin allows you to edit tables using edit fields and drop down boxes. Tables have an button if preceeded by an %EDITTAB...
ACRONYM
What is an ACRONYM? Linking topics using acronyms. An acronym is an abbreviation that is typically made up of the first letter or letters of a phrase. An acronym ...
TipTopic011
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...
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 ...
CountryList
Country list List of countries used in the UserForm . To use this list in Foswiki applications, see the country SEARCH example in SearchPatternCookbook . ...
FAQDeleteOrRenameAnAttachment
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...
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 ...
WebCreateNewTopicTemplate
%{ ========================================= Create new topic template This template uses parts from .WebCreateNewTopicComponents. =====================...
FAQAnApplicationWithWikiForm
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...
FAQDeleteOrRenameATopic
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...
FAQEditDoesNotIncreaseTheRevision
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...
FAQSearchDoesNotWork
That is often an indication that Foswiki can't find the egrep and fgrep commands on your system. Check the {Store}{EgrepCmd} and {Store}{FgrepCmd} settings in con...
FAQSimultaneousEdits
Foswiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening u...
FAQWhatIsWikiWiki
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 crea...
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...
VarSHOWPREFERENCE
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
VarACTIVATEDPLUGINS
ACTIVATEDPLUGINS list of currently activated plugins Examples * %ACTIVATEDPLUGINS% expands to Related PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION
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...
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...
VarCOMMENT
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...
VarDOCUMENTVIEWER
DOCUMENTVIEWER Embed a presentation, spreadsheet, PDF or other document in a viewer The %DOCUMENTVIEWER% variable is handled by the DocumentViewerPlugin Paramete...
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...
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 ... 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 VarHTTPHOST HTTP_HOST environment variable Examples * %HTTP_HOST% expands to == Related ENV, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER 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... 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 ... 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 ... 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" }% ... 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... 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... 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... 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... VarREVARG REVARG rev=n parameter of current request If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten... 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 Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to ... 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 ... 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... 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...
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...
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
VarWIKIHOMEURL
WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...
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 Foswiki Related WIKIHOMEURL, WIKIVERSION
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
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...
VarCALCULATE
CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar...
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...
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...
VarMAINWEB
VarSUBSCRIBE
SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCRIBE{...}% or si...
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...
Category
%SEARCH{"parent.name=''" web="" type="query" nonoise="on" format=" $dollar$topic : $pattern(.*? ^\n \n ( ^\n ).)"}% Related Topics %SEARCH{"parent.nam... AdminDocumentationCategory A List of Wiki Administrator Documentation List of documents relevant for the installer and administrator of the Foswiki installation ChangeEmailAddress Change registered email address %IF{ "context passwords_modifyable" then="$percentINCLUDE{\"ChangeEmailAddress\" section=\"secretEmailEnabled\"}$percent" el... 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...
GoodStyle
Collaboration Tips A short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. #SignAndDate * If a dis...
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 e...
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...
#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...
RegularExpression
Regular Expressions Regular expressions (REs), unlike simple text queries, allow you to search for text which matches a particular pattern. Introduction REs are ...
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...
SitePermissions
Permissions settings of the webs on this Foswiki site Web Sitemap VIEW CHANGE RENAME * * Listed DENY ALLOW DENY ALLOW DENY ALLOW ...
SiteTools
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...
TextEditor
Text Editor A text editor is different from a WYSIWYG editor because it doesn't do display formatting like bold type, or mixed font styles, sizes and colors. ...
TimeSpecifications
Time Specifications Date/time formats recognised and generated by Foswiki. For all strings the time is optional. * 31 Dec 2001 23:59 * 2001/12/31 23:59:59...
TwentyMinuteTutorial
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...
UserDocumentationCategory
A List of User Documentation Documentation mainly useful to end users
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...
UsersTemplate
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 ...
UserToolsCategory
A List of User Tools List of tools the user may need for setting and resetting passwords, changing email address etc.
UsingHTML
Using HTML When, and how, to use HTML in topics. You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is...
WikiSyntaxSummary
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 your site's part...
WikiWord
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are used to refer to topics. WikiWords refer to topics...
WYSIWYG
What is WYSIWYG? WYSIWYG is an acronym for for "What You See Is What You Get". Foswiki allows you to edit content using a WYSIWYG editor. This editor lets you edi...
PreferencesPlugin
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...
%MAKETEXT{"Your username is a sequence of alphanumeric characters and underscores that uniquely identifies you to the system. The exact format of the username dep...
SkinTemplateTokens
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...
JSCalendarContribInline
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
MailerContribPlugin
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...
EditRowPluginExamples
Nr Project State Progress Timestamp 1 Sliced yoghourt completed : ) 26 Jun 2002 2 Cubical turkeys not started : ( 27 Oct 2007 3 ...
Group Member Toggle This topic implements a button that will turn Admin status on or off for the current user (!), by adding or removing the user from the AdminGr...
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 ...
BookView
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...
HomePagePlugin
HomePagePlugin Usage This plugin makes the Default frontpage configurable 1 any time a user goes to they will be shown the topic configured by the Foswiki...
SkinTemplateViewTemplate
SkinTemplateViewTemplate is a Skin Template So should not be viewed directly. Use to see the Template source. ** Skin Templates Set VIEW_TEMPLATE=SkinTemplateVie...
TWikiCompatibilityPlugin
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
WebNotifyHelp
WebTemplateTopics
"}% ** "}% %SEARCH{ "'1'" type="query" topic="*Template" excludetopic="WebTopicEditTemplate,*WebCreateNewTopicTemplate,*ViewTemplate" scope="topic" ...
FAQRebuildingWikiUsersTopic
Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...
WikiName
. %MAKETEXT{"Your name is also a potentially valid _1 .WikiWord WikiWord when used within a topic. However the home pages of registered users on this site ...
TipTopic003
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 ...
DefaultPreferencesForm
*Name* Type Size Value Tooltip message Attributes WEBBGCOLOR text 20 #FFD8AA HTML Color S FAVICON text 30 /System/WebPreferences...
WebLeftBarCookbook
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar bloc...
WysiwygPluginSettings
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...
TipTopic023
Control table attributes with TablePlugin The TablePlugin gives extra control of table display: * Allows sorting * Changing table properties like border wid...
TipTopic029
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...
DefaultWebStatistics
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...
FAQForm
Name: Type: Size: Values: Tooltip message: Attributes TopicTitle text 80 H TopicClassification select 1 Classify a topic ...
SiteToolStatistics
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 ...
SiteMap
Foswiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. %SEARCH{ "1" topic="" web="all" type="query" not...
NewUserTemplate
NewUserTemplate * :
UserFormHelp
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 ... 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... PerlDoc See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, Tec... TemplateWeb 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... LatexIntro \usepackage{amsfonts} \definecolor{Lightmaroon}{rgb}{0.6667,0,0} \definecolor{Cornflowerblue}{rgb}{0,0.4,0.8} Introduction to \Large\LaTeX \LaTeX is a complete... LatexModePlugin LatexModePlugin This LaTeX Mode Plugin allows you to include LaTeX mark up commands within a Foswiki page. It uses external programs (specifically latex, dvipng ... LatexSymbols Latex Symbols (1 of 5) Greek letters lower case Symbol Latex Command Symbol Latex Command Symbol Latex Command ... LatexSymbols2 Latex Symbols (2 of 5) Relationship Symbols Symbols Latex Command Symbols Latex Command %$\leq$% \leq %$\equiv$% ... LatexSymbols3 Latex Symbols (3 of 5) Arrows Symbols Latex Command Symbols Latex Command %$ \leftarrow $% \leftarrow %$ \Leftarrow $% ... LatexSymbols4 Latex Symbols (4 of 5) Symbols Latex Command Symbols Latex Command Symbols for Sets and Analytic Equations Symbols Latex Command Symbols Latex ... LatexSymbols5 Latex Symbols (5 of 5) Delimiters Symbols Latex Command Symbols Latex Command %$ \lfloor $% \lfloor %$\rfloor $% \rfloor %$...
WebAtom
Foswiki's System web
WebNotify
* .WikiGuest
" else="Foswiki's System web"}% /System
WebSiteTools
Web Site Tools * (More options in WebSearch) * WebChanges: Display recent changes to the web * WebIndex: List all topics in alphabetical order. Se...
WebStatisticsTemplate
%IF{ "istopic '.Default'" then="$percentINCLUDE{$quot.Default$quot}$percent" else="$percentINCLUDE{$quot.Default$quot}$percent" }%
WebTopicCreator
** Wiki admins Please replace all web's WebTopicCreator topic contents with this text: All WebTopicCreator topics on this site: %SEARCH{ "WebTopicCreator" ...
SkinBrowser
Skin Browser You can try out the Skins currently installed on this system: %SEARCH{ "1" topic="*Skin" scope="topic" web=",TWiki" type="que...
StaticMethod
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 defaul...
TimBernersLee
Tim Berners Lee invented the World Wide Web while working at CERN in 1989. See his biography at http://www.w3.org/People/Berners Lee/
TopicClassification
EnhancementRequests
* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. *...
ExampleTopicTemplate
(just an example illustrating how to create a new topic based on a specific template topic. TemplateTopics has more)
FAQEditTemplate
%{ Include the default edit templates from your current SKIN and COVER paths }%%{ Define the formtop container to display the form }%%{ Define the formbot...
FAQHiddenUsersAndGroups
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 co...
FAQTemplate
FAQTroubleshootingExtensions
Some questions to answer: * Perhaps the plugin is installed, but did you remember to enable it in configure? * Did the installer mention any missing depende...
FileAttribute
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 attachme...
GoBox
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 ...
ObjectMethod
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() Ob...
ClassMethod
A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new object inst...
WebStatistics
Statistics for System Web Month: Topic views: Topic saves: File uploads: Most popular topic views: Top contributors for topic save and uploads: ...
by reiner
WebLeftBarPersonalTemplate
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...
PatternSkinColorSettings
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...
VarEDITTABLE
#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * ...
TipTopic001
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 th...
TipTopic002
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 ...
TipTopic004
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 no...
TipTopic006
TipTopic014
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 i...
TipTopic015
TipTopic016
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 layo...
TipTopic017
Revision control In Foswiki, assuming appropriate AccessControls, anyone can change anything but those changes are logged. There is a complete audit trail with r...
TipTopic019
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spa...
TipTopic020
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enab...
TipTopic025
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() *$IF() * $REPLACE() *$...
TipTopic026
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when conte...
TipTopic027
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More ...
TipsOfTheDayTemplate
TipTopic009
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with = noautolink = and = /noautolink = tags. Each ...
TipTopic010
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. ...
TipTopic012
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good bro...
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….
TipTopic021
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 frow...
TipTopic024
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write %COMMENT{ attributes ...
TipTopic028
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 ...
JQueryThemeSwitcher
JQueryThemeSwitcher %JQPLUGINS{"themeswitcher" format=" Homepage: $homepage Author(s):$author Version: \$version " }% User interface for showing...
DigestPlugin
DigestPlugin Examples You type You should get You get %DIGEST{"Hello World"}% b10a8db164e0754105b7a99be72e3fe5 %DIGEST{"%DIGEST{"Hello World"}...
WikiWikiClones
Foswiki is a Wiki Wiki clone and has its root in JOS Wiki via TWiki . * Foswiki's home is at http://foswiki.org/ * Foswiki takes a lot of ideas from Ward Cu...
WikiNotation
Wiki links topics automatically when you use WikiWord notation.
AppendixEncodeURLsWithUTF8
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of inte...
ForceNewRevision
Force new revision option Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), Foswiki will fold toget...
DontNotify
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 We...
ShortHand
QuietSave
Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentation...
BumpyWord
See System.WikiWord
AccessKeys
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 ha...
WebsTable
(included from .SiteMap; change . to include from SiteMap instead of WebsTable)
MacrosQuickStart
WabiSabi
Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Ko...
YouAreHere
* You are currently in the web. The color code for this web is this background, so you know where you are. * If you are not familiar with the Foswiki collabor...
PatternSkinGraphics
PatternSkin Graphics This topic contains original Photoshop files of the graphics used in PatternSkin.
CssPlugin
CssPlugin Usage CSS abstract classes Install that plugin and take a look class.tmpl for the full list of supported CSS abstract classes. Examples Installation...
MediaWikiToFoswikiContrib
MediaWikiToFoswikiAddOn Introduction Powered by WikiRing Consultants This is a commandline tool to import MediaWiki pages and images to Foswiki….
HiddenAttachment
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...
ShortcutMacros
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...
TextFormattingRules
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 aut...
VarBB
#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR...
VarBB2
#VarBB2 BB2 level 2 bullet with line break * Line break and bullet, level 2. * Current value: BB2 = * Related: BR, BULLET, BB, BB3, BB4, VBAR
VarBB3
#VarBB3 BB3 level 3 bullet with line break * Line break and bullet, level 3. * Current value: BB3 = * Related: BR, BULLET, BB, BB2, BB4, VBAR
by !!ProjectContributor
VarBB4
#VarBB4 BB4 level 4 bullet with line break * Line break and bullet, level 4. * Current value: BB4 = * Related: BR, BULLET, BB, BB2, BB3, VBAR
by !!ProjectContributor
VarBR
#VarBR BR line break * Current value: BR = * Related: BULLET, BB, BB2, BB3, BB4, CARET, VBAR
VarBULLET
#VarBULLET BULLET bullet character * Current value: BULLET = * Related: BR, BB, BB2, BB3, BB4, CARET, VBAR
VarCARET
#VarCARET CARET caret symbol * The CARET macro is useful in TML tables. * Current value: CARET = * Related: BR, BULLET, BB, BB2, BB3, BB4, VBAR
VarH
#VarH H help icon * Current value: H = * Related: I, ICON, M, N, P, Q, S, T, U, X, Y
VarI
#VarI I idea icon * Current value: I = * Related: H, ICON, M, N, P, Q, S, T, U, X, Y
VarM
#VarM M moved to… icon * Current value: M = * Related: H, I, ICON, N, P, Q, S, T, U, X, Y
VarN
#VarN N "new" icon * Current value: N = * Related: H, I, ICON, M, P, Q, S, T, U, X, Y
VarP
#VarP P pencil icon * Current value: P = * Related: H, I, ICON, M, N, Q, S, T, U, X, Y
VarQ
#VarQ Q question icon * Current value: Q = * Related: H, I, ICON, M, N, P, S, T, U, X, Y
VarS
#VarS S red star icon * Current value: S = * Related: H, I, ICON, M, N, P, Q, T, U, X, Y
VarT
#VarT T tip icon * Current value: T = * Related: H, I, ICON, M, N, P, Q, S, U, X, Y
VarTOPICURL
#VarTOPICURL TOPICURL shortcut to viewing the current topic * This macro always expands to an url pointing to the current base topic. * Current value: TO...
VarU
#VarU U "updated" icon * Current value: U = * Related: H, I, ICON, M, N, P, Q, S, T, X, Y
VarVBAR
#VarVBAR VBAR vertical bar * The vertical bar macro can be used in TML tables. * Current value: VBAR = * Related: BR, BULLET, BB, BB2, BB3, BB4, CARE...
VarX
#VarX X warning icon * Current value: X = * Related: H, I, ICON, M, N, P, Q, S, T, U, Y
VarY
#VarY Y "yes" icon * Current value: Y = * Related: H, I, ICON, M, N, P, Q, S, T, U, X
WikiReferences
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology * Book: The W...
WikiSyntax
Shorthand Basics If you can enter text, you're ready for Foswiki. With a few simple rules, you'll be able to use plain text to create well styled postings, instan...
VarEDITACTION
#VarEDITACTION EDITACTION Selects an edit template * The EDITACTION preference setting lets you define the use of an editaction template instead of the stan...
TWIKI.NET Discussion Forum Application Add On This discussion forum application is contributed by , a company cultivating, nurturing and advancing TWiki as the le...
by PeterThoeny
InterWikis
Inter Wiki Link Rules (or Links to other Sites) This topic lists all aliases needed to map Inter Site links to external wikis/sites. Whenever you write ExternalSi...
LdapNgPlugin
LdapNgPlugin Powered by WikiRing Consultants This plugin provides an interface to query an LDAP directory and display the results in a WikiApplica...
XmlQueryPlugin
XmlQuery TWiki Plugin This Plugin allows TWiki to process XML Data using the XSLT language. The inputs supported are * TWiki topics (data from tables, actions,...
r70 - 17 Aug 2006 - 09:39 by PatrickDiamond
XmlQueryPluginRecipe5
Recipe showing how to extract the values from a Table Column, sort them and produce a unique list Sample Table Title Author Early Israel and the Surroun...
by PatrickDiamond
XmlQueryPluginRecipe4
Recipe showing how to restructure a table or set of tables Sample Table Title Author Early Israel and the Surrounding Nations Sayce, Archibald Henry ...
by PatrickDiamond
XmlQueryPluginRecipe3
Recipe showing how to Transform a table or set of tables Sample Tables Author Title Rider, Henry Allan and the Holy Flower Rider, Henry Allan Qua...
r10 - 28 Feb 2006 - 10:19 by PatrickDiamond
XmlQueryPluginRecipe2
XmlQueryPluginRecipe2 List Attachments in the current Web per user Annotated XSLT Query Text puburl= }% The last two arguments on the xsl:stylesheet element...
r44 - 28 Feb 2006 - 10:18 by PatrickDiamond
XmlQueryPluginRecipe1
XmlQueryPluginRecipe1 List all Attachments in the current Web Annotated XSLT Required XSL header tag Match each /twiki item in the XML TopicAttachmentUs...
by PatrickDiamond
PatternSkinWebCreateNewTopicTemplate
%{"hide page top controls"}% %ADDTOZONE{"script" tag="PatternSkinWebCreateNewTopicTemplate.txt" text=" // " requires="JavascriptFiles/foswikiWindow"}%
Number of topics: 640