WebIndex - TWiki - b r a y d e n . o r g

See also the faster WebTopicList

The ambar skin is a simple but fully functional blue-hued skin - suitable for beginners as well as stalwarts. This skin provides many features to improve productivity while obscuring the less used features/areas.

Some of the ideas were collected from several other skins, looking for the best in each - TWiki:Plugins/GnuSkin, TigerSkin and TWiki:Plugins/KoalaSkin to name a few.

Things I like about this skin: uses the savemulti script, so you don't have to preview before save very readable and clean, and a minimum of graphics easily customizable left-menu action menus at top and bottom

AppendixFileSystem : #FileSystem

Annotated listings of files included in the 01-Sep-2001 TWiki distribution

This Appendix contains directory and file listings, and individual file descriptions, for the full 01-Sep-2001 TWiki distribution package.

You can rename the root TWiki directory - twiki - to whatever you like by changing it in the twiki.cfg configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure intact: ... table elided ...

The following partial directory listings from a Linux installation show typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution.

BookView : BookView is part of search. It allows you to display the result in book view, e.g. the whole content of topcis is shown instead of a topic summary. This allows you to easily see a whole set of pages, which is useful for printing.

BumpyWord : See TWiki.WikiWord

ChangePassword : Change password

Forgot your old password? Then use ResetPassword instead. Please only use ResetPassword in case you really forgot your password. Thank you.

... table elided ...

After submitting this form your password will be changed.

DallasSkin : This is the skin we primarily use at my company. Nothing fancy, really. Should work on any normal browser IE, NS, Opera, etc. , but I haven't tested it on all of them yet. The nice thing about this is that is is pretty fast. The bad thing is that I have seen it do some wierd stuff.. the table formatting is really a hack job. I just don't have the time to clean it up. Maybe somebody wants to volunteer :

The graphics suck I'm not a professional at this ... I kinda hacked them from the old MikebSkin found on twiki.org plus make a couple of new ones .

I also drew on a couple of tricks from OpenWiki and fixed up the fonts a little and set it up so that you can double click anywhere in the topic and start editing the page whee! .

DefaultPlugin :

The default plugin is used for some deprecated rendering of older TWiki versions and of JosWiki. This plugin can also be used to specify some simple custom rendering rules. Note: Create a new TWikiPlugin based on EmptyPlugin if you plan to offer some complex rendering or other functionality.

Custom rendering rules of the default plugin:

Allow old include syntax == if Plugin Preferences variable ==OLDINCLUDE is set to 1 Render deprecated = text = as bold italic text. Test if installed: This is bold italic Enable JosWiki rules if JosWiki specific code is uncommented

DeleteOrRenameATopic :

How do I delete or rename a topic?

New to the 01-Sep-2001 version of TWiki, you can rename, move and delete topics directly from your browser previously, these operations could only be done manually, by someone with file-level access to the Web server .

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 that screen. There's a link that launches to the ManagingTopics reference page in a pop-up window.

DocStyleSheet : This is the stylesheet used by the 'doc' template - a template for producing clean, stand-alone html documentation from a twiki page.

... elided ...

-- Main.DaleBrayden - 16 Sep 2003

DontNotify : 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.

EditDoesNotIncreaseTheRevision :

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

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

-- Main.PeterThoeny - 27 Nov 2000

EmptyPlugin :

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

To create your own plugin:

Copy file TWiki/Plugins/EmptyPlugin.pm to namePlugin.pm and customize the plugin. Create a namePlugin topic in the TWiki web. Do so by visiting http://TWiki.org/cgi-bin/view/Plugins/ 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 TWiki.TWikiPlugins.

none

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

ExampleTopicTemplate : just an example illustrating how to create a new topic based on a specific template topic. TWikiTemplatesVer1 has more

-- TWikiGuest - 09 Feb 2012

FileAttachment :

Each topic can have files attached to it, similar to an email attachment. Use your browser to upload or download a file. Attachments are stored under revision control, so uploads can never be lost, and files changes can be made with a rollback option that lets you retrieve all previous versions.

File Attachments can be used to create powerful groupware solutions - file sharing, document management - and for speedy Web authoring.

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; create a central reference library that's easy to access and manage by an entire user group.

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

-- JohnTalintyre - 30 Aug 2001

FlexibleSkin :

This project aims to build a flexible Skin to TWiki ...

making possible to change the look of a web simply by adding/removing/editing some special topics in the web, or changing the value of some special web-level variables; making easier the task of translating the TWiki layout to other languages;

Comments about design, bugs and other implementation stuff about FlexibleSkin must be put in FlexibleSkinDev.

FlexibleSkin uses some variables at global level -- -- for using FlexibleSkin globally, or at web level for using it on some web to get some information for displaying. They are:

FlexibleSkinBottomBar : ... table elided ...

FlexibleSkinLeftBar :

FlexibleSkinPrintingFooter : ... table elided ...

FlexibleSkinPrintingHeader : T++ - http://tplusplus.sourceforge.net

FlexibleSkinRightBar : ... table elided ... Print this topic

... table elided ...

FlexibleSkinStyleSheet : ... elided ...

-- Main.AntonioTerceiro - 14 Feb 2003

FlexibleSkinTopBar : ... form elided ...

FlexibleSkinTopicHeader :

FormattedSearch :

-- Main.PeterThoeny - 28 Nov 2001

GnuGeneralPublicLicense :

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

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.ai.mit.edu/copyleft/gpl.html

GoodStyle :

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 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 a sub-topic develops, separate it with a horizontal rule at beginning and end

