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.9, $Rev: 6017 (2010-01-11) $): add TWiki personality to Foswiki
• SpreadSheetPlugin (10 Nov 2009, $Rev: 5484 (2009-11-10) $): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
• AttachContentPlugin (2.3.3, $Rev: 8629 (2010-08-21) $): Saves dynamic topic text to an attachment
• AttachmentListPlugin (1.3.4, $Rev: 7042 (2010-04-01) $): Displays a formattable list of topic attachments - from any topic - anywhere in a topic
• BreadCrumbsPlugin (v2.42, $Rev: 4694 (2009-08-20) $): A flexible way to display breadcrumbs navigation
• CommentPlugin (24 Feb 2010, $Rev: 6512 (2010-02-24) $): Quickly post comments to a page without an edit/save cycle
• ControlWikiWordPlugin (1.2, $Rev: 8870 (2010-09-03) $): Plugin to stop linking of WikiWords or force linking of non-standard WikiWords
• DBCachePlugin (3.50, $Rev: 8342 (2010-07-28) $): Lightweighted frontend to the DBCacheContrib
• DateTimePlugin (1.2, 4740): Display date and time with formatting options, relative date parameters and localized dates
• DpSyntaxHighlighterPlugin (1.9, $Rev: 8361 (2010-07-30) $): Client side syntax highlighting using the dp.SyntaxHighlighter
• EditTablePlugin (4.34, $Rev: 5854 (2009-12-23) $): Edit tables using edit fields, date pickers and drop down boxes
• ExternalLinkPlugin (1.21, $Rev: 5906 (2009-12-31) $): Adds a visual indicator to outgoing links
• FilterPlugin (2.03, $Rev: 8284 (2010-07-23) $): Substitute and extract information from content by using regular expressions
• FlexWebListPlugin (v1.51, $Rev: 5698 (2009-12-02) $): Flexible way to display hierarchical weblists
• FlowchartPlugin (16 Jul 2010, $Rev: 8203 (2010-07-16) $):
• FreeMindPlugin (1.0, $Rev: 15942 (11 Aug 2008) $): Plugin to render FreeMind? mindmaps
• GenPDFAddOnPlugin (1.2, $Rev: 7410 (2010-05-14) $): GenPDFAddOnPlugin helper plugin for GenPDFAddOn renders the %GENPDF% tag
• GlobalReplacePlugin ($Rev: 2960 (2009-03-10) $, $Rev: 2960 (2009-03-10) $): Global search and replace functionality across all topics in a web
• GluePlugin (2.20, $Rev: 4420 (2009-07-03) $): Enable markup to span multiple lines
• HeadlinesPlugin (2.21.2, $Rev: 6822 (2010-03-21) $): Show headline news in Foswiki pages based on RSS and ATOM news feeds from external sites
• IfDefinedPlugin (v2.00, $Rev: 4422 (2009-07-03) $): Render content conditionally
• ImageGalleryPlugin (5.10, $Rev: 6295 (2010-02-12) $): Displays image gallery with auto-generated thumbnails from attachments
• ImagePlugin (2.31, $Rev: 6307 (2010-02-12) $): Control the display and alignment of images using an easy syntax
• InterwikiPlugin (20 Sep 2009, $Rev: 5022 (2009-09-20) $): Link ExternalSite?:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (3.51, $Rev: 20090710 (2009-07-10) $): jQuery JavaScript library for Foswiki
• NatEditPlugin (v4.21, $Rev: 6336 (2010-02-15) $): A Wikiwyg Editor
• NatSkinPlugin (3.96, $Rev: 6287 (2010-02-12) $): Theming engine for NatSkin
• PreferencesPlugin (20 Sep 2009, $Rev: 5037 (2009-09-20) $): Allows editing of preferences using fields predefined in a form
• RedirectPlugin (1.1, $Rev: 7923 (2010-06-26) $): Create a redirect to another topic or website.
• RenderListPlugin (2.2, $Rev: 5042 (2009-09-20) $): Render bullet lists in a variety of formats
• SendEmailPlugin (1.5.1, $Rev: 6581 (2010-02-28) $): Allows to send e-mails through an e-mail form.
• SetVariablePlugin (1.02, $Rev: 4287 (2009-06-23) $): Flexible handling of topic variables
• SlideShowPlugin (02 Aug 2008, $Rev: 2742 (2009-02-26) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (20 Sep 2009, $Rev: 5046 (2009-09-20) $): Render smilies like as icons
• SubscribePlugin (03 Dec 2008, $Rev: 13787 (18 May 2007) $): Subscribe to web notification
• TablePlugin (1.046, $Rev: 6733 (2010-03-13) $): Control attributes of tables and sorting of table columns
• TagCloudPlugin (v2.21, $Rev: 5764 (2009-12-10) $): Renders a tag cloud given a list of terms
• TopicDataHelperPlugin (1.1.2, $Rev: 7039 (2010-04-01) $): helper plugin for collecting, filtering and sorting data objects
• TwistyPlugin (1.5.4, $Rev: 6281 (2010-02-12) $): Twisty section Javascript library to open/close content dynamically
• UploadPlugin (1.11, $Rev: 4414 (2009-07-03) $): Attach multiple files to a topic in one go
• ZonePlugin (2.1, $Rev: 6966 (2010-03-28) $): Gather content of a page in named zones while rendering it