Slide template for ATasteOfTWiki presentation

%SLIDETITLE%
	%SLIDETEXT%
%SLIDENAVFIRST% %SLIDENAVPREV% Slide %SLIDENUM% of %SLIDEMAX% %SLIDENAVNEXT% %SLIDENAVLAST% Copyright © 2014 by the contributing authors

Access Keys

What are access keys?

Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without having to use a mouse or other pointing device.

What are the advantages of using access keys?

Its an alternative to using a mouse, or other pointing device, and can sometimes be quicker than using a mouse.

How do I use access keys?

This depends on the browser you are using (see also cross-browser support below):

• If you use Internet Explorer
  • Press and hold the 'Alt' key
  • Press the required letter
  • Release the keys and press the 'ENTER' key

• If you use Netscape Navigator, Mozilla, or Firefox
  • Press and hold the 'Alt' key
  • Press the required letter

• If you are using a Mac
  • Press and hold the 'Ctrl' key
  • Press the required letter

Learn more

Related Topics: UserDocumentationCategory

A List of TWiki Administrator Documentation

• AdminSkillsAssumptions
  • For each of these, the requirement is either pre existing knowledge/skill, or the willingness to spend ...
• AdminToolsCategory
  • Manage whole Bernstein site from one screen. Users: Register, NewUserTemplate, .UserForm, ResetPassword ...
• AppendixEncodeURLsWithUTF8
  • #EncodeURLsUTF8 # Appendix B: Encode URLs With UTF8 Use internationalised characters within !WikiWords ...
• ClassicSkin
  • The classic TWiki skin is the traditional TWiki skin, as seen in previous TWiki versions. Skin Info ...
• EmptyPlugin
  • This is an empty Plugin you can use as a template to build your own .TWikiPlugins. This Plugin does nothing ...
• ForceNewRevision
  • Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin ...
• InstalledPlugins
  • Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities. ...
• InstantEnhancements
  • These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators ...
• InterWikis
  • This topic lists all aliases needed to map Inter Site links to external wikis/sites. Whenever you write ...
• MainFeatures
  • Any web browser: Edit existing pages or create new pages by using any web browser. There is no need ...
• ManagingTopics
  • # Managing Topics Browser based rename, move, and delete for individual topics Overview You can use ...
• ManagingUsers
  • # Manage Users Register users on your TWiki site; change/reset/install passwords; remove user accounts ...
• ManagingWebs
  • # Managing Webs Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite ...
• PatternSkin
  • PatternSkin is developed to provide a CSS based default look and feel for TWiki flexible and W3C compliant ...
• PatternSkinCss
  • This page is a reference for all CSS classes used in PatternSkin. !PatternSkin uses 4 stylesheets: ...
• PlainSkin
  • The plain skin is used to get the rendered topic text without any page decoration such as side, top or ...
• PreviewBackground
  • Preview looks like the real page, but the links lead to an oops dialog warning users of not yet saved ...
• PrintSkin
  • The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin ...
• SearchDoesNotWork
  • I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic ...
• SitePermissions
  • Web Sitemap VIEW CHANGE RENAME ^ Listed DENY ALLOW DENY ALLOW ...
• StandardColors
  • This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 #0000CC ...
• TWikiAccessControl
  • # TWiki Access Control Restricting read and write access to topics and webs, by Users and groups TWiki ...
• TWikiCss
  • # Appendix C: TWiki CSS Listing of CSS class names emitted from TWiki core code and standard plugins ...
• TWikiDocGraphics
  • This is the TWiki icon library. The graphics can be used in topics and by web applications. Usage There ...
• TWikiDocumentation
  • This page contains all documentation topics as one long, complete reference sheet. Doubleclick anywhere ...
• TWikiDownload
  • I would like to install TWiki on my server. Can I get the source? Answer: TWiki is distributed under ...
• TWikiInstallationGuide
  • # TWiki Installation Guide Installation instructions for the TWiki 4.0 production release. If you are ...
• TWikiPlugins
  • # TWiki Plugins Add functionality to TWiki with readily available Plugins; create Plugins based on APIs ...
• TWikiReferenceManual
  • Documentation for webmasters, system administrators, project managers, team leaders, and all other users ...
• TWikiScripts
  • # TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering ...
• TWikiSiteTools
  • # TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools ...
• TWikiSkinBrowser
  • You can try out the TWikiSkins currently installed on this system: /TWiki/TWikiSkinBrowser?skin $pattern ...
• TWikiSkins
  • # TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. ...
• TWikiSystemRequirements
  • # TWiki System Requirements Server and client requirements Low client and server base requirements ...
• TWikiTemplates
  • # TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview ...
• TWikiTopics
  • The basic building block of a TWiki site is called a topic , identified by a unique, hopefully descriptive ...
• TWikiUpgradeGuide
  • # TWiki Upgrade Guide Upgrade from the previous TWiki 01 Sep 2004 Prodcution Release to TWiki 4.0.0 ...
• TWikiUserAuthentication
  • # TWiki User Authentication TWiki site access control and user activity tracking options Overview ...
• WebLeftBar
  • ATasteOfTWiki TextFormattingRules TWikiVariables FormattedSearch TWikiDocGraphics ...

Administrator Skills Assumptions

For each of these, the requirement is either pre-existing knowledge/skill, or the willingness to spend significant time (i.e. from hours to days) learning these.

• Operating system administration: Ability to use Unix/Linux command line tools (or equivalent Windows tools), including ability to move/copy/delete files, change permissions, view web server log files, set environment variables, use a text editor, etc.
• Web server administration: Ability to do basic setup, e.g. ability to edit config files or use GUI configuration tools to enable CGI scripts on a directory.
• Program compilation: Where RCS is not pre-installed (that is most Unix systems), the ability to download and compile the RCS program from source, including use of configure, make, etc. This is often not necessary on Linux or Windows.
• Troubleshooting: Ability to perform tests, inspect error logs, talk to technical support (whether in an IT department or web hosting provider) and read documentation in order to help with diagnosing installation problems.

Installing TWiki is not recommended for people who only know HTML and web design, unless they are willing to learn the above, or team up with someone who can handle the installation.

Although the TWikiInstallationGuide is quite complete, there will on occasion be parts that don't work in your local environment (particularly with TWiki:Codev/TWikiOnWebHostingSites, which are sometimes challenging even for those with good OS and web server skills).

There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and e-mail lists. The TWiki:Support web must not be depended on as a resource for this purpose - in other words, it is not there to answer basic questions about operating system and web server administration. Asking and answering questions is time consuming for all concerned and is best used for specific TWiki related issues, rather than helping you learn the OS and web server.

r.

To get started with Linux, visit http://linuxbasics.org/. LinuxBasics.org offers Linux tutorials, a mailing-list and an IRC-channel to answer questions, and links to sites with information to install and use Linux. A nice tool for people migrating from Windows is http://www.MidnightCommander.org/. It is already installed on Linux systems: try mc -ac and ESC 1 to get help.

Related Topics: AdminDocumentationCategory

Admin tools

Manage whole Bernstein site from one screen.

• Users: Register, NewUserTemplate, UserForm, ResetPassword, ChangePassword
• Site Tools: Configure, TWikiPreferences, InterWikis, Variables
• Managing: Topics, Webs, YouAreHere
• Webs:

Web	Tools	Use to...
Handbook		...an educational material by the Bernstein Consortium
Main		...see who is registered on this TWiki
Sandbox		...experiment in an unrestricted hands-on web.
Shahrazad		...such as links, course notes, images, etc.
Silk		...collaborate on various projects
TWiki		...discover TWiki details, and how to start your own site.
Waqwaq		...describe the services
This table is updated automatically based on WebPreferences settings of the individual webs.

Legend:		WebHome	WebSearch	WebChanges	WebNotify
		WebPreferences	WebStatistics	WebTopicList	WebIndex

All Admin Tools Category topics

• BulkRegistration: The .TWikiAdminGroup can use BulkRegistration to register (i.e. create logins and UserTopics) for a group ...
• ChangeEmailAddress: Security Note : Set Email user #64;example #46;com Registered e mail addresses for currently ...
• ChangePassword: : : : : () ResetPassword, ChangeEmailAddress ...
• InstalledPlugins: Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities. ...
• ManagingWebs: # Managing Webs Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite ...
• ResetPassword: : () ChangePassword, ChangeEmailAddress, UserToolsCategory, AdminToolsCategory ...
• SiteMap: Web Bernstein Site Map Use to... You can use color coding by web for ...
• SitePermissions: Web Sitemap VIEW CHANGE RENAME ^ Listed DENY ALLOW DENY ALLOW ...
• TWikiReferenceManual: Documentation for webmasters, system administrators, project managers, team leaders, and all other users ...
• TWikiSiteTools: # TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools ...
• WebHome: The official TWiki site is twiki.org Welcome to the TWiki Web The place to learn about TWiki features ...
• WebLeftBar: ATasteOfTWiki TextFormattingRules TWikiVariables FormattedSearch TWikiDocGraphics ...
• WebStatistics: Month: Topic views: Topic saves: File uploads: Most popular topic views: Top contributors ...

Plugins

Administrators can enable and disable plugins using configure.

• SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Bernstein topics.
• CommentPlugin (Dakar, 8164): Allows users to quickly post comments to a page without an edit/preview/save cycle.
• EditTablePlugin (Dakar, 8154): Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin (Dakar, $Rev: 8329$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (Dakar, $Rev: 8154$): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, 8154): Render smilies as icons, like  :-) for or  :cool: for :cool:
• TablePlugin (Dakar, 8154): Control attributes of tables and sorting of table columns
• WysiwygPlugin (Dakar, 9565): Translator framework and WYSIWYG editor for TWiki topics

see also: TWikiPlugins

TWiki Version

• TWiki engine: TWiki-4.0.4-4, Wed, 14 Jul 2006, build 11482
• Plugin API: 1.1

Related Topics: AdminDocumentationCategory

FAQ:

How can I create a simple TWiki Form based application?

Answer:

1. Create a TWiki Form and define fields (see TWikiForms for details)
2. Add the form in the list of Web Forms. Set the variable WEBFORMS in WebPreferences
3. Create a Template Topic
4. In edit mode add the TWiki Form you defined to the Template Topic using the "Add Form" button
5. Create a HTML Form with necessary fields
6. Define SEARCH function for listing items (see VarSEARCH for details)

For more information follow the links...

The following is the code source of TWikiFAQ:

<form action="%SCRIPTURLPATH{edit}%/TWiki/">
New FAQ topic: &nbsp; (Use a name in TWiki.WikiNotation) <br />
<input type="text" name="topic" size="32" />&nbsp;<input type="submit" class="twikiSubmit" value="Create Topic" />
<input type="hidden" name="onlywikiname" value="on" />
<input type="hidden" name="templatetopic" value="TWikiFaqTemplate" />
<input type="hidden" name="topicparent" value="AnApplicationWithWikiForm" />
<br />
</form>

---

And the SEARCH function:

%SEARCH{ "Back to\:__ TWikiFAQ" casesensitive="on" regex="on" nosearch="on" nototal="on"}%

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

-- TWiki:Main.MiyokoTakushima - 18 Oct 2004

Appendix B: Encode URLs With UTF8

Use internationalised characters within WikiWords and attachment names

This topic addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N.

Current Status

To simplify use of internationalised characters within WikiWords and attachment names, TWiki now supports UTF-8 URLs, converting on-the-fly to virtually any character set, including ISO-8859-*, KOI8-R, EUC-JP, and so on.

Support for UTF-8 URL encoding avoids having to configure the browser to turn off this encoding in URLs (the default in Internet Explorer, Opera Browser and some Mozilla Browser URLs) and enables support of browsers where only this mode is supported (e.g. Opera Browser for Symbian smartphones). A non-UTF-8 site character set (e.g. ISO-8859-*) is still used within TWiki, and in fact pages are stored and viewed entirely in the site character set - the browser dynamically converts URLs from the site character set into UTF-8, and TWiki converts them back again.

System requirements are updated as follows:

• ASCII or ISO-8859-1-only sites do not require any additional CPAN modules to be installed.
• Perl 5.8 sites using any character set do not require additional modules, since CPAN:Encode is installed as part of Perl.
• This feature still works on Perl 5.005_03 as per TWikiSystemRequirements, or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.

The following 'non-ASCII-safe' character encodings are now excluded from use as the site character set, since they interfere with TWiki markup: ISO-2022-*, HZ-*, Shift-JIS, MS-Kanji, GB2312, GBK, GB18030, Johab and UHC. However, many multi-byte character sets work fine, e.g. EUC-JP, EUC-KR, EUC-TW, and EUC-CN. In addition, UTF-8 can already be used, with some limitations, for East Asian languages where EUC character encodings are not acceptable - see TWiki:Codev.ProposedUTF8SupportForI18N.

It's now possible to override the site character set defined in the {SiteLocale} setting in configure - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp').

This feature should also support use of Mozilla Browser with TWiki:Codev.TWikiOnMainframe (as long as mainframe web server can convert or pass through UTF-8 URLs) - however, this specific combination is not tested. Other browser-server combinations should not have any problems.

Please note that use of UTF-8 as the site character set is not yet supported - see Phase 2 of TWiki:Codev.ProposedUTF8SupportForI18N for plans and work to date in this area.

This feature is complete in TWiki releases newer than February 2004.

Note for skin developers: is no longer required (TWiki:Plugins.InternationalisingYourSkin).

Details of Implementation

URLs are not allowed to contain non-ASCII (8th bit set) characters: http://www.w3.org/TR/html4/appendix/notes.html#non-ascii-chars

The overall plan for UTF-8 support for TWiki is described in two phases in TWiki:/Codev.ProposedUTF8SupportForI18N - this page addresses the first phase, in which UTF-8 is supported for URLs only.

UTF-8 URL translation to virtually any character set is supported as of TWiki Release 01 Sep 2004, but full UTF-8 support (e.g. pages in UTF-8) is not supported yet - this will be phase 2.

The code automatically detects whether a URL is UTF-8 or not, taking care to avoid over-long and illegal UTF-8 encodings that could introduce TWiki:Codev.MajorSecurityProblemWithIncludeFileProcessing (tested against a comprehensive UTF-8 test file, which IE 5.5 fails quite dangerously, and Opera Browser passes). Any non-ASCII URLs that are not valid UTF-8 are then assumed to be directly URL-encoded as a single-byte or multi-byte character set (as now), e.g. EUC-JP.

The main point is that you can use TWiki with international characters in WikiWords without changing your browser setup from the default, and you can also still use TWiki using non-UTF-8 URLs. This works on any Perl version from 5.005_03 onwards and corresponds to Phase 1 of TWiki:Codev.ProposedUTF8SupportForI18N. You can have different users using different URL formats transparently on the same server.

UTF-8 URLs are automatically converted to the current {Site}{Charset}, using modules such as CPAN:Encode if needed.

TWiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used. Since Apache serves attachment downloads without TWiki being involved, TWiki's code can't do its UTF-8 decoding trick, so TWiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset.

TWiki:Codev.TWikiOnMainframe uses EBCDIC web servers that typically translate their output to ASCII, UTF-8 or ISO-8859-1 (and URLs in the other direction) since there are so few EBCDIC web browsers. Such web servers don't work with even ISO-8859-1 URLs if they are URL encoded, since the automated translation is bypassed for URL-encoded characters. For TWiki on Mainframe, TWiki assumes that the web server will automatically translate UTF-8 URLs into EBCDIC URLs, as long as URL encoding is turned off in TWiki pages.

Testing and Limitation

It should work with TWiki:Codev.TWikiOnMainframe. Tested with IE 5.5, Opera 7.11 and Mozilla (Firebird 0.7).

Opera Browser on the P800 smartphone is working for page viewing but leads to corrupt page names when editing pages.

For up to date information see TWiki:Codev.EncodeURLsWithUTF8

Related Topics: AdminDocumentationCategory

BookView is an option available from the advanced search topic. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of a topic summary. This allows you to easily see a whole set of pages, which is useful for printing.

Related Topics: UserDocumentationCategory

Bulk Registration

The TWikiAdminGroup can use BulkRegistration to register (i.e. create logins and UserTopics^?) for a group of people quickly. Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata. Then press the button on this page to perform registration for those users. Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required. Note that the new users are not notified that they have an account. This is so you can prepare and verify the accounts before announcing them. To announce them use the BulkResetPassword feature: this will assign a new random password and notify users.

Bulk Registration usage

Any fields you define in this table will end up in the User's topic. If a form (such as UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.

