Appendix C: CSS Listing of CSS class names emitted from Foswiki core code and standard extensions. With Foswiki 2.0 a number of classes have been deprecated. Thes...

Bulk Registration Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. Unlike normal registratio...

Package == extends CGI::Session::ErrorHandler =head1 NAME CGI::Session persistent session data in CGI applications =head1 SYNOPSIS # Object initialization:...

Package == =head1 NAME CGI::Session::Tutorial Extended CGI::Session manual =head1 STATE MAINTENANCE OVERVIEW Since HTTP is a stateless protocol, each subsequent...

Change registered email address %IF{ "context passwords_modifyable" then="$percentINCLUDE{\"ChangeEmailAddress\" section=\"secretEmailEnabled\"}$percent" el...

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...

Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...

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...

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...

(just an example illustrating how to create a new topic based on a specific template topic. TemplateTopics has more)

Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...

The answer is...

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...

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...

Collaboration Tips A short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. #SignAndDate * If a dis...

History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...

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...

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 ...

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...

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...

Installed Plugins This site is running Foswiki version * * "}%, Release , Foswiki API version * Here is a list of the plugins currently installed and enabled ...

Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...

JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...

JQueryBlockUI %JQPLUGINS{"blockui" format=" Homepage: $homepage Author(s): $author Version: $version " }% The jQuery BlockUI Plugin lets you simu...

JQueryLoader %JQPLUGINS{"loader" format=" Homepage: $homepage Author(s): $author Version: $version " }% This plugin allows to reload parts of a p...

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...

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...

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...

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 ...

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...

NewUserTemplate * :

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...

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...

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...

System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...

PatternSkin Navigation Include main navigation with: Include sections "}% %IF{"istopic '.LeftBar'" then=" $n$percntINCLUDE{\".LeftBar\"}$percnt" }...

PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre...

#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *...

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...

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...

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 ...

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...

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...

%IF{ "{EnableEmail} AND context passwords_modifyable" then="$percentINCLUDE{\"ResetPassword\" section=\"resetPassword\"}$percent" else="" }% * * Ch...

Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...

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...

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 ...

Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...

Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...

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 ...

TWiki Source Code Packages This documentation is automatically generated from the pod, so it always matches the running code This package doesn't smell This pa...

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...

Package TWiki::AccessControlException Exception used raise an access control violation. This exception has the following fields: * web the web which was bein...

TWiki Add Ons Add functionality to TWiki with extensions not based on the TWiki scripts. Overview An add on runs separately from the TWiki scripts, e.g. for data...

TWiki Contribs Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the functionality of TWiki, typically used by plug...

Site Documentation Graphics %NOP{ Do not modify this system topic. This is the template topic for .SiteDocGraphics, instantiated in .TWikiDocGraphics . }% Si...

Package TWiki TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the s...

FAQ: Answer: Back to: TWikiFAQ

TWiki Forms Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database a...

Package TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that TWiki plugins can use to interact wi...

Appendix A: TWiki Development Time line #HelsinkiRelease TWiki Release 5.0 (Helsinki) released on 2010 05 29 2010 10 10 New Features and Enhancements of TWiki ...

TWiki Installation Guide The following is installation instructions for the TWiki 5.0 production release on an Apache web server on Linux. Visit TWiki:TWiki.Insta...

Package TWiki::LoginManager::ApacheLogin This is login manager that you can specify in the security setup section of configure. It instructs TWiki to cooperate wi...

Package TWiki::LoginManager The package is also a Factory for login managers and also the base class for all login managers. On it's own, an object of this class ...

Package TWiki::LoginManager::TemplateLogin This is a login manager that you can specify in the security setup section of configure. It provides users with a templ...

Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this TWikiSite. _ NOTE:_ Don't edit this topic, changes...

%IF{"context registration_supported" then="** __ "}%" else="**" }% * * * * * * ...

TWiki Release 4.0 (Dakar) Note: This is the release note for the previous major release version 4.0.X. It is included with 4.1.X because it contains valuable info...

TWiki Release 4.1.2 (Edinburgh), 2007 03 03 Note: This is the release note for the previous major release version 4.1.X. This note and the TWikiReleaseNotes04x00 ...

TWiki Release 4.2.4 (Freetown), 2008 12 06 Note: This is the release note for the previous major release version 4.2.X. This note, TWikiReleaseNotes04x00 and TWik...

Package TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finis...

Package == package TWiki::Request Class to encapsulate request data. Fields: * action action requested (view, edit, save, ...) * cookies hashref whose key...

TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki scripts are located in...

TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up wit...

TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. Overview TWiki uses TWikiTemplates files as the basis of all the ...

Package TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the "real" store provider which is hidden b...

TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates are plain text with embedded template directives...

Preferences settings TWiki has these levels of preferences settings: 1 System level settings: * Site name, proxy settings, access control, skin 1 Sit...

Heading Quick Summary with link to more information. See More Tips... Contributor:

20 Minute TWiki Tutorial This step by step, hands on tutorial gets you up to speed with all the TWikiSite basics, in mere minutes... 1. Get set... Open two brows...

Package TWiki::UI::Register User registration handling. StaticMethod register_cgi ($session) register command handler. This method is designed to be invoked via ...

TWiki Upgrade Guide This guide covers upgrading from a previous version of TWiki (such as TWiki 4.3) to TWiki 5.0 Overview TWiki 5.0.0 is a major release introdu...

TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or "login", is the process by which a user lets T...

Package TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMappi...

Package TWiki::Users::BaseUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where ...

TWiki Variables Special text strings expand on the fly to display user data or system info TWikiVariables are text strings %VARIABLE% or %VARIABLE{ parameter="v...

Tag me Plugin Plugin to tag wiki content collectively in order to find content by tags and to get a meaningful page ranking. Introduction The larger a wiki gets,...

#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...

Preference settings Foswiki has several levels of preferences settings. See PreferenceSettings for a full list and more information: 1 Default settings: (nev...

Heading Quick Summary with link to more information. See More Tips...

Top Bar of TopMenuSkin Top bar of TopMenuSkin, replacing WebTopBar. %IF{ "istopic '.WebTopMenu'" then="$percntINCLUDE{.WebTopMenu}$percnt" else="$percntINCLUD...

TopicUserMappingContrib The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...

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...

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...

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...

FORMAT format a list of objects Parameters Parameter Description Default "one, two, three" The list to be expanded into the format. R...

GROUPINFO retrieve details about a group Parameters Parameter Description Default "groupname" Optional name of group format ...

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...

HISTORY control attributes of tables and sorting of table columns The %HISTORY{}% macro is handled by the HistoryPlugin Parameters Parameter ...

MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...

REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...

REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...

#VarREVINFO2 REVINFO{"format"} formatted revision information of topic * Syntax: %REVINFO{"format"}% * Supported parameters: Parameter: Descript...

USERINFO retrieve details about a user Parameters Parameter Description "name" WikiName or login username. May be a group. current user ...

USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...

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...

WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your Foswiki home page This macro is an alias for the USERINF...

WIKIUSERSTOPIC name of topic listing all registered users Examples * %WIKIUSERSTOPIC% expands to == * with prefix renders as . Related WIKIUSERNAME

%IF{ "context authenticated" then=""}% "}%" }%%IF{ "$ LOGOUT = ''" then="$percntLOGOUT$percnt" else="Logout"}%" }%%IF{ "$ LOGIN = '' and not conte...

My links: * My home page * My activities * edit

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...

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...

. %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 ...

TWiki Shorthand Basics If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create...