HeadingOutlineSample : 1 TreeTop 1.1 TheOne Summary for TheOne 1.1.1 OneOne Summary for OneOne 1.1.1.1 OneOneOne Summary for OneOneOne 1.1.2 OneTwo Summary for OneTwo 1.1.2.1 OneTwoOne Summary for OneTwoOne 1.1.2.2 OneTwoTwo Summary for OneTwoTwo 1.1.2.2.1 OneTwoTwoOne Summary for OneTwoTwoOne 1.1.2.2.2 OneTwoTwoThree Summary for OneTwoTwoThree 1.1.2.2.3 OneTwoTwoTwo Summary for OneTwoTwoTwo 1.2 TheThree Summary for TheThree 1.2.1 ThreeOne Summary for ThreeOne 1.2.2 ThreeThree Summary for ThreeThree 1.2.2.1 ThreeThreeOne Summary for ThreeThreeOne 1.2.3 ThreeTwo Summary for ThreeTwo 1.3 TheTwo Summary for TheTwo

HeadlinesPlugin :

This plugin displays RSS feeds from news sites. Use it to build news portals that show headline news.

Note: Syndic8.com http://www.syndic8.com/ is a good site listing many RSS feeds.

Plugin settings are stored as preferences variables. To reference a plugin setting write %plugin_setting%, for example, %HEADLINES_SHORTDESCRIPTION%

One line description, shown in the TWiki.TextFormattingRules topic: Set SHORTDESCRIPTION = Build news portals that show headline news based on RSS news feeds from news sites.

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

HiddenAttachment :

You can hide/unhide file attachments.

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

-- Main.PeterThoeny - 13 Nov 2001

InclRecentChanges :

IncludeTopicsAndWebPages : =, =

InterWikis :

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.

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 TWiki.WikiWord links, and no external links. Hint: Escape 'WikiWords' and '$page'.

InterwikiPlugin : InterwikiPlugin

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

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

ManagingTopics :

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

Use browser controls while viewing a topic, to change its name, move it to another TWiki web, or delete it to a hidden Trash web.

Click on = More = bottom right of page on the topic to be changed, then, in the new screen, on = Rename/move =.
Select target web if other than the current web - chose Trash to delete a topic
Enter the new topic name - default is current name NOTE: You will be warned if there are locks or if there is a name conflict.
Select from the list of referring links any topics NOT to be updated with the new name by default, all referring links will be updated .
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 =.

ManagingWebs :

Adding, renaming and deleting webs are manual operations done directly on the server

Managing TWiki webs requires direct access to the installation files on the host server. There are currently no browser-based equivalents of the Rename/move/delete topic tools for working with webs.

Adding new webs is quick and easy - you can have a basic web up and running in a couple of minutes:

Create a new directory under twiki/data/, ex: twiki/data/Newweb the name has to start with a capital and cannot be a WikiWord
Copy in the contents of twiki/data/_default.

For detailed instructions, see TWiki Installation Guide: Adding a New Web .

MetaDataDefinition :

MetaDataRendering :

Various meta data can be stored in topics - MetaDataDefinition

This is rendered using the %META% variable. This is mostly used in the view, preview and edit scripts.

At present support is fairly basic: ... table elided ... Possible future additions: Rendering of form data to alternate formats e.g. bullet lists Specify a template to be used for rendering

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

OriginalSlideShowTemplate : ... table elided ... ... table elided ... ... table elided ...

PhantomSkin :

The phantom skin is a minimalist skin, very easy on the eyes and on the bandwidth. It is laid out similar to the default twiki plain skin, but has a look all its own. Try it out! The skin was developed by TWiki:Main/AlexeyEfimov and saved at twiki.org in 2002.

Things I like about this skin:

very simple layout readable interesting layout

Things I don't like about this skin:

not customizable by preferences minimal navigational aids

PreviewBackground : Background Image for Preview

Preview looks like the real page, but the links leed to an oops dialog warning users of not yet saved topics. In addition, a background with a "PREVIEW" watermark is shown to have visual clue that you are previewing a topic. You can change the background image by specifying the name of an attached background image file in the PREVIEWBGIMAGE variable in the TWikiPreferences.

Remarks:

You also could attach a new image file to this topic. You can override the PREVIEWBGIMAGE preference variable in your personal home page.

-- Main.PeterThoeny - 02 Oct 2000

RegularExpression : Regular expressions REs , unlike simple queries, allow you to search for text which matches a particular pattern.

REs are similar to but more poweful than the "wildcards" used in the command-line interfaces found in operating systems such as Unix and MS-DOS. REs are used by sophisticated search engines, as well as by many Unix-based languages and tools e.g., awk, grep, lex, perl, and sed .

Examples

compan y ies

Search for company , companies

peter paul

Search for peter , paul

bug

Search for bug , bugs , bugfix

ResetPassword : Request for reset of password

Please only use this ResetPassword form in case you really forgot your password. Otherwise just change it using ChangePassword. Thank you.

... table elided ...

After submitting this form you will receive a page with yor new password appearing encrypted .

SearchDoesNotWork :

I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem.

That is an indication that TWiki can't find the egrep and fgrep commands on your system. Check the $egrepCmd and $fgrepCmd variables in twiki/lib/TWiki.cfg.

Back to: TWikiFAQ

-- Main.PeterThoeny - 26 Jan 2001

SelectSkin : Allows you to select a new skin.

... form elided ...

Notes:

this will only persist for your session and this will only work if the SessionPlugin in installed