If you use the UserForm then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!

Mandatory fields

• WikiName
• Email
• FirstName
• LastName

Optional fields

• LoginName - if not set will register with WikiName

Settings

• • Set REGISTERTOPIC = UnprocessedRegistrations
  • Set LOGTOPIC = %REGISTERTOPIC%Log

• • Set OVERWRITEHOMETOPICS = 0

Example format

The following should be inserted into your REGISTERTOPIC as a table.

| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
| Test | User | you@example.com | TestUser | A | B | C |

To use this:

1. Make sure that the Custom fields appear on the UserForm
2. Copy the above table to your clipboard
3. Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
4. Click the Bulk register button below
5. Read %LOGTOPIC%
6. When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.

Notes:

1. The first row of the table dictates the heading format and that the fieldnames must be plain, i.e. must not contain bolded entries.
2. You are responsible for ensuring that the fieldnames appear in the Main.UserForm
3. Only members of the TWikiAdminGroup can run this.

 

%REGISTERTOPIC%

Warning: Can't find topic TWiki.REGISTERTOPIC

%LOGTOPIC%

Warning: Can't find topic TWiki.LOGTOPIC

Related Topics: AdminToolsCategory

See WikiWord

Related Topics: UserDocumentationCategory

List of all Category topics

• AdminDocumentationCategory
• AdminToolsCategory
• DeveloperDocumentationCategory
• UserDocumentationCategory
• UserToolsCategory

Change E-mail Address

This form is used to change your registered e-mail addresses. Your registered e-mails are used by TWiki for sending you e-mails, include notifications of password changes. The addresses you register via this form are kept secret and will not be published anywhere on this site.

Security Note: You really ought to register a valid e-mail address. If TWiki can't find a registered e-mail for you in the secret database, it will look in your user topic for a line like this:

   * Set Email = user@example.com

If your user topic is not protected from changes by other people, and you don't register an e-mail address using this form, then your user account could be hijacked by someone else.

If your old e-mail addresses are all invalid (you can't receive mail there any more) and you have forgotten your password, please contact emanuel.wenger@oeaw.ac.at for help.

Registered e-mail addresses for currently logged in user (TWikiGuest):

TWikiUsers has a list of other TWiki users.

Your LoginName:	**
Password:	**
New e-mails (space-separated list):	**
	(Fields marked ** are required)

After submitting this form your e-mail will be changed, and you will be returned to this form.

If you have any questions, please contact emanuel.wenger@oeaw.ac.at.

Related topics: ChangePassword, ResetPassword, UserToolsCategory, AdminToolsCategory

Note to administrator: This form applies only if TWiki uses a {PasswordManager} that supports storing e-mails (e.g. TWiki::Users::HtPasswdUser). Otherwise replace this topic with a note describing how to change registered e-mail in your organization).

Change Password

Forgotten your password? Use ResetPassword instead.

TWikiUsers has a list of other TWiki users.

Your LoginName:	**
Current password:	**
New password:	**
Retype new password:	**
	(Fields marked ** are required)

After submitting this form your password will be changed.

If you have any questions, please contact emanuel.wenger@oeaw.ac.at.

Related topics: ResetPassword, ChangeEmailAddress, UserToolsCategory, AdminToolsCategory

Note to administrator: This form applies only if TWiki uses a {PasswordManager} that supports changing passwords. Otherwise replace this topic with a note describing how to change the password in your organization. See TWikiUserAuthentication for more information.

A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new object instances. For example,

package Telecoms

ClassMethod new()

my $mobile = new Telecoms();

or

my $mobile = Telecoms->new();

Related Topics: DeveloperDocumentationCategory, StaticMethod, ObjectMethod

Classic Skin

The classic TWiki skin is the traditional TWiki skin, as seen in previous TWiki versions.

Skin Info

Description:	Bare bone and functional, for any browser, with a minimum of graphics
Screenshot:
Preview:	Preview with this topic
Base Name:	classic
Skin Author:	TWiki:Main/PeterThoeny
Skin Version:	25 Jul 2004 (v1.000)
Change History:
25 Jul 2004:	Initial version (v1.000)
Dependencies:
Skin Home:	http://TWiki.org/cgi-bin/view/Plugins/ClassicSkin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ClassicSkinDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/ClassicSkinAppraisal

Note: The Description, Screenshot and Base Name rows are needed by the TWikiSkinBrowser

Related topic: TWikiSkins, TWikiSkinBrowser, UserDocumentationCategory, AdminDocumentationCategory

Log In or Register

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 plugin with an earlier version of TWiki, please see here

Features

Inserts an edit box into the page that allows users to type in and save comments. Comments can be made

• in different formats (as defined by a template),
• in both forward and reverse chronological order,
• signed or unsigned, dated or undated (as defined by a template),
• in other topics, or other positions within the current topic.

Syntax Rules

Write the command %COMMENT{ attributes }% anywhere in a TWiki topic. %COMMENT% is also legal.

The following attributes are recognised

Name	Description
type	This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see Customisation, below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. By default this is 'below'.
target	Name of the topic to add the comment to. Defaults to the current topic.
location	Regular expression specifying the comment location in the target topic. Read carefully below!
mode	For compatability with older versions only, synonymous with type
nonotify	Set to "on" to disable change notification for target topics
noform	Set to "on" to disable the automatic form that encloses your comment block - remember to insert <FORM> tags yourself!

Positioning the comment

%COMMENT supports several ways to specify where a comment should be inserted in the target topic. This is referred to as the location of the comment.

Location relative to %COMMENT tag

The default location is the %COMMENT tag itself. For example:

%COMMENT{type="below"}%

will add comments in the current topic, directly below the %COMMENT tag.

Location relative to a TWiki anchor

The target attribute may specify a web, and may also specify an anchor within the target topic; for example,

%COMMENT{type="above" target="%MAINWEB%.PersonalRemarks#InsertHere"}%

This uses a standard TWiki in-topic anchor as the insertion location. See TextFormattingRules for more about TWiki anchors.

Location relative to an arbitrary text string

Getting more sophisticated, you can also specify a regular expression for the target location using the location parameter. The target topic is searched for the regular expression, and the comment inserted relative to the string that the search matched. For example,

%COMMENT{type="above" location="Flights of Fancy"}%

will place comments above the first occurence of the string Flights of Fancy in the current topic.

Warning of course, if a user's comment contains the string "Flights of Fancy" they may and up changing the location for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the %COMMENT! So be very careful how you specify the RE for location. Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively.

I look forward to someone leveraging this feature to create - for example - threaded conversations using %COMMENT.

If you specify an anchor and a location, the anchor will be ignored.

Default templates

Templates are used to define the "comment style" i.e. how comments appear in the page. The default is to add comments in "Blog like" style using bulleted lists, with the most recent comment at the top, but many other styles are available such as tables or Wiki thread mode comments. It is easy to define your own customer styles as well.

A set of default comment templates are shipped with the plugin. These are:

Template type	Description
top	Comments, signed and dated (server time), added at top of the topic (the anchor is ignored)
bottom	Comments, signed and dated (server time), added at end of the target topic (the anchor is ignored)
above	Comments, signed and dated (server time), added immediately before the target anchor, or the %COMMENT if no anchor is specified
below	Comments, signed and dated (server time), added immediately below the target anchor, or the %COMMENT if no anchor is specified
threadmode	Wiki thread mode comment, signed and dated (server time)
tableprepend	Comments, signed and dated (server time), formatted as an HTML table row, added below the anchor (which must be in an HTML <table>)
tableappend	Comments, signed and dated (server time), formatted as an HTML table row, added above the anchor (which must be in an HTML <table>)

Your local installation may add more template types as well - see Customisation, below.

Customisation

Customisation of the comment plugin requires

• familiarity with HTML forms,
• some familiarity with the TWiki templating language.

To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named PROMPT:mytype and OUTPUT:mytype respectively. See comments.tmpl in the templates directory for examples.

The plugin picks up these template definitions from a standard TWiki template file, templates/comments.tmpl. This allows different templates to be defined for different TWiki skins. By default, this template includes the topic CommentPluginTemplate, which contains all the shipped standard templates and in turn includes TWiki.UserCommentsTemplate. This allows for several levels of customisation:

1. To override all default templates, everywhere, change comments.tmpl to include a different topic (this customisation will be lost next time you upgrade, though).
2. To add site-wide local template customisations, add them to TWiki.UserCommentsTemplate. You can redefine the standard templates here if you want, and your definitions will override the standard definitions.
3. To override templates on a web-by-web basis, add a topic UserCommentsTemplate to the web (this will replace TWiki.UserCommentsTemplate)
4. To override templates for a specific skin, add them to TWiki.UserComments<Skin>Template (where <Skin> is the name of the skin with the first letter capitalised, e.g. Pattern)

Templates are picked up by following the standard TWiki rules for locating template files. Note that you can use %TMPL:INCLUDE to include other files of templates.

The PROMPT template

The PROMPT template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as input, textarea and select. The user enters values for these parameters, and these are then available when the OUTPUT template is expanded, in the form of %URLPARAM%s.

Only the input fields of the form need be defined. The plugin automatically generates the >form< and &gt:/form< tags, unless you specify noform="on", in which case you have to provide them yourself. Note that you must define a "submit" button if you want the form to work!

If an attribute is given to the %COMMENT tag that is not one of the standard attributes, then that attribute is taken as the name of a parameter to be expanded in the PROMPT template. Expressions in the template of the form %param|default% (e.g. %rows|3%, %button|Push me%) are expanded to the values given in the %COMMENT. For example, if the PROMPT template 'example' contains:

<textarea rows=%rows|3% cols="%cols|50%" value="%tval|Rubbish%">

and the %COMMENT tag is:

%COMMENT{type="example" cols="75"}%

then the template will be expanded as

<textarea rows="3" cols="75" value="Rubbish">

As well as support for all the usual TWiki variables in templates, the following special variables are supported in the PROMPT definition:

Variable	Description
%MESSAGE%	A helpful generated message, either a lock message or a reminder to refresh.
%DISABLED%	Set to 'disabled' when you cannot comment (e.g. in preview mode).

The OUTPUT template

The OUTPUT template defines the format for the text that actually gets embedded into the topic. All the usual TWiki variables are available in the PROMPT definition, but note that they get expanded when the comment is inserted in the text, so time, date and username will refer to the time and date when the comment was made and the user who made it.

There are also four position tags that are used to indicate where the comment should be placed, relative to the location defined in the %COMMENT tag:

%POS:TOP%	If present, comments will be inserted at the top of the topic i.e. before any other text
%POS:BOTTOM%	If present, comments will be inserted at the end of the topic i.e. after all existing text
%POS:BEFORE%	If present, comments will be inserted immediately before the %COMMENT% tag
%POS:AFTER%	If present, comments will be inserted immediately after the %COMMENT% tag

Note that these position tags are obviously mutually exclusive. If you define more than one, the result is undefined. If none is present, the default is taken from the plugin setting DEFAULT_TYPE

All the usual TWikiVariables that can be used in a topic template can also be used in an OUTPUT template. See TWikiVariables for details.

Settings

• Description:
  • Set SHORTDESCRIPTION = Allows users to quickly post comments to a page without an edit/preview/save cycle.
• Name of file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from CommentsTmpl^?
  • Set TEMPLATES = comments
• default template type (if not present, defaults to "below")
  • Set DEFAULT_TYPE = below

Plugin Installation Instructions

• This plugin is pre-installed in most TWiki releases. However if you need to upgrade the plugin for any reason:
  • Download the archive file from the Plugin web (see below)
  • Unpack the archive in your twiki installation directory.
  • You may need to correct file permissions.
  • Run CommentPlugin_installer to automatically check and install other modules that this module depends on. You can also do this step manually. Dependencies: %$DEPENDENCIES%
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

Plugin Author:	TWiki:Main.DavidWeller, TWiki:Main.PeterMasiar, TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk
Change History:
11118	Item2322 removed span tag around oneliner bullet output
8788	Item1465 Item1577: reverted 8433 to fix inclusion of correct user templates
8787	Item1573 renamed standard templates topic to avoid naming clash on Windows, where filenames are case-insensitive
8433	Item1465 Fix 'TWiki.' to '%TWIKIEB%.'; also fixed include 'UserComments' to 'UserCommentsTemplate' (at least that is what the doc suggests)
7427	Item845 removed duplicate date in default comments; stick with server time
7251	Item810 fix for user template inclusion; reorganised templates to make customisation easier
5906	Item143 apache warning from comment plugin when CommentsTmpl?.txt not foudn
5519	CommentPluginOnAnchorsBroken?: incorporated JacobEisinger?'s fix
5518	CommentPluginOnAnchorsBroken?: incorporated OlivierBerger?'s fix
5455	On Niels Kodslo's prompting, removed the global recursion prevention that I believe is no longer needed.
5280	Removed templates, and some minor fixes
5250	Removed newlines from prompt box
4902	Changed to use viewauth. Moved templates into user topics.
4901	Added templates in user webs support
4897	Fixes for disabling during preview; re-enabled old legacy parameters
4889	Chopped down from PeterMasiar? version, removing several parameters, savecomment script, changing way templates are done. Major rewrite, atcherly.
4882	Update from PeterMasiar?'s 2.0 version, plus documentation and small code improvements.
4745	06Mar 2002 initial commit
Perl Version:	>= 5.6.1
Plugin Home:	TWiki:Plugins/CommentPlugin
Feedback:	TWiki:Plugins/CommentPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/CrawfordCurrie - %$DATE%

Templates for CommentPlugin - See CommentPlugin#Customisation for help.

While this topic can be viewed as a TWiki topic, it is used by the CommentPlugin as a template file - see TWikiTemplates. The important content in here is in the verbatim blocks. The rest of the topic is just comments.

WARNING: THIS FILE WILL BE OVERWRITTEN WHEN YOU UPGRADE THE COMMENT PLUGIN

Put your local templates into UserCommentsTemplate^?. LOCAL TEMPLATES WILL OVERRIDE TEMPLATES DEFINED IN THIS FILE

Template definitions

Templates used in rest of file

Generic prompt box used by other templates

%TMPL:DEF{promptbox}%
<div class="commentPlugin commentPluginPromptBox">
<table><tr valign="middle"><td><textarea %DISABLED% rows="%rows|3%" cols="%cols|70%" name="comment" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea></td><td><input %DISABLED% type="submit" value="%button|Add comment%" /></td></tr></table>
</div><!--/commentPlugin-->
%TMPL:END%

Short comment, signed and dated

%TMPL:DEF{outputoneliner}%   * %URLPARAM{"comment"}% -- %WIKIUSERNAME% - %SERVERTIME%%TMPL:END%

---

User templates

top

Comments, signed and dated, added at top of file

%TMPL:DEF{PROMPT:top}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:top}%%TMPL:P{outputoneliner}%%POS:TOP%
%TMPL:END%

---

bottom

Comments, signed and dated, added at end of file

%TMPL:DEF{PROMPT:bottom}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:bottom}%%POS:BOTTOM%%TMPL:P{outputoneliner}%%TMPL:END%

---

above

Comments, signed and dated, added immediately before anchor

%TMPL:DEF{PROMPT:above}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:above}%%POS:BEFORE%%TMPL:P{outputoneliner}%
%TMPL:END%

---

threadmode

Wiki thread mode comment, signed and dated

%TMPL:DEF{PROMPT:threadmode}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:threadmode}%%POS:BEFORE%

%URLPARAM{"comment"}%

-- %WIKIUSERNAME% - %DATE%
%TMPL:END%

---

below

Comments, signed and dated, added immediately below anchor

%TMPL:DEF{PROMPT:below}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:below}%%POS:AFTER%%TMPL:P{outputoneliner}%
%TMPL:END%

---

tableprepend

Comments, signed and dated, added at top of table below the anchor/location/COMMENT

%TMPL:DEF{PROMPT:tableprepend}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:tableprepend}%%POS:AFTER%| %URLPARAM{"comment" newline="<br />"}% </td><td> %WIKIUSERNAME% </td><td> %SERVERTIME% |
%TMPL:END%

---

tableappend

Comments, signed and dated, added at end of table above the anchor/location/COMMENT

%TMPL:DEF{PROMPT:tableappend}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:tableappend}%%POS:BEFORE%| %URLPARAM{"comment" newline="<br />"}% | %WIKIUSERNAME% | %SERVERTIME% |
%TMPL:END%

---

after: Add before the comment box, after the last comment

%TMPL:DEF{PROMPT:after}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:after}%%NOP%
%TMPL:P{outputoneliner}% %POS:BEFORE%%TMPL:END%

