TWiki User's Guide

Documentation for TWiki users.

• TWiki Quick Start
  • WelcomeGuest: A fast track intro covering all the basics
  • ATasteOfTWiki: A short introduction training course for beginners
  • TWikiRegistration: Sign up so you can edit pages and select options

• One-Page Primers
  • TWikiSite: Ultra-compact, 2-minute TWiki primer
  • TWikiTutorial: A compact, 20-minute TWiki primer

  • TWikiTopics: Customize, rename, move, or delete TWiki topics
  • SearchHelp: Tips and help on search
  • GoodStyle: Working tips for an open collaboration environment
  • TWikiShorthand: All of the TWiki shorthand basics
  • TextFormattingRules: Scan all TWiki text formatting rules on one page
  • TWikiVariables: How to easily embed text, graphics, dynamic content
  • FileAttachments: Browser-upload files for distribution or display
  • WebChangesAlert: Get e-mail alerts linking to the latest page changes
  • TWikiGlossary: A simple glossary of TWiki terms

• TWiki Help FAQs
  • TWikiFAQ: The first things people ask about TWiki
  • TextFormattingFAQ: Common how-to questions about posting in TWiki
  • Frequent users should also browse the full Reference Manual!

• Help on InstalledPlugins

• ControlsPlugin (Dakar, $Rev: 16980 (12 Dec 2008) $): This plugin renders a control (typically used in an HTML form) based on values defined in a topic.
• CommentPlugin (03 Aug 2008, $Rev: 17303 (12 Dec 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
• MacrosPlugin (Dakar, $Rev: 15763 (12 Dec 2008) $): Supports parameterised includes.
• FormQueryPlugin (TWiki-4, $Rev: 15561 (12 Dec 2008) $): Provides query capabilities across a database defined using forms and embedded tables in TWiki topics.
• SpreadSheetPlugin (any TWiki, $Rev: 18078 (02 Sep 2009) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
• ForEachPlugin (1.000): Loop over successive elements of a list, or a range of numbers.
• EditTablePlugin (4.7.10, $Rev: 16239 (22 Jan 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
• ActionTrackerPlugin (21 May 2007, $Rev: 16787 (12 Dec 2008) $): Adds support for action tags in topics, and automatic notification of action statuses
• AttachContentPlugin (2.2.0, $Rev: 15560 (12 Dec 2008) $): Saves dynamic topic text to an attachment
• AttachmentListPlugin (2010-07-25, $Rev: 19248 (2010-07-25) $): Displays a formattable list of topic attachments, anywhere in a topic.
• CalendarPlugin (Dakar, $Rev: 14775 (11 Dec 2008) $): Show a monthly calendar with highlighted events
• ChartPlugin (any TWiki, $Rev: 18184 (23 Oct 2009) $): Create PNG or GIF charts to visualize TWiki tables
• ChecklistPlugin (Cairo, Dakar, Edinburgh, ..., $Rev: 18181 (21 Oct 2009) $): Create simple checklists.
• DBCachePlugin (2.01, $Rev: 16969 (12 Dec 2008) $): Lightweighted frontend to the DBCacheContrib
• DateFieldPlugin (Dakar, $Rev: 15760 (12 Dec 2008) $): Adds a date type for use in forms
• DiskUsagePlugin (1.010): This plugin shows the disk usage for the current web
• ExplicitNumberingPlugin (Dakar, $Rev: 15561 (12 Dec 2008) $): Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Support also numbered headings.
• FlowchartPlugin (Dakar, $Rev: 15561 (12 Dec 2008) $): Bilds a flowchart from information on the topic
• GaugePlugin (Dakar, $Rev: 15564 (12 Dec 2008) $): Build dashboards that contain graphical images of gauges defined with %GAUGE{}% variables.
• GoogleWeatherPlugin (V1.01, $Rev: 15942 (11 Aug 2008) $): Plugin to return the weather using Google
• HeadlinesPlugin (2.3, $Rev: 18123 (02 Sep 2009) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
• HtmlFormsPlugin (Dakar, $Rev: 15564 (12 Dec 2008) $): HtmlFormsPlugin
• ImageGalleryPlugin (3.72, $Rev: 17034 (12 Dec 2008) $): Displays image gallery with auto-generated thumbnails from attachments
• InterwikiPlugin (28 Feb 2009, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (0.80, $Rev: 17031 (12 Dec 2008) $): jQuery JavaScript library for TWiki
• LatexModePlugin (3.71, $Rev: 16926 (12 Dec 2008) $): Enables LaTeX markup (mathematics and more) in TWiki topics
• LightboxPlugin (Dakar, $Rev: 13273$): TWiki hooks to the Lightbox Javascript package for better thumbnail clickthrough
• LocalCityTimePlugin (Dakar, $Rev: 15565 (12 Dec 2008) $): Shows the local time of a city embedded in a Everiware topic.
• MathModePlugin (2.96, $Rev: 15934 (12 Dec 2008) $): Include LaTeX formatted math in your TWiki pages
• NewsPlugin (Dakar, $Rev: 15565 (12 Dec 2008) $): %NEWS% generates a short headlines topic from a list of news
• NotificationPlugin (Dakar, $Rev: 15565 (12 Dec 2008) $): This plugin allows you to send fine grained notifications of topics you are interested in
• PreferencesPlugin (TWiki-4.3, $Rev: 18016 (02 Sep 2009) $): Allows editing of preferences using fields predefined in a form
• ProjectPlannerPlugin (Dakar, $Rev: 15566 (12 Dec 2008) $): This plugin is used for project planning
• RenderFormPlugin (Dakar, $Rev: 17581 (05 Oct 2008) $): Create new topics with simple forms like TWikiForms.
• RenderListPlugin (2.0, $Rev: 16235 (02 Sep 2009) $): Render bullet lists in a variety of formats
• SendEmailPlugin (1.2.2, $Rev: 17666 (12 Dec 2008) $): Allows to send e-mail through an e-mail form
• SlideShowPlugin (02 Aug 2008, $Rev: 17260 (02 Sep 2009) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, $Rev: 16049 (02 Sep 2009) $): Render smilies as icons, like for  :-) or for  :eek:
• TWikiDrawPlugin (Dakar, 8154): Java Applet based drawing editor
• TablePlugin (1.036, $Rev: 17769 (02 Sep 2009) $): Control attributes of tables and sorting of table columns
• TimeTablePlugin (Dakar, $Rev: 18182 (23 Oct 2009) $): Render a weekly timetable
• TimelinePlugin (Dakar, $Rev: 16542 (12 Dec 2008) $): Show a scrolling Timeline from a TWiki SEARCH
• TinyMCEPlugin (03 Aug 2008, $Rev: 18146 (02 Sep 2009) $): Integration of TinyMCE? with WysiwygPlugin
• ToolTipPlugin (1.4, $Rev: 17565 (12 Dec 2008) $): create Tool Tips for links
• TopicCreatePlugin (1.1, $Rev: 18188 (25 Oct 2009) $): Automatically create a set of topics and attachments at topic save time
• TwistyPlugin (1.4.12, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
• WebPermissionsPlugin (1.120, $Rev: 17115 (12 Dec 2008) $): View and edit web permissions
• WorkflowPlugin (28 Jan 2008, $Rev: 16724 (12 Dec 2008) $): Supports work flows associated with topics
• WysiwygPlugin (18 Apr 2009, $Rev: 18083 (02 Sep 2009) $): Translator framework for Wysiwyg editors