This is a short introductory training course for TWiki beginners. A Taste of TWiki The basic function of TWiki is a Wiki (if that helps!) A Wiki is like a web si...
Admin tools Manage whole Foswiki site from one screen. * Users: Register, NewUserTemplate, .UserForm, ResetPassword, ChangePassword * Site Tools: Configure,...
Comment Plugin This plugin allows users to quickly post comments to a page without an edit/preview/save cycle. WARNING: TWiki 4 only. If you want to use this plu...
# 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. A...
# TWiki Formatted Search Inline search feature allows flexible formatting of search result The default output format of a %SEARCH{...}% is a table consisting of t...
The %IF% construct gives TWiki the power to include content in topics based on the value of simple expressions. %IF{"CONDITION" then="THEN" else="ELSE"}% In the e...
Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encourag...
Main Features of TWiki * Any web browser: Edit existing pages or create new pages by using any web browser. There is no need to upload pages. * Edit link: T...
Welcome to Foswiki. This page assumes that you are a new user to Foswiki, and that you've never heard of Wiki before. Here are the most important pages you should...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Doubleclick anywhere to return to the top of the page...
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...
# 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...
Package TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that Plugins can use to interact with the...
# TWiki Glossary Simple glossary of TWiki terms Term Definition Attachment: Any type of file that is uploaded via browser and attached to a topic, where...
# Appendix A: TWiki Development Timeline #DakarRelease TWiki Release 4.0.0 (Dakar), 01 Feb 2006 Major New Features * Much simpler install and configuration ...
#TWikiMetaData # TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored in META variable name/value pairs Overview TWikiMetaData...
Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this TWikiSite. _ Note:_ This topic should be regarded a...
TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki Enterprise Collaborat...
TWiki Release 4.0 (Dakar) 'Dakar' is the first major release of the TWiki Enterprise Collaboration Platform in over a year. The focus of this release has been on ...
# 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 ...
# TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up w...
# 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 th...
# TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview There are three types of template: * Master Templates...
Creating a Table of Contents The TWikiVariables %TOC% will automatically create a table of contents for a topic based on the headers of the topic. To exclude a he...
Linking to a file attachment One can create a link to a file attachment using one of the following TWikiVariables, %ATTACHURL% or %PUBURL%. %ATTACHURL% is the ful...
Inline search To embed a search in a topic, use the %SEARCH{ parameters }% TWiki Variable. The search variable is used by many TWiki based applications. More In...
TWiki Topics The basic building block of a TWiki site is called a topic, identified by a unique, hopefully descriptive, .WikiWord title. It may seem easier just t...
# TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or "login", is the process by which a user lets...
TWiki Variables Quickstart TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly. Some variables take arguments, such as %IN...
Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system...
# TWiki Text Formatting Working in TWiki 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 creat...
#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, F...
#VarALLVARIABLES ALLVARIABLES list of currently defined TWikiVariables * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined TWikiVariables ...
#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can r...
#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBUR...
#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login template...
#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 n...
#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...
#VarDATE DATE signature format date * Syntax: %DATE% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded when th...
#VarDISPLAYTIME2 DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on setting in configure. Same fo...
#VarENCODE ENCODE{"string"} encodes a string to HTML entities * Encode "special" characters to HTML numeric entities. Encoded characters are: * all no...
#VarENDSECTION ENDSECTION{"name"} marks the end of a named section within a topic * Syntax: %ENDSECTION{"name"}% * Syntax: %ENDSECTION{type="include"}% ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See TWikiPlugins#FAIL...
#VarGMTIME GMTIME GM time * Syntax: %GMTIME% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded when the templa...
#VarHTTP HTTP get HTTP headers * Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores a...
#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 us...
#VarICON ICON{"name"} small documentation graphic or icon of common attachment types * Generates the HTML img tag of a small graphic image attached to TWiki...
#VarICONURL ICONURL{"name"} URL of small documentation graphic or icon * Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image...
#VarICONURLPATH ICONURLPATH{"name"} URL path of small documentation graphic or icon * Generates the URL path of a TWikiDocGraphics image, typically used in ...
#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syn...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in cas...
#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 INC...
#VarLANGUAGE LANGUAGE current user's language * Returns the language code for the language used as the current user. This is the language actually used by T...
#VarLANGUAGES LANGUAGES list available TWiki languages * List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's ...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. This topic is read for prefer...
#VarLOGIN LOGIN present a full login link * Syntax: %LOGIN% * Expand to: * Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION_V...
#VarLOGOUT LOGOUT present a full logout link * Syntax: %LOGOUT% * Expand to: * Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSIO...
#VarMETA META displays meta data * Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta data (attac...
#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion...
#VarPLUGINVERSION PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specific p...
#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %P...
#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 cu...
#VarSCRIPTNAME SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) * ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTS...
#VarSCRIPTURL2 SCRIPTURL{"script"} URL of TWiki script * Syntax: %SCRIPTURL{"script"}% * Expands to: == * Example: To get the authenticated version of...
#VarSCRIPTURLPATH SCRIPTURLPATH base URL path of TWiki scripts * As %SCRIPTURL%, but doesn't include the protocol and host part of the URL * Syntax: %SCR...
#VarSCRIPTURLPATH2 SCRIPTURLPATH{"script"} URL path of TWiki script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL ...
#VarSERVERTIME SERVERTIME server time * Syntax: %SERVERTIME% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded...
#VarSERVERTIME2 SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME{"format"}% * Example: %SERVERTIM...
#VarSESSIONID SESSIONID unique ID for this session * Syntax: %SESSIONID% * Expand to: * Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGI...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: TWikiUserAuthent...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated * The current topic name with added URL encoded spaces, for use in regular express...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places * Inserts spaces after lower case letters that are followed by a digi...
#VarSTARTINCLUDE STARTINCLUDE start position of topic text if included * If present in included topic, start to include text from this location up to the en...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Se...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included * If present in included topic, stop to include text at this location and ignore the rema...
#VarTOC2 TOC{"Topic"} table of contents * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSynta...
#VarTOPICLIST TOPICLIST{"format"} topic index of a web * List of all topics in a web. The "format" defines the format of one topic item. It may include vari...
#VarTWIKIWEB TWIKIWEB name of TWiki documentation web * The web containing all documentation and site wide preference settings for Foswiki * Syntax: %TWI...
#VarURLPARAM URLPARAM{"name"} get value of a URL parameter * Returns the value of a URL parameter. * Syntax: %URLPARAM{"name"}% * Supported parameters...
#VarUSERNAME USERNAME your login username * TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME lik...
#VarVAR VAR{"NAME" web="Web"} get a preference value from another web * Syntax: %VAR{"NAME" web="Web"}% * Example: To get %WEBBGCOLOR% of the web write...
#VarWEBLIST WEBLIST{"format"} index of all webs * List of all webs. Obfusticated webs are excluded, e.g. webs with a NOSEARCHALL = on preference variable. T...
#VarWIKINAME WIKINAME your Wiki username * The WikiName is the same as %USERNAME% if not defined in the . topic * Syntax: %WIKINAME% * Expands to: == ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Foswiki home page * Syntax: ...
#VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registers users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * R...
Help on Preferences * A preference setting is defined by: 3 or 6 spaces * Set NAME = value Example: * Set WEBBGCOLOR = #FFFFC0 * A preferences setti...
Wiki name Your name, usually your first and last name connected without a space. For example, Tim Berners Lee's WikiName is TimBernersLee. Your name is also a po...
Wysiwyg Plugin Support for the integration of WYSIWYG (What You See Is What You Get) editors. Comes bundled with a complete integration of the feature rich Kupu e...