---

action

Action added to action table directly above comment box

%TMPL:DEF{PROMPT:action}%
<table>
 <tr>
  <td align="right">Action for (%TWIKIWEB%.WikiName):</td>
  <td><input name="who" type="text" size="50" value="%URLPARAM{"who"}%" /></td>
 </tr>
 <tr>
  <td align="right">Due date:</td>
  <td>
   <input name="due" id="idDue" type="text" size="30" value="%URLPARAM{"due"}%" />
  </td>
 </tr>
 <tr>
  <td colspan="2">
   <textarea %DISABLED% rows="5" cols="120" name="comment" wrap="soft"></textarea>
  </td>
 </tr>
 <tr>
  <td colspan=2 align=middle><input %DISABLED% type="submit" value="Add action" /></td>
 </tr>
</table>
%TMPL:END%

%TMPL:DEF{OUTPUT:action}%%POS:BEFORE%%AC%NOP%TION{who="%URLPARAM{"who"}%" due="%URLPARAM{"due"}%"}% %URLPARAM{"comment" newline="<br />"}%<br />- Created by %WIKIUSERNAME%, %SERVERTIME%
%TMPL:END%

---

table

Tablerows adding on end - TWiki:Main/FranzJosefSilli

%TMPL:DEF{PROMPT:table}%
<hr width="60%" /> Date: <input %DISABLED% type="text" size="40" name="comment_date" /> <br /> City: <input %DISABLED% type="text" size="40" name="comment_city" value="" /> <input %DISABLED% type="submit" value="%button|Add%" /> entry <hr width="90%" />
%TMPL:END%

%TMPL:DEF{OUTPUT:table}%
%POS:BEFORE%| %URLPARAM{"comment_date"}% | %WIKIUSERNAME% | %URLPARAM{"comment_city" }% |
%TMPL:END%

---

toctalk

Talk using TOC adding on end - TWiki:Main/FranzJosefSilli

%TMPL:DEF{PROMPT:toctalk}%
<hr width="60%" /> Summary: <input %DISABLED% type="text" size="40" name="comment_summary" /> <br /> <textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="comment_text" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea> <br /> <input %DISABLED% type="submit" value="%button|Add%" /> <hr width="90%" />
%TMPL:END%

%TMPL:DEF{OUTPUT:toctalk}%
%POS:BEFORE%---+++ %SERVERTIME% %WIKIUSERNAME%: %URLPARAM{"comment_summary"}%
%POS:BEFORE%%URLPARAM{"comment_text" }%
%POS:BEFORE%
%TMPL:END%

---

bookmark

Talk using TOC adding on end - TWiki:Main/FranzJosefSilli

%TMPL:DEF{PROMPT:bookmark}%
<hr width="60%" /> URL: <input %DISABLED% type="text" size="40" name="comment_url" value="http://" /> <br /> Link: <input %DISABLED% type="text" size="40" name="comment_link" /> <br /> Text: <input %DISABLED% type="text" size="40" name="comment_text" value="%MESSAGE%" /> <input %DISABLED% type="submit" value="%button|Add%" /> bookmark <hr width="90%" />
%TMPL:END%

%TMPL:DEF{OUTPUT:bookmark}%
%POS:BEFORE%   * [[%URLPARAM{"comment_url"}%][%URLPARAM{"comment_link"}%]] - %URLPARAM{"comment_text" }%
%TMPL:END%

Include UserCommentsTemplate

Including UserCommentsTemplate^?:

%TMPL:INCLUDE{"UserComments"}%

FAQ:

How do I delete or rename a topic?

Answer:

These two questions are answered together because often when you think you want to delete a page, more often it makes sense to rename the page to contain more context, e.g. rename it to include the date.

You can rename, move and delete topics directly from your browser. Moving lets you transfer a topic from one web to another. The soft delete moves a topic to the special Trash web, where it's hidden but can be "undeleted" with system administrator access.

Click [More] on the control bar at the bottom of the page you want to change, then choose [Rename/move], and make your changes to that screen. There's a link that launches to the ManagingTopics reference page in a pop-up window.

NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.

Note for site administrators: To remove a topic permanently move it to the Trash web, then with file-level access, delete the .txt and .txt,v files manually from /twiki/data/Trash.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

FAQ:

How do I delete or rename a file attachment?

Answer:

You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. The soft delete moves an attachment to the special TrashAttachment topic in the Trash web, where it's hidden but can be "undeleted" with system administrator access. Please note that you cannot rename an attachment in the current TWiki release.

Click on action on the file in the FileAttachment table, then in the Update attachment screen choose [Move attachment], and make your changes to that screen.

NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.

Note for system administrators: To remove an attachment permanently move it to the Trash.TrashAttachment topic, then with file-level access, delete the file attachment and its ,v repository file manually from twiki/pub/Trash/TrashAttachment.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

A List of TWiki Developer Documentation

• ClassMethod
  • A ClassMethod is a method that must be called relative to the containing class object. This normally ...
• EmptyPlugin
  • This is an empty Plugin you can use as a template to build your own .TWikiPlugins. This Plugin does nothing ...
• FileAttribute
  • Each FileAttachment in a Topic has an attribute string. At present only the hidden attribute is supported ...
• ObjectMethod
  • An ObjectMethod is a method that must be called relative to a previous constructed object of the class ...
• StaticMethod
  • A StaticMethod is a method in a package that can be called without reference to an object of the package ...
• TWikiCss
  • # Appendix C: TWiki CSS Listing of CSS class names emitted from TWiki core code and standard plugins ...
• TWikiDocGraphics
  • This is the TWiki icon library. The graphics can be used in topics and by web applications. Usage There ...
• TWikiHistory
  • # Appendix A: TWiki Development Timeline #DakarRelease TWiki Release 4.0.0 (Dakar), 01 Feb 2006 Major ...
• TWikiMetaData
  • #TWikiMetaData # TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored ...
• TWikiPlugins
  • # TWiki Plugins Add functionality to TWiki with readily available Plugins; create Plugins based on APIs ...
• TWikiReferenceManual
  • Documentation for webmasters, system administrators, project managers, team leaders, and all other users ...
• TWikiScripts
  • # TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering ...
• TWikiSkins
  • # TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. ...
• TWikiTemplates
  • # TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview ...
• WebLeftBar
  • ATasteOfTWiki TextFormattingRules TWikiVariables FormattedSearch TWikiDocGraphics ...

Use the "Minor changes, don't notify" checkbox in preview in case you only make a minor change to a topic and you do not want to inform everybody who is on the WebNotify list of the current web of this change.

Note: No new revision is created in case you save the same topic again within a certain time frame (default is one hour). You only need to checkmark the "Minor change, don't notify" checkbox once within this time frame, because subsequent save operations do not notify users.

Note: The initial state of the checkbox can be set to on with the DONTNOTIFYCHECKBOX preferences variable. See TWikiPreferences for more.

Related Topics: UserDocumentationCategory

FAQ:

Why does the topic revision not increase when I edit a topic?

Answer:

The same topic revision will be used when you save a topic again within a certain time frame (one hour by default). This is to prevent unnecessary topic revisions when you do several edit cycles in a row. Note that a new revision is created if another person edits the same topic, regardless of the time.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

Edit Table Plugin

This plugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an [ Edit table ] button if preceeded by an %EDITTABLE{...}% variable. Each column can be a text field, a drop down box, a date field, etc. Multiple tables per topic are editable, but only one at a time can be edited.

Per Table Settings

Add a %EDITTABLE{...}% variable just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table. Parameters:

Parameter	Comment	Default
header	Specify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button	(no header)
format	The format of one column when editing the table. A cell can be a text input field, or any of these edit field types: • Text input field (1 line):   | text, <size>, <initial value> | • Textarea input field:   | textarea, <rows>x<columns>, <initial value> | • Drop down box:   | select, <size>, <option 1>, <option 2>, etc | • Radio buttons:   | radio, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of buttons per line in edit mode • Checkboxes:   | checkbox, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of checkboxes per line in edit mode • Fixed label:   | label, 0, <label text> | • Row number:   | row, <offset> | • Date:   | date, <size>, <initial value>, <DHTML date format> |   * see Mishoo documentation for more infos about the DHTML date format	"text, 16" for all cells
changerows	Rows can be added and removed if "on"; Rows can be added but not removed if "add"	CHANGEROWS Plugin setting
quietsave	Quiet Save button is shown if "on", hidden if "off"	QUIETSAVE Plugin setting
include	Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place.	(none)
helptopic	Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown.	(no help text)
headerislabel	Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0"	"on"
editbutton	Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%TWIKIWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell)	EDITBUTTON Plugin setting

Initial Values

