TWiki Installation Guide The following is installation instructions for the TWiki 6.1 production release on an Apache web server on Linux. Visit TWiki:TWiki.InstallingTWiki...
TWiki Formatted Search Inline search feature allows flexible formatting of search result The default output format of a % SEARCH{... is a table consisting of topic...
TWiki Access Control Restricting read and write access to topics and webs, by Users and groups TWiki Access Control allows you restrict access to single topics and...
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...
HEADLINES{`url`} show RSS and ATOM feeds in TWiki pages The % HEADLINES{`url` variable is handled by the HeadlinesPlugin. Syntax: % HEADLINES{ `http:...
WIKIWEBMASTER email address of the administrator % WIKIWEBMASTER% expands to the email address of the administrator of . Syntax: % WIKIWEBMASTER% , expands...
SESSION VARIABLE get, set or clear a session variable Session variables are stored in a personal `persistent memory space` that is not lost until the web browser...
Package TWiki::Engine The engine class is a singleton that implements details about TWiki`s execution mode. This is the base class and implements basic behavior....
GROUPS a formatted list of groups Expands to a formatted list of user groups in your TWiki. The variable is intended to be used in .TWikiGroups, to allow a group...
NBSP non breaking space The WYSIWYG editor tends to change nbsp; into normal space. Use this variable where non breaking space needs to be retained, such as...
Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged...
TWiki Plugins Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You can add plugins to extend TWiki functionality...
`Create New Topic` page has moved Continue to create the new page TWiki admins Please replace all web`s WebTopicCreator topic contents with this text: % `WebTopicCreator...
Installed Plugins Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in...
INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as % TOPIC% in case there is no include...
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 no INCLUDE....
MAROON start maroon colored text MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
TEAL start teal colored text TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
WIKILOGOALT site logo tooltip message Syntax: % WIKILOGOALT% Expands to: Defined in: TWikiPreferences Category: AdministrationVariables, SystemInformationVar...
SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % SESSIONVAR% Expand to: Category: DevelopmentVariables, SystemInformationVariables...
REDBG start red colored background section REDBG is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut...
PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API Syntax: % PLUGINVERSION{`name` to get the version of a specific plugin Example:...
PINK start pink colored text PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
ORANGE start orange colored text ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
ICON{`name`} small documentation graphic or icon of common attachment types Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics....
EDITACTION select an edit template EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit...
COMMENT{ attributes } insert an edit box into the topic to easily add comments. A % COMMENT% without parameters shows a simple text box. A % COMMENT...
Package TWiki::Users::HtPasswdUser Support for htpasswd and htdigest format password files. Subclass of TWiki::Users::Password . See documentation of that class...
Preferences settings TWiki has these levels of preferences settings: 1 System level settings: Site name, proxy settings, access control, skin 1 Site...
Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod...
Package TWiki::UI::Edit Edit command handler StaticMethod edit ($session) Edit command handler. This method is designed to be invoked via the UI::run method...
Text Formatting FAQ This topics lists frequently asked questions on text formatting. Text formatting applies to people who edit TWiki pages in raw edit mode . TextFormattingRules...
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...