Difference: TWikiDocumentation (29 vs. 30)

Revision 302001-09-07 - MikeMannix

-<
<
+ TWiki Webmaster Reference (ver. 01 Sep 2001)
->
>
+ TWiki Reference Manual (01-Sep-2001)
-<
<
+This page contains all documentation topics as one long and complete reference sheet. Use the extended menu below to jump directly to sections. Doubleclick anywhere on-screen to return to the top of the page.
->
>
+This page contains all documentation topics as one long, complete reference sheet.

Doubleclick anywhere to return to the top of the page.
-<
<
+(You can also browse the TWiki reference as individual pages from the full topics menu.) CHECK

On this page: 
  TWiki System Requirements 
  Server Requirements 
  Required CPAN Modules
   Optional CPAN Modules
 
   Client Requirements
   Important note about TWiki Plugins
 
   TWiki Installation Guide 
  Preparing to install TWiki
   Basic Installation
   Important Server Security Settings
   Next Steps
   Enable Authentication of Users
   Define the Administrator User(s)
   Set TWiki Preferences
   Enable Email Notification
   Enable Signed Email Notification
   Enable WebStatistics
   Automate removal of expired sessions and lease files
   Enable Localization
   Tailor New User Profile Topic
   Custom Start Web and Homepage
   Customize the Look of Your TWiki!
   Customize Special Pages
   Install Plugins
   WYSIWYG And Raw Edit
   Copyright, License and Classification Statements
   Troubleshooting
   Appendices
   TWiki System Requirements 
  Server Requirements
   Client Requirements
   Important note about TWiki Plugins
 
   Notes on Installing TWiki on Non-Root Account
   Installing Manually Without Configure
 
   TWiki Upgrade Guide 
  Overview
   Upgrade Requirements
   Major Changes Compared to Earlier TWiki Releases
   New Upgrade Option with BackupRestorePlugin
   Upgrade Procedure 
  Installation
   Install Extensions
   Copy your old webs to new TWiki
   Copy Users And Their Topics From Main Web
   Apply Customizations To The Skin
   Apply Preferences From Old Installation
   Switch-Over
 
   Customization of Special Pages
   Upgrading from Cairo to TWiki-4 (additional advice) 
  Favicon
   TWikiUsers topic in Main web
 
   Important Changes since TWiki-4.0.5 
  Supported Perl version
   Template spec changed
 
   Important Changes since TWiki-4.1.0 
  New location for session and other temporary files
 
   Important Changes since TWiki-4.1.2 
  New WYSIWYG Editor
   NEWTOPICLINKSYMBOL removed
   UserForm and NewUserTemplate Customization
   TWikiUsers no longer distributed
   New working directory
   New Internal Admin Login
 
   Important Changes since TWiki-5.0.0 
  New TopMenuSkin
 
   Important Changes since TWiki-5.1.0 
  New Page Bookmarks Feature
   User Profile Pages Tailored for Workplace
 
   Important Changes since TWiki-6.0.0 
  Spec Change for Empty DENYTOPICVIEW
 
 
   TWiki User Authentication 
  Overview
   Password Management
   User Mapping
   User Registration
   Login Management 
  No Login (select none in configure)
   Template Login (select TWiki::LoginManager::TemplateLogin in configure)
   Apache Login (select TWiki::LoginManager::ApacheLogin in configure)
 
   Sessions 
  Getting, Setting, and Clearing Session Variables
   Cookies and Transparent Session IDs
 
   TWiki Username vs. Login Username
   Changing Passwords
   Changing E-mail Addresses
   Controlling access to individual scripts
   How to choose an authentication method
 
   TWiki Access Control 
  An Important Control Consideration
   Permissions settings of the webs on this TWiki site
   Authentication vs. Access Control
   Users and Groups 
  Managing Users
   Managing Groups
   The Super Admin Group
 
   Restricting Access 
  Controlling access to a Web
   Controlling access to a Topic
   Allowing public access to specific topics in a restricted web
   Empty values in access control variables
   Securing File Attachments
   Controlling who can manage top-level webs
   How TWiki evaluates ALLOW/DENY settings
   Allowing web creation by user mapping manager
 
   Forbid certain users to do certain actions by configuration
   User masquerading
   Dynamic access control 
  Example 1 - restriction based on topic name
   Example 2 - restriction based on form field
   Dynamic access control in accessing a different web's topic
   Topic level dynamic access control
   Dynamic access control and user masquerading
   Avoiding vulnerability
   Disabling dynamic access control
 
   Access control and INCLUDE
   Customizing "access denied" message
   Custom user/group notations
   Access Control quick recipes 
  Restrict Access to Whole TWiki Site
   Authenticate and Restrict Selected Webs Only
   Hide Control Settings
   Obfuscating Webs
   Read-only Skin Mode
 
   Configuring access control for topics of a certain name in all webs
 
   TWiki Text Formatting 
  TWiki Editing Shorthand
   Using HTML, CSS and JavaScript
   Hyperlinks 
  Internal Links
   External Links
 
   TWiki Variables
   TWikiPlugin Formatting Extensions
   Common Editing Errors
 
   TWiki Variables 
  TWiki Variables Wizard
   Using Variables 
  Variable Names
 
   Preferences Variables 
  Setting Preferences Variables
   Controlling User Level Preferences Override
   Parameterized Variables (Macros)
   Access Control Variables
   Local values for variables
   Frequently Used Preferences Variables
 
   Predefined Variables
   Search or List Variables by Category
   Documenting TWiki Variables
 
   TWiki Formatted Search 
  Syntax 
  1. header="..." parameter
   2. format="..." parameter
   3. footer="..." parameter
   4. default="..." parameter
 
   Results pagination
   Evaluation order of variables
   Examples 
  Bullet list showing topic name and summary
   Table showing form field values of topics with a form
   Extract some text from a topic using regular expression
   Nested Search
   Most recently changed pages
   Search with conditional output
   Restrict search based on a date range
   Embedding search forms to return a formatted result
 
 
   File Attachments 
  What Are Attachments Good For? 
  Document Management System
   File Sharing
   Web Authoring
 
   Uploading Files
   Downloading Files
   Moving Attachment Files
   Deleting Attachments
   Linking to Attached Files
   File Attachment Contents Table
   File Attachment Controls 
  Attach new file 
   Comment 
   Properties 
 
   File names
   Known Issues
 
   TWiki Forms - Foundation of TWiki Applications 
  Overview
   Defining a Form
   Adding a Form to a Topic
   Changing a Form
   Structure of a Form Template
   Form Field Types 
  Values in Other Topics
 
   Using a form template on a different web
   Extending the range of form data types
   Hints and Tips 
  Editing Just Form Data, Without Topic Text
   Build an HTML Form to Create New Form-based Topics
   Update Specific Form Fields
   Searching for Form Data
   Gotcha!
 
 
   TWiki Templates 
  Overview
   Master Templates 
  How Template Directives Work
   Finding Templates
   TMPL:INCLUDE recursion for piecewise customization, or mixing in new features
   Default master template
 
   Template Topics 
  Variable Expansion
   Specifying a Form
   Automatically Generated Topic Names
   Template Topics in Action
   Using Absolute vs Relative URLs in Templates
 
 
   TWiki Skins 
  Overview
   Changing the default TWiki skin
   Defining Skins 
  Partial customization, or adding in new features to an existing skin
 
   Variables in Skins
   The Jump Box and Navigation Box
   Using Cascading Style Sheets
   Attachment Tables
   Packaging and Publishing Skins
   Browsing Installed Skins
   Activating Skins
   Conditional Skin Activation
   Hard-Coded Skins
 
   TWiki Meta Data 
  Overview
   Meta Data Syntax
   Meta Data Specifications 
  META:TOPICINFO
   META:TOPICMOVED
   META:TOPICPARENT
   META:FILEATTACHMENT
   META:FORM
   META:FIELD
   Recommended Sequence
 
   Viewing Meta Data in Page Source
   Rendering Meta Data
 
   TWiki Add-Ons 
  Overview
   Add-Ons Installed on this TWiki
   Installing Add-Ons
   Creating new Add-Ons
 
   TWiki Contribs 
  Overview
   TWiki Contribs Installed on this TWiki
   Installing Contribs
   Creating new Contribs
 
   TWiki Plugins 
  Overview
   Installing Plugins 
  On-Site Pretesting
   Some Notes on Plugin Performance
 
   Managing Installed Plugins 
  Enabling/Disabling Plugins
   Plugin Evaluation Order
   Plugin-Specific Settings
   Listing Active Plugins
 
   The TWiki Plugin API 
  Available Core Functions
   Predefined Hooks
   Hints on Writing Fast Plugins
   Version Detection
   Security
 
   Creating Plugins 
  Anatomy of a Plugin
   Creating the Perl Module 
   Writing the Documentation Topic
   Packaging for Distribution
   Measuring and Improving the Plugin Performance
   Publishing for Public Use
 
   Recommended Storage of Plugin Specific Data 
  Plugin Internal Data
   Web Accessible Data
 
   Integrating with configure 
  Structure of a Config.spec file
 
   Maintaining Plugins 
  Discussions and Feedback on Plugins
   Maintaining Compatibility with Earlier TWiki Versions
   Handling deprecated functions
 
   Environment 
  getSkin( ) -> $skin
   getUrlHost( ) -> $host
   getScriptUrl( $web, $topic, $script, ... ) -> $url
   getViewUrl( $web, $topic ) -> $url
   getPubUrlPath( ) -> $path
   getExternalResource( $url, \@headers, \%params ) -> $response
   postExternalResource( $url, $text, \@headers, \%params ) -> $response
   getCgiQuery( ) -> $query
   getSessionKeys() -> @keys
   getSessionValue( $key ) -> $value
   setSessionValue( $key, $value ) -> $boolean
   clearSessionValue( $key ) -> $boolean
   getContext() -> \%hash
   pushTopicContext($web, $topic)
   popTopicContext()
 
   Preferences 
  getPreferencesValue( $key, $web ) -> $value
   getPluginPreferencesValue( $key ) -> $value
   getPreferencesFlag( $key, $web ) -> $value
   getPluginPreferencesFlag( $key ) -> $boolean
   setPreferencesValue($name, $val)
   getWikiToolName( ) -> $name
   getMainWebname( ) -> $name
   getTwikiWebname( ) -> $name
 
   User Handling and Access Control 
  getDefaultUserName( ) -> $loginName
   getCanonicalUserID( $user ) -> $cUID
   getWikiName( $user ) -> $wikiName
   getWikiUserName( $user ) -> $wikiName
   wikiToUserName( $id ) -> $loginName
   userToWikiName( $loginName, $dontAddWeb ) -> $wikiName
   emailToWikiNames( $email, $dontAddWeb ) -> @wikiNames
   wikinameToEmails( $user ) -> @emails
   isGuest( ) -> $boolean
   isAnAdmin( $user, $topic, $web ) -> $boolean
   isGroupMember( $group, $id ) -> $boolean
   eachUser() -> $iterator
   eachMembership($id) -> $iterator
   eachGroup() -> $iterator
   isGroup( $group ) -> $boolean
   eachGroupMember($group) -> $iterator
   checkAccessPermission( $type, $id, $text, $topic, $web, $meta ) -> $boolean
 
   Webs, Topics and Attachments 
  getListOfWebs( $filter ) -> @webs
   webExists( $web ) -> $boolean
   isValidWebName( $name, $templateWeb ) -> $boolean
   createWeb( $newWeb, $baseWeb, $opts )
   moveWeb( $oldName, $newName )
   eachChangeSince($web, $time) -> $iterator
   getTopicList( $web ) -> @topics
   topicExists( $web, $topic ) -> $boolean
   isValidTopicName( $name ) -> $boolean
   checkTopicEditLock( $web, $topic, $script ) -> ( $oopsUrl, $loginName, $unlockTime )
   setTopicEditLock( $web, $topic, $lock )
   saveTopic( $web, $topic, $meta, $text, $options ) -> $error
   saveTopicText( $web, $topic, $text, $ignorePermissions, $dontNotify ) -> $oopsUrl
   moveTopic( $web, $topic, $newWeb, $newTopic )
   getRevisionInfo($web, $topic, $rev, $attachment ) -> ( $date, $user, $rev, $comment )
   getRevisionAtTime( $web, $topic, $time ) -> $rev
   readTopic( $web, $topic, $rev ) -> ( $meta, $text )
   readTopicText( $web, $topic, $rev, $ignorePermissions ) -> $text
   attachmentExists( $web, $topic, $attachment ) -> $boolean
   readAttachment( $web, $topic, $name, $rev ) -> $data
   saveAttachment( $web, $topic, $attachment, $opts )
   moveAttachment( $web, $topic, $attachment, $newWeb, $newTopic, $newAttachment )
 
   Assembling Pages 
  readTemplate( $name, $skin ) -> $text
   loadTemplate ( $name, $skin, $web ) -> $text
   expandTemplate( $def  ) -> $string
   writeHeader( )
   redirectCgiQuery( $query, $url, $passthru, $viaCache )
   addToHEAD( $id, $header, $requires )
   expandCommonVariables( $text, $topic, $web, $meta ) -> $text
   renderText( $text, $web ) -> $text
   internalLink( $pre, $web, $topic, $label, $anchor, $createLink ) -> $text
 
   E-mail 
  sendEmail ( $text, $retries ) -> $error
   wikiToEmail( $wikiName ) -> $email
 
   Creating New Topics 
  expandVariablesOnTopicCreation ( $text, $web, $topic ) -> $text
 
   Special Handlers 
  registerTagHandler( $var, \&fn, $syntax )
   registerRESTHandler( $alias, \&fn, )
   registerExternalHTTPHandler( \&fn )
   decodeFormatTokens($str) -> $unencodedString
 
   Searching 
  searchInWebContent($searchString, $web, \@topics, \%options ) -> \%map
 
   Plugin-specific File Handling 
  getWorkArea( $pluginName ) -> $directorypath
   readFile( $filename ) -> $text
   saveFile( $filename, $text )
 
   Read-only and Mirror Webs 
  getSiteName() -> $siteName
   getContentMode( $web ) -> $contentMode
   webWritable( $web ) -> $boolean
 
   Using multiple disks 
  getDiskList() -> @diskIDs
   getDiskInfo($web, [$diskID]) -> ($dataDir, $pubDir, $diskID)
   trashWebName(web => $web | disk => $diskID) -> $trashWebName
 
   General Utilities 
  getRegularExpression( $name ) -> $expr
   normalizeWebTopicName($web, $topic) -> ($web, $topic)
   sanitizeAttachmentName($fname) -> ($fileName, $origName)
   buildWikiWord( $text ) -> $text
   spaceOutWikiWord( $word, $sep ) -> $text
   writeWarning( $text )
   writeDebug( $text )
   writeLog( $action, $extra, $web, $topic, $user )
   formatTime( $time, $format, $timezone ) -> $text
   isTrue( $value, $default ) -> $boolean
   isValidWikiWord ( $text ) -> $boolean
   extractParameters($attr ) -> %params
   extractNameValuePair( $attr, $name ) -> $value
   entityEncode( $text, $extra ) -> $text
   entityDecode( $text ) -> $text
   urlEncode( $text ) -> $text
   urlDecode( $text ) -> $text
 
   Deprecated functions 
  getScriptUrlPath( ) -> $path
   getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url
   permissionsSet( $web ) -> $boolean
   getPublicWebList( ) -> @webs
   formatGmTime( $time, $format ) -> $text
   getDataDir( ) -> $dir
   getPubDir( ) -> $dir
   checkDependencies( $moduleName, $dependenciesRef ) -> $error
 
   TWiki API History 
  TWiki-2001-09-01 (Athens Release)
   TWiki-2003-02-01 (Beijing Release)
   TWiki-2004-09-02 (Cairo Release)
   TWiki-4.0.0 (Dakar Release)
   TWiki-4.0.1 (Dakar Patch Release)
   TWiki-4.1 (Edinburgh Release)
   TWiki-4.2 (Freetown Release)
   TWiki-4.3 (Georgetown Release)
   TWiki-5.0 (Helsinki Release)
   TWiki-5.1 (Istanbul Release)
   TWiki-6.0 (Jerusalem Release)
   TWiki-6.02 (Kampala Release)
 
 
   TWiki CGI and Command Line Scripts 
  CGI Scripts 
  General Information
   attach
   changes
   configure
   edit
   login
   logon
   manage
   oops
   preview
   rdiff
   register
   rename
   copy
   mdrepo
   rest
   save
   search
   statistics
   upload
   view
   viewfile
 
   Command Line Scripts 
  geturl.pl
   rewriteshebang.pl
   tick_twiki.pl
 
 
   Page Rendering Process 
  Basics 
  Preferences variables are read
   Template is read and expanded
   Variable expansion
   TWiki markup to HTML
 
   Plugins
 
   TWiki Site Tools 
  WebNotify - recent changes alert 
  Web Changes Notification Service
 
   WebSearch - search TWiki site
   WebChanges - what's new
   WebRss and WebAtom - news feeds on recent changes
   WebIndex - list of topics
   WebStatistics - site statistics 
  Configuring for automatic operation
   Generating statistics manually by URL
   The maximum number of items in columns
   Affiliation breakdown of views, saves, and uploads
   Excluding some webs from WebStatistics update
   Preventing WebStatistics and SiteStatistics from growing big
   Upgrade from pre 6.0
 
   Log Files
   E-mail 
  Configuring outgoing mail
   Setting the automatic e-mail schedule
 
   Site Permissions
   Backup and Restore
   Help with crontab
 
   Managing Topics 
  Overview
   How to Rename/Move/Delete a Topic
   Deleted Topics: How to Clear the Trash
   Redirecting from an Old Topic
   How Rename/Move Works 
  How Referring Topics Are Found
   Effect of User Access Settings
 
   Special Considerations
   Known Issues
 
   Managing Webs 
  Overview
   Namespace and URL
   Choose Web Template
   Adding a New Web
   Hierarchical Webs 
  Sub-web Preferences are Inherited
   Navigation
 
   Renaming or Deleting a Web 
  Permissions
   Edit Conflicts
   Renaming the TWiki or Main webs
 
 
   Manage Users 
  Authentication and Access Control
   List Users
   Register Users
   Query and Edit User Account Data (Passwords, E-mails)
   Changing User Account Names
   Removing User Accounts
   Customizing registration Emails.
 
   Appendix A: TWiki Development Time-line 
  TWiki Release 6.0 (Jerusalem) released on 2013-10-14 — 2015-11-29
   TWiki Release 5.1 (Istanbul) released on 2011-08-20 — 2013-02-16
   TWiki Release 5.0 (Helsinki) released on 2010-05-29 — 2011-04-21
   TWiki Release 4.3 (Georgetown) released on 2009-04-29
   TWiki Release 4.2 (Freetown), 2008-01-22
   TWiki Release 4.1 (Edinburgh), 2007-01-16
   TWiki Release 4.0 (Dakar), 2006-02-01
   01-Sep-2004 Release (Cairo)
   01-Feb-2003 Release (Beijing)
   01-Dec-2001 Release (Athens)
   01-Sep-2001 Release
   01-Dec-2000 Release
   01-May-2000 Release
   01-Sep-1999 Release
   01-Jul-1999 Release
   1998 Releases
   Dev Flow
 
   Appendix B: Encode URLs With UTF8  
  Current Status
   Details of Implementation
   Testing and Limitation
 
   Appendix C: TWiki CSS 
  Who should read this document?
   Naming conventions 
  TWiki styles in core code
   TWiki Styles in Plugins
   TWiki Styles in Templates
   TWiki Styles used in configure
   TWiki Styles in topics
   TWiki Styles in Skins
   Reserved Styles
 
   Tips