this assumes that %SKINS% has a comma-separated list of available skins in it

this page will not work correctly if you came to it directly. Call it with CGI parameters fromweb and fromtopic. Clicking Go above will then refresh to that web and that topic with your desired skin stuck to your session until you clear it with the default skin. see TWiki.SessionPlugin for an example of how to use this page

SessionPlugin :

_ Development discussions in TWiki:Plugins/SessionPluginDev _

Traditionally, TWiki modes of operation that did not require authentication like viewing did not "remember" if a user had already authenticated in a different mode that did require authentication. In other words, if a user logged in, his or her settings would not persist in non-authenticated modes like the viewing mode.

This plugin provides one strong solution to this problem while also adding a number of other interesting features. This plugin adds the ability to use sessions within TWiki to store information persistently throughout a web browser's visit to a TWiki website. This information will be forgotten after the web browser has been closed, but during the visit it will persist in all modes of operation. This plugin uses cookies primarily to accomplish this, but also is configured by default to allow for a purely CGI way of doing this as well that does not require cookies.

SimultaneousEdits :

What happens if two of us try to edit the same topic simultaneously?

The second person gets a warning that the topic is currently being edited by another user. A topic gets locked automatically for some time default is one hour when you edit, preview or save the topic. If you get the lock warning you should wait until the lock is gone or contact the other person to ask if you can go ahead and break the lock. See also UnlockTopic.

Back to: TWikiFAQ

-- Main.PeterThoeny - 27 Nov 2000

SiteUsageStatistics :

You can automatically generate usage statistics for all webs. To enable this: Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/logdate.txt . Topic WebStatistics must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template. Call the twiki/bin/statistics script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs. Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on most systems. Example crontab entry: =0 0 cd /path/to/TWiki/bin; ./statistics /dev/null 21 = There is a workaround in case you can't run the script as user nobody : Run the utility twiki/bin/geturl in your cron job and specify the URL of the twiki/bin/statistics script as a parameter. Example: =0 0 cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics /dev/null 21 = The twiki/bin/statistics script can also be executed as a CGI script, just enter the URL in your browser. Examples: Update current month for all webs: http://mydomain.com/twiki/bin/statistics Update current month for Main web only: http://mydomain.com/twiki/bin/statistics/Main Update January 2000 for Main web: http://mydomain.com/twiki/bin/statistics/Main?logdate=200001

SlideShowPlugin :

This Plugin converts a topic with headings into a slide show.

There is already a defacto standard for presentations, why this Plugin? This Plugin makes sense for organizations that do already have lots of content in TWiki: It is easy to create a web based presentation that contains many links to related content. The Plugin does not try to compete with the bells and whistles of the other presentation program, but the markup of TWiki and other Plugins like TWiki:Plugins/ChartPlugin, TWiki:Plugins/GaugePlugin, TWiki:Plugins/SpreadSheetPlugin, TWiki:Plugins/TWikiDrawPlugin can be used to create an appealing presentation.

StandardColors : The 256 Standard Colors

This table can be used to choose a color in WebPreferences of each web.

000000 000033 000066 000099 0000CC 0000FF 003300 003333 003366 003399 0033CC 0033FF 006600 006633 006666 006699 0066CC 0066FF 009900 009933 009966 009999 0099CC 0099FF 00CC00 00CC33 00CC66 00CC99 00CCCC 00CCFF 00FF00 00FF33 00FF66 00FF99 00FFCC 00FFFF

330000 330033 330066 330099 3300CC 3300FF 333300 333333 333366 333399 3333CC 3333FF 336600 336633 336666 336699 3366CC 3366FF 339900 339933 339966 339999 3399CC 3399FF 33CC00 33CC33 33CC66 33CC99 33CCCC 33CCFF 33FF00 33FF33 33FF66 33FF99 33FFCC 33FFFF

StylePlugin :

This plugin lets you add CSS style attributes to your pages.

See Main.StylePluginDetails for the detailed description and actual examples.

