NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

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

• SpreadSheetPlugin (2014-09-23, $Rev: 28085 (2014-09-23) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables or anywhere in topic text
• AutoSectionsPlugin (2014-10-08, $Rev: 29491 (2016-02-16) $): Automatically make editable sections based on headings
• BackupRestorePlugin (2013-02-16, $Rev: 25448 (2013-10-14) $): Administrator utility to backup, restore and upgrade a TWiki site
• BlackListPlugin (2013-02-28, $Rev$): Utility to keep malicious users away from a public TWiki site
• CalendarPlugin (2016-01-22, 29936): Show a monthly calendar with highlighted events
• ChartPlugin (2013-05-23, $Rev: 25974 (2013-05-23) $): Visualize TWiki tables with area charts, bar charts, line graphs, scatter charts and sparklines
• ColorPickerPlugin (2013-02-15, $Rev: 25074 (2013-10-14) $): Color picker, packaged for use in TWiki forms and TWiki applications
• CommentPlugin (2013-02-10, $Rev: 24977 (2013-10-14) $): Quickly post comments to a page without an edit/preview/save cycle
• DatePickerPlugin (2013-09-04, $Rev: 26272 (2013-10-14) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
• EditTablePlugin (2013-12-03, $Rev: 26647 (2013-12-03) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
• GaugePlugin (2013-05-16, $Rev: 25944 (2013-05-16) $): Create gauges (graphical or not), typically used for dashboards
• GeoLookupPlugin (2012-11-21, $Rev: 24174 (2012-11-21) $): Lookup geolocation by IP address or domain name
• HeadlinesPlugin (2013-11-18, 26619): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
• IfThenActionPlugin (2015-04-20, $Rev: 29087 (2015-04-20) $): Execute if-then actions on topic view, save, file upload, and user registration, with rules defined in a topic
• InterwikiPlugin (2013-02-12, $Rev: 25126 (2013-10-14) $): Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic
• JQueryPlugin (2013-09-28, $Rev: 26439 (2013-10-14) $): jQuery JavaScript library for TWiki
• LocalCityTimePlugin (2011-07-13, $Rev: 21742 (2011-07-13) $): Shows the local time of a city embedded in a TWiki topic.
• PercentCompletePlugin (2012-12-05, $Rev: 24337 (2012-12-06) $): Percent complete selector, for use in TWiki forms and TWiki applications
• PreferencesPlugin (2013-09-08, $Rev: 26286 (2013-10-14) $): Allows editing of preferences using fields predefined in a form
• QRCodePlugin (2012-11-14, $Rev: 24045 (2012-11-15) $): Create QR Code (a matrix barcode) in TWiki pages, useful for mobile applications
• RecentVisitorPlugin (2012-12-22, $Rev: 24176 (2012-11-22) $): Show recent visitors to a TWiki site
• RenderListPlugin (2013-01-28, $Rev: 24820 (2013-10-14) $): Render bullet lists in a variety of formats
• SetGetPlugin (2015-04-09, $Rev: 29040 (2015-04-09) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
• ShareMePlugin (2012-12-01, $Rev: 24254 (2012-12-01) $): Icon bar to share a TWiki page on popular social media sites such as Facebook, StumbleUpon, Twitter
• SlideShowPlugin (2015-01-14, $Rev: 28669 (2015-01-14) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (2013-01-13, $Rev: 24784 (2013-10-14) $): Render smilies as icons, like  :-)  as or  :eek:  as
• TWikiDrawPlugin (2013-05-17, $Rev: 25952 (2013-05-17) $): Vector drawing editor and clickable maps for diagrams and workflows
• TWikiOrgPlugin (1.001): TWiki.org specific extensions
• TWikiSheetPlugin (2016-04-14, $Rev: 30150 (2016-04-14) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
• TablePlugin (2013-09-25, $Rev: 26425 (2013-10-14) $): Control attributes of tables and sorting of table columns
• TagMePlugin (2014-05-15, $Rev: 27384 (2014-05-15) $): Tag wiki content collectively or authoritatively to find content by keywords
• TinyMCEPlugin (2013-09-18, $Rev: 26397 (2013-10-14) $): Integration of the Tiny MCE WYSIWYG Editor
• TwistyPlugin (2013-03-22, $Rev: 25508 (2013-10-14) $): Twisty section JavaScript library to open/close content dynamically
• VarCachePlugin (2012-11-14, $Rev: 24077 (2012-11-15) $): Cache TWiki variables in selected topics for faster page rendering
• WatchlistPlugin (2016-02-13, $Rev$): Watch topics of interest and get notified of changes by e-mail
• WysiwygPlugin (2013-09-18, $Rev: 26391 (2013-10-14) $): Translator framework for WYSIWYG editors

Comments & Questions about this Distribution Document Topic