->
>
+On this page: 
  TWiki System Requirements 
  Server Requirements 
  Required CPAN Modules
   Optional CPAN Modules
 
   Client Requirements
   Important note about TWiki Plugins
 
   TWiki Installation Guide 
  Preparing to install TWiki
   Basic Installation
   Important Server Security Settings
   Next Steps
   Enable Authentication of Users
   Define the Administrator User(s)
   Set TWiki Preferences
   Enable Email Notification
   Enable Signed Email Notification
   Enable WebStatistics
   Automate removal of expired sessions and lease files
   Enable Localization
   Tailor New User Profile Topic
   Custom Start Web and Homepage
   Customize the Look of Your TWiki!
   Customize Special Pages
   Install Plugins
   WYSIWYG And Raw Edit
   Copyright, License and Classification Statements
   Troubleshooting
   Appendices
   TWiki System Requirements 
  Server Requirements 
  Required CPAN Modules
   Optional CPAN Modules
 
   Client Requirements
   Important note about TWiki Plugins
 
   Notes on Installing TWiki on Non-Root Account
   Installing Manually Without Configure
 
   TWiki Upgrade Guide 
  Overview
   Upgrade Requirements
   Major Changes Compared to Earlier TWiki Releases
   New Upgrade Option with BackupRestorePlugin
   Upgrade Procedure 
  Installation
   Install Extensions
   Copy your old webs to new TWiki
   Copy Users And Their Topics From Main Web
   Apply Customizations To The Skin
   Apply Preferences From Old Installation
   Switch-Over
 
   Customization of Special Pages
   Upgrading from Cairo to TWiki-4 (additional advice) 
  Favicon
   TWikiUsers topic in Main web
 
   Important Changes since TWiki-4.0.5 
  Supported Perl version
   Template spec changed
 
   Important Changes since TWiki-4.1.0 
  New location for session and other temporary files
 
   Important Changes since TWiki-4.1.2 
  New WYSIWYG Editor
   NEWTOPICLINKSYMBOL removed
   UserForm and NewUserTemplate Customization
   TWikiUsers no longer distributed
   New working directory
   New Internal Admin Login
 
   Important Changes since TWiki-5.0.0 
  New TopMenuSkin
 
   Important Changes since TWiki-5.1.0 
  New Page Bookmarks Feature
   User Profile Pages Tailored for Workplace
 
   Important Changes since TWiki-6.0.0 
  Spec Change for Empty DENYTOPICVIEW
 
 
   TWiki User Authentication 
  Overview
   Password Management
   User Mapping
   User Registration
   Login Management 
  No Login (select none in configure)
   Template Login (select TWiki::LoginManager::TemplateLogin in configure) 
  Enabling Template Login
 
   Apache Login (select TWiki::LoginManager::ApacheLogin in configure) 
  Enabling Apache Login using mod_auth
   Logons via bin/logon
 
 
   Sessions 
  Getting, Setting, and Clearing Session Variables
   Cookies and Transparent Session IDs
 
   TWiki Username vs. Login Username
   Changing Passwords
   Changing E-mail Addresses
   Controlling access to individual scripts
   How to choose an authentication method
 
   TWiki Access Control 
  An Important Control Consideration
   Permissions settings of the webs on this TWiki site
   Authentication vs. Access Control
   Users and Groups 
  Managing Users
   Managing Groups
   The Super Admin Group
 
   Restricting Access 
  Controlling access to a Web
   Controlling access to a Topic
   Allowing public access to specific topics in a restricted web
   Empty values in access control variables
   Securing File Attachments
   Controlling who can manage top-level webs
   How TWiki evaluates ALLOW/DENY settings
   Allowing web creation by user mapping manager
 
   Forbid certain users to do certain actions by configuration
   User masquerading
   Dynamic access control 
  Example 1 - restriction based on topic name
   Example 2 - restriction based on form field
   Dynamic access control in accessing a different web's topic
   Topic level dynamic access control
   Dynamic access control and user masquerading
   Avoiding vulnerability
   Disabling dynamic access control
 
   Access control and INCLUDE
   Customizing "access denied" message
   Custom user/group notations
   Access Control quick recipes 
  Restrict Access to Whole TWiki Site
   Authenticate and Restrict Selected Webs Only
   Hide Control Settings
   Obfuscating Webs
   Read-only Skin Mode
 
   Configuring access control for topics of a certain name in all webs
 
   TWiki Text Formatting 
  TWiki Editing Shorthand
   Using HTML, CSS and JavaScript
   Hyperlinks 
  Internal Links
   External Links
 
   TWiki Variables
   TWikiPlugin Formatting Extensions
   Common Editing Errors
 
   TWiki Variables 
  TWiki Variables Wizard
   Using Variables 
  Variable Names
 
   Preferences Variables 
  Setting Preferences Variables
   Controlling User Level Preferences Override
   Parameterized Variables (Macros)
   Access Control Variables
   Local values for variables
   Frequently Used Preferences Variables
 
   Predefined Variables
   Search or List Variables by Category
   Documenting TWiki Variables
 
   TWiki Formatted Search 
  Syntax 
  1. header="..." parameter
   2. format="..." parameter
   3. footer="..." parameter
   4. default="..." parameter
 
   Results pagination
   Evaluation order of variables
   Examples 
  Bullet list showing topic name and summary
   Table showing form field values of topics with a form
   Extract some text from a topic using regular expression
   Nested Search
   Most recently changed pages
   Search with conditional output
   Restrict search based on a date range
   Embedding search forms to return a formatted result
 
 
   File Attachments 
  What Are Attachments Good For? 
  Document Management System
   File Sharing
   Web Authoring
 
   Uploading Files
   Downloading Files
   Moving Attachment Files
   Deleting Attachments
   Linking to Attached Files
   File Attachment Contents Table
   File Attachment Controls 
  Attach new file 
   Comment 
   Properties 
 
   File names
   Known Issues
 
   TWiki Forms - Foundation of TWiki Applications 
  Overview
   Defining a Form
   Adding a Form to a Topic
   Changing a Form
   Structure of a Form Template
   Form Field Types 
  Values in Other Topics
 
   Using a form template on a different web
   Extending the range of form data types
   Hints and Tips 
  Editing Just Form Data, Without Topic Text
   Build an HTML Form to Create New Form-based Topics
   Update Specific Form Fields
   Searching for Form Data
   Gotcha!
 
 
   TWiki Templates 
  Overview
   Master Templates 
  How Template Directives Work
   Finding Templates
   TMPL:INCLUDE recursion for piecewise customization, or mixing in new features
   Default master template
 
   Template Topics 
  Variable Expansion 
  1. Default variable expansion
   2. Preventing variable expansion
   3. Causing variable expansion in a section
   4. Specifying variables to be expanded individually
 
   Specifying a Form
   Automatically Generated Topic Names
   Template Topics in Action
   Using Absolute vs Relative URLs in Templates
 
 
   TWiki Skins 
  Overview
   Changing the default TWiki skin
   Defining Skins 
  Partial customization, or adding in new features to an existing skin
 
   Variables in Skins
   The Jump Box and Navigation Box
   Using Cascading Style Sheets
   Attachment Tables
   Packaging and Publishing Skins
   Browsing Installed Skins
   Activating Skins
   Conditional Skin Activation
   Hard-Coded Skins
 
   TWiki Meta Data 
  Overview
   Meta Data Syntax
   Meta Data Specifications 
  META:TOPICINFO
   META:TOPICMOVED
   META:TOPICPARENT
   META:FILEATTACHMENT
   META:FORM
   META:FIELD
   Recommended Sequence
 
   Viewing Meta Data in Page Source
   Rendering Meta Data
 
   TWiki Add-Ons 
  Overview
   Add-Ons Installed on this TWiki
   Installing Add-Ons
   Creating new Add-Ons
 
   TWiki Contribs 
  Overview
   TWiki Contribs Installed on this TWiki
   Installing Contribs
   Creating new Contribs
 
   TWiki Plugins 
  Overview
   Installing Plugins 
  On-Site Pretesting
   Some Notes on Plugin Performance
 
   Managing Installed Plugins 
  Enabling/Disabling Plugins
   Plugin Evaluation Order
   Plugin-Specific Settings
   Listing Active Plugins 
  %ACTIVATEDPLUGINS%
   %PLUGINDESCRIPTIONS%
   %FAILEDPLUGINS%
 
 
   The TWiki Plugin API 
  Available Core Functions
   Predefined Hooks
   Hints on Writing Fast Plugins
   Version Detection
   Security
 
   Creating Plugins 
  Anatomy of a Plugin
   Creating the Perl Module 
   Writing the Documentation Topic
   Packaging for Distribution
   Measuring and Improving the Plugin Performance
   Publishing for Public Use
 
   Recommended Storage of Plugin Specific Data 
  Plugin Internal Data
   Web Accessible Data
 
   Integrating with configure 
  Structure of a Config.spec file
 
   Maintaining Plugins 
  Discussions and Feedback on Plugins
   Maintaining Compatibility with Earlier TWiki Versions
   Handling deprecated functions
 
   Environment 
  getSkin( ) -> $skin
   getUrlHost( ) -> $host
   getScriptUrl( $web, $topic, $script, ... ) -> $url
   getViewUrl( $web, $topic ) -> $url
   getPubUrlPath( ) -> $path
   getExternalResource( $url, \@headers, \%params ) -> $response
   postExternalResource( $url, $text, \@headers, \%params ) -> $response
   getCgiQuery( ) -> $query
   getSessionKeys() -> @keys
   getSessionValue( $key ) -> $value
   setSessionValue( $key, $value ) -> $boolean
   clearSessionValue( $key ) -> $boolean
   getContext() -> \%hash
   pushTopicContext($web, $topic)
   popTopicContext()
 
   Preferences 
  getPreferencesValue( $key, $web ) -> $value
   getPluginPreferencesValue( $key ) -> $value
   getPreferencesFlag( $key, $web ) -> $value
   getPluginPreferencesFlag( $key ) -> $boolean
   setPreferencesValue($name, $val)
   getWikiToolName( ) -> $name
   getMainWebname( ) -> $name
   getTwikiWebname( ) -> $name
 
   User Handling and Access Control 
  getDefaultUserName( ) -> $loginName
   getCanonicalUserID( $user ) -> $cUID
   getWikiName( $user ) -> $wikiName
   getWikiUserName( $user ) -> $wikiName
   wikiToUserName( $id ) -> $loginName
   userToWikiName( $loginName, $dontAddWeb ) -> $wikiName
   emailToWikiNames( $email, $dontAddWeb ) -> @wikiNames
   wikinameToEmails( $user ) -> @emails
   isGuest( ) -> $boolean
   isAnAdmin( $user, $topic, $web ) -> $boolean
   isGroupMember( $group, $id ) -> $boolean
   eachUser() -> $iterator
   eachMembership($id) -> $iterator
   eachGroup() -> $iterator
   isGroup( $group ) -> $boolean
   eachGroupMember($group) -> $iterator
   checkAccessPermission( $type, $id, $text, $topic, $web, $meta ) -> $boolean
 
   Webs, Topics and Attachments 
  getListOfWebs( $filter ) -> @webs
   webExists( $web ) -> $boolean
   isValidWebName( $name, $templateWeb ) -> $boolean
   createWeb( $newWeb, $baseWeb, $opts )
   moveWeb( $oldName, $newName )
   eachChangeSince($web, $time) -> $iterator
   getTopicList( $web ) -> @topics
   topicExists( $web, $topic ) -> $boolean
   isValidTopicName( $name ) -> $boolean
   checkTopicEditLock( $web, $topic, $script ) -> ( $oopsUrl, $loginName, $unlockTime )
   setTopicEditLock( $web, $topic, $lock )
   saveTopic( $web, $topic, $meta, $text, $options ) -> $error
   saveTopicText( $web, $topic, $text, $ignorePermissions, $dontNotify ) -> $oopsUrl
   moveTopic( $web, $topic, $newWeb, $newTopic )
   getRevisionInfo($web, $topic, $rev, $attachment ) -> ( $date, $user, $rev, $comment )
   getRevisionAtTime( $web, $topic, $time ) -> $rev
   readTopic( $web, $topic, $rev ) -> ( $meta, $text )
   readTopicText( $web, $topic, $rev, $ignorePermissions ) -> $text
   attachmentExists( $web, $topic, $attachment ) -> $boolean
   readAttachment( $web, $topic, $name, $rev ) -> $data
   saveAttachment( $web, $topic, $attachment, $opts )
   moveAttachment( $web, $topic, $attachment, $newWeb, $newTopic, $newAttachment )
 
   Assembling Pages 
  readTemplate( $name, $skin ) -> $text
   loadTemplate ( $name, $skin, $web ) -> $text
   expandTemplate( $def  ) -> $string
   writeHeader( )
   redirectCgiQuery( $query, $url, $passthru, $viaCache )
   addToHEAD( $id, $header, $requires )
   expandCommonVariables( $text, $topic, $web, $meta ) -> $text
   renderText( $text, $web ) -> $text
   internalLink( $pre, $web, $topic, $label, $anchor, $createLink ) -> $text
 
   E-mail 
  sendEmail ( $text, $retries ) -> $error
   wikiToEmail( $wikiName ) -> $email
 
   Creating New Topics 
  expandVariablesOnTopicCreation ( $text, $web, $topic ) -> $text
 
   Special Handlers 
  registerTagHandler( $var, \&fn, $syntax )
   registerRESTHandler( $alias, \&fn, )
   registerExternalHTTPHandler( \&fn )
   decodeFormatTokens($str) -> $unencodedString
 
   Searching 
  searchInWebContent($searchString, $web, \@topics, \%options ) -> \%map
 
   Plugin-specific File Handling 
  getWorkArea( $pluginName ) -> $directorypath
   readFile( $filename ) -> $text
   saveFile( $filename, $text )
 
   Read-only and Mirror Webs 
  getSiteName() -> $siteName
   getContentMode( $web ) -> $contentMode
   webWritable( $web ) -> $boolean
 
   Using multiple disks 
  getDiskList() -> @diskIDs
   getDiskInfo($web, [$diskID]) -> ($dataDir, $pubDir, $diskID)
   trashWebName(web => $web | disk => $diskID) -> $trashWebName
 
   General Utilities 
  getRegularExpression( $name ) -> $expr
   normalizeWebTopicName($web, $topic) -> ($web, $topic)
   sanitizeAttachmentName($fname) -> ($fileName, $origName)
   buildWikiWord( $text ) -> $text
   spaceOutWikiWord( $word, $sep ) -> $text
   writeWarning( $text )
   writeDebug( $text )
   writeLog( $action, $extra, $web, $topic, $user )
   formatTime( $time, $format, $timezone ) -> $text
   isTrue( $value, $default ) -> $boolean
   isValidWikiWord ( $text ) -> $boolean
   extractParameters($attr ) -> %params
   extractNameValuePair( $attr, $name ) -> $value
   entityEncode( $text, $extra ) -> $text
   entityDecode( $text ) -> $text
   urlEncode( $text ) -> $text
   urlDecode( $text ) -> $text
 
   Deprecated functions 
  getScriptUrlPath( ) -> $path
   getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url
   permissionsSet( $web ) -> $boolean
   getPublicWebList( ) -> @webs
   formatGmTime( $time, $format ) -> $text
   getDataDir( ) -> $dir
   getPubDir( ) -> $dir
   checkDependencies( $moduleName, $dependenciesRef ) -> $error
 
   TWiki API History 
  TWiki-2001-09-01 (Athens Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-2003-02-01 (Beijing Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-2004-09-02 (Cairo Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-4.0.0 (Dakar Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-4.0.1 (Dakar Patch Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-4.1 (Edinburgh Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-4.2 (Freetown Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-4.3 (Georgetown Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-5.0 (Helsinki Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-5.1 (Istanbul Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-6.0 (Jerusalem Release) 
  EmptyPlugin.pm
   Func.pm
 
   TWiki-6.02 (Kampala Release) 
  EmptyPlugin.pm
 
 
 
   TWiki CGI and Command Line Scripts 
  CGI Scripts 
  General Information 
  CGI environment
   Command-line
   Common parameters
 
   attach
   changes
   configure
   edit
   login
   logon
   manage 
  action=createweb
   action=renameweb
   action=editSettings
   action=saveSettings
   action=bulkRegister
   action=changePassword
   action=resetPassword
   action=deleteUserAccount
 
   oops
   preview
   rdiff
   register
   rename
   copy
   mdrepo
   rest 
  Invocation Examples
 
   save
   search
   statistics
   upload
   view
   viewfile
 
   Command Line Scripts 
  geturl.pl
   rewriteshebang.pl
   tick_twiki.pl
 
 
   Page Rendering Process 
  Basics 
  Preferences variables are read
   Template is read and expanded
   Variable expansion
   TWiki markup to HTML
 
   Plugins
 
   TWiki Site Tools 
  WebNotify - recent changes alert 
  Web Changes Notification Service
 
   WebSearch - search TWiki site
   WebChanges - what's new
   WebRss and WebAtom - news feeds on recent changes
   WebIndex - list of topics
   WebStatistics - site statistics 
  Configuring for automatic operation
   Generating statistics manually by URL
   The maximum number of items in columns
   Affiliation breakdown of views, saves, and uploads
   Excluding some webs from WebStatistics update
   Preventing WebStatistics and SiteStatistics from growing big
   Upgrade from pre 6.0 
  Statistics topic conversion
   Top Contributors on SiteStatistics
 
 
   Log Files
   E-mail 
  Configuring outgoing mail
   Setting the automatic e-mail schedule
 
   Site Permissions
   Backup and Restore
   Help with crontab
 
   Managing Topics 
  Overview
   How to Rename/Move/Delete a Topic
   Deleted Topics: How to Clear the Trash
   Redirecting from an Old Topic
   How Rename/Move Works 
  How Referring Topics Are Found
   Effect of User Access Settings
 
   Special Considerations
   Known Issues
 
   Managing Webs 
  Overview
   Namespace and URL
   Choose Web Template
   Adding a New Web
   Hierarchical Webs 
  Sub-web Preferences are Inherited
   Navigation
 
   Renaming or Deleting a Web 
  Permissions
   Edit Conflicts
   Renaming the TWiki or Main webs
 
 
   Manage Users 
  Authentication and Access Control
   List Users
   Register Users
   Query and Edit User Account Data (Passwords, E-mails)
   Changing User Account Names
   Removing User Accounts
   Customizing registration Emails.
 
   Appendix A: TWiki Development Time-line 
  TWiki Release 6.0 (Jerusalem) released on 2013-10-14 — 2015-11-29
   TWiki Release 5.1 (Istanbul) released on 2011-08-20 — 2013-02-16
   TWiki Release 5.0 (Helsinki) released on 2010-05-29 — 2011-04-21
   TWiki Release 4.3 (Georgetown) released on 2009-04-29
   TWiki Release 4.2 (Freetown), 2008-01-22
   TWiki Release 4.1 (Edinburgh), 2007-01-16
   TWiki Release 4.0 (Dakar), 2006-02-01
   01-Sep-2004 Release (Cairo)
   01-Feb-2003 Release (Beijing)
   01-Dec-2001 Release (Athens)
   01-Sep-2001 Release
   01-Dec-2000 Release
   01-May-2000 Release
   01-Sep-1999 Release
   01-Jul-1999 Release
   1998 Releases
   Dev Flow
 
   Appendix B: Encode URLs With UTF8  
  Current Status
   Details of Implementation
   Testing and Limitation
 
   Appendix C: TWiki CSS 
  Who should read this document?
   Naming conventions 
  TWiki styles in core code
   TWiki Styles in Plugins 
  TablePlugin
 
   TWiki Styles in Templates
   TWiki Styles used in configure
   TWiki Styles in topics
   TWiki Styles in Skins
   Reserved Styles
 
   Tips
 Note: Read the most up to date version of this document at http://TWiki.org/cgi-bin/view/TWiki/TWikiDocumentation

View topic | History: r50 < r49 < r48 < r47 | More topic actions...

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiDocumentation.