Headlines Plugin Description This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news. Note: Syndic8.com ...
#VarHEADLINES HEADLINES{"url"} show RSS and ATOM feeds in TWiki pages The %HEADLINES{"url"}% variable is handled by the HeadlinesPlugin. Syntax: %HEADLINES ...
# TWiki Upgrade Guide Upgrade from the previous TWiki 01 Sep 2004 Production Release to TWiki 4.X Overview TWiki 4.0.0 was a major new release. TWiki 4.1.0 is a ...
#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 ...
#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 ...
Package TWiki::UI Service functions used by the UI packages StaticMethod run (\ method,...) Entry point for execution of a UI function. The parameter is a reference ...
Package TWiki::UI::Edit Edit command handler StaticMethod edit ($session) Edit command handler. This method is designed to be invoked via the TWiki::UI::run ...
Package TWiki::Sandbox This object provides an interface to the outside world. All calls to system functions, or handling of file names, should be brokered by this ...
Package TWiki::UI::Statistics Statistics extraction and presentation StaticMethod statistics ($session) statistics command handler. This method is designed to ...
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 ...
Package TWiki::User A User object is an internal representation of a user in the real world. The object knows about users having login names, wiki names, personal ...
Package TWiki::Users::TWikiUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a wikiname and back. It is also where groups ...
Package TWiki::UI::RDiff UI functions for diffing. StaticMethod diff ($session,$web,$topic,$query) diff command handler. This method is designed to be invoked ...
Package TWiki::UI::View UI delegate for view function StaticMethod view ($session) view command handler. This method is designed to be invoked via the TWiki ...
Package TWiki::If Support for the conditions in %IF{} statements. Basically a simple stack based parser for infix expressions that generates a parse tree that can ...
Package TWiki::Users Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking. ClassMethod new ($session,$impl ...
Package TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) upload command handler. This method is designed to be ...
Package TWiki::UI::Register User registration handling. StaticMethod register cgi ($session) register command handler. This method is designed to be invoked ...
Package TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class ...
Package TWiki::Prefs The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences ...
Package TWiki::UI::Manage UI functions for web, topic and user management StaticMethod manage ($session) manage command handler. This method is designed to be ...
Package TWiki::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description ...
#VarSEARCH SEARCH{"text"} search content Inline search, shows a search result embedded in a topic Syntax: %SEARCH{"text" ...}% Supported parameters ...
#VarENCODE ENCODE{"string"} encodes a string to HTML entities Encode "special" characters to HTML numeric entities. Encoded characters are: all non ...
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 ...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default is ...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology and TWiki Book ...
ATOM News Feeds Find out What's New There are several ways to find out what's new in each TWiki web: 1. Visit WebChanges to see recent changes 1. Subscribed ...
FAQ: What does the "T" in TWiki stand for? Answer: TWiki is short for TakeFive Wiki, the name of the company where its founder Peter Thoeny worked. Peter first named ...
#VarYELLOW YELLOW start yellow colored text YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarWHITE WHITE start white colored text WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarSILVER SILVER start silver colored text SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarTOPICURL TOPICURL shortcut to viewing the current topic This variable always expands to an url pointing to the current base topic. Type: Preference ...
#VarTEAL TEAL start teal colored text TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarORANGE ORANGE start orange colored text ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarPURPLE PURPLE start purple colored text PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarRED RED start red colored text RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings ...
#VarMAROON MAROON start maroon colored text MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarOLIVE OLIVE start olive green colored text OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering ...
#VarNAVY NAVY start navy blue colored text NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarLIME LIME start lime colored text LIME 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 ...
#VarGRAY GRAY start gray colored text GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarAQUA AQUA start aqua colored text AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#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 ...
#VarGREEN GREEN start green colored text GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
#VarENDCOLOR ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings ...
#VarBROWN BROWN start brown colored text BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut ...
What is a !WikiWord? A !WikiWord consists of two or more words with initial capitals, run together. WikiWords are topic names. A TWiki topic name always has a fixed ...
# TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or "login", is the process by which a user lets ...
Web template topics Template topics define the default text for new topics. Available templates in Web: " type "regex" nosearch "on" format " $topic"}%
# TWiki System Requirements Server and client requirements Low client and server base requirements are core features that keep TWiki widely deployable, particularly ...
#VarWEBLIST WEBLIST{"format"} index of all webs List of all webs. Obfusticated webs are excluded, e.g. webs with a NOSEARCHALL on preference variable. ...
# TWiki Variables Special text strings expand on the fly to display user data or system info TWikiVariables are text strings %VARIABLE% or %VARIABLE{ parameter ...
Using HTML You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write strike deleted text /strike ...
Welcome, ! Welcome to TWiki! This is a TWikiSite (pronounced twee kee site ), a meeting place to work on common interests. Anyone can contribute using any web browser ...
TwistyContrib This contrib packages in a convenient way the !JavaScript library and the CSS file needed to implement Twisty sections. !TwistyContrib is installed ...
Package TWiki::UI::Save UI delegate for save function StaticMethod save ($session) Command handler for save command. This method is designed to be invoked via ...
Package TWiki::Users::ApacheHtpasswdUser extends TWiki::Users::Password Password manager that uses Apache::HtPasswd to manage users and passwords. Subclass of ...
Package TWiki::UI::ChangeForm Service functions used by the UI packages ClassMethod generate ($session,$theWeb,$theTopic,$editaction) Generate the page that supports ...
Package TWiki::UI::Oops UI delegate for oops function StaticMethod oops cgi ($session) oops command handler. This method is designed to be invoked via the TWiki ...
TWiki Javascripts This topic contains javascript files that are included by TWiki templates, and may be used by skin templates and in topics. Related Topics: TWikiTemplates ...
/ "; feedbackText feedbackHeader wikiWordName; insertHtml(feedbackText, "webTopicCreatorFeedback"); / Update hidden field value Use the negative value of ...
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: ...
The official TWiki site is twiki.org Welcome to the TWiki Web The place to learn about TWiki features and perform TWiki system maintenance. TWiki is a flexible ...
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 TWiki collaboration ...
FAQ: So what is this WikiWiki thing exactly? Answer: A set of pages of information that are open and free for anyone to edit as they wish. They are stored in a server ...
This is a subscription service to be automatically notified by e mail when topics change in this TWiki web. This is a convenient service, so you do not have to come ...
FAQ: Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer: TWiki is one of many WikiWikiClones, the first one was built by Ward Cunningham ...
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 potentially ...
This page provides online help for new users of TWiki when editing a page. If there's some formatting that your contributors use often, you can customize this for ...
RSS News Feeds Find out What's New There are several ways to find out what's new in each TWiki web: 1. Visit WebChanges to see recent changes 1. Subscribed ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your TWiki home page Syntax: %WIKIUSERNAME ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate . !WebLeftBarPersonalTemplate is a topic template to create a personal left bar block ...
TWiki is a Wiki Wiki clone and has its root in JOS Wiki. TWiki's home is at http://TWiki.org/ TWiki takes a lot of ideas from Cunningham's remarkable Wiki ...
Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Koren ...
Web Changes Notification Service Each TWiki web has an automatic e mail notification service that sends you an e mail with links to all of the topics modified since ...
# 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 ...
#VarTWIKIWEB TWIKIWEB name of TWiki documentation web The web containing all documentation and site wide preference settings for TWiki Syntax: %TWIKIWEB ...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic Section boundaries are defined with %STARTSECTION{}% and %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 ...
#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 ...
#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 ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix Some TWiki installations require a file extension for CGI scripts, such as .pl or .cgi Syntax: %SCRIPTSUFFIX ...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID Syntax: %SESSIONVAR% Expand to: Related: TWikiUserAuthentication ...
#VarWIKIHOMEURL WIKIHOMEURL site home URL Syntax %WIKIHOMEURL% Expands to Defined in TWikiPreferences and normally per default set to %SCRIPTURLPATH ...
#VarSCRIPTURLPATH SCRIPTURLPATH base URL path of TWiki scripts As %SCRIPTURL% , but doesn't include the protocol and host part of the URL Syntax: %SCRIPTURLPATH ...
#VarSCRIPTURLPATH2 SCRIPTURLPATH{"script"} URL path of TWiki script As %SCRIPTURL{"script"}% , but doesn't include the protocol and host part of the URL ...
#VarUSERNAME USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME ...
#VarSCRIPTNAME SCRIPTNAME name of current script The name of the current script is shown, including script suffix, if any (for example viewauth.cgi ) ...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit ...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions ...
#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 ...
#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 ...
#VarIF IF{"condition" ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax ...
#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 ...
#VarPLUGINDESCRIPTIONS PLUGINDESCRIPTIONS list of plugin descriptions Syntax: %PLUGINDESCRIPTIONS% Expands to: Related: ACTIVATEDPLUGINS, FAILEDPLUGINS ...
#VarLANGUAGES LANGUAGES list available TWiki languages List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's ...
#VarINCLUDE QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: %QUERYPARAMS{... ...
#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 ...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as %TOPIC% in case ...
#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 ...
#VarICONURL ICONURL{"name"} URL of small documentation graphic or icon Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image ...
#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 ...
#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 ...
#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 ...
#VarICONURLPATH ICONURLPATH{"name"} URL path of small documentation graphic or icon Generates the URL path of a TWikiDocGraphics image, typically used in an ...
#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 ...
#VarPLUGINVERSION PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API Syntax: %PLUGINVERSION{"name"}% to get the version of a specific ...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. This topic is read for preferences ...
#VarAUTHREALM AUTHREALM authentication realm String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login templates ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: %FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS ...
#VarDISPLAYTIME2 DISPLAYTIME{"format"} formatted display time Formatted time either GMT or Local server time, depending on setting in configure. Same format ...
#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 ...
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 ...