User's Guide

Documentation for users.

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

• One-Page Primers
  • BeginnersStartHere: Ultra-compact, 2-minute primer
  • TwentyMinuteTutorial: A compact, 20-minute primer

  • SearchHelp: Tips and help on search
  • GoodStyle: Working tips for an open collaboration environment
  • ShortHand: All of the shorthand basics
  • TextFormattingRules: Scan all text formatting rules on one page
  • Macros: 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
  • GlossaryOfTerms: A simple glossary of terms
  • FrequentlyAskedQuestions: The first things people ask

  • Frequent users should also browse the full Reference Manual!

• Help on Plugins

• TWikiCompatibilityPlugin (Foswiki-1.0, $Rev: 2422 (20 Feb 2009) $): add TWiki personality to Foswiki
• GluePlugin (2.20, 3494): Enable markup to span multiple lines
• IfDefinedPlugin (v2.00, 3637): Render content conditionally
• SpreadSheetPlugin (06 Jan 2009, $Rev: 1842 (20 Feb 2009) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to Foswiki tables and other topic text
• AutoTemplatePlugin (1.0, $Rev: 5797 (2009-12-16) $): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
• BreadCrumbsPlugin (v2.42, 4694): A flexible way to display breadcrumbs navigation
• CommentPlugin (Foswiki-1.0.1, $Rev: 1984 (20 Feb 2009) $): Quickly post comments to a page without an edit/preview/save cycle
• CompareRevisionsAddonPlugin (09 Jan 2009, $Rev: 1904 (2009-01-09) $):
• DBCachePlugin (4.30, 4.30): Lightweighted frontend to the DBCacheContrib
• EditChapterPlugin (2.03, 4371): An easy sectional edit facility
• EditTablePlugin (4.20, $Rev: 2961 (2009-03-10) $): Edit tables using edit fields, date pickers and drop down boxes
• ExplicitNumberingPlugin ($Foswiki 1.0 beta $, 4054): Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Also support numbered headings.
• FilterPlugin (1.80, 3491): Substitute and extract information from content by using regular expressions
• FlexWebListPlugin (v1.40, 4372): Flexible way to display hierarchical weblists
• HeadlinesPlugin (2.21.1, $Rev: 2931 (2009-03-08) $): Show headline news in Foswiki pages based on RSS and ATOM news feeds from external sites
• HistoryPlugin (1.5, $Rev: 2464 (2009-02-12) $): Shows a complete history of a document
• ImageGalleryPlugin (5.01, 4425): Displays image gallery with auto-generated thumbnails from attachments
• ImagePlugin (2.11, 4679): Control the display and alignment of images using an easy syntax
• InterwikiPlugin (03 Aug 2008, $Rev: 1490 (20 Feb 2009) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (2.10, $Rev: 20090710 (2009-07-10) $): jQuery JavaScript library for Foswiki
• NatEditPlugin (v4.10, 4699): A Wikiwyg Editor
• NatSkinPlugin (3.93, 4697): Theming engine for NatSkin
• NewUserPlugin (v2.01, $Rev: 3642 (2009-04-23) $): Create a user topic if it does not exist yet
• RedDotPlugin (2.01, 3650): Renders edit-links as little red dots
• RenderPlugin (3.0, 3644): Render WikiApplications asynchronously
• SendEmailPlugin (1.2.3, $Rev: 2847 (2009-03-03) $): Allows to send e-mail through an e-mail form
• SetVariablePlugin (1.00, $Rev: 4287 (2009-06-23) $): Flexible handling of topic variables
• SmiliesPlugin (04 Jan 2009, $Rev: 1751 (20 Feb 2009) $): Render smilies as icons, like for  :-) or for  :eek:
• TablePlugin (1.038, $Rev: 2910 (2009-03-06) $): Control attributes of tables and sorting of table columns
• TagCloudPlugin (v2.10, 4762): Renders a tag cloud given a list of terms
• TimeSincePlugin (3.00, 3647):
• TreePlugin (1.8): Dynamic generation of Foswiki topic trees
• TwistyPlugin (1.5.3, 4750): Twisty section Javascript library to open/close content dynamically
• UploadPlugin (1.11, 1340): Attach multiple files to a topic in one go