By default, variables in <initial value> (of text input field) and <label text> (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters if you do not want that:

Text:	To Escape:
$quot	Double quote ("). Alternatively write \" to escape it
$percnt	Percent sign (%)
$dollar	Dollar sign ($)
$nop or $nop()	Is a "no operation"

Date Field Type

The date field type allows one to choose a date with a popup calendar. Popup calendar works for Netscape 6.0 or better, all other Gecko-based browsers, Internet Explorer 5.0 or better for Windows, Opera 7 and Konqueror 3.1.2. The ... button is inactive if the browser cannot support the popup calendar. It uses the nice Mishoo DHTML calendar, see also TWiki:Codev/JavaScriptDatePickerForForm

Per Cell Settings

An individual edit field type can be defined for each table cell. Place an %EDITCELL{ "type, ..." }% variable at the end of the cell content. This is useful to override the per column %EDITTABLE{ format="..." }% settings, or to create tables with key/value rows. All edit field types of the format="..." parameter are supported. For example, to define a text field, type: | cell content %EDITCELL{ "text, 20" }% |

It is also possible to place the edit button inside a cell instead of default location below the table. Type | %EDITCELL{ "editbutton, 1, Edit this table" }% | to show a button, or | %EDITCELL{ "editbutton, 1, Edit table, Image-URL" }% | to show a button image with alternate text.

Note: The %EDITCELL{ }%=variable cannot be used by itself; place an =%EDITTABLE{ }%=variable at the beginning of a table where you want to use =%EDITCELL{ }% variables.

Table Buttons

• In page view mode:
  • - turn the table into edit mode
• In edit mode:
  • - save your changes
  • - save your changes without alerting subscribed WebNotify users
  • - add row to the table (if enabled)
  • - remove last row from the table (if enabled)
  • - cancel without saving and release edit lock

Examples

Line before table: %EDITTABLE{ format="| row, -1 | text, 20, init | select, 1, one, two, three, four | radio, 3,:-),:-I,:-( | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }%

Note: Please do not save this example table! Use TWiki:Sandbox.EditTablePluginTesting if you want to try out this Plugin

If this plugin is installed you will see an [ Edit table ] button above; if you were to click on it (please don't, use TWiki:Sandbox.EditTablePluginTesting for testing) you get this form:

Nr	Text field	Drop down	Mood	Timestamp
1		one two three four		26 Jun 2002 12:30
2		one two three four		27 Jun 2002 12:40

(demo only, these buttons do not work)

The following example shows a simple table with key/value rows. The default edit field type for the value column is a text field. This is overloaded by a selector for the Gender, and a date picker for the DOB. This is typically used by TWiki applications where new topics with tables are created based on a template topic.

You type: %EDITTABLE{ format="| label | text, 40 |" }% |*Key*|*Value*| | Name: | John Smith | | Gender: | M %EDITCELL{select, 1, , F, M}% | | DOB: | 1999/12/31 %EDITCELL{date, 10}% | | City: | New York |

Screenshot:

Screenshot in edit mode:

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EDITTABLEPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Edit TWiki tables using edit fields, date pickers and drop down boxes

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

• Default for change rows flag: on, off, add
  • Set CHANGEROWS = on

• Default flag for quiet save option: on to show the Quiet Save button, off to hide
  • Set QUIETSAVE = on

• Default edit button: Specify button text, or specify alternate text, image URL
  • #Set EDITBUTTON = Edit table
  • Set EDITBUTTON = Edit this table,

Note: The Plugin uses base settings like language and style from the JSCalendarContrib. The standard date format is '%e %B %Y' and is defined within this plugin.

Limitations and Known Issues

• This Plugin does not support TWiki table formatting like Multi-span cells (e.g. | ... ||) and cell justification (e.g. |  centered  |   right |)
• There is a performance issue when editing a large table, say, with more then 50 rows
• Variables like %ATTACHURL% get expanded unless they are in a label
• You cannot put two %EDITTABLE{}% statements on the same line in the source
• You can include %-vars now in select values, by quoting them with <nop>, as in %<nop>X% for %X%, say for instance:
  select,1,%<nop>X%,%<nop>Y%

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this Plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip EditTablePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/EditTablePlugin.txt	Plugin topic
  data/TWiki/EditTablePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/EditTablePlugin.pm	Plugin Perl module
  pub/TWiki/EditTablePlugin/edittable.gif	Edit table button image
  pub/TWiki/EditTablePlugin/*.gif	Screenshots and Mishoo DHTML calendar images
  pub/TWiki/EditTablePlugin/README	Mishoo DHTML calendar README
  pub/TWiki/EditTablePlugin/release-notes.html	Mishoo DHTML calendar release notes
  pub/TWiki/EditTablePlugin/*.js	Mishoo DHTML calendar JavaScript files
  pub/TWiki/EditTablePlugin/calendar-system.css	Mishoo DHTML calendar stylesheet

• The Plugin depends on the viewauth script to authenticate the user. As described in TWikiAccessControl, copy the view script to viewauth (or better, create a symbolic link) and add viewauth to the list of authenticated scripts in the .htaccess file.
• The Mishoo DHTML calendar 0.9.5 is preinstalled and should work without any configuration. If you wish to use another language, specify the in the Plugin settings, or create a new language files, attach it to the Plugin topic, and change the Plugin settings
• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the Plugin is correctly installed:
  • Check above example if there is an [ Edit table ] button below the table in above example
  • Click on [ Edit table ], make changes and save the table

License

• The Edit Table Plugin is released under the GPL
• The Mishoo DHTML calendar bundled with this Plugin was created by Mihai Bazon and is released under the LGPL -- thanks Mihai for the great tool

Plugin Info

Plugin Author:	Peter Thoeny
Copyright:	© 2002-2006, TWiki:Main.PeterThoeny
License:	GPL (GNU General Public License)
Plugin Version:	%$VERSION%
Change History:
30 Aug 2006:	Item2829 Remove whitespace from select, radio and checkbox items; restored topic lock if $TWiki::Plugins::VERSION < 1.1
29 Jul 2006:	Item2684 - Quietly ignore topic edit locks on table edit
21 Jan 2006:	TWiki:Main.CrawfordCurrie ported to TWiki-4.0.0, changed to use JSCalendarContrib
16 Sep 2004:	Added radio buttons and checkbox controls; escaped "|" pipe symbol found in input fields to preserve tables
01 Aug 2004:	Fixed bug where edittable did not work if at the end of a topic
07 Apr 2004:	Fixed bug where two tables got updated when you edit and save a table included into a topic containing other edit tables
02 Mar 2004:	Default for %EDITCELL{editbutton}% is EDITBUTTON preference
27 Feb 2004:	Added QUIETSAVE setting and quietsave parameter; image for Edit button
18 Feb 2004:	Doc fixes; allow edit button anywhere in a cell not just at the end of a cell
17 Feb 2004:	Added per cell definition of edit field types with %EDITCELL{}% variable; added headerislabel and editbutton parameters
20 Dec 2003:	Fixed bug where calendar did not work after adding a row (TWiki:Main/PaulineCheung); added all language files of Mishoo DHTML calendar 0.9.5
13 Dec 2003:	Added CHANGEROWS, JSCALENDARDATEFORMAT, JSCALENDARLANGUAGE, JSCALENDAROPTIONS settings
16 Oct 2003:	small typo fixed (garbled if ---+ header on top)
15 Oct 2003:	new date field type with javascript calendar - CN
14 Oct 2003:	docfix: the documentation page was an old one - CN
13 Oct 2003:	bugfix: %-vars in select were resetted to first on add/del row - CN
18 Sep 2003:	incompatibility: changed default of changerows to on; support for %-vars, Quiet save for saving without notification; all other fixes in Dev topic integrated - CN
08 Nov 2002:	Prevent variable expansion in label text; added escape characters
27 Jun 2002:	New helptopic parameter
26 Jun 2002:	Support for variables in included EDITTABLE parameters; fixed problem with HTML in cells
21 May 2002:	Added fixed label format; new changerows="add" parameter
27 Apr 2002:	Fixed bug where text after a double quote in a cell disappeared
18 Apr 2002:	Fixed bug where table was breaking when pasting multiple lines into an edit field using Netscape on Unix
08 Apr 2002:	Check for change permission and edit lock of topic
05 Apr 2002:	Initial version
Dependencies:	%$DEPENDENCIES%
Perl Version:	5.0
TWiki:Plugins/Benchmark:	GoodStyle 98%, FormattedSearch 98%, EditTablePlugin 95%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/PeterThoeny - 30 Aug 2006

Empty TWiki Plugin

This is an empty Plugin you can use as a template to build your own TWikiPlugins. This Plugin does nothing, but is ready to be used.

To create your own Plugin:

• Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
• Create a <name>Plugin topic in the TWiki web. Do so by visiting http://TWiki.org/cgi-bin/view/Plugins/PluginPackage#NewPlugin and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs.
• See details in TWikiPlugins.

Syntax Rules

(none)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins

• Your own setting, for example:
  • Set EXAMPLE = got it!

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

• This plugin is preinstalled, you do not need to install it.

Plugin Info

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright:	© 2001-2006, TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	01 Feb 2006
Change History:
01 Feb 2006:	Dakar changes
21 Mar 2004:	Added afterSaveHandler
14 Jul 2001:	Changed to plug&play
27 Feb 2001:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins/Benchmark:	GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiContributor - 01 Feb 2006

(just an example illustrating how to create a new topic based on a specific template topic. TWikiTemplates has more)

-- TWikiGuest - 22 Jan 2014

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 are stored under revision control: uploads are automatically backed up; all previous versions of a modified file can be retrieved.

What Are Attachments Good For?

File Attachments can be used to archive data, or to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.

Document Management System

• You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using web and topic-level access control; create a central reference library that's easy to share with an user group spread around the world.

File Sharing

• For file sharing, FileAttachments on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload!

Web Authoring

• Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to link to on a page) and place them on a single page, or use them across a web, or site-wide.
  • NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can use your browser to create TWikiVariables shortcuts, like this %H% = .

Uploading Files

• Click on the Attach link at the bottom of the page. The Attach screen lets you browse for a file, add a comment, and upload it. The uploaded file will show up in the File Attachment table.
  • NOTE: The topic must already exist. It is a two step process if you want to attach a file to a non-existing topic; first create the topic, then add the file attachment.
  • Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: *.php files are renamed to *.php.txt so that no one can place code that would be read in a .php file.
  • The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
  • TWiki can limit the file size. This is defined by the %ATTACHFILESIZELIMIT% variable of the TWikiPreferences, currently set at 10000 KB.
    • It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads.
• Automatic attachments:
  • When enabled, all files in a topic's attachment directory are shown as attachments to the topic - even if they were directly copied to the directory and never attached by using an 'Attach' link. This is a convenient way to quickly "attach" files to a topic without uploading them one by one; although at the cost of losing audit trail and version control.
  • To enable this feature, set the {AutoAttachPubDir} configuration option.
  • NOTE: The automatic attachment feature can only be used by an administrator who has access to the server's file system.

Downloading Files

• Click on the file in the File Attachment table.

• NOTE: There is no access control on individual attachments. If you need control over single files, create a separate topic per file and set topic-level access restrictions for each.

Moving Attachment Files

An attachment can be moved between topics.

• Click Manage on the Attachment to be moved.
• On the control screen, select the new web and/or topic.
• Click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data.

Deleting Attachments

Move unwanted Attachments to web Trash, topic TrashAttachment.

Linking to Attached Files

• Once a file is attached it can be referenced in the topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and enter: %ATTACHURL%/Sample.txt
  3. Preview: %ATTACHURL%/Sample.txt text appears as: /twiki/pub/TWiki/FileAttachment/Sample.txt, a link to the text file.

• To reference an attachment located in another topic, enter:
  • %PUBURLPATH%/%WEB%/OtherTopic/Sample.txt (if it's within the same web)
  • %PUBURLPATH%/Otherweb/OtherTopic/Sample.txt (if it's in a different web)

• Attached HTML files and text files can be inlined in a topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%
     • Content of attached file is shown inlined.
     • Read more about INCLUDE in TWikiVariables

• GIF, JPG and PNG images can be attached and shown embedded in a topic. Example:
  1. Attach file: Smile.gif
  2. Edit topic and write text: %ATTACHURL%/Smile.gif
  3. Preview: text appears as /twiki/pub/TWiki/FileAttachment/Smile.gif, an image.

File Attachment Contents Table

Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.

I	Attachment	Action	Size	Date	Who	Comment
	Sample.txt	manage	0.1 K	22 Jul 2000 - 19:37	UploadingUser	Just a sample
	Smile.gif	manage	0.1 K	22 Jul 2000 - 19:38	UploadingUser	Smiley face

File Attachment Controls

Clicking on a Manage link takes you to a new page that looks a bit like this (depending on what skin is selected):

Update attachment Sample.txt Version Action Date Who Comment 1 view 22 Jul 2000 - 19:37 UploadingUser Just a sample Previous upload Sample.txt (TWikiContributor) Select a new local file to update this attachment. Local file Upload up to 10000 KB. Comment Link Create a link to the attached file Images will be displayed, for other attachments a link will be created. Hide file Do not show attachment in table Attachments will not be shown in topic view page.

• The first table is a list of all attachments, including their attributes. An h means the attachment is hidden, it isn't listed when viewing a topic.

• The second table is all the versions of the attachment. Click on View to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want.
  • To change the comment on an attachment, enter a new comment and then click Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.
  • To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.

Known Issues

• Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.
• Attachments are not secured. Anyone can read them if they know the name of the web, topic and attachment.

Related Topics: UserDocumentationCategory

Each FileAttachment in a Topic has an attribute string. At present only the hidden attribute is supported. If the attribute includes h then the attachment is considered to be hidden. It is not listed in the topic, but is displayed when attach page is displayed.

Related Topics: UserDocumentationCategory, DeveloperDocumentationCategory

Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), Bernstein will fold together your changes. This is often the "right thing to do", as it can reduce the visual clutter of diffs.

The "Force New Revision" checkbox is a way to force it to create a separate revision each time you save.

The TWiki.TWikiPreferences variable FORCENEWREVISIONCHECKBOX controls whether this is checked by default or not.

On a related note, you can force every save to be a new revision number by setting ReplaceIfEditedAgainWithin to 0.

Related Topics: UserDocumentationCategory, AdminDocumentationCategory

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 names and topic summaries. Use the format="..." parameter to customize the search result. The format parameter typically defines a bullet or a table row containing variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%. See %SEARCH{...}% for other search parameters, such as separator="".

Syntax

Two parameters can be used to specify a customized search result:

1. header="..." parameter

Use the header parameter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional.
Example: header="| *Topic:* | *Summary:* |"

2. format="..." parameter

Use the format parameter to specify the format of one search hit.
Example: format="| $topic | $summary |"

Variables that can be used in the format string:

Name:	Expands To:
$web	Name of the web
$topic	Topic name
$topic(20)	Topic name, "- " hyphenated each 20 characters
$topic(30, -<br />)	Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...)	Topic name, shortended to 40 characters with "..." indication
$parent	Name of parent topic; empty if not set
$parent(20)	Name of parent topic, same hyphenation/shortening like $topic()
$text	Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.
$locked	LOCKED flag (if any)
$date	Time stamp of last topic update, e.g. 22 Jan 2014 - 14:44
$isodate	Time stamp of last topic update, e.g. 2014-01-22T14:44Z
$rev	Number of last topic revision, e.g. 4
$username	Login name of last topic update, e.g. jsmith
$wikiname	Wiki user name of last topic update, e.g. JohnSmith
$wikiusername	Wiki user name of last topic update, like Main.JohnSmith
$createdate	Time stamp of topic revision 1
$createusername	Login name of topic revision 1, e.g. jsmith
$createwikiname	Wiki user name of topic revision 1, e.g. JohnSmith
$createwikiusername	Wiki user name of topic revision 1, e.g. Main.JohnSmith
$summary	Topic summary, just the plain text, all formatting and line breaks removed; up to 162 characters
$summary(50)	Topic summary, up to 50 characters shown
$summary(showvarnames)	Topic summary, with %ALLTWIKI{...}% variables shown as ALLTWIKI{...}
$summary(noheader)	Topic summary, with leading ---+ headers removed Note: The tokens can be combined, for example $summary(100, showvarnames, noheader)
$changes	Summary of changes between latest rev and previous rev
$changes(n)	Summary of changes between latest rev and rev n
$formname	The name of the form attached to the topic; empty if none
$formfield(name)	The field value of a form field; for example, $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$formfield(name, 10)	Form field value, "- " hyphenated each 10 characters
$formfield(name, 20, -<br />)	Form field value, hyphenated each 20 characters with separator "-<br />"
$formfield(name, 30, ...)	Form field value, shortended to 30 characters with "..." indication
$pattern(reg-exp)	A regular expression pattern to extract some text from a topic (does not search meta data; use $formfield instead). In case of a multiple="on" search, the pattern is applied to the line found in each search hit. • Specify a RegularExpression that covers the whole text (topic or line), which typically starts with .*, and must end in .* • Put text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*) • Example: $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the e-mail address from a bullet of format * Email: ... • This example has non-greedy .*? patterns to scan for the first occurance of the Email bullet; use greedy .* patterns to scan for the last occurance • Limitation: Do not use .*) inside the pattern, e.g. $pattern(.*foo(.*)bar.*) does not work, but $pattern(.*foo(.*?)bar.*) does • Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag
$count(reg-exp)	Count of number of times a regular expression pattern appears in the text of a topic (does not search meta data). Follows guidelines for use and limitations outlined above under $pattern(reg-exp). Example: $count(.*?(---[+][+][+][+]) .*) counts the number of <H4> headers in a page.
$n or $n()	New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$nop or $nop()	Is a "no operation". This variable gets removed; useful for nested search
$quot	Double quote ("). Alternatively write \" to escape it
$percnt	Percent sign (%)
$dollar	Dollar sign ($)

Examples

Bullet list showing topic name and summary

Write this:

%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header="   * *Topic: Summary:*" format="   * [[$topic]]: $summary" }%

To get this:

• Topic: Summary:
• TWikiFAQ: Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of an easily implemented knowledge base solution. To see how it's done, view the source ...
• TWikiFaqTemplate: FAQ: Answer: Back to: TWikiFAQ
• TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...

Table showing form field values of topics with a form

In a web where there is a form that contains a TopicClassification field, an OperatingSystem field and an OsVersion field we could write:

| *Topic:* | *OperatingSystem:* | *OsVersion:* |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%

To get this:

Topic:	OperatingSystem:	OsVersion:
IncorrectDllVersionW32PTH10DLL	OsWin	95/98
WinDoze95Crash	OsWin	95

Extract some text from a topic using regular expression

Write this:

%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%

To get this:

TWiki FAQs:

• How can I create a simple TWiki Form based application? Answer...
• How do I delete or rename a topic? Answer...
• How do I delete or rename a file attachment? Answer...
• Why does the topic revision not increase when I edit a topic? Answer...
• TWiki has a GPL (GNU General Public License). What is GPL? Answer...
• I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
• What happens if two of us try to edit the same topic simultaneously? Answer...
• I would like to install TWiki on my server. Can I get the source? Answer...
• What does the "T" in TWiki stand for? Answer...
• So what is this WikiWiki thing exactly? Answer...
• Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...

Nested Search

Search can be nested. For example, search for some topics, then form a new search for each topic found in the first search. The idea is to build the nested search string using a formatted search in the first search.

Here is an example. Let's search for all topics that contain the word "culture" (first search), and let's find out where each topic found is linked from (second search).

• First search:
  • %SEARCH{ "culture" format="   * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%
• Second search. For each hit we want this search:
  • %SEARCH{ "(topic found in first search)" format="$topic" nosearch="on" nototal="on" separator=", " }%
• Now let's nest the two. We need to escape the second search, e.g. the first search will build a valid second search string. Note that we escape the second search so that it does not get evaluated prematurely by the first search:
  • Use $percnt to escape the leading percent of the second search
  • Use \" to escape the double quotes
  • Use $dollar to escape the $ of $topic
  • Use $nop to escape the }% sequence

Write this:

%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%

To get this:

• ATasteOfTWiki is referenced by:
  • ATasteOfTWiki, ATasteOfTWikiTemplate, NewUserTemplate, TWikiUsersGuide, WebLeftBar, WebStatistics, WelcomeGuest
• FormattedSearch is referenced by:
  • EditTablePlugin, EmptyPlugin, ManagingWebs, PreferencesPlugin, RenderListPlugin, SearchHelp, SearchPatternCookbook, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TWikiDocumentation, TWikiForms, TWikiHistory, TWikiReferenceManual, TWikiReleaseNotes04x00, TWikiScripts, TWikiSearchDotPm, TWikiSiteTools, TWikiUISearchDotPm, TWikiVariablesQuickStart, VarMETA, VarSEARCH, VarURLPARAM, WebLeftBar, WebStatistics, WelcomeGuest
• TWikiAccessControl is referenced by:
  • EditTablePlugin, FileAttachment, MainFeatures, ManagingTopics, ManagingUsers, SitePermissions, SourceCode, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiFuncDotPm, TWikiHistory, TWikiPreferences, TWikiReferenceManual, TWikiScripts, TWikiSiteTools, TWikiTopics, TWikiTutorial, TWikiUserAuthentication, TWikiVariables, VarSEARCH, WebPreferences, WebPreferencesHelp, WebStatistics, WikiCulture, WikiWord
• TWikiSite is referenced by:
  • AdminToolsCategory, InstantEnhancements, InterwikiPlugin, ManagingWebs, StartingPoints, TWikiDocumentation, TWikiGlossary, TWikiI18NDotPm, TWikiInstallationGuide, TWikiPreferences, TWikiReferenceManual, TWikiRegistration, TWikiSite, TWikiTopics, TWikiTutorial, TWikiUserAuthentication, TWikiUsersGuide, WabiSabi, WebLeftBar, WebSiteTools, WebStatistics, WelcomeGuest, WhatDoesTWikiStandFor, WhatIsWikiWiki, WikiCulture, WikiReferences
• WabiSabi is referenced by:
  • TWikiSite, WabiSabi, WhatIsWikiWiki, WikiCulture
• WhatIsWikiWiki is referenced by:
  • TWikiReleaseNotes04x00, WikiCulture
• WikiCulture is referenced by:
  • TWikiAccessControl, TWikiSite, WabiSabi, WhatIsWikiWiki

Note: Nested search can be slow, especially if you nest more then 3 times. Nesting is limited to 16 levels. For each new nesting level you need to "escape the escapes", e.g. write $dollarpercntSEARCH{ for level three, $dollardollarpercntSEARCH{ for level four, etc.

Most recently changed pages

Write this:

%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="| [[$topic]] | $wikiusername  | $date |" limit="7" }%

To get this:

WebLeftBarLogin	VladAtanasiu	23 Dec 2011 - 14:19
WebStatistics	VladAtanasiu	23 Dec 2011 - 03:14
TWikiPreferences	EmanuelWenger	25 Oct 2010 - 09:53
TWikiRegistration	EmanuelWenger	25 Oct 2010 - 09:20
TWikiAccessControl	VladAtanasiu	30 Apr 2010 - 20:51
PreviewBackground	VladAtanasiu	06 Mar 2009 - 23:17
TWikiGuest	VladAtanasiu	02 Mar 2009 - 22:01

Search with conditional output

A regular expression search is flexible, but there are limitations. For example, you cannot show all topics that are up to exactly one week old, or create a report that shows all records with invalid form fields or fields within a certain range, etc. You need some additional logic to format output based on a condition:

1. Specify a search which returns more hits then you need
2. For each search hit apply a spreadsheet formula to determine if the hit is needed
3. If needed, format and output the result
4. Else supress the search hit

This requires the TWiki:Plugins.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old.

Write this:

%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%
%SEARCH{ "." scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="$percntCALC{$IF($TIME($date) < $GET(weekold), <nop>, | [[$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }%

• The first line sets the weekold variable to the serialized date of exactly one week ago
• The SEARCH has a deferred CALC. The $percnt makes sure that the CALC gets executed once for each search hit
• The CALC compares the date of the topic with the weekold date
• If topic is older, a <nop> is returned, which gets removed at the end of the TWiki rendering process
• Otherwise, the search hit is formatted and returned

To get this:

Embedding search forms to return a formatted result

Use an HTML form and an embedded formatted search on the same topic. You can link them together with an %URLPARAM{"..."}% variable. Example:

Write this:

<form action="%SCRIPTURLPATH{"view"}%/TWiki/FormattedSearch">
Find Topics: 
<input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />&nbsp;<input type="submit" class="twikiSubmit" value="Search" />
</form>
Result:
%SEARCH{ search="%URLPARAM{"q"}%" format="   * $web.$topic: %BR% $summary" nosearch="on" }%

To get this:

Find Topics:  

Result:

Related Topics: UserDocumentationCategory

FAQ:

TWiki has a GPL (GNU General Public License). What is GPL?

Answer:

TWiki is distributed under the GNU General Public License, see TWikiDownload. GPL is one of the free software licenses that protects the copyright holder, and at the same time allows users to redistribute the software under the terms of the license. Extract:

• This program is open source software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
• This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
• See the GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

Go Box

The box at the top or sidebar of each page, also called Jump box.

Enter a topic name to quickly jump to the topic, for example:

• WebNotify to jump to WebNotify in the current web
• Main.WebNotify to jump to WebNotify in the Main web
• Main. to jump to the home of the Main web
• BrandNewTopic to jump to a non existing topic in the current web, which is useful to create orphaned topics

Enter part of a topic name to get a list of similar topics, for example:

• faq to get TWikiFAQ, TWikiFaqTemplate, TextFormattingFAQ

Note: The Go box is not a search box

Related Topics: UserDocumentationCategory

GoodStyle Collaboration Tips

• TWiki has a very simple text formatting shorthand. In any case, you won't go wrong if you simply:
  • start each line without spaces
  • separate paragraphs with a blank line

• Run together capitalized words to form WikiWords:
  • WikiWords automatically appear as hyperlinks
  • make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
  • WikiWords has name-creation tips that may help

• If a discussion is going on:
  • separate each follow-up with a space
  • add your WikiName and the date at the end. Example:
    -- Main.TWikiGuest - 22 Jan 2014
  • OR, by all means, insert your comment where it seems to fit best:
    • you may want to inset it with a bullet and/or set it in italics so it's clear (always sign and date)
  • if you'd like to use an initial, use a link with label. Example:
    -- [[Main.TWikiGuest][ZXQ]] - 22 Jan 2014

• A good format for a new topic is "dissertation followed by discussion":
  • start with a brief, factual introduction, followed by double horizontal rules
  • let the discussion begin

• When a discussion dies down and the page becomes static, if you're clear on your course, feel free to refactor mercilessly:
  • fearlessly edit down to capture the key points
  • reduce the noise without losing the facts or the flavor
  • if you merge or delete comments, group credit Contributors: at the end of the page
  • This is how Wiki content matures and grows in value over time.

• For external site links, you can type URLs directly into the text - http://etcete.ra/... - it'll be clear to anyone where they're headed on click.

• TWiki is intended for world-wide use, and an internationally understood date format like 01 Sep 2003 or 2003/09/01 is preferred. It's clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...

• TIP: Check the source when you want to find out how something is formatted: click Edit on the lower toolbar. To see earlier versions, click More, then check Raw text format and click View revision. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary.

Related Topics: UserDocumentationCategory

Hide/Unhide Attachments

You can hide/unhide file attachments in normal topic view.

• In the FileAttachment table, click on an action link,
• enable the Hide file checkbox,
• then click Change properties

Note: All attachments are listed in the attach screen, regardless of the hide file flag.

Related Topics: UserDocumentationCategory

If Statements

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 example above, if CONDITION evaluates to TRUE, then THEN will be included in the topic; otherwise ELSE will be included.

What can be included in the THEN and ELSE parameters is obviously limited by standard TWiki syntax for parameters.

The basic syntax of a condition is as follows:

expr ::= '(' expr ')' ;
expr ::= andexpr | andexpr 'or' expr ;
andexpr ::= notexpr | notexpr 'and' andexpr ;
notexpr ::= basexpr | 'not' baseexpr ;
basexpr ::= atom | uop atom | atom bop basexpr ;
uop ::= 'context' | 'defined' | '$' ;
bop ::= '=' | '!=' | '>' | '<' | '>=' | '<=' ;
atom ::= context identifier, TWiki variable name, single-quoted string, or configuration item

Operators
and	True if both sides are true
or	True if one or other side is true
not	negate the following expression
=, !=	String comparison
<, >, <=, >=	Number comparison (there is no explicit numeric =)
context	True if the current context is set (see below)
defined	True if a preference variable or url parameter of this name is defined.
$	expands a URL parameter or TWikiVariable. Plugin handlers are not called. Built-in variables and user-defined preferences are supported. You can pass a limited subset of parameters to TWiki variables by enclosing the variable name in single quotes; for example, $ 'VARIABLE{value}'. The 'VARIABLE{value}' string may not contain quotes (' or ").

examples:

TWiki variable defined or not
%IF{"defined WIKINAME" then="WIKINAME is defined" else="WIKINAME is not defined"}%

You are %IF{ "$ WIKINAME='TWikiGuest' and not defined OPEN_DAY" then="not" }% allowed to
%IF{ "context view" then="view" else="edit"}% this TWiki today.

URL parameter
%IF{ "defined search" then="Search: %URLPARAM{search}%" else="No search passed in"}%

Configuration item set or not
%IF{ "{AntiSpam}{HideUserDetails}" then="User details are hidden" }%

url param t is %IF{ "0 < $ t and $ t < 1000" then="in" else="out of"}% range.

Text comparison
%IF{ "$'URLPARAM{scope}'='text'" then="Plain text search" }% 

Configuration items are defined in configure. You cannot see the value of a configuration item, you can only see if the item is set or not.

Context identifiers are used in TWiki to label various stages of the rendering process. They are especially useful for skin authors to find out where they are in the rendering process. The following context identifiers are available:

id	context
absolute_urls	Set if absolute URLs are required
authenticated	a user is authenticated
body_text	when the body text is being processed in a view (useful in plugin handlers)
can_login	current environment supports login
changes	in changes script (see TWikiScripts)
command_line	the running script was run from the command line, and not from CGI
diff	in rdiff script (see TWikiScripts)
edit	in edit script (see TWikiScripts)
footer_text	when the footer text is being processed in a view (useful in plugin handlers)
header_text	when the header text is being processed in a view (useful in plugin handlers)
i18n_enabled	when user interface I18N support is enabled (i.e., user can choose the language for UI)
inactive	if active links such as 'edit' and 'attach' should be disabled
mirror	if this is a mirror
new_topic	if the topic doesn't already exist
oops	in oops script (see TWikiScripts)
preview	in preview script (see TWikiScripts)
rss	if this is an RSS skin rendering
save	in save script (see TWikiScripts)
search	in search script (see TWikiScripts)
view	in view script (see TWikiScripts)
rest	in rest script (see TWikiScripts)

In addition there is a context identifier for each enabled plugin; for example, if GallousBreeksPlugin is installed and enabled, then the context ID GallousBreeksPluginEnabled will be set. Other extensions may set additional context identifiers.

The %IF% statement is deliberately kept simple. In particular, note that there is no way to conditionally execute a Set statement. If you need more sophisticated control over formatting, then consider using the SpreadSheetPlugin.

Include Topics and Web Pages Using %INCLUDE{...}% Variable

Use the %INCLUDE{...}% variable to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in TWikiPreferences.

Syntax Example

%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }%

The pattern parameter is optional and allows you to extract some parts of a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag.

VarINCLUDE explains the other parameters.

Note: All text of a topic is included unless it contains a %STARTINCLUDE% and %STOPINCLUDE%, or you specify a section parameter and/or a pattern parameter. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE%.

Usage Examples

1. Display regression test results in a TWiki page

  <pre>
  %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
  </pre>

2. Display Google's robot.txt file

  %INCLUDE{"http://www.google.com/robots.txt"}%

3. Display the current time in Tokyo in a TWiki page

• You type:
  • Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
• You get:
  • Tokyo:

Warning

This site does not allow %INCLUDE% of URLs

Related Topics: VarINCLUDE, UserDocumentationCategory

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 the core TWiki distribution - and any those can be removed - while the rest are optional, available from TWiki:Plugins.PluginPackage.

Here is a list of the plugins currently installed and enabled on this TWiki site:

• SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Bernstein topics.
• CommentPlugin (Dakar, 8164): Allows users to quickly post comments to a page without an edit/preview/save cycle.
• EditTablePlugin (Dakar, 8154): Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin (Dakar, $Rev: 8329$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (Dakar, $Rev: 8154$): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, 8154): Render smilies as icons, like  :-) for or  :cool: for :cool:
• TablePlugin (Dakar, 8154): Control attributes of tables and sorting of table columns
• WysiwygPlugin (Dakar, 9565): Translator framework and WYSIWYG editor for TWiki topics

Administrators can enable and disable plugins using configure.

Contrib Modules

• JSCalendarContrib
• MailerContrib
• TipsContrib
• TwistyContrib

Plugin Diagnostics

Plugin	Errors
SpreadSheetPlugin	none
CommentPlugin	none
EditTablePlugin	none
InterwikiPlugin	none
PreferencesPlugin	none
SlideShowPlugin	none
SmiliesPlugin	none
TablePlugin	none
WysiwygPlugin	none

Handler	Plugins
beforeCommonTagsHandler	PreferencesPlugin WysiwygPlugin
beforeEditHandler	WysiwygPlugin
beforeSaveHandler	CommentPlugin WysiwygPlugin
commonTagsHandler	SpreadSheetPlugin CommentPlugin EditTablePlugin SlideShowPlugin SmiliesPlugin
initPlugin	SpreadSheetPlugin CommentPlugin EditTablePlugin InterwikiPlugin PreferencesPlugin SlideShowPlugin SmiliesPlugin TablePlugin WysiwygPlugin
modifyHeaderHandler	WysiwygPlugin
postRenderingHandler	EditTablePlugin PreferencesPlugin WysiwygPlugin
preRenderingHandler	InterwikiPlugin SmiliesPlugin TablePlugin

9 plugins

Note: The diagnostics are provided by the %FAILEDPLUGINS% variable

Related Topics: TWikiPlugins, TWikiPreferences, AdminDocumentationCategory, AdminToolsCategory

Instant TWiki Site Enhancements

These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful. The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a big differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes. No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.

Many of these tips are based on setting some special TWikiVariables.

We recommend implementing at least some of these enhancements right after installation to get a taste for what is possible. Some of these tips and enhancements should be implemented before or during initial roll-out.

This may spark your imagination to really customize your site so that it's optimal for your users. Slightly more advanced customization tips are listed in TWiki:TWiki.TWikiAdminCookBook.

---

Tips using TWiki Variables

TWikiVariables are a great resource to customize your site. You need to know the variable name and decide where to put it.

Change Colors of Page Header/Footer

Incredibly obvious, maybe, but some TWiki site admins don't get around to changing the default web colors right off, whether they like them or not. Simply changing the defaults will make a huge difference in the overall look.

What we are doing

We want to set variable WEBBGCOLOR in topic WebPreferences to one of the StandardColors. WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki Web{*}. Each web has its own WebPreferences, and you can set them differently for each web.

How to do it

1. Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference.
2. Go to WebPreferences in each web, and edit the topic.
3. Set your preferred WEBBGCOLOR preferences variable, and save the topic.
4. Add a new line immediately after the color code. If there is (invisible) space after the color code, the page header might get strange colors (e.g. black).

It's just as easy to refine later on, so you're not locked in, just looking better.

Set Page Background Color

Without getting into the TWikiTemplates system yet, you can easily edit the view.tmpl (in the templates directory). In the HTML at the top, the body tag has the page background hardcoded to white bgcolor="#ffffff". You can change that color value to new variable. First, define a new preferences variable in the site-level Main.TWikiPreferences, e.g. * Set =PAGEBGCOLOR = #d0d0d0, then edit the view.tmpl template file and change bgcolor="#ffffff" to bgcolor="%PAGEBGCOLOR%". If you want, you can set the page background color individually per web, simple add a * Set =PAGEBGCOLOR = #d0d0d0 bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.)

Titles-Only Topic List - WebTopicList

WebTopicList is a good first navigation tool for new users, a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerful WebIndex is used.

Without explaining what WEBTOPICLIST is, just try it:

1. Go to WebPreferences in each web, and edit the topic.
2. In WEBTOPICLIST variable, replace WebIndex with WebTopicList, and save.

Simple way to create colored text and graphics

This should be enabled, see the "Miscellaneous Settings" in the TWikiPreferences, . If not, look at TWiki:TWiki/TWikiPreferences. Look for variables RED, BLUE etc (which define HTML tag FONT). To copy/paste the variables defining the colors you need to see the source text, but Edit is disabled. Instead, go to More and view the topic in raw format.

EZ Graphic Icons to Highlight Text

Icons can do a lot to enhance scannability of topics. For instance, on HELP pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits.

TWikiDocGraphics has a whole collection of ready icon images. You can use these images in any topic by referring to their name. For example, TWikiDocGraphics has an image attachment called days.gif. To show this image in a topic, write %ICON{"days"}% to get .

Creating image variables

You may find it easier to write shorthand graphic notation. You can create your own image variables by defining them in a preference topic (most likely Main.TWikiPreferences.)

A variable name may be one letter, like Y, or may be longer like HELP, WARN etc. You can also add your own images, e.g. a NEW, or a ASK to ask question.

For instance, if we want to write %DOWN% instead of %ICON{"arrowbdown"}%, define the new variable like this:

   * Set DOWN = %ICON{"arrowbdown"}%

Or if you have a custom image to use, attach this to Main.TWikiPreferences and write:

   * Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />

Most images in TWikiDocGraphics are 16 x 16 pixels.

• Related: There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See TWikiDocGraphics for more info.

Use TOC variable to create table of content

TOC is Table-Of-Content, generated automagically from headers (defined like that: ---++ , see TWikiShorthand).

For example, you may want to put all your custom variables in Main.TWikiPreferences right on top of the page, and generate table of contents, like:

• Preferences for easy creating nice pages
  • Graphics icons in text
  • Colored text
• System Preferences
  • Contents of page header and footer
  • User interface defaults
  • Email
  • Plugins
  • Notes

Non-admin users wil be interested only in first part, non-system preferences.

---

Personal Productivity - Tools and Tips for Working Faster

Although this area applies to all TWiki setups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!

Use your favorite text editor for major edits

When you have a fair bit of TWiki formatting work - for example, compiling new info pages from various cut'n'paste sources, editing multiple TWiki topics or contributed material - it's often easier to use a real TextEditor instead of the browser's text edit box. There are several methods for doing this. For Windows, there are several well-recommended text editors.

Windows Example: TextPad is a low-cost, top flight Windows program, with an extended trial period. You can download from a well-stocked library of user-contributed macros, dictionaries, and syntax and clip files. You can also easily create a TWiki clip collection that allows you to format text with TWiki code: select a text string and click for bold, italic, links, bullet lists - just like a regular HTML editor - and also insert blocks of TWiki code, use simple or regex search and replace, more.

Copy & Paste: Using the web window this can work very well. System differences may present difficulties with this method but it is simple and reliable in most cases.

Browser Integration: Some web browsers can be configured to automatically use an external editor. See your browser documentation for details. Such a configuration and a small tool for Linux is described in an example on TWiki.org. TWiki:Codev/EditDaemonWithGVimIntegration

Alternate Browser: While your main browser might not have the features for TWiki topic editing, another one might.

• An example on the Linux platform is the w3m pager/browser for Linux. This is a text based version similar to lynx but it includes text editor features and a configurable command set to act like lynx if you are more accustomed to it.

Ready to use SEARCH

Personal directory of topics you're involved in

Here's how you can create your own personal directory of topics you've contributed to recently. Copy the text below (between Start Copy and End Copy) and paste it into your personal page (TWikiGuest). You can add other webs to search by duplicating one of the web subsections and editing the string {web ="webname"} in the search parameters to refer to the specific web you want to search. This script would also work for a group.

Start Copy

__Here's a list of topics I've been involved in recently:__

---++++ Codev

%SEARCH{ "InstantEnhancements" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%
---++++ Support

%SEARCH{ "InstantEnhancements" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%

---++++ TWiki

%SEARCH{ "InstantEnhancements" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="10"}%

End Copy

The SEARCH variable has many more formatting options, see TWikiVariables.

Recently changed pages

Here are the last 15 changed pages, formatted into a neat table.

<table>
%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="<tr><td>  [[$topic][$topic]] </td><td>  $wikiusername  </td><td> $date  </td></tr>" limit="15" }%
</table>

---

Hidden Edit Lock for Individual Topics

When you're creating main gateway pages, you may want to temporarily (or permanently) restrict editing to yourself or a limited group of people. You can do this with a Preference setting that includes one or more users and groups. Only auhorized users will be able to use Edit.

• Example: Set ALLOWTOPICCHANGE = Main.UserName, Main.GroupName
• To hide the setting: Use HTML comment tags - put <!-- on the line _above the setting, and --> on the line below.

---

Change the Default Logo

If you want to change the logo per TWiki web, simply attach a new logo.gif to the web's WebPreferences, and change the logo's filename by overriding the name using WEBLOGONAME in WebPreferences:

• Set WEBLOGONAME = filename.gif

Other cusomtisations are possible using WEBLOGOIMG, WEBLOGOURL, and WEBLOGOALT (they mirror the WIKILOGO* TWiki variables, but are applied to each web, rather than to the %WIKITOOLNAME%-based references)

If you'd like to have the same customised logo for all the webs, make these changes in TWikiPreferences instead of each web's WebPreferences, e.g.,

• Set WEBLOGOIMG = %PUBURLPATH%/Main/WebPreferences/mylogo.gif

---

Customize Topic Classification Forms

With a simple one or two-line default topic form available for every topic - in Edit mode, click the [Add] button, and select the form if it isn't already enabled. Then, click the title to get to the actual form, [Edit], and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with TWikiForms, without having to read up about them first. (add the corresponding search per category - copy a default and change)

---

Add Your Favorite JavaScript Features

You're no doubt familiar or better with HTML, JS, and "webmastering". Without getting into the TWikiTemplates system yet, you can easily edit the view.tmpl (in the templates directory) for some dramatic effects. The top of the template is mostly regular HTML with some variables. Open up some space in the <head> area, and you can drop in reliable JavaScripts - a pop-up window script, for example - or tag it as an external script.

• Obviously, you can do the same - place a link to an external stylesheet as well. If you set values for standard HTML tags, you can control a good deal of the type size, style and color with out adding CSS tags. example

Depending on what you load up, you may change the overall cross-browser compatibility - however be careful that your site does not look beat up in various other browsers. The scripts you choose will determine compatibility.

---

Customize The Left Navigation Bar

Customize the contents of the WebLeftBar for each web to include important topics for that web, or to link to an important topic for the overall site. Each web has its own WebLeftBar page. (This is specific to the PatternSkin.)

---

NOTE: Feel free to add your own tips to TWiki:TWiki.InstantEnhancements as quick notes at the end of the list, following the existing format!

Related Topics: AdminDocumentationCategory

-- Contributors: TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie, TWiki:Main.AmandaSmith

Inter-Wiki Link Rules (or Links to other Sites)

This topic lists all aliases needed to map Inter-Site links to external wikis/sites.

Whenever you write ExternalSite:Page it will be linked automatically to the page on the external site. The link points to the URL corresponding to the ExternalSite alias below, concatenated to the Page you choose. Example: Type Wiki:RecentChanges to get Wiki:RecentChanges, the RecentChanges page at the original Wiki site.

How to define Inter-Site links

• Inter-Site links are defined in the tables below.
• Each entry must be of format:
  | External site alias | URL | Tooltip help text |.
• The URL and Tooltip Text may contain optional $page variables; the variable gets expanded to the page name.
• Note: The Tooltip Text must not contain any HTML tags (including <nop> escape code), no internal WikiWord links, and no external links. Hint: Escape 'WikiWords' and '$page'.

General Inter-Site Links

Alias:	URL:	Tooltip Text:
Acronym	http://www.acronymfinder.com/af-query.asp?Acronym=$page&String=exact	Look up '$page' on Acronym Finder site
CPAN	http://search.cpan.org/perldoc?	CPAN perl repository
Dictionary	http://www.dictionary.com/cgi-bin/dict.pl?term=	Look up '$page' at Dictionary.com
Google	http://google.com/search?q=	Search for '$page' on Google
Group	http://groups.google.com/groups?hl=en&safe=off&group=	News group '$page' at Google.com
ISBN	http://service.bfast.com/bfast/click?bfmid=2181&sourceid=38704253&bfpid=	Book with ISBN#$page (One click patent? Say no to Amazon!)
News	http://news.google.com/news?q=	Search for '$page' on Google news
RFC	http://www.faqs.org/rfcs/rfc$page.html	IETF RFC #$page

Inter-Wiki Links

Alias:	URL:	Tooltip Text:
Advogato	http://www.advogato.org/	'$page' on Advogato community site (with peer review)
C2find	http://c2.com/cgi/wiki?FindPage&value=	Search '$page' on the original 'WikiWikiWeb' site
DokuWiki	http://wiki.splitbrain.org/wiki:	'$page' on Doku Wiki site
DolphinWiki	http://www.object-arts.co.uk/wiki/html/Dolphin/$page.htm	'$page' on Dolphin Wiki site
FoxWiki	http://fox.wikis.com/wc.dll?Wiki~	'$page' on Fox Wiki site
HammondWiki	http://www.dairiki.org/HammondWiki/index.php3?	'$page' on 'HammondWiki' site
LegoWiki	http://www.object-arts.com/wiki/html/Lego-Robotics/	'$page' on 'LegoWiki' site
MbTest	http://www.usemod.com/cgi-bin/mbtest.pl?	'$page' on 'UseMod' Wiki variant
MeatBall	http://www.usemod.com/cgi-bin/mb.pl?	'$page' on 'MeatBall' site, a 'UseMod' Wiki variant
MoinMoin	http://moinmoin.wikiwikiweb.de/	'$page' on 'MoinMoin' Wiki site
MuWeb	http://www.dunstable.com/scripts/MuWebWeb?	'$page' on 'MuWeb' site
OrgPatterns	http://www.easycomp.org/cgi-bin/OrgPatterns?	'$page' on Organizational Patterns site
PhpWiki	http://phpwiki.sourceforge.net/phpwiki/index.php3?	'$page' on Wiki site written in PHP
PolitizenWiki	http://www.politizen.com/wiki.asp?	'$page' on 'PolitizenWiki' site
PPR	http://c2.com/cgi/wiki?	'$page' on the original 'PortlandPatternRepository' site
PyWiki	http://www.voght.com/cgi-bin/pywiki?	'$page' on Wiki site written in Python
Squeak	http://minnow.cc.gatech.edu/squeak/	'$page' on Squeak Smalltalk Wiki
TWiki	http://twiki.org/cgi-bin/view/	'$page' on TWiki.org
UseMod	http://www.usemod.com/cgi-bin/wiki.pl?	'$page' on 'UseMod' Wiki site
VisualWorks	http://wiki.cs.uiuc.edu/VisualWorks/	'$page' on 'VisualWorks' site
Wiki	http://c2.com/cgi/wiki?	'$page' on the original 'WikiWikiWeb' site
Wikipedia	http://en.wikipedia.org/wiki/	'$page' on 'Wikipedia'
ZWiki	http://joyful.com/zwiki/	'$page' on Zope's Wiki

Note: This topic configures the InterwikiPlugin.

Related Topics: TWikiPlugins, UserDocumentationCategory, AdminDocumentationCategory

Interwiki Plugin

The InterwikiPlugin links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This plugin is inspired by UseMod Wiki's inter-wiki links, http://www.usemod.com/cgi-bin/wiki.pl?InterWiki.

Syntax Rules

• Enter ExternalSite:Page to create a link that points to the Page on the ExternalSite server.
• All ExternalSite aliases are defined in the InterWikis topic.
• Add and edit aliases in InterWikis.
• For TWiki sites, both the web and the topic have to be specified: TWikisite:Webname/SomePage
  • TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin

InterwikiPlugin Settings

Plugin settings are stored as Preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One-line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Link ExternalSite:Page text to external sites based on aliases defined in a rules topic

• Link rules topic name: (default is InterWikis)
  • Set RULESTOPIC =

• Suppress tooltip help for links: (0 or 1, default is 0)
  • Set SUPPRESSTOOLTIP = 0

Plugin Installation Instructions

NOTE: This Plugin is included in the TWiki distribution package. You do not need to install it unless you want to upgrade to a newer version.

• Download the ZIP file from the TWiki:Plugins web (see below)
• Unzip InterwikiPlugin.zip in your TWiki installation directory. Content:

  File:	Description:
  data/TWiki/InterwikiPlugin.txt	Plugin topic
  data/TWiki/InterWikis.txt	Link rules topic for inter-site links
  lib/TWiki/Plugins/InterwikiPlugin.pm	Plugin Perl module

• Test: If the Plugin is correctly installed, this Wiki:InterWiki link should point to http://c2.com/cgi/wiki?InterWiki topic - try it out.

Plugin Info

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version:	1.008
Change History:
26 Feb 2005:	1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready
25 Aug 2004:	1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change)
09 Mar 2004:	Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler
16 Feb 2004:	Support [[Site:Page][label]] Interwiki links (PTh); use TWiki::Func interface for I18N regular expressions (Walter Mundt)
18 Jan 2003:	Allow number sign # in Page name (PTh)
31 Aug 2002:	Allow percent sign % in page name (PTh)
27 Jul 2001:	Allow numbers 0-9 in site name
26 Jul 2001:	Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin)
14 Jul 2001:	Changed to plug & play
16 Jun 2001:	Made tooltips optional; prevent Module::Sub type of link
12 Jun 2001:	Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional $page in URL
10 Jun 2001:	Changed rules topic to table-based syntax
20 Feb 2001:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	TWiki:Plugins/InterwikiPlugin (TWiki:Plugins/InterwikiPlugin)
Feedback:	TWiki:Plugins/InterwikiPluginDev (TWiki:Plugins/InterwikiPluginDev)

Related Topics: InterWikis, TWikiPreferences, TWikiPlugins

JSCalendarContrib

Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.

Summary of Contents

This module packages the Mishoo JSCalendar Javascript in a form suitable for use with TWiki.

Detailed Documentation

Read the Mishoo documentation or visit the demo page.

This package also includes a small Perl module to make using the calendar easier from TWiki plugins. This module includes the function:

addHEAD( $setup )

that can automatically add the required headers to the page being rendered. $setup is the name of the calendar setup module; it can either be ommitted, in which case the method described in the Mishoo documentation can be used to create calendars, or it can be 'twiki', in which case a helper function is added that simplifies using calendars to set a value in a text field. For example,

    # Add styles and javascript for the calendar
    require TWiki::Contrib::JSCalendarContrib;
    if( $@ || !$TWiki::Contrib::JSCalendarContrib::VERSION ||
        $TWiki::Contrib::JSCalendarContrib::VERSION < 0.961 ) {
        TWiki::Func::writeWarning('JSCalendarContrib >=0.961 not found '.$@);
    } else {
        TWiki::Contrib::JSCalendarContrib::addHEAD( 'twiki' );
    }

    $html .= CGI::textfield(
        { name => 'datefield',
          id => "id_datefield" });
    $html .=
          CGI::image_button(
                      -name => 'datefield_calendar',
                      -onclick =>
                          "return showCalendar('id_datefield','%e %B %Y')",
                      -src=> TWiki::Func::getPubUrlPath() . '/' .
                        TWiki::Func::getTwikiWebname() .
                            '/JSCalendarContrib/img.gif',
                      -alt => 'Calendar',
                      -align => 'MIDDLE' );
            }
        }

The first parameter to showCalendar is the id of the textfield. See the Mishoo documentation for details of the '$e %B %Y' parameter.

Note that the header will only be added once, regardless of the number of times that addHEAD is called.

addHEAD can be called from commonTagsHandler for adding the header to all pages, or to beforeEditHandler just for edit pages etc.

Settings

• Name of the perl package
  • Set STUB = TWiki::Contrib::JSCalendarContrib
• What do I do
  • Set SHORTDESCRIPTION = Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.

Installation Instructions

• Download the archive from the Plugins web (see below)
• Unpack it in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/JSCalendarContrib.txt
  lib/TWiki/Contrib/JSCalendarContrib.pm
  pub/TWiki/JSCalendarContrib/twiki.js
  pub/TWiki/JSCalendarContrib/bugtest-hidden-selects.html
  pub/TWiki/JSCalendarContrib/calendar-blue2.css
  pub/TWiki/JSCalendarContrib/calendar-blue.css
  pub/TWiki/JSCalendarContrib/calendar-brown.css
  pub/TWiki/JSCalendarContrib/calendar-green.css
  pub/TWiki/JSCalendarContrib/calendar.js
  pub/TWiki/JSCalendarContrib/calendar.php
  pub/TWiki/JSCalendarContrib/calendar-setup.js
  pub/TWiki/JSCalendarContrib/calendar-setup_stripped.js
  pub/TWiki/JSCalendarContrib/calendar_stripped.js
  pub/TWiki/JSCalendarContrib/calendar-system.css
  pub/TWiki/JSCalendarContrib/calendar-tas.css
  pub/TWiki/JSCalendarContrib/calendar-win2k-1.css
  pub/TWiki/JSCalendarContrib/calendar-win2k-2.css
  pub/TWiki/JSCalendarContrib/calendar-win2k-cold-1.css
  pub/TWiki/JSCalendarContrib/calendar-win2k-cold-2.css
  pub/TWiki/JSCalendarContrib/ChangeLog
  pub/TWiki/JSCalendarContrib/dayinfo.html
  pub/TWiki/JSCalendarContrib/doc/html/field-button.jpg
  pub/TWiki/JSCalendarContrib/doc/html/reference.css
  pub/TWiki/JSCalendarContrib/doc/html/reference.html
  pub/TWiki/JSCalendarContrib/doc/html/reference-Z-S.css
  pub/TWiki/JSCalendarContrib/doc/reference.pdf
  pub/TWiki/JSCalendarContrib/img.gif
  pub/TWiki/JSCalendarContrib/index.html
  pub/TWiki/JSCalendarContrib/lang/calendar-af.js
  pub/TWiki/JSCalendarContrib/lang/calendar-al.js
  pub/TWiki/JSCalendarContrib/lang/calendar-bg.js
  pub/TWiki/JSCalendarContrib/lang/calendar-big5.js
  pub/TWiki/JSCalendarContrib/lang/calendar-big5-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-br.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ca.js
  pub/TWiki/JSCalendarContrib/lang/calendar-cs-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-cs-win.js
  pub/TWiki/JSCalendarContrib/lang/calendar-da.js
  pub/TWiki/JSCalendarContrib/lang/calendar-de.js
  pub/TWiki/JSCalendarContrib/lang/calendar-du.js
  pub/TWiki/JSCalendarContrib/lang/calendar-el.js
  pub/TWiki/JSCalendarContrib/lang/calendar-en.js
  pub/TWiki/JSCalendarContrib/lang/calendar-es.js
  pub/TWiki/JSCalendarContrib/lang/calendar-fi.js
  pub/TWiki/JSCalendarContrib/lang/calendar-fr.js
  pub/TWiki/JSCalendarContrib/lang/calendar-he-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-hr.js
  pub/TWiki/JSCalendarContrib/lang/calendar-hr-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-hu.js
  pub/TWiki/JSCalendarContrib/lang/calendar-it.js
  pub/TWiki/JSCalendarContrib/lang/calendar-jp.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ko.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ko-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-lt.js
  pub/TWiki/JSCalendarContrib/lang/calendar-lt-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-lv.js
  pub/TWiki/JSCalendarContrib/lang/calendar-nl.js
  pub/TWiki/JSCalendarContrib/lang/calendar-no.js
  pub/TWiki/JSCalendarContrib/lang/calendar-pl.js
  pub/TWiki/JSCalendarContrib/lang/calendar-pl-utf8.js
  pub/TWiki/JSCalendarContrib/lang/calendar-pt.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ro.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ru_win_.js
  pub/TWiki/JSCalendarContrib/lang/calendar-ru.js
  pub/TWiki/JSCalendarContrib/lang/calendar-si.js
  pub/TWiki/JSCalendarContrib/lang/calendar-sk.js
  pub/TWiki/JSCalendarContrib/lang/calendar-sp.js
  pub/TWiki/JSCalendarContrib/lang/calendar-sv.js
  pub/TWiki/JSCalendarContrib/lang/calendar-tr.js
  pub/TWiki/JSCalendarContrib/lang/calendar-zh.js
  pub/TWiki/JSCalendarContrib/lang/cn_utf8.js
  pub/TWiki/JSCalendarContrib/skins/aqua/active-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/dark-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/hover-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/menuarrow.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/normal-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/rowhover-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/status-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/theme.css
  pub/TWiki/JSCalendarContrib/skins/aqua/title-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/today-bg.gif
  pub/TWiki/JSCalendarContrib/skins/aqua/transparent-bg.png
  pub/TWiki/JSCalendarContrib/menuarrow.gif
  pub/TWiki/JSCalendarContrib/menuarrow2.gif
  pub/TWiki/JSCalendarContrib/multiple-dates.html
  pub/TWiki/JSCalendarContrib/README
  pub/TWiki/JSCalendarContrib/release-notes.html
  pub/TWiki/JSCalendarContrib/simple-1.html
  pub/TWiki/JSCalendarContrib/simple-2.html
  pub/TWiki/JSCalendarContrib/simple-3.html
  pub/TWiki/JSCalendarContrib/test.php
  pub/TWiki/JSCalendarContrib/test-position.html

• Make sure that all files are readable by the web server user

Contrib Info

Author:	TWiki:Main/CrawfordCurrie http://www.c-dot.co.uk
Version:	10613 of the Mishoo calendar
Copyright ©:	See the Mishoo documentation
License:	GPL (GNU General Public License)

|

Dependencies:	None
Change History:
10247	Item2054 put the calendar at z-index 2000, way above pattern skin divs.
6634	Item453 removed EditTablePlugins private copy of the Mishoo JS calendar, and made sure it works with JSCalendarContrib. Improved the documentation of the JSCalendar while I was there.
6626	Item468 updated docs for Dakar release
5048	Cairo readiness
5039	Split from SharedCode?
27 Dec 2005	updated to calendar version 1.0; set style for Safari to win2k-1
14 Aug 2004	Separated out from SharedCode? module
Home:	http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContrib
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContribDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContribAppraisal

Related Topics: TWikiPreferences

Language selection dropdown

To be included where a language selection is needed, for instance in the top bar or left bar.

Note: this dropdown is only shown if localization is enabled.
Test: localization is not enabled

Usage:

%INCLUDE{%TWIKIWEB%.LanguageSelector}%

Result:

The name you log in with

A login name is a sequence of alphanumeric characters and underscores.

You cannot alter your LoginName: you have to get the administrator to do this for you.

How to find yours

Look in TWikiUsers - if your name is followed by a dash and a word, usually lowercase, this is what you log in with.

e.g.

• TWikiGuest - guest - 05 Sep 2004

Would mean that TWikiGuest would log in using the login name 'guest'

If, on the other hand, if your entry is like this:

• TWikiGuest - 05 Sep 2004

Then you would log in using your WikiName, in this case 'TWikiGuest'

Related Topics: UserDocumentationCategory

MailerContrib

Add-on to the TWiki kernel that supports e-mail notification of changes.

WARNING: TWiki-4 only. If you want to use this extension with an earlier version of TWiki, please see here

Summary of Contents

tools/mailnotify

The main part of the mailer module is a script, tools/mailnotify. This script is designed to be run from 'cron' (or an equivalent offline job scheduler), and processes the contents of the standard WebNotify topic. As well as providing the usual notification service, it also provides per-topic notification services. The script may be run from the command line or a cron job.

Subscribers are listed in WebNotify following one of these bullet list formats:

three spaces * [ webname . ] wikiName - SMTP mail address
three spaces * [ webName . ] wikiName
three spaces * SMTP mail address
three spaces * SMTP mail address : topics
three spaces * [ webname . ] wikiName : topics

where topics is a space-separated list of topic names.

• Specify topics without a Web. prefix
• Topics must exist in this web.
• Topics may be specified using * wildcards
• Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
• Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic" (the same as not putting anything). The '-' sign means "don't send notifications regarding this topic". This allows users to elect to filter out changes to certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+').

For example:

   * daisy@flowers.com
   * daisy@flowers.com: Web*
   * DaisyCutter: Petal* (1) WeedKillers (3) Red*Phlox
   * StarTrekFan: * - *Wars - *sInTheirEyes - *shipTroopers

A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified of changes to that topic once.

If a TWiki group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.

Tip: List names in alphabetical order to make it easier to find the names.

In the future it is intended that individual users will be able to control the frequency with which they are notified of topic changes, by changing a schedule specification in their home topic. However at present, the notification schedule is controlled by the frequency of activation of the cron job that runs the mailnotify script.

Note mailnotify ignores permissions in webs. It is entirely possible for a user to get added to a WebNotify topic in a web, when they are not authorised to view the topics in that web. This could result in them having limited access to sensitive information (the topic summaries).

TWiki/Contrib/MailerContrib code library

The second part of the module is a code library that provides the services for other applications to modify WebNotify through a clean, well documented interface. This allows (for example) plugin developers to add a "Register me for notification" button to their pages. The main interface is the WebNotify package described below.

Installation Instructions

This Contrib is pre-installed as part of the TWiki release package, and should only have to be re-installed if an upgrade is required.

• Download the ZIP file from the Plugin web (see below)
• Unzip MailerContrib.zip in your twiki installation directory.
• Run the installer script MailContrib_intaller.pl or alternatively resolve all dependencies manually.
• To make sure the installation was successful, run the mailnotify script from the command line, with no parameters. In this case it will print out what it would have done to STDOUT.

Setting up your cron job

You need to set up a cron (or equivalent) job to run mailnotify.

Usage: perl -I <bin> mailnotify [-q] [ web1 web2 ... webN ] <bin> is the path to the TWiki bin directory (usually ../bin), so that the script can find the rest of TWiki.

-q	Don't print progress information
web1 web2 ... webN	List of webs to process, separated by spaces or commas. Default is to process all legal TWiki webs. Wildcards (*) are supported.

For example, perl -I /usr/local/twiki/bin mailnotify -q Public Private will generate notifications for the Public and Private webs.

Settings

• Set STUB = TWiki::Contrib::Mailer
• Set SHORTDESCRIPTION = Supports e-mail notification of changes.

Contrib Info

Author:	TWiki:Main/CrawfordCurrie (http://c-dot.co.uk)
Copyright ©:	2004, Wind River Systems
License:	GPL
Change History:
8808	Item1654 mailnotify must enter the command_line context
8625	Item1508 Making the dashes in the separatator clearer
8606	Item1508 MailerContrib: Brushing up HTML mailnotify template
8602	Item1508 MailerContrib: Cleaning up plaintext e-mail template, removing TEXTAREA
8522	Item1511 arguments to getScriptUrl in wrong order
8434	Item1465 Fix 'TWiki.' to '%TWIKIEB%.'
8398	Item1460 polished up the comment a bit
8308	Item1362 moving mailnotify cron script
7848	Item1167 forced all mail operations to generate absolute URLs
7568	Item910 use SCRIPTURL{view} instead of complex url expr
6864	Item624 mailer templates moved the the right places
6861	Item624 Added proper templates support for plain text mails
6809	Item623 don't print anything if verbosity is switched off.
6659	Item528 Updated MailerContrib. it's working and the sendmail parameter is used.
6474	Item420 removed spurious remove_obsolete_locks from MailerContrib
5924	Item153 fix mail URL-fixing scheme
5269	Minor doc fixes
5266	Doc tidy-ups, added filtering of _ webs, added obsolete lock script
5264	Changed default to add web name to user name (I hope)
5263	Minor doc tidyups
5261	Documentation changes, and fixed to scan all webs.
5253	runnable as CGI script, minor bugfixes, removed dependency on DBCacheContrib?
5234	Minor doc changes
5231	Made a change an object, added unit tests to CVS, lots of testing.
4 March 2005	1.010 Dakar release ready.
12 Oct 2004	1.004 Added support for anti-subscriptions. Doc fixes from TWiki:Main.PeterThoeny. Bug fixes to permissions code. Back-off and retry if the mailer can't be reached (should really be in Net::sendEmail)
6 Oct 2004	1.003 Excluded _ webs from processing, added bin/remove_obsolete_locks for full reverse-compatibility
1 Oct 2004	1.002 PeterThoeny provided additional documentation
27 Sep 2004	1.001 runnable as CGI script, minor bugfixes, removed dependency on DBCacheContrib
8 Sep 2004	1.000 Initial version
Home:	TWiki:Plugins/MailerContrib
Feedback:	TWiki:Plugins/MailerContribDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/MailerContribAppraisal

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: To edit a page, simply click on the Edit link at the top or bottom of the page.
• Auto links: Web pages are linked automatically. You do not need to learn HTML commands to link pages.
• Text formatting: Simple, powerful and easy-to-learn text formatting rules. Basically you write text like you would write an e-mail.
• Webs: Pages are grouped into TWiki webs (or collections). This allows you to set up separate collaboration groups.
• Search: Full text search with/without regular expressions. See a sample search result.
• E-mail notification: Get automatically notified when something has changed in a TWiki web.
• Structured content: Use TWikiForms to classify and categorize unstructured web pages and to create simple workflow systems.
• File attachments: Upload and download any file as an attachment to a page by using your browser. This is similar to file attachments in an e-mail, but it happens on web pages.
• Revision control: All changes to pages and attachments are tracked. Retrieve previous page revisions; compare differences; find out who changed what and when.
• Access control: Define groups and impose fine-grained read and write access restrictions based on groups and users.
• Variables: Use variables to dynamically compose your pages. This allows you for example to dynamically build a table of contents, include other pages, or show a search result embedded in a page.
• TWiki plugins: Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl using the TWiki Plugin API.
• Templates and skins: A flexible templating system separates program logic and presentation. Skins overwrite template headers and footers; page content is unaffected.
• Managing pages: Individual pages can be renamed, moved and deleted through the browser.
• Managing users: Web-based user registration and change of password.
• Statistics: Create statistics of TWiki webs. Find out most popular pages and top contributors.
• Preferences: Three levels of preferences: TWikiPreferences for site-level, WebPreferences for each web, and user level preferences.
• simultaneous page editing:
• Referred-By: Find the pages that contain links to a topic.

Related Topics: UserDocumentationCategory, AdminDocumentationCategory

Managing Topics

Browser-based rename, move, and delete for individual topics

Overview

You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hidden Trash web.

How to Rename/Move/Delete a Topic

1. Click on [More] (bottom right of page) on the topic to be changed, then, in the new screen, on [Rename/move]. You can now rename and/or move/delete in one operation:
2. Move/Delete: Select the target web if other than the current web - choose Trash to delete a topic.
3. Rename: Enter the new topic name - default is current name
   NOTE: You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.
4. Prevent updates by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, all referring links will be updated).
5. Click on [Rename/Move]: the topic will be renamed and links to the topic updated as requested.
   • If any of the referring pages are locked then they will be listed: you can correct these later by again pressing [Rename/Move].
   • There is a Put back feature that allows you to undo a Rename/Move/Delete - an instruction line and undo link will appear at the bottom of the modified topic. This allows you to revert from the last modification only.

Deleted Topics: How to Clear the Trash

Deleted topics are moved to a special Trash web - they are NOT physically erased from the server. All webs share Trash - in case of a name conflict with a topic already Trash, the user is alerted and asked to choose a new name.

The Trash web should be be cleared periodically, by archiving (saving) the text and RCS files if required (recommended), then deleting them from the Trash directory.

• This can only be done from on the server, not through the browser.
  • Since simple FTP access to the Trash directory is all that's required for maintenance, it's possible to grant Trash admin privileges to multiple users, while strictly limiting server access.

Redirecting from an Old Topic

You can use TWikiMetaData to place a command in the WebTopicViewTemplate and WebTopicNonWikiTemplate that will indicate that a topic has been moved by searching for the tag %META:TOPICMOVED{...}%. Customize something like this:

%<nop>METASEARCH{type="topicmoved" web="TWiki" topic="ManagingTopics" 
title="This topic used to exist and was moved to: "}%

How Rename/Move Works

1. %SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant TWikiMetaData definitions.
   • User can omit one or more topics from the update list by unchecking them.
   • <pre> and <verbatim> are honoured - no changes are made to text within these areas.
2. The topic is moved (if locks allow).
3. References are changed (locks and permissions permitting).
4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.

How Referring Topics Are Found

First, matching topics in the current web are listed - matches are to topic. Next, all webs (including the current one) are listed that match web.topic. All webs will be searched during rename, even if NOSEARCHALL is defined on a web, though access permissions will of course be honoured.

Changed references are kept are as short as possible, ex: topic is used in preference to web.topic.

Effect of User Access Settings

User permissions affect the Rename function in various ways. To rename a topic, you need both ALLOWTOPICCHANGE and ALLOWTOPICRENAME permission for that topic. To alter referring topics, you need change permission. See TWikiAccessControl for information on setting up access permissions.

Special Considerations

Consider carefully whether to make browser-based Rename/Move/Delete widely available, or to restrict it to an administrator/moderator group. Allowing all users to easily manipulate topics can be extremely useful in refactoring a busy web or site. However, there are at least two significant potential drawbacks to take into account:

• When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
• Due to current limitations, fairly heavy use of Rename/Move/Delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename... is used heavily, these negatives will obviously increase, in number and effect.

Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall.

Known Issues

Rename/Move is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present. Instead, %SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that search can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different.

The following shows some limitations of square bracket processing.

[[Old Topic]]  => [[NewTopic][Old Topic]]
[[old topic]]  => [[NewTopic][old topic]]
[[old t opic]] => not changed
[[OldTopic]]   => [[NewTopic]]

Related Topics: UserDocumentationCategory, AdminDocumentationCategory

Manage Users

Register users on your TWiki site; change/reset/install passwords; remove user accounts

Authentication and Access Control

• TWikiUserAuthentication describes options of user authentication
• TWikiAccessControl describes how to define groups and how to restrict access to content

Register User

It is not necessary to have user home pages in the TWiki system for Authentication to work - see TWikiUserAuthentication for details.

• TWikiRegistration is for users to fill out a form
• NewUserTemplate can be changed to customize user home pages, it can optionally use the UserForm to define user fields as meta data
• BulkRegistration is for administrators to use to set up one or more accounts: either from a table or from an external file

Change, Reset and Install Passwords

• ChangePassword is for users who can remember their password and want to change it
• ResetPassword is for users who cannot remember their password; a system generated password is e-mailed to them
• BulkResetPassword if for administrators who want to reset many passwords at once

Removing User Accounts

To remove a user account (FredQuimby, who logs in as "fred"):

1. If you are using a .htpasswd file, edit the .htpasswd file to delete the line starting fred:
   • Warning: Do not use the Apache htpasswd program with .htpasswd files generated by TWiki! htpasswd wipes out email addresses that TWiki plants in the info fields of this file.
2. Remove the FredQuimby - fred line from the Main.TWikiUsers topic
3. Remove FredQuimby from all groups and from all the ALLOWWEB/ALLOWTOPIC... declarations, if any.
   Note: If you fail to do this you risk creating a security hole, as the next user to register with the wikiname FredQuimby will inherit the old FredQuimby's permissions.
4. [optional] Delete their user topic Main.FredQuimby.

Note: Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like AnUncreatedTopic^?. If you want to make it clear the user is no longer with the organization or has been banished, replace the topic content with a note to that effect. The existance of the UserName topic should also prevent that user name from being re-used, sealing the potential security hole regarding inherited permissions..

Related Topics: AdminDocumentationCategory

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 of collaboration. Administrators (in the TWikiAdminGroup) can add/rename/delete webs.

Choose Web Template

There are two methods used to create a new web. First you can use a specially designed TemplateWeb. This is an invisible web that begins with an underscore "_" character (for example _default). All topics in the template web will be copied into your new web.

The second method is to use an existing web as a template web. This may be useful if you already have a web that you would like to use as a starting point. Only topics that have names beginning with Web... (like "WebHome", "WebNotify", etc.) are copied.

In either case you will want to be sure to verify that your new web has all the custom modifications that you desire.

Adding a New Web

Create a new web by filling out this form.
Note: Keep the number of webs to a minimum! It is not recommended to create a new web for each little project. You can organize content within a web using categories, TWikiForms and FormattedSearch. Cross-linking topics and search is easier if there are only a few larger webs.

Name of new web:		The name must start with an upper case letter, followed by upper or lower case letters or numbers. Specify a short name to avoid long URLs.
Based on web:	_default _empty Handbook Main Sandbox Shahrazad Silk TWiki Waqwaq	Select a TemplateWeb
Web color:		Enter a StandardColors code for the web
Description:	Enter a short description of the web. Write Web.TopicName instead of just TopicName if you include links. This will list the web in the SiteMap (leave field empty if you prefer not to update the directory.)
Use to...	Continue the sentence describing the intended use. This is also for the SiteMap
Set NOSEARCHALL:	No   Yes	Specify if you want to exclude the web from a "search all webs" search. This will not prevent users accessing the web. It will simply hide it from searches.

Notes:

• Attachments will NOT get copied over along with their topics
• While creating the new web, TWiki will update the following variables in the WebPreferences: WEBBGCOLOR, SITEMAPLIST, SITEMAPWHAT, SITEMAPUSETO and NOSEARCHALL. These variables are used to dynamically generate the SiteMap
• TWiki does not edit the TWiki.TWikiPreferences to update the WIKIWEBLIST. This must be done by hand

Renaming or Deleting a Web

Rename a web via the Tools section in each web's WebPreferences topic. You may delete a web by moving it into a Trash web.

Permissions

You may only rename a web if you have permissions to rename all the topics within that web, including any topics in that web's subwebs. You will also need permissions to update any topics containing references to that web.

Edit Conflicts

If anyone is editing a topic which requires updating, or which lives in the web being renamed, a second confirmation screen will come up which will indicate which topics are still locked for edit. You may continue to hit the refresh button until an edit lease is obtained for each topic which requires updating (the "Refresh" button will change to "Submit"), or hit "Cancel", which will cancel your edit lease on all affected topics.

Renaming the webs in the distribution

If you plan to rename the Main web, remember that TWiki stores user and group topics in this web. That means that every WikiName signature - Main.SomeUserName - points to it and would need updating (unless the variable, %MAINWEB%.SomeUserName, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of WebPreferences, as described above.

If you want to rename the TWiki or Main webs, remember they are referred to in the TWiki configuration. You will need to change the relevant settings in the configuration using the configure interface.

Hierarchical Webs

Hierarchical web support is enabled by turning on the {EnableHierarchicalWebs} setting in configure. Without this setting, TWiki will only allow a single level of hierarchy (webs). If you set this, you can use multiple levels, like a directory tree, i.e. webs within webs.

Note: You might not need hierarchical webs. TWiki topics already have a parent/child relationship within a web, which is shown in the breadcrumb. Try to keep the number of webs to a minimum in order to keep search and cross-referencing simple.

You can create hierarchical webs via the Adding a New Web form above, by using a slash- or dot-separated path name which is based on an existing web name in the Name of new web: field.

Example:

To create a subweb named Bar inside a web named Foo, use Foo/Bar or Foo.Bar as the new web name in the form above.

Subweb Preferences are Inherited

The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the TWiki.TWikiPreferences topic.

Example Preference Inheritance for Sandbox/TestWeb/SubWeb.SubWebTopic topic:

1. TWiki.TWikiPreferences site-wide preferences
2. Sandbox.WebPreferences inherits from and overrides settings in TWiki.TWikiPreferences
3. Sandbox/TestWeb.WebPreferences inherits from and overrides settings in Sandbox.WebPreferences
4. Sandbox/TestWeb/SubWeb.WebPreferences inherits from and overrides settings in Sandbox/TestWeb.WebPreferences
5. Sandbox/TestWeb/SubWeb.SubWebTopic inherits from and overrides settings in Sandbox/TestWeb/SubWeb.WebPreferences

Navigation

The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.

Related Topics: AdminDocumentationCategory, AdminToolsCategory

ManagingTopics can be used to move a topic from one Web to another. One specialised use of this is DeleteWeb^?.

Related Topics: UserDocumentationCategory

%SPLIT%

• %KEY%: %VALUE%%SPLIT%

Announcements

Type %WZMA% to get an automatic link to WZMA! Idem with NIKI, POL, WILC. -- VladAtanasiu - 13 Sep 2006

Open issues

My Links

• ATasteOfTWiki - view a short introductory presentation on TWiki for beginners
• WelcomeGuest - starting points on TWiki
• TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference
• Sandbox - try out TWiki on your own
• NewUserTemplateSandbox^? - just for me

My Personal Data

Note: if personal data is being stored using a secret database, then it is only visible to the user and to administrators.

E-mail

%USERINFO{"NewUserTemplate" format="$emails"}%

My Personal Preferences

Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in TWikiPreferences.

• Show tool-tip topic info on mouse-over of WikiWord links, on or off:
  • #Set LINKTOOLTIPINFO = off
• Horizontal size of text edit box:
  • #Set EDITBOXWIDTH = 70
• Vertical size of text edit box:
  • Set EDITBOXHEIGHT = 35
• Style of text edit box. width: 99% for full window width (default), width: auto to disable.
  • #Set EDITBOXSTYLE = width: 99%

Note: Don't write-protect your home page with ALLOWTOPICCHANGE. Other users won't be able then to leave you messages.

Related Topics

• ChangePassword for changing your password
• ChangeEmailAddress for changing your email address
• TWikiUsers has a list of other TWiki users
• UserDocumentationCategory is a list of TWiki user documentation
• UserToolsCategory lists all TWiki user tools

Note to TWiki Administrator:

Above text is for English speaking users. If you have a multilingual wiki community you can replace the "My Links", "Personal Preferences" and "Related Topics" sections above with the localized text below. Text enclosed in %MAKETEXT will be shown in the language selected by the user. Please note that the %MAKETEXT can be quite intimidating to new users. Consider translating above text to your own language if your community uses a non-English language. (Remove all text from %STARTSECTION{type="templateonly"}% to %ENDSECTION{type="templateonly"}% when you are done)

Text for multilingual wiki community, copy from here to %ENDSECTION{type="templateonly"}%

My Links

• ATasteOfTWiki - view a short introductory presentation on TWiki for beginners
• WelcomeGuest - starting points on TWiki
• TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference
• Sandbox - try out TWiki on your own
• NewUserTemplateSandbox^? - just for me

Personal Preferences

Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in TWikiPreferences.

• Show tool-tip topic info on mouse-over of WikiWord links, on or off:
  • #Set LINKTOOLTIPINFO = off
• Horizontal size of text edit box:
  • #Set EDITBOXWIDTH = 70
• Vertical size of text edit box:
  • #Set EDITBOXHEIGHT = 22
• Style of text edit box. width: 99% for full window width (default), width: auto to disable.
  • #Set EDITBOXSTYLE = width: 99%
• Write protect your home page: (set it to your WikiName)
  • Set ALLOWTOPICCHANGE = TWikiGuest

Related Topics

• ChangePassword for changing your password
• ChangeEmailAddress for changing your email address
• TWikiUsers has a list of other TWiki users
• UserDocumentationCategory is a list of TWiki user documentation
• UserToolsCategory lists all TWiki user tools

An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example:

package Telecoms

ClassMethod new()

ObjectMethod phone( $who )

must be called something like this

my $mobile = new Telecoms();
$mobile->phone( "home" );

or you can pass the object in as a parameter if you need to:

Telecoms::phone( $mobile, "home" );

Related Topics: ClassMethod, StaticMethod, DeveloperDocumentationCategory

Pattern skin

PatternSkin is developed to provide a CSS based default look and feel for TWiki - flexible and W3C-compliant. Its layout and color scheme are designed to provide a nice, clean and productive editing environment. For use in corporate or perhaps in personal websites it should be fairly easy to tune the looks or even create a PatternSkin-based new skin.

Screen Shot

Creating your own look

It is easy to tune the look and feel of PatternSkin by changing the color and space (margin, padding) settings in the Style Sheet files.

You may also choose to radically change the look and create a PatternSkin-based new skin. This is easier than to create a skin by writing new template files; you can concentrate on how things should look instead of what elements should get displayed.

• PatternSkinCustomization - how to configure page elements
• PatternSkinCssCookbook - how to customize the default look of TWiki
• PatternSkinCss - documentation of PatternSkin CSS classes

Supported browsers

PatternSkin has been tested successfully on the following browsers:

• Windows
  • Internet Explorer 6.0, 5.5 (note: Explorer 5.0 is not supported: will function but shows visual quirks)
  • Mozilla/Firefox
• Mac OS X
  • Safari 2.0.3
  • Mozilla/Firefox 1.5 (note: Firefox 1.0 will show visual quirks)
• *nix
  • Mozilla/Firefox 1.5 (note: Firefox 1.0 will show visual quirks)

Installation

Note: You do not need to install anything on the browser to use this skin. The following instructions are for the administrator who installs the skin on the server where TWiki is running.

Note 2: PatternSkin is included with TWiki by default. Use the following instructions only if you are upgrading PatternSkin.

• Download the ZIP file from the Skin Home page (see below)
• Unzip PatternSkin.zip in your twiki installation directory
• Test if installed: /twiki/bin/view/TWiki/PatternSkin?skin=pattern
• For skin activation see TWikiSkins

Troubleshooting

If you have set the SKIN variable setting to pattern and you still don't see the layout as on the screenshot, a few settings in may have been disabled.

Check these variables here:

• TWIKILAYOUTURL = /twiki/pub/TWiki/PatternSkin/layout.css
• TWIKISTYLEURL = /twiki/pub/TWiki/PatternSkin/style.css
• TWIKICOLORSURL = /twiki/pub/TWiki/PatternSkin/colors.css
• SKIN = pattern

If TWIKILAYOUTURL or TWIKISTYLEURL don't give a value or point to non-existing files, check in TWikiPreferences that the following variables do exist and that they are set to on:

   * %TWIKIWEB%.PatternSkin settings:
      * Set TWIKILAYOUTURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/layout.css
      * Set TWIKISTYLEURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/style.css
      * Set TWIKICOLORSURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/colors.css

If this still does not work, contact the administrator who installs skins.

For further troubleshooting and feedback, go to TWiki:Plugins/PatternSkinDev. Report bugs in the Support web.

Skin Info

Description:	TWiki's default skin; CSS based, flexible and W3C-compliant
Screenshot:
Preview:	Preview with this topic
Base Name:	pattern
Skin Author:	TWiki:Main/ArthurClemens
Skin Version:	31 Jan 2006 (v2.0.0)
History:
31 Jan 2006:	v.2.0.0 - DAKAR RELEASE VERSION
28 Aug 2004:	v.1.0.9 - CAIRO RELEASE VERSION
08 Aug 2004:	Initial version (v1.0.0)
Dependencies:	TWiki:Plugins/TwistyContrib (automatically supported by Dakar)
Skin Home:	http://TWiki.org/cgi-bin/view/Plugins/PatternSkin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/PatternSkinDev
Download:	http://TWiki.org/cgi-bin/view/Plugins/PatternSkin

Related topics

• TWikiCss
• PatternSkinCss
• PatternSkinCssCookbook
• PatternSkinCssCookbookCenterPage
• PatternSkinCssCookbookEditTableStyle
• PatternSkinCssCookbookFonts
• PatternSkinCssCookbookNoLeftBar
• PatternSkinCssCookbookNoTopBar
• PatternSkinCustomization
• PatternSkinJavascripts
• WebBottomBar
• WebLeftBar
• WebLeftBarCookbook
• WebLeftBarExample
• WebLeftBarLogin
• WebLeftBarPersonalTemplate
• WebLeftBarSearch
• WebLeftBarWebsList
• WebTopBar
• AdminDocumentationCategory

Other skins:

• TWikiSkins
• TWikiSkinBrowser

Feedback

Leave remarks, suggestions and other feedback in TWiki:Plugins.PatternSkinDev.

CSS elements in PatternSkin

This page is a reference for all CSS classes used in PatternSkin.

PatternSkin uses 4 stylesheets:

• layout.css: positioning of block elements on the page
• style.css: margins, paddings, borders, font sizes
• colors.css: text colors, background colors, border colors
• print.css: optimalizations for printed page

If you want to learn how to create your own look or skin based on PatternSkin, read further in PatternSkin.

Naming conventions

• All PatternSkin specific classes have the prefix pattern: patternEditPage, patternTopicAction, etcetera.
• TWiki specific classes (emitted by the TWiki engine) have the prefix twiki: twikiButton, twikiToc, etcetera. See for a complete list TWikiCss.
• Positional containers are referred by id, for instance #patternLeftBar.

Namespaces

PatternSkin uses namespaces for templates, by adding one (sometimes two - multiple) class names to the template's body tag.

• The body tag in view.pattern.tmpl for instance has the class name "patternViewPage": <body class="patternViewPage">. All CSS elements specific to the view template thus can be defined as .patternViewPage .someClassName.
• All templates that are not the view template have the body class name "patternNoViewPage". That makes it easy to give all of these pages a different layout in one sweep (smaller or wider margins for instance). Template edit.pattern.tmpl uses <body class="patternNoViewPage patternEditPage">.

Page type classes

• .patternViewPage
• .patternViewPage .patternPrintPage
• .patternNoViewPage
• .patternNoViewPage .patternEditPage
• .patternNoViewPage .patternAttachPage
• .patternNoViewPage .patternChangeFormPage
• .patternNoViewPage .patternDiffPage
• .patternNoViewPage .patternRenamePage
• .patternSearchResultsPage
• .patternPlainPage (viewplain.pattern.tmpl)

Layout classes

• Main layout elements (in order of appearance in body.pattern.tmpl)
  • #patternScreen - outer container, used when centering the page (see PatternSkinCssCookbookCenterPage)
  • #patternPageShadow - shadow border around patternPage; default not used (see PatternSkinCssCookbookCenterPageBorder)
  • #patternPage - html content container
  • Left bar:
    • #patternWrapper
    • #patternLeftBar - left bar area
    • #patternLeftBarContents - used for left menu
  • #patternOuter - wrapper container
  • #patternFloatWrap - wrapper container
  • #patternMain - center area
  • #patternMainContents - holder of patternTop, patternTopic, twikiForm, twikiAttachments, etc.
  • #patternTopBar - top bar area
  • #patternTopBarContents - header art / logo; contains topic WebTopBar
  • #patternBottomBar - bottom bar area
  • #patternBottomBarContents - copyright

Style classes

• View
  • .patternContent - container around .patternTopic in view.pattern.tmpl only; to be able to give .twikiAttachments and .twikiForm a different appearance when they are not enclosed by it, for example the personal data form on the user pages (where the user form is positioned outside, above the topic text)
  • .patternTopBarLogo - logo position in patternTopBar (topic WebTopBar)
  • .patternTopBarOverlay - striped white image background
  • .patternTopic - TWiki topic text
  • .patternTop - area at top of topic text, with patternHomePath, revision and action buttons
  • .patternTopicActions - container for multiple .patternTopicAction rows
  • .patternTopicAction - container for .patternActionButtons
  • .patternActionButtons - action buttons at bottom of page
  • .patternMoved - topic moved info (only visible when the topic has changed name or web)
  • .patternWebIndicator - colored block at the top of the left bar to indicate the current web
  • .patternFormHolder - container around form to manage the size of form elements
  • .patternLeftBarPersonal - block of personal links (included topic %MAINWEB%.%USERNAME%LeftBar)
  • .patternHomePath - breadcrumb at top
  • .patternHomePathTitle - "You are here" text
  • .patternRevInfo - revision info and author name
  • .patternToolBar - holder for .patternToolBarButtons
  • .patternToolBarButtons - action buttons at top of page
  • .patternToolBarBottom - seperator
  • .patternSimpleLogo - logo used on 'simple' pages like the login screen
  • .patternButton - tab button Edit, Attach, Printable at top of topic
  • .patternMetaMenu - search box, jump box, language selector

• Edit
  • .patternSig - signature copy box
  • .patternSaveOptions - holder for .patternSaveOptionsContents
  • .patternSaveOptionsContents - checkboxes that change the state of a topic save; for instance "Force revision" checkbox
  • .patternSaveHelp - info block with help on save options (access keys and potentially other info)

• Preview page
  • .patternPreviewArea - container around preview of .patternTopic

• Attach page
  • .patternPrevious - attachment table of previous versions
  • .patternMoveAttachment - container for "Move or Delete attachment"
  • .patternAttachForm

• Rename (rename, move, delete)
  • patternRenameOptionsList - list of topics that can be updated

• More
  • patternDiffOptions - row of revision options under "Compare revisions"

• Search results
  • .patternSearchResults - container on rename pages (no longer used on actual search results 'view' pages)
  • .patternSearchResultsHeader - horizontal bar with the web color
  • .patternSearchResults - block of one result
  • .patternSearchResultCount - the number of results
  • .patternSearched - feedback on the string used to search

• WebLeftBarSearch
  • .patternFormButton
  • .patternChangeLanguage - change language button (deprecated)

Related Topics: TWikiSkins, AdminDocumentationCategory