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

• SpreadSheetPlugin (10 Nov 2009, $Rev: 7176 (2010-04-12) $): 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: 10310 (2010-12-14) $): Displays a formattable list of topic attachments - from any topic - anywhere in a topic
• BatchUploadPlugin (1.2, $Rev: 9957 (2010-11-11) $): Attach multiple files at once by uploading a zip archive
• BeautifierPlugin (1.0, $Rev: 7136 (2010-04-09) $): Provides the %CODE% and %ENDCODE% macros to display code fragments with formatting and syntax highlighting for improved readbility in wiki topics.
• BreadCrumbsPlugin (v2.42, $Rev: 4694 (2009-08-20) $): A flexible way to display breadcrumbs navigation
• CalendarPlugin (12 Aug 2009, $Rev: 5432 (2009-11-04) $): Show a monthly calendar with highlighted events
• CommentPlugin (31 Jul 2010, $Rev: 8771 (2010-08-26) $): Quickly post comments to a page without an edit/save cycle
• DBCachePlugin (3.61, $Rev: 11312 (2011-04-06) $): Lightweighted frontend to the DBCacheContrib
• DateTimePlugin (1.2, 4740): Display date and time with formatting options, relative date parameters and localized dates
• EditTablePlugin (4.34, $Rev: 5854 (2009-12-23) $): Edit tables using edit fields, date pickers and drop down boxes
• ExcelImportExportPlugin (Foswiki, $Rev: 0$): Renders an attached Excel spreadsheet as Foswiki table
• FilterPlugin (2.04, $Rev: 11314 (2011-04-06) $): Substitute and extract information from content by using regular expressions
• FlexWebListPlugin (v1.51, $Rev: 5698 (2009-12-02) $): Flexible way to display hierarchical weblists
• FlotChartPlugin (1.3, $Rev: 9525 (2010-10-06) $): A JQuery based CHARTs for Foswiki
• ForEachPlugin (1.102, $Rev: 10382 (2010-12-22) $): Loop over successive elements of a list, or a range of numbers.
• FormPlugin (2.0.2, $Rev: 11805 (2011-05-31) $): Lets you create simple and advanced web forms
• 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 (6.00, $Rev: 11854 (2011-06-06) $): Displays image gallery with auto-generated thumbnails from attachments
• ImagePlugin (2.40, $Rev: 11303 (2011-04-05) $):
• InterwikiPlugin (12 Jul 2010, $Rev: 8158 (2010-07-13) $): Link ExternalSite?:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (4.10, $Rev: 11763 (2011-05-25) $): jQuery JavaScript library for Foswiki
• LocalMaketextPlugin (0.0.1, $Rev: 20100111 (2010-01-11) $): Provides LOCAL_MAKETEXT for handling .po files for the local system
• NatEditPlugin (4.50, $Rev: 11307 (2011-04-05) $): 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
• RenderPlugin (3.0, $Rev: 4818 (2009-09-09) $): Render WikiApplications asynchronously
• 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
• TagMePlugin (29 Jun 2011, $Rev: 12071 (2011-06-28) $): Tag wiki content collectively to find content by keywords
• TimeSincePlugin (3.00, $Rev: 3647 (2009-04-23) $):
• TimeTablePlugin (Foswiki, $Rev: 5368 (2009-10-23) $): Render a weekly timetable
• TinyMCEPlugin (26 Feb 2010, $Rev: 6527 (2010-02-26) $): Integration of the Tiny MCE WYSIWYG Editor
• TopicDataHelperPlugin (1.1.2, $Rev: 7039 (2010-04-01) $): helper plugin for collecting, filtering and sorting data objects
• TopicTranslationsPlugin (1.0.1, $Rev: 9547 (2010-10-11) $): Manages a topic's translations into several languages.
• TwistyPlugin (1.5.3.1, $Rev: 6737 (2010-03-13) $): 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
• VotePlugin (1.33, $Rev: 5560 (2009-11-17) $): Simple way to count votes
• WysiwygPlugin (17 Jan 2010, $Rev: 6068 (2010-01-17) $): Translator framework for Wysiwyg editors
• ZonePlugin (3.1, $Rev: 9442 (2010-09-30) $): Gather content of a page in named zones while rendering it