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...
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...
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...
Configure Plugin This plugin provides access to all Foswiki configuration data through the webserver, supports running server side checkers and wizards, and allow...
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 ...
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...
JSCalendarContrib Summary of Contents This module packages the Mishoo JSCalendar Javascript in a form suitable for use with Foswiki. Detailed Documentation Read...
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...
PlainFileStoreContrib This is a full implementation of a Foswiki store that uses nothing more sophisticated than plain files and directories In the Foswiki spirit...
Render List Plugin Syntax Rules RENDERLIST Macro * Place a %RENDERLIST{ parameters }% before any bullet list * The lists can be handcrafted, generate...
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...
CompareRevisionsAddOn Description The CompareRevisionsAddOn compares two revisions of a document, like rdiff does. But in contrast to normal rdiff, the compariso...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, .CommentPlugi...
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: ...
JQueryPlugin Description "jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and a...
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...
CompareRevisionsAddOn Plugin This is an helper plugin for the CompareRevisionsAddOn on Foswiki It has two purposes: 1 It sets the CompareRevisionAddonPluginEna...
JQueryCodingStandards Follow Drupal #8217;s JavaScript coding standards See also Foswiki:Development/UsingJQueryWithFoswiki for more information, tips and tricks....
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...
#VarEDITTABLE EDITTABLE{ attributes } edit tables using edit fields and other input fields * The %EDITTABLE{}% macro is handled by the EditTablePlugin * ...
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 ...
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: ...
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...
TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. Parameters All parameters...
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 ...
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 ...
SyntaxHighlightingPlugin Description The Syntax Highlighting Plugin is used to emphasize the rendering of your wiki text according to several languages. It uses ...
JQueryAjaxHelper This page contains a set of example JQueryPlugin helpers that can be used in wiki applications. The examples demonstrate how you can dynamically ...
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...
JSCalendarContribInline Inline include of JSCalendarContrib HTML for use in forms. Initializes the library (called only once) %ADDTOZONE{ "head" id="JSCa...
History Plugin . The output can arbitrarily be formatted. An example for a Wikipedia like history is included. When using PatternSkin enabling the HistoryPlugin c...
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...
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...
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...
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...
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...
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...
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...
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 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 The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an external authenticat...
#SettingPrefs #PreferencesMacros Preference Settings A preference setting lets you define a simple macro that will be expanded in your output. In addition: *...
System Requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platform...
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...
Table Plugin Gives extra control of table display: * Sorting * Setting visual table properties like border width, cell spacing and cell padding * Setting...
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...
%{ 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...
REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...
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...
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...
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...
Developer Documentation List of documents for application developers as well as developers of skins and extensions. Application Developer Topics Topics for norm...
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...
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. ...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wi...
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 Skins Skins overlay regular templates to give different looks and feels to Foswiki screens. Overview Foswiki uses skin templates as the basis of all ...
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...
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...
Skin Templates The framework used to render output. Overview Skin Templates are plain text with embedded template directives, macros and tokens that are expanded...
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 ...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentati...
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...
Pattern Skin Elements Some intro text. Text. Heading 1 text Heading 2 text Heading 3 text Heading 4 text Heading 5 text Heading 6 text A very very very ver...
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 This add on packages up the jQuery "JEditable" plugin from Miko Tuupala. This excellent little plugin gives you edit in place capability with man...
PatternSkin horizontal navigation example Include main navigation with: This is done automatically in the templates by setting in the .SitePreferences: * #Set ...
PatternSkin theme: Foswiki "Fat Willy" Site Skin Navigation Include main navigation with: This is done automatically in the templates by setting in the .SitePre...
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...
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 ...
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 ...
Pending Registrations Template Tailoring instructions: The contents of the Pending Registrations report can be modified to report any fields collected on a custo...
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...
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...
System.PatternSkinCssCookbook Recipe: Left Sidebar Toggle The Sidebar is hidden for screens with width This line loads the extra style definition: * Set USERS...
.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...
WIKIAGENTEMAIL From: email address in emails sent by Foswiki. Examples * %WIKIAGENTEMAIL% expands to == Related WIKIAGENTNAME, WIKIWEBMASTER, WIKIWEBMASTERNA...
WIKIAGENTNAME From: Name used in emails sent by Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME
.PatternSkin Customization Guidelines how to create and customize page templates. For styling your Foswiki using stylesheets, see PatternSkinCssCookbook. First R...
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...
What is Topic Markup Language (TML)? The special text format used in Foswiki topics to simplify topic text. Foswiki lets you work using a WYSIWYG editor, which fo...
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...
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...
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 Description This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a corresponding form definition. So when you attac...
Parent list Generated list of (potential) parent topics. select To use this list in Foswiki applications, use: %INCLUDE{ ".ParentList" section="select" }...
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...
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 ...
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...
Foswiki is distributed under the Gnu General Public License, and sources are freely available. When you download an official Foswiki package from https://foswiki....
Foswiki is distributed under the GNU General Public License, see FAQDownloadSources. GPL is one of the free software licenses that protects the copyright holder, ...
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...
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...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki as quickly as possible. New site administrators are encoura...
What makes Foswiki .... the ideal collaboration tool? Foswiki is... Wiki Structured Data Programmable Pages * Share knowledge * Edit pages collaboratively ...
Project Contributor Foswiki is a development of the Foswiki community. Foswiki is based on TWiki , which was originally written by Peter Thoeny, who based his wor...
Foswiki brand material The official Foswiki logo and derivatives are attached to this page. Logo artwork Logo customization The logo can be changed by redefinin...
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 ...
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...
User's Guide Some documentation topics selected specially for users * Quick Start * User Registration: Sign up so you can edit pages and select options ...
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...
This is where Foswiki keeps system documentation, including documentation that is included with optional extensions. For most people, the web is read only; even ...
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...
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...