Plugin settings are stored as preferences variables. To reference a plugin setting write %plugin_setting%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION% Security Set ALLOWTOPICCHANGE = Main.DaleBrayden, Main.TWikiAdminGroup Set ALLOWTOPICRENAME = Main.DaleBrayden, Main.TWikiAdminGroup One line description, is shown in the TWiki.TextFormattingRules topic: Set SHORTDESCRIPTION = A TWiki notation for adding css style class references with span and div tags Debug plugin: See output in data/debug.txt Set DEBUG = 0 Disable styles for non-rendering skins Set SKIPSKIN = rss, cdf site styles Set SITESTYLES = .minilink { font-size:smaller; } .webref { font-size:larger; font-weight:bold; } .author, .BAuthor {font-weight:bold; font-style:normal;} .booktitle, .BTitle {font-style:normal; text-decoration:none;font-weight:bold;} .publisher, .BPublisher { font-style:italic; } .note {color:green; font-style:italic; } .note:before {display:inline; content: "Note: "; } .new {font-weight:bold; color:red; } .deprecated {text-decoration:line-through; color:gray; } .comment {font-style:italic; background-color: #CCFFCC; } .ebook {width:6in; text-align:justify;} .super {vertical-align:super; font-size:smaller;} .sub {vertical-align:sub; font-size:smaller;} .article { padding-left:10px;padding-right:10px; width:6in; text-align:justify; } .pullquote { border-left:1px;border-right:1px;border-color:black;border-style:solid; border-top:0px;border-bottom:0px; padding-left:10px;padding-right:10px; margin-left:10px; font-style:italic; } .sidebar { background-color:white; border-width:2px; margin-left:4px; border-color:black;border-style:solid; padding:3px; padding-right:5px; position:relative;float:right; width:230px; font-size:smaller;} .leftsidebar { background-color:white; border-width:2px; margin-right:4px; border-color:black;border-style:solid; padding:3px; padding-right:5px; position:relative;float:left; width:260px; font-size:smaller;} .question {font-weight:bold; } .answer {font-style:italic; } abbr, acronym, .help { border-bottom: 1px dotted #333; cursor: help; } DT {font-weight:bold;text-decoration:underline;margin-left:10px; } .intro {font-weight:bold;font-style:italic;margin-left:30px;} TH {text-align: center; font-weight: bold; background-color:#eeeeee; vertical-align: top; } TD {vertical-align: top; } TABLE { border-width: 1; } {position:absolute; width:1px;visibility:hidden; height:1px;} .TOC { border-width:2px; border-color:black;border-style:outset; -moz-border-radius: 5px 5px 5px 5px;} .TOC:before {content:"Table of Contents";font-weight:bold;} .submitButton {-moz-border-radius: 10px 10px 10px 10px;} .widget {-moz-border-radius: 10px 10px 10px 10px; } .slidetitle {font-size:x-large; font-weight: bold; color:white;} .slidetext, .slidetext LI {font-size:large; font-weight:bold; } .slidecopyright {font-size: smaller; } .slideindex {font-size:smaller;} .blogrollfolder {font-weight: bold;} .blogrollitem {font-size:smaller;}

TWikiAccessControl :

Restricting read and write access to topics and webs, by users and groups

TWikiAccessControl allows you restrict access to single topics and entire webs, by individual user and by user groups, in three main areas: view; edit attach; and rename/move/delete. These controls, combined with TWikiUserAuthentication, let you easily create and manage an extremely flexible, fine-grained privilege system.

Open, freeform editing is the essence of the WikiCulture - it's what makes TWiki different and often more effective than other collaboration tools. So, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with care. Experience shows that unrestricted write access works very well because:

TWikiCategoryTable : Note: This feature has been replaced by: TWikiForms

TWikiContributor :

Note: Please contact a TWiki:Codev.CoreTeam member in case you contributed to TWiki and your name is not on this list!

See TWikiHistory

-- PeterThoeny

TWikiDocGraphics :

– Temporary: standard 88x31px logo ID button:

Help:

Tip:

Warning:

TWikiDocumentation : function dblclick { window.scrollTo 0,0 } if document.layers { document.captureEvents Event.ONDBLCLICK ; } document.ondblclick=dblclick; //--

TWiki Reference Manual 01-Dec-2001

This page contains all documentation topics as one long, complete reference sheet. Doubleclick anywhere to return to the top of the page.

TOC: No TOC in "TWiki.WebIndex"

Note: Read the most up to date version of this document at http://TWiki.org/cgi-bin/view/TWiki/TWikiDocumentation

Related Topics: TWikiSite, TWikiHistory, TWikiPlannedFeatures, TWikiEnhancementRequests

TWikiDownload :

I would like to install TWiki on my server. Can I get the source?

TWiki is distributed under the GnuGeneralPublicLicense. You can request the source from http://TWiki.org/download.html.

Back to: TWikiFAQ

-- Main.PeterThoeny - 27 Nov 2000

TWikiEnhancementRequests : Please add enhancement request at the TWiki home at http://TWiki.org/cgi-bin/view/Codev/FeatureEnhancementRequest

Related Topics TWikiHistory has a list of added features in TWiki. TWikiPlannedFeatures has a list of planned features. TWikiDocumentation is the implementation documentation.

-- Main.PeterThoeny - 12 May 2000

TWikiFAQ :

NOTE: The most recent version of this FAQ is at TWiki:TWiki/TWikiFAQ.

Please ask support questions in the TWiki:Support web. The FAQs are here for frequently asked questions including answers.

... form elided ...

Other places where you can find answers to your questions:

TWikiDocumentation: All you need to know to install and configure TWiki TWikiTutorial: Get a jump start on using TWiki GoodStyle: Things to consider when changing text WikiSyntax, TextFormattingRules: A quick one-two guide to TWiki shorthand basics TextFormattingFAQ: Answers to frequently asked questions about text styling in TWiki If you can't find an answer, ask a question - post it in the TWiki:Support web

TWikiFaqTemplate :

Back to: TWikiFAQ

-- TWikiGuest - 09 Feb 2012

TWikiForms :

Form-based input in topics, with name/value pairs stored as Meta Data variables; multiple forms per web topic

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki.

TWikiGlossary :

TWiki uses a handful of general computer and Internet terms in a TWiki-specific way. This could get confusing, but it actually works out fine in use. The TWikiGlossary is also a quick way to get familiar with the overall TWiki set-up...

_ Under...construction: this is a rough draft _

Attachment aka File Attachment - upload files by browser and attach them to any page, where they can be viewed, edited, downloaded; accessed by clicking Attach at page bottom TWiki.FileAttachments

Plugin - a TWiki feature add-on; a Perl module that enhances TWiki, through the Plugin API spec; named _Plugin.pm, ex: SomePlugin.pm TWikiPlugins

TWikiHistory : = to show a search result embedded in a topic text. TWikiVariables has more on the syntax. Inline search combined with the category table feature can be used for example to create a simple bug tracking system. 04 Feb 2000 - PeterThoeny Access statistics. Each web has a WebStatistics topic that shows monthy statistics with number of topic views and changes, most popular topics, and top contributors. It needs to be enabled, TWikiDocumentation has more. 29 Jan 2000 - PeterThoeny Fixed bug where TWiki would not initialize correctly under certain circumstances, i.e. when running it under mod_perl. Sub initialize in wiki.pm did not handle $thePathInfo correctly. 24 Jan 2000 - PeterThoeny Fixed bug where an email address starting with a WikiName was rendered as an internal Wiki link instead of an email address, i.e. SomeWikiNamesomewhere.test . 10 Jan 2000 - PeterThoeny No more escaping for '%' percent characters. Number of consecutive '%' entered and displayed is identical. 03 Oct 1999 - PeterThoeny Limit the number of revisions shown at the bottom of the topic. Example Topic TWikiHistory . { ..... Diffs r1.10 r1.9 r1.8 r1.7 ... } Additional revisions can be selected by pressing the ... link.

TWikiImplementationNotes :

Server and client system requirements for TWiki 01-Sep-2001

Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.

TWiki is written in Perl 5, uses a number of shell commands, and requires RCS Revision Control System , a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements: ... table elided ... Current documentation covers Linux only. A TWikiOnWindows installation guide is next.

TWikiInstallationGuide :

Installation instructions for the TWiki 01-Sep-2001 production release

These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements . Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.

#StandardInstallation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. _ To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo. _

TWikiMetaData : #MetaDataDefinition

Additional topic data, program-generated or from TWikiForms, is stored in META variable name/value pairs

TWikiMetaData uses META variables to store topic data that's separate from the main free-form content. This includes program-generated info like FileAttachment and topic movement data, and user-defined TWikiForms info. Use META variables to format and display Meta Data.

Format is the same as in TWikiVariables, except all fields have a key. ==

Order of fields within the meta variables is not defined, except that if there is a field with key name, this appears first for easier searching note the order of the variables themselves is defined .

TWikiPages :

Each page in a TWiki web is called a topic, defined by its meaningful, descriptive TWiki.WikiWord title.

A TWiki topic is a self-contained information unit rich in features:

a WikiWord title that lets you: instantly identify what the page is about automatically link to it from other pages an edit-anywhere collaboration area where you can: enter plain or fully-HTML formatted text work with simple TWiki editing shorthand that includes HTML mark-up and special TWiki functions include Web links, images, anything else you can put on a Web page an extra forms input option: store structured info alongside the free-form page content use text fields and boxes, radio buttons, pulldown selector menus, checkboxes select from one or many different input forms, with all data preserved a FileAttachment feature that lets you: upload files through your browser to the TWiki server attach any type of file documents, images, applications for viewing or downloading make changes and update existing files TWiki Skins to customize the look of headers and footers: apply skins across an entire TWiki web level, or to a single page browser-based controls for renaming, moving, and deleting pages: rename a page and automatically update all the references to it, site-wide move a page from one TWiki web to another safely delete a topic to a special Trash web invisible, but accessible to the TWiki administrators if needed flexible access control : independently determine who can see, edit, rename, move or delete topics set permissions by individual users and user groups revision control automatically saves topic changes: uses the established standard RCS Revision Control System efficiently stores every change made to the original version allows comparison of changes between any two versions, and review of any version, as formatted or raw text referred-by searches that list all topics in a web or site wide that link to a particular page hierarchical parent-child topic navigation: automatically links a new page as the "child" of the page it was created from allows manual assignment of parent page from a list of all topics in the local web offers navigation displays, by topic parent, or by related topic

TWikiPlannedFeatures : Planned features are listed up at the TWiki home at http://TWiki.org/cgi-bin/view/Codev/FeatureToDo Features currently under construction are at http://TWiki.org/cgi-bin/view/Codev/FeatureUnderConstruction

Related Topics TWikiHistory has a list of added features in TWiki. TWikiDocumentation is the implementation documentation. TWikiEnhancementRequests is the place where you can add your enhancement requests.

-- Main.PeterThoeny - 12 May 2000

TWikiPlugins :

Plug-in enhanced feature add-ons, with a Plugin API for developers

You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you:

add virtually unlimited features while keeping the main TWiki code compact and efficient; heavily customize an installation and still do clean updates to new versions of TWiki; rapidly develop new TWiki functions in Perl using the Plugin API.

Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the TWiki:Plugins web.

TWikiPreferences : TWiki Site-Level Preferences

The following settings are site-level preferences , e.g. affecting all users in all TWiki webs. These preferences can be overwritten by web preferences topic WebPreferences in each TWiki web and user preferences your personal topic, i.e. Main.TWikiGuest in the TWiki.Main web

Preferences:

List of TWiki webs: the first line of a topic; to add a web see TWikiDocumentation and TWikiWebsTable Set WIKIWEBLIST = Random | Software | Books | Main | TWiki

List of topics of a web: the second line of a topic, is overwritten by web preferences Set WEBTOPICLIST = Home | Changes | Index | Search | Go

TWikiRegistration : To edit pages on this TWiki Collaborative Web, you must have a registered user name and password.

To register as a new user, simply fill out this form:

... form elided ...

Submitting the form will automatically:

Create an account for you, so that you can start editing pages using your WikiName. Create your personal TWiki topic using your WikiName as topic name, and add the data you submitted to the topic. Add your name to the list of users in the TWikiUsers topic in the TWiki.Main web. Send you a confirmation of your registration by email.

Once registered you can login using your WikiName and password.

TWikiRegistrationPriv : To edit pages on this TWiki Collaborative Web, you must have a registered user name in WikiNotation.

To register as a new user, simply fill out this form:

... form elided ...

Submitting the form will automatically:

Once registered you can login using your WikiName and password.

TWikiRegistrationPub : To edit pages on this TWiki Collaborative Web, you must have a registered user name and password. Note: You can also login anonymously as user TWikiGuest with password guest

To register as a new user, simply fill out this form:

... form elided ...

Submitting the form will automatically:

TWikiShorthand :

Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWikiShorthand gives you all the power of HTML with a simple coding system that takes little time to learn. It's all layed out below - refer back to this table in a pop-up window from the Edit screen.

... table elided ...

You can use just about any HTML tag without a problem, HOWEVER, it's recommended NOT to. Using TWikiShorthand, you can do practically anything you'd normally do with HTML, and it keeps the text uncluttered and easy for people to browse edit.

TWikiSite :

A TWiki site is a easy-to-use, full-featured open communication environment: people anywhere on the Web or on an intranet can meet rich Web text, images, and online multimedia are easily shared documents and other files can be uploaded and downloaded everything works through a regular Web browser

TWiki's parsing engine is written in Perl. It reads a text file, and converts TWiki shorthand into standard HTML, on the fly. The point is to: make adding and editing text simple _ How simple? Click on the Edit link at the bottom of the page... _ let you find information fast WebSearch

TWikiSiteTools :

Utilities for searching, navigation, and monitoring site activity

TWikiSiteTools include utilities for navigating, searching and keeping up with site activity. Preferences can be configured by web or site-wide. You are currently in the TWiki web. In particular, TWiki provides two highly configurable, automated site monitoring tools, WebNotify , to email alerts when topics are edited, and WebStats , to generate detailed activity reports.

Each TWiki web has an automatic email alert service that sends a list of recent changes on a preset schedule, like once a day. Users can subscribe and unsubscribe using WebNotify in each web. The Perl script mailnotify is called by a deamon in regular intervals. The script sends an automated email to subscribed users if topics were changed in a web within last interval.

TWikiSkins :

Skins overlay regular templates with alternate header/footer layouts; topic text is not affected

Skins are customized TWikiTemplates files. You can use skins to change the look of a TWiki topic, for example, the layout of the header and footer. Rendered text between header and footer does not change. You can also use skins to define an alternate view, like a view optimized for printing.

Skin files are located in the twiki/templates directory and are named with the syntax: scriptname.skin.tmpl. For example, the Printable skin for the view template is view.print.tmpl.

TWikiTemplates :

Definition of the templates used to render all HTML pages displayed in TWiki

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML mark-up for template-specific content. Templates are used to define page layout , and also to supply default content for new pages.

Where the old templates were each complete HTML documents, the new templates are defined using variables to include template parts from a master file. You can now change one instance of a common element to update all occurrences; previously, every affected template had to be updated. This simplifies the conversion of templates into XHTML format, and provides a more versatile solution for templates and for TWikiSkins. The new system:

TWikiTutorial :

This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in mere minutes...

Open two browser windows, so that you can follow these steps in one window, while trying things out in the other.

A TWikiSite is divided into webs; each one usually represents one area of collaboration. You can navigate the webs from the upper right corner of each web page. Each web has hyperlinked topics, displayed as pages in your browser. The home page in each web is the WebHome topic. To browse a TWiki web, just click on any highlighted link. These links are called WikiWords and comprise two or more words with initial capitals, run together. Follow the WikiWord link and learn what it is. If you know the name of a topic, you can jump directly to it by typing its name into the Go field on the top of the page. Type WebSearch to jump to the search page. Hint: Do not confuse the Go field with search. You can search each TWiki web. Enter a search string in the WebHome topic or the WebSearch topic accessible from the Search link on each topic. TWiki searches for an exact match; optionally, you can also use RegularExpressions.

TWikiUpgradeGuide : = and =

TWikiUpgradeTo01Dec2000 :

If you are coming from a version earlier than the 01 May 2000 production release, please see TWikiUpgradeTo01May2000 first. For the latest version read TWikiUpgradeGuide.

The 01 Dec 2000 release has these changes that affect the upgrade of the 01 May 2000 version:

Improved search, i.e. search multiple webs. The changes script has been retired related to new search . Reorganization of topics: The TWiki.Main web was split up into TWiki.Main and TWiki.TWiki web.

This upgrade is somewhat more labor intensive, mainly caused by splitting up the TWiki.Main web. Please note that subsequent updates will be much easier because user related topics in TWiki.Main web and TWiki related documents in TWiki.TWiki web have been separated.

TWikiUpgradeTo01May2000 : To upgrade an earlier TWiki version like 01 Sep 1999 to version 01 May 2000 you should do the following things:

Back up your system. Update the templates in the /templates directory and its subdirs : Take the templates of the latest distribution as the base and merge your changes back into it. Update the Perl scripts in the /bin directory: Take the scripts of the latest distribution as the base and merge your changes back into it. Do so also for wikicfg.pm because it has important changes as well. Update topics: Copy the new Main. Main.TWikiPreferences topic and = ,v= file into your TWiki.Main web. Customize the topic to your needs. Copy the new Main. Main.WebPreferences, Main.WebStatistics topics and = ,v= files into all your webs. Customize all WebPreferences topics to your needs e.g. web color . Copy WebSearch into all your webs, or modify the existing ones. Reason: Some switches for search changed. Copy the TWiki documentation into your Main web: Topics TWikiDocumentation, TWikiUsernameVsLoginUsername, TWikiVariables, WebNotification, TWikiCategoryTable, TWikiImplementationNotes, TWikiInstallationGuide, TWikiUpgradeTo01May2000, TextFormattingRules, TWikiHistory . Copy the registration topic into your Main web: In case you are on an Intranet: Copy topic TWikiRegistration to Main.TWikiRegistration. Customize if needed. In case you are on a public server: Copy topic TWikiRegistrationPub to Main.TWikiRegistration. Customize if needed. Copy the Main. TWikiWebsTable topic and = ,v= file into your Main web and customize it. Reason: The new release does not use the = .inc= include files anymore. Optionally: Search for %INCLUDE%'s in all your webs and change them to the new = syntax. Note: Your old = syntax still works the legacy rule is defined in wikicfg.pm . Add the PoweredByTWikiLogo to your TWiki home page.

TWikiUserAuthentication :

TWiki site access control and user activity tracking

TWiki does not authenticate users internally, it depends on the REMOTE_USER environment variable. This variable is set when you enable Basic Authentication .htaccess or SSL "secure server" authentication https protocol .

TWiki uses visitor identification to keep track of who made changes to topics at what time and to manage a wide range of personal site settings. This gives a complete audit trail of changes and activity.

No special installation steps are required if the server is already authenticated. If it isn't, you have three standard options for controlling user access:

Forget about authentication to make your site completely public - anyone can browse and edit freely, in classic Wiki mode. All visitors are assigned the Main.TWikiGuest default identity, so you can't track individual user activity.
Use SSL Secure Sockets Layer; HTTPS to authenticate and secure the whole server.
Use Basic Authentication .htaccess to control access by protecting key scripts: attach, edit=, installpasswd, preview, rename, save, upload using the .htaccess file. The TWikiInstallationGuide has step-by-step instructions.

TWikiUsernameVsLoginUsername :

This section applies only if your TWiki is installed on a server that is both authenticated and on an intranet .

TWiki internally manages two usernames: Login username and TWiki username.

Login username: When you login to the intranet, you use your existing login username, ex: pthoeny. This name is normally passed to TWiki by the REMOTE_USER environment variable. TWiki uses this name internally to log topic changes. Login usernames are maintained by your system administrator. TWiki username: This is your name in WikiNotation, ex: PeterThoeny, recorded when you register in TWikiRegistration; doing so also generates your personal home page in the Main web of your TWiki site.

TWikiVariables :

Text strings expanded on the fly to display data or system info

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info like the date, or the current user . There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.

Most predefined variables return values that were either defined when TWiki was installed, or taken from server info like current username, or date and time . Many of the variables let you control how the formatted results appear.

TWikiVariablesExamples :

You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

Example: Create a custom logo variable To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic any topic name you choose : ==Set MYLOGO = http://www.brayden.org/twiki/pub/Main/LogoTopic/logo.gif==

TWikiWebsTable : ... table elided ...

TablePlugin : TablePlugin

This optional but recommended Plugin is available at TWiki:Plugins/TablePlugin.

TextFormattingFAQ : Text Formatting FAQ

The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system on one quick reference page.

Create a separator - a horizontal rule - by entering three dashes at the beginning of a blank line: = =

You can create six sizes of headings - h1...h6 in HTML - by typing, from the beginning of a line, three dashes - , from one to six plus signs + , a space, and your heading text. The FAQ questions on this page are created with: = You can insert a nested table of contents, generated from headings, by placing TOC: No TOC in "TWiki.WebIndex" wherever you like on a page see TWiki.TWikiVariables for more TOC: No TOC in "TWiki.WebIndex" options .

TextFormattingRules :

Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the Edit screen.

#TWikiShorthand

... table elided ...

You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit. NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.

TreeBookviewOutlineSample : ... table elided ...

Summary

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for TheOne

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneOne

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneOneOne

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneTwo

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneTwoOne

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneTwoTwo

-- SlavaKozlov - 10 Feb 2002

... table elided ...

Summary for OneTwoTwoOne

-- SlavaKozlov - 10 Feb 2002

TreePlugin :

Enables dynamic generation of TWiki topic trees based on topics' parent-child relationships.

Useful for dynamic sitemaps and threads.

Alpha release. Documentation will be enhanced. More features finalized.

Plugin settings are stored as preferences variables. To reference a plugin setting write %plugin_setting%, for example, Link =ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic.=

One line description, shown in the TWiki.TextFormattingRules topic: Set SHORTDESCRIPTION = Dynamic generation of TWiki topic trees

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

TreePluginSamples : Here are some ways of using TreePlugin's TREEVIEW tag.

#SampleLists Note: The links under TreeTop incl. are not functional. They are only for demonstrational purpooses only. %BR% Note: The children of each tree are presented in alphabetical order which is why a "Three" topic always preceeds a "Two" topic.

#UlList

%TREEVIEW{topic="WebHome" topic="TreeTop" formatting="ullist"}%

TreeTop TheOne OneOne OneOneOne OneTwo OneTwoOne OneTwoTwo OneTwoTwoOne OneTwoTwoThree OneTwoTwoTwo TheThree ThreeOne ThreeThree ThreeThreeOne ThreeTwo TheTwo

UnlockTopic : Topics get locked for some time default is one hour whenever a user edits, previews or saves a topic. This is to prevent simultaneous topic updates. There is a lock warning if another users tries to edit a topic while the lock is still on.

You can remove the lock by checking the "Release edit lock" checkbox in preview. This is a way to let other people know that you are done with your editing. Note: Please remember not to go back in your browser in case you checked the box and after that you decide to do more changes to the topic. Instead press the Edit link to re-edit your page.

Note: The "Cancel edit" link in edit mode lets you cancel out of an edit session without saving any changes. It also releases the edit lock, so that other people don't get the lock warning.

WabiSabi : Since wabi-sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Koren, wabi-sabi is the most conspicuous and characteristic feature of what we think of as traditional Japanese beauty and it "occupies roughly the same position in the Japanese pantheon of aesthetic values as do the Greek ideals of beauty and perfection in the West."

Wabi-sabi is a beauty of things imperfect, impermanent, and incomplete. It is the beauty of things modest and humble. It is the beauty of things unconventional.

The concepts of wabi-sabi correlate with the concepts of Zen Buddhism, as the first Japanese involved with wabi-sabi were tea masters, priests, and monks who practiced Zen. Zen Buddhism originated in India, traveled to China in the 6th century, and was first introduced in Japan around the 12th century. Zen emphasizes "direct, intuitive insight into transcendental truth beyond all intellectual conception." At the core of wabi- sabi is the importance of transcending ways of looking and thinking about things/existence.

WebTopicNonWikiTemplate :

WARNING: It is not recommended to use this topic name, because it will not be linked automatically. See TWiki.WikiWord for details.

Make sure you spelled the TWiki.WikiWord correctly and try again. Remember, a WikiWord is case sensitive.

... form elided ...

WebTopicViewTemplate :

Simply click on the Create link at the bottom of this page.

Make sure you spelled the TWiki.WikiWord correctly and try again. Remember, a WikiWord is case sensitive.

... form elided ...

WhatIsWikiWiki :

So what is this WikiWiki thing exactly?

A set of pages of information that are open and free for anyone to edit as they wish. They are stored on a server and managed using some Perl CGI scripts. The system creates cross-reference hyperlinks between pages automatically. See WelcomeGuest and TWikiSite for more information.

Back to: TWikiFAQ

-- Main.PeterThoeny - 27 Nov 2000

WikiCulture :

Everybody can edit any page, this is scary. Doesn't that lead to chaos?

TWiki is one of many WikiWikiClones, the first one was built by Ward Cummingham. Collaborating the Wiki way is different from other collaboration tools like Usenet. A distinct Wiki culture forms around these tools:

Any and all information can be deleted by anyone. Wiki pages represent nothing but discussion and consensus because it's much easier to delete flames, spam and trivia than to indulge them. What remains is naturally meaningful.

Anyone can play. This sounds like a recipe for low signal - surely wiki gets hit by the unwashed masses as often as any other site. But to make any sort of impact on wiki you need to be able to generate content. So anyone can play, but only good players have any desire to keep playing.

WikiName : Your name in WikiNotation. Usually your first and last name connected togther.

For example, Bill Clinton's WikiName is BillClinton.

Note: All users are in the TWiki.Main web. Prepend the "Main" name if you write a username in a topic, i.e. write Main.TWikiGuest to link to Main.TWikiGuest.

WikiNotation : Wiki links topics automatically when you use the WikiWord notation.

WikiReferences :

Some useful articles and books around collaboration and the Wiki technology in particular.

Book: The Wiki Way, Quick Collaboration on the Web; by Bo Leuf and Ward Cunningham; Addison-Wesley Pub Co; ISBN:020171499X

Article: Corporate Collaboration With TWiki; by Peter Thoeny; Web Techniques Magazine; December 2000; http://www.webtechniques.com/archives/2000/12/thoeny/

Presentation: TWiki Collaboration Tool - A Mature and Full Featured Platform for building Web Based Groupware Applications; by Peter Thoeny; TWiki:Main/TWikiPlatformPresentation

Directory: Google.com Computers Software Groupware Wiki; http://directory.google.com/Top/Computers/Software/Groupware/Wiki/

WikiSyntax :

If you can enter text, you're ready for TWiki. With a few simple, intuitive TWikiShorthand rules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...

Separate each paragraph with a blank line.

To display a word or phrase in bold type , put it in asterisks: = bold type =.

To display a word or phrase in italic, put it in underscores: _italic_.

To display a word or phrase in bold italic, put it in double underscores: __bold italic__.

To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: Test.WebHome.

WikiTopic : A WikiTopic is one unit of information in the TWiki web. It is one web page in your browser. The name of the WikiTopic should be a WikiWord.

WikiWikiClones : TWiki is a Wiki Wiki clone and has its root in JOS Wiki.

TWiki's home is at http://TWiki.org/ TWiki takes a lot of ideas from Ward Cunningham's remarkable Wiki Wiki Web invention. A list of Wiki Wiki clones can be found at http://c2.com/cgi/wiki?WikiWikiClones

WikiWord : A WikiWord consists of two or more words with initial capitals, run together.

When you type a WikiWord, you establish a hyperlink. It's as easy as that.

WikiWords are styled like this because:

It makes Wiki hyperlinks instantly recognizable It leads to interesting Wiki topics It avoids the need to fiddle with HTML tags It avoids over-general topics because at least two words are required

Syntax of a WikiWord

Uppercase letter s Lowercase letter s Uppercase letter s Optional lowercase or uppercase letter s or number s

Good examples for WikiWords:

WikiWord GoodStyle AVeryLongWikiTopicNameIsAlsoPossible YearTwoThousand

Number of topics: 109

b r a y d e n . o r g / TWiki