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 site ...
nop AttachLinkPlugin Syntax Rules % nop ATTACHMENT{ name "filename" topic "TopicName" web "Webname" label "sometimes text sometimes magic" }% This apparently trivial ...
Comment Plugin Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, CommentPluginExamples ...
Edit Table Plugin Edit TWiki tables in place, using edit fields and drop down boxes, without having to edit the complete topic. Simply add an Edit table button ...
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. Attachments ...
TWiki Formatted Search Inline search feature allows flexible formatting of search result The default output format of a % nop SEARCH{...}% is a table consisting ...
IF Statements The % nop IF% construct gives TWiki the power to include content in topics based on the value of simple expressions. % nop IF{"CONDITION" then "THEN ...
Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged ...
KupuContrib The integration uses the TWiki:Plugins.WysiwygPlugin to translate text to and from a format that Kupu can edit. Caveat : KupuContrib is designed for editing ...
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 ...
Managing Webs Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite is divided into webs; each one represents one subject, one area ...
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 query ...
Render List Plugin Render bullet lists in a variety of formats Syntax Rules RENDERLIST Variable Place a % nop RENDERLIST{ parameters }% before any bullet ...
Search Pattern Cookbook The Search function in TWiki is very powerful. Especially searches using a RegularExpression play an important part of tapping TWiki's full ...
Slide Show Plugin This plugin converts a topic with headings into a slideshow. Introduction There is already a defacto standard for presentations, why this plugin ...
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 package ...
TWiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to TWiki topics. Formulae like % nop CALC{"$INT(7/3)"}% are evaluated at page view time. They ...
Welcome to nop TWiki. This page assumes that you are a new user to nop TWiki, and that you've never heard of Wiki before. Here are the most important pages you should ...
Table Plugin Gives extra control of table display: Allows sorting Changing table properties like border width, cell spacing and cell padding Changing ...
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 created ...
TinyMCEPlugin This is an integration of the WYSIWYG editor. This is great little editor, fast and highly functional, and supporting a wide range of browsers, including ...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiPlannedFeatures ...
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 system ...
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 applications ...
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 ...
Appendix A: TWiki Development Time line #FreetownRelease TWiki Release 4.2.2 (Freetown) released 00:54:17 11 August 2008 Patch release following the 4.2.0 released ...
#TWikiMetaData TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored embedded in the topic text using META: tags Overview By ...
nop TWiki 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 ...
TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki Enterprise Collaboration ...
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 information ...
TWiki Release 4.2.2 (Freetown), 00:54:17 11 August 2008 Introduction TWiki 4.2.0 was released 22 Jan 2008 and introduced some hot new features that make TWiki a better ...
Rendering Shortcuts Easy ways to save some typing Some TWiki preferences variables are just shortcuts for convenience, to either save typing or to easily allow line ...
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 with ...
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 ...
TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates are plain text with embedded template directives ...
Creating a Table of Contents The TWikiVariables % nop TOC% will automatically create a table of contents for a topic based on the headers of the topic. To exclude ...
Linking to a file attachment One can create a link to a file attachment using one of the following TWikiVariables, % nop ATTACHURL% or % nop PUBURL% . % nop ATTACHURL ...
Inline search To embed a search in a topic, use the % nop SEARCH{ parameters }% TWiki Variable. The search variable is used by many TWiki based applications. More ...
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 ...
TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or "login", is the process by which a user lets ...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default is ...
TWiki Variables Quickstart TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example ...
nop 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 ...
#VarALLVARIABLES ALLVARIABLES list of currently defined TWikiVariables Syntax: % nop ALLVARIABLES% Expands to: a table showing all defined TWikiVariables ...
#VarAQUA AQUA start aqua colored text AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarAUTHREALM AUTHREALM authentication realm String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login templates ...
#VarBASETOPIC BASETOPIC base topic where an INCLUDE started The name of the topic where a single or nested INCLUDE started same as % nop TOPIC% if there ...
#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 ...
#VarBLACK BLACK start black colored text BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarBLUE BLUE start blue colored text BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarBROWN BROWN start brown colored text BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarCALC CALC{"formula"} add spreadsheet calculations to tables and outside tables The % nop CALC{"formula"}% variable is handled by the SpreadSheetPlugin ...
#VarCARET CARET caret symbol The caret variable can be used in TWiki tables. Type: Preference variable TWikiRenderingShortcut. Current value: CARET ...
#VarCOMMENT COMMENT{ attributes } insert an edit box into the topic to easily add comments. A % nop COMMENT% without parameters shows a simple text box ...
#VarDISPLAYTIME2 DISPLAYTIME{"format"} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in ...
#VarEDITACTION EDITACTION Selects an edit template EDITACTION defined in a topic or preference setting will define the use of an editaction template instead ...
#VarEDITTABLE EDITTABLE{ attributes } edit TWiki tables using edit fields and other input fields The % nop EDITTABLE{}% variable is handled by the EditTablePlugin ...
#VarENCODE ENCODE{"string"} encodes a string to HTML entities Encode "special" characters to HTML numeric entities. Encoded characters are: all non ...
#VarENDCOLOR ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings ...
#VarENV ENV{"varname"} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % nop FAILEDPLUGINS% Expands to: See TWikiPlugins ...
#VarFORMFIELD FORMFIELD{"fieldname"} renders a field in the form attached to some topic Syntax: % nop FORMFIELD{"fieldname"}% Supported parameters: ...
#VarGRAY GRAY start gray colored text GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarGREEN GREEN start green colored text GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarGROUPS GROUPS a formatted list of groups Expands to a formatted list of user groups in your TWiki. Syntax: % nop GROUPS% The variable is intended ...
#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 are ...
#VarHTTPS HTTPS get HTTPS headers The same as % nop HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can ...
#VarICON ICON{"name"} small documentation graphic or icon of common attachment types Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics ...
#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 an ...
#VarIF IF{"condition" ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax ...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as % nop TOPIC% ...
#VarINCLUDINGWEB INCLUDINGWEB web that includes current topic The web name of the topic that includes the current topic same as % nop WEB% if there is ...
#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 TWiki ...
#VarLANGUAGES LANGUAGES list available TWiki languages List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's ...
#VarLIME LIME start lime colored text LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload ...
#VarMAROON MAROON start maroon colored text MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#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 (attachments ...
#VarNAVY NAVY start navy blue colored text NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarNOP NOP template text not to be expanded in instantiated topics Syntax: % nop NOP% In normal topic text, expands to nop , which prevents expansion ...
#VarOLIVE OLIVE start olive green colored text OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering ...
#VarORANGE ORANGE start orange colored text ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarPINK PINK start pink colored text PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarPLUGINVERSION PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API Syntax: % nop PLUGINVERSION{"name"}% to get the version of a specific ...
#VarPURPLE PURPLE start purple colored text PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarINCLUDE QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: % nop QUERYPARAMS ...
#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 ...
#VarRED RED start red colored text RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings ...
#VarRENDERLIST RENDERLIST render bullet lists in a variety of formats The % nop RENDERLIST% variable is handled by the RenderListPlugin Syntax: % nop ...
#VarREVINFO REVINFO revision information of current topic Syntax: % nop REVINFO% Expands to: Date format defined as {DefaultDateFormat} in configure ...
#VarSCRIPTNAME SCRIPTNAME name of current script The name of the current script is shown, including script suffix, if any (for example viewauth.cgi ) ...
#VarSCRIPTURLPATH SCRIPTURLPATH base URL path of TWiki scripts As % nop SCRIPTURL% , but doesn't include the protocol and host part of the URL Syntax ...
#VarSCRIPTURLPATH2 SCRIPTURLPATH{"script"} URL path of TWiki script As % nop SCRIPTURL{"script"}% , but doesn't include the protocol and host part of the ...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % nop SESSIONVAR% Expand to: Related: TWikiUserAuthentication ...
#VarSILVER SILVER start silver colored text SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarSLIDESHOWSTART SLIDESHOWSTART convert a topic with headings into a slideshow The % nop SLIDESHOWSTART% variable is handled by the SlideShowPlugin ...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions ...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit ...
#VarSTARTINCLUDE STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the end ...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic Section boundaries are defined with % nop STARTSECTION{}% and % nop ENDSECTION ...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining ...
#VarSYSTEMWEB SYSTEMWEB name of TWiki documentation web The web containing all documentation and default preference settings Syntax: % nop SYSTEMWEB ...
#VarTEAL TEAL start teal colored text TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarTOC2 TOC{"Topic"} table of contents Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ...
#VarTOPIC TOPIC name of current topic % nop TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name ...
#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 variables ...
#VarURLPARAM URLPARAM{"name"} get value of a URL parameter Returns the value of a URL parameter. Syntax: % nop URLPARAM{"name"}% Supported parameters ...
#VarUSERINFO USERINFO{"name"} retrieve details about a user Syntax: % nop USERINFO% Expands to: (comma separated list of the username, wikiusername ...
#VarUSERNAME USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME ...
#VarUSERSWEB USERSWEB name of users web The web containing individual user topics, .TWikiGroups, and customised site wide preferences. Syntax: % nop ...
#VarVAR VAR{"NAME" web "Web"} get a preference value from another web Syntax: % nop VAR{"NAME" web "Web"}% Example: To get % nop WEBBGCOLOR% of the ...
#VarWEB WEB name of current web % nop WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic ...
#VarWEBLIST WEBLIST{"format"} index of all webs List of all webs. Obfusticated webs are excluded, e.g. webs with a NOSEARCHALL on preference variable. ...
#VarWHITE WHITE start white colored text WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix Your % nop WIKINAME% with web prefix, useful to point to your nop TWiki home page Syntax ...
#VarYELLOW YELLOW start yellow colored text YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
Wiki name Your name, usually your first and last name connected without a space. For example, Tim Berners Lee's nop WikiName is TimBernersLee. Your name is also ...
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 HTML ...
Settings for WysiwygPlugin that are common to most editor integrations The global TWiki Variable WYSIWYG EXCLUDE can be set to make the plugin sensitive to what ...
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback