This is a short introductory training course for TWiki beginners. A Taste of TWiki The basic function of TWiki is a Wiki (if that helps!) A Wiki is like a web si...
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 ha...
FAQ: How can I create a simple TWiki Form based application? Answer: 1 Create a TWiki Form and define fields (see TWikiForms for details) 1 Add the form in...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names This topic addresses implemented UTF 8 ...
Backup Restore Plugin Beta Version Overview This is a solution to backup, restore and upgrade TWiki sites. It can be used via browser and on the command line. ...
Behaviour Javascript Framework Contrib Introduction This contrib packages the third party Behaviour Javascript event library, available from http://bennolan.com/...
Classic Skin The classic TWiki skin is a bare bone and functional skin, supporting any browser, and has a minimum of graphics This is not really a skin. It is the...
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 m...
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 ...
Use the "Minor changes, don't notify" checkbox when saving a page in case you only make a minor change to a topic and you do not want to inform everybody who is o...
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...
Normally, if you make subsequent edits within a one hour period (configuration item {ReplaceIfEditedAgainWithin}), Foswiki will fold together your changes. This ...
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 ...
Google Analytics Plugin Adds Google Analytics javascript code to specified pages. %TWISTY{ mode="div" class="twikiNotification" showlink=" #9658; Changes in versi...
Headlines Plugin Description This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news. Note: Syndic8.com ( h...
Hide/Unhide Attachments You can hide/unhide file attachments in normal topic view. * In the FileAttachment table, click on an action link, * enable the "H...
Jump Box The Jump Box at the top or sidebar of each page is a hidden gem for quick navigation in a large TWiki. 1. Quick Jump: Enter a topic name to quickly jump ...
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...
Color scheme settings for .PatternSkin Use this topic to change the color settings of .PatternSkin. When this topic is saved, the attachment theme colors.css will...
Personal Preferences Help Below help text gets included by user homepages instantiated from NewUserTemplate or .NewUserTemplate (if exists) Note: TWiki h...
Peter Thoeny Founder and BDFL of TWiki and TWiki.org, co founder and CTO of Twiki Inc, inventor of structured wikis, co author of Wikis for Dummies book, speaker....
Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentation...
Foswiki Release 1.0.10 08 Sep 2010 Foswiki The Free and Open Source Wiki Foswiki is an enterprise collaboration and information sharing tool targeted for pro...
FAQ: 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: That is an indication...
FAQ: What happens if two of us try to edit the same topic simultaneously? Answer: TWiki allows multiple simultaneous edits of the same topic, and then merges the...
TWiki Source Code Packages This documentation is automatically generated from the pod, so it always matches the running code This package doesn't smell This pa...
Foswiki Spreadsheet Plugin This Plugin adds spreadsheet capabilities to Foswiki topics. Formulae like %CALC{"$INT(7/3)"}% are evaluated at page view time. They ca...
Welcome to Foswiki. This page assumes that you are a new user to Foswiki, and that you've never heard of Wiki before. Here are the most important pages you should...
TWiki Access Control Restricting read and write access to topics and webs, by Users and groups TWiki Access Control allows you restrict access to single topics an...
TWiki Add Ons Add functionality to TWiki with extensions not based on the TWiki scripts. Overview An add on runs separately from the TWiki scripts, e.g. for data...
TWiki Contribs Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the functionality of TWiki, typically used by plug...
Appendix C: TWiki CSS Listing of CSS class names emitted from TWiki core code and standard plugins. Who should read this document? Most HTML elements generated b...
TWiki Documentation Graphics and File Type Icons This is the TWiki icon library. The graphics can be used in topics and by web applications. Doc graphics are defi...
Site Documentation Graphics %NOP{ Do not modify this system topic. This is the template topic for .SiteDocGraphics, instantiated in .TWikiDocGraphics . }% Si...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiEnhance...
FAQ: I would like to install TWiki on my server. Can I get the source? Answer: TWiki is distributed under the GnuGeneralPublicLicense. You can get the source fro...
TWiki Enhancement Requests The TWiki community is looking forward to getting feedback from the actual TWiki user base. You can help make TWiki a better product by...
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...
TWiki Forms Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database a...
TWiki Glossary Simple glossary of TWiki terms Term Definition Attachment: Any type of file that is uploaded via browser and attached to a topic, where i...
Appendix A: TWiki Development Time line #HelsinkiRelease TWiki Release 5.0 (Helsinki) released on 2010 05 29 2010 10 10 New Features and Enhancements of TWiki ...
TWiki Installation Guide The following is installation instructions for the TWiki 5.0 production release on an Apache web server on Linux. Visit TWiki:TWiki.Insta...
TWiki Javascripts This topic contains JavasSript files that are included by TWiki templates, and may be used by skin templates and in topics. * Set ALLOWTOPICC...
TWiki Logos The official TWiki logo is a big "T" in a speech bubble conveying "working together", and has a "collaborate with TWiki" tag line. TWiki.org Logo Ar...
#TWikiMetaData TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored embedded in the topic text using META: tags Overview By de...
TWikiNetSkin Introduction The TWikiNetSkin is functional and clean and has corporate appeal. It is the default skin provided with Twiki, Inc. products, designed ...
Color scheme settings for TWikiNetSkin * Set SKIN = twikinet,pattern Usage Step 1 Let .TWikiNetSkin point to the custom made colors style sheet. In .TWik...
TWikiNetSkin Plugin Helps TWikiNetSkin to render tables and h2 headers. This plugin is only enabled if the skin is set to twikinet. Syntax Rules (none) Plugin S...
TWiki Plugins Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You can add plugins to extend TWiki functionality,...
TWiki Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of the TWiki Enterprise Collaborat...
TWiki Release 4.0 (Dakar) Note: This is the release note for the previous major release version 4.0.X. It is included with 4.1.X because it contains valuable info...
TWiki Release 4.1.2 (Edinburgh), 2007 03 03 Note: This is the release note for the previous major release version 4.1.X. This note and the TWikiReleaseNotes04x00 ...
TWiki Release 4.2.4 (Freetown), 2008 12 06 Note: This is the release note for the previous major release version 4.2.X. This note, TWikiReleaseNotes04x00 and TWik...
Release Notes of TWiki 4.3.2 (Georgetown), 2009 09 02 Note: This is the release note for the previous major release version 4.3.X. This note, TWikiReleaseNotes04x...
Release Notes of TWiki 5.0.1 (Helsinki), 2010 10 10 Introduction TWiki 5.0.0 released on 2010 05 29 is a major release introducing usability enhancements, featur...
Rendering Shortcuts Easy ways to save some typing Some TWiki preferences variables are just shortcuts for convenience, to either save typing or to easily allow li...
TWiki CGI and Command Line Scripts Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki scripts are located in...
TWiki Site TWiki is a Web based collaboration platform * A TWiki site is an easy to use, full featured open communications environment: * people anywher...
TWiki Site Tools Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities for navigating, searching and keeping up wit...
TWiki Skin Browser You can try out the TWikiSkins currently installed on this system: /System/TWikiSkinBrowser?skin=$pattern(.*\ Base Name\: ^\ \ *(\w).) pr...
TWiki Skins Skins overlay regular templates to give different looks and feels to TWiki screens. Overview TWiki uses TWikiTemplates files as the basis of all the ...
TWiki System Requirements Server and client requirements Low client and server base requirements are core features that keep TWiki widely deployable, particularly...
TWiki Templates Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates are plain text with embedded template directives...
The Jump Box as a browser The JumpBox is not only a tool to allow you to jump from page to page, you can use it to search for documents. If you do not know the en...
WebChanges to see recent activity Each TWiki web has a WebChanges topic that lists recent activity from all editors of the web. This page can be useful when looki...
Raw View link At the bottom of the page next to Edit and Attach , there is a Raw View link that allows one to easily see how the TWiki topic looks in its raw...
E mail alert of topic changes Subscribing to WebNotify will enable TWiki to send you details of changes made on topics in a certain web. You can choose to be noti...
Re parenting a topic The breadcrumb displayed with a particular TWiki topic is constructed with a topic's parent. The footer of each page has a link called More ...
Creating a Table of Contents The TWiki variable %TOC% will automatically create a table of contents for a topic based on the headings of the topic. To exclude a h...
Linking to a file attachment One can create a link to a file attachment using one of the following TWikiVariables, %ATTACHURL% or %PUBURL%. %ATTACHURL% is the ful...
Escaping TWiki rendering Use the verbatim tag to surround code excerpts and other formatted text with = verbatim = and = /verbatim = tags. Example: verbatim H...
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with = noautolink = and = /noautolink = tags. See M...
Disabling individual WikiWords Prevent a WikiWord from being linked by prefixing it with an exclamation point. Example: To escape SunOs write SunOs to get SunOs. ...
Server side include To include the contents of a web page or TWiki topic, use %INCLUDE{"page"}%. Examples: * %INCLUDE{"http://www.google.com/"}% * %INCLUDE{...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good bro...
Preferences settings TWiki has these levels of preferences settings: 1 System level settings: * Site name, proxy settings, access control, skin 1 Sit...
File attachments One can attach files to any topic. The action of attaching a file to a topic is similar to attaching a file to an e mail. The link to attach a fi...
Breadcrumb The breadcrumb of a topic shows you the page hierarchy. It is constructed using a topic's parent setting. See More Tips... Contributors: TWiki:Main....
TWiki Skins Skins overlay regular templates with alternate header/footer layouts. You can use Skins to change the look of a TWiki topic, for example, the layout ...
Revision control TWiki has "soft security" anyone can change anything, but changes are logged. There is a complete audit trail: * Version * Date of last r...
Inline search To embed a search in a topic, use the %SEARCH{ parameters }% TWiki Variable. The search variable is used by many TWiki applications. Related Topic...
Commenting with hidden text To hide some text within a TWiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example ...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enab...
SmiliesPlugin emoticons Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile #058; ) : ) or a frow...
Edit tables with EditTablePlugin The EditTablePlugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an Edit button if pr...
Control table attributes with TablePlugin The TablePlugin gives extra control over table display: * Allows sorting * Changing table properties like border w...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/save cycle. Write %COMMENT{ attributes }% or si...
SpreadSheetPlugin for dynamic content Over 60 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $...
SlideShowPlugin for presentations Use the SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful for or...
Custom rendered bullets The RenderListPlugin can render bullet lists in a variety of different ways, for example to show org charts or a directory tree. Use %REN...
Keyword search Interactive search uses keyword search by default. For example, to search for all topics that contain "SOAP", "WSDL", a literal "web service", but ...
RSS news feed of topic changes You can use an RSS news reader to find out what is new in a TWiki web. This complements WebChanges that shows recent changes in a w...
TWiki Tips TWiki Tips are tips and hints contributed by TWiki users. Use this form to search for tips. You can contribute new tips. " topic="TWiki*Tip*" excludeto...
TWiki Tips Of The Day These are all tips of the day. They are located in the web (official TWiki tips) and web (custom tips). Total: tips See also: TWiki Tips ...
Add New TWiki Tip Of The Day There are Custom Tips maintained on your local Foswiki installation, Official TWiki Tips maintained on the TWiki.org web site, and Pl...
TWiki Tips Of the Day Include This Page randomly picks a Tip of the day to display. The includes the part between the horizontal rules. TWiki Tip of the Day ))$...
TWiki Topics The basic building block of a TWiki site is called a topic, identified by a unique, hopefully descriptive, WikiWord title. It may seem easier just to...
20 Minute TWiki Tutorial This step by step, hands on tutorial gets you up to speed with all the TWikiSite basics, in mere minutes... 1. Get set... Open two brows...
TWiki Upgrade Guide This guide covers upgrading from a previous version of TWiki (such as TWiki 4.3) to TWiki 5.0 Overview TWiki 5.0.0 is a major release introdu...
TWiki User Authentication TWiki site access control and user activity tracking options Overview Authentication, or "login", is the process by which a user lets T...
TWikiUserMappingContrib Introduction The User Mapping Manager interface provides services for mapping between a 'user identity' as used when talking to an extern...
User Settings preference variables customizable by users Some of the TWikiPreferences are explicitly intended to be customized by TWiki users, though a default ...
Package TWiki::Users::BaseUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where ...
List of Foswiki Users Below is a list of users with accounts. If you want to edit topics or see protected areas of the site then you can get added to the list by ...
TWiki Variables Special text strings expand on the fly to display user data or system info TWikiVariables are text strings %VARIABLE% or %VARIABLE{ parameter="v...
TWiki Variables Quickstart TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For exam...
Tag me Plugin Plugin to tag wiki content collectively in order to find content by tags and to get a meaningful page ranking. Introduction The larger a wiki gets,...
Text Formatting FAQ This topics lists frequently asked questions on text formatting. Text formatting applies to people who edit TWiki pages in raw edit mode. Text...
TWiki Text Formatting Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created...
TopMenuSkin The TopMenuSkin adds pulldown menus to the PatternSkin. Screen Shot Tob Bar and Menu Structure This skin is sponsored by: * TopMenuSkinTopBar t...
Default Web Top Menu of TopMenuSkin This topic defines the default menu structure of a web. It is used by the TopMenuSkin in case the WebTopMenu topic is missing ...
Top Bar of TopMenuSkin Top bar of TopMenuSkin, replacing WebTopBar. %IF{ "istopic '.WebTopMenu'" then="$percntINCLUDE{.WebTopMenu}$percnt" else="$percntINCLUD...
Topic Menu of TopMenuSkin This topic defines the Topic pulldown menu with topic actions, used by the TopMenuSkin. * %META{ "parent" nowebhome="on" prefix=...
TwistyContrib Introduction This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections. TwistyContrib i...
#VarAQUA AQUA start aqua colored text * AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarBLACK BLACK start black colored text * BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortc...
#VarBLUE BLUE start blue colored text * BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarBROWN BROWN start brown colored text * BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortc...
#VarBULLET BULLET bullet sign * Bullet sign, useful to create a bullet list in a TWiki table, such as %BULLET% One %BB% Two %BB% Three * Type: Prefer...
#VarCARET CARET caret symbol * The caret variable can be used in TWiki tables. * Type: Preference variable TWikiRenderingShortcut. * Syntax: %CARET%...
#VarDISPLAYTIME2 DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting i...
#VarEDITACTION EDITACTION Selects an edit template * EDITACTION defined in a topic or preference setting will define the use of an editaction template inste...
#VarENDBG ENDBG end background color section * ENDBG is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut set...
#VarGRAY GRAY start gray colored text * GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarGREEN GREEN start green colored text * GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortc...
#VarJQENDTAB JQENDTAB end a JQuery tab within a tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPA...
#VarJQENDTABPANE JQENDTABPANE end a JQuery tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPANE% %...
#VarJQTAB JQTAB start a JQuery tab within a tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPANE% ...
#VarJQTABPANE JQTABPANE start a JQuery tab pane * Create nice looking horizontal tab panes in TWiki topics. Write a sequence of %JQTAB{"..."}% and %JQENDTAB...
#VarLIME LIME start lime colored text * LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarMAROON MAROON start maroon colored text * MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...
#VarNAVY NAVY start navy blue colored text * NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering short...
#VarOLIVE OLIVE start olive green colored text * OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering ...
#VarORANGE ORANGE start orange colored text * ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...
#VarPINK PINK start pink colored text * PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarPURPLE PURPLE start purple colored text * PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...
#VarRED RED start red colored text * RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut setti...
#VarREDBG REDBG start red colored background section * REDBG is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rend...
#VarSCRIPTURL2 SCRIPTURL{"script"} URL of TWiki script * Syntax: %SCRIPTURL{"script"}% * Expands to: == * Example: To get the authenticated version of...
#VarSCRIPTURLPATH2 SCRIPTURLPATH{"script"} URL path of TWiki script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL ...
#VarSERVERTIME2 SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME{"format"}% * Supported variables...
#VarSILVER SILVER start silver colored text * SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...
#VarTEAL TEAL start teal colored text * TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...
#VarTOC2 TOC{"Topic"} table of contents * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSynta...
#VarTOPICURL TOPICURL shortcut to viewing the current topic * This variable always expands to an url pointing to the current base topic. * Type: Preferen...
#VarVBAR VBAR vertical bar * The vertical bar variable can be used in TWiki tables. * Type: Preference variable TWikiRenderingShortcut. * Syntax: %V...
#VarWHITE WHITE start white colored text * WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortc...
#VarWIKILOGOURL WIKILOGOURL site logo home URL * Syntax: %WIKILOGOURL% * Expands to: == * Defined in: TWikiPreferences, default %SCRIPTURLPATH{"view"}...
#VarYELLOW YELLOW start yellow colored text * YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...
Wabi Sabi Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to ...
Web Changes Notification Service Each TWiki web has an automatic e mail notification service that sends you an e mail with links to all of the topics modified sin...
Recent changes in web: /$web/$topic\" title=\"By $wikiname: $summary\" $percntSPACEOUT{$topic}$percnt" separator=" " }% Web Changes Box on the Right Side This...
FAQ: What does the "T" in TWiki stand for? Answer: TWiki is short for TakeFive Wiki, the name of the company where its founder Peter Thoeny worked. Peter first n...
FAQ: So what is this WikiWiki thing exactly? Answer: A set of pages of information that are open and free for anyone to edit as they wish. They are stored in a ...
Wiki Notation TWiki links topics automatically when you use WikiWord notation. Related topics: WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiEditi...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology and TWiki * B...
TWiki Shorthand Basics If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create...
* You are currently in the web. The color code for this web is this background, so you know where you are. * If you are not familiar with the Foswiki collabor...