#MetaData Meta data Additional data, Foswiki generated or from forms, may be embedded in the topic text using META: macros Overview The default store engines st...
Regular Expressions Regular expressions (REs), unlike simple text queries, allow you to search for text which matches a particular pattern. Introduction REs are ...
Search Pattern Cookbook The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfor...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activ...
Text Editor A text editor is different from a WYSIWYG editor because it doesn't do display formatting like bold type, or mixed font styles, sizes and colors. ...
Time Specifications Date/time formats recognised and generated by Foswiki. For all strings the time is optional. * 31 Dec 2001 23:59 * 2001/12/31 23:59:59...
20 Minute Tutorial This step by step, hands on tutorial gets you up to speed with all the Foswiki basics... 1. Get set... Open two browser windows, so that you...
User Settings preference settings customizable by users Some of the preference settings are explicitly intended to be customized by users, though a default is p...
List of GSICS Wiki users Below is a list of users with accounts. If you want to edit topics or see protected areas of the site then you can get added to the list ...
Using HTML When, and how, to use HTML in topics. You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is...
What is WYSIWYG? WYSIWYG is an acronym for for "What You See Is What You Get". Foswiki allows you to edit content using a WYSIWYG editor. This editor lets you edi...
Online help for new users of Foswiki when editing a page. If there's some formatting that your contributors use often, you can customize this for your site's part...
What is a WikiWord? A WikiWord consists of two or more words with initial capitals, run together. WikiWords are used to refer to topics. WikiWords refer to topics...
PreferencesPlugin Allows editing of preferences using fields predefined in a .DataForms. However, the edit fields are inlined in the text, similar to how tables a...
%MAKETEXT{"Your username is a sequence of alphanumeric characters and underscores that uniquely identifies you to the system. The exact format of the username dep...
Skin Template Tokens Placeholders expanded by Foswiki scripts when generating output Overview Template Tokens are written exactly like Foswiki macros, but they a...
MailerContribPlugin This is a 'mini' plugin that provides a rest handler for invoking the mail notification process via an HTTP request (e.g. from the browser). I...
Group Member Toggle This topic implements a button that will turn Admin status on or off for the current user (!), by adding or removing the user from the AdminGr...
IF statements The %IF% macro gives you the ability to test for macro values, URL parameters, access permissions, topic existence and more. Syntax In the example ...
BookView is an option available for the SEARCH macro. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of...
HomePagePlugin Usage This plugin makes the Default frontpage configurable 1 any time a user goes to they will be shown the topic configured by the Foswiki...
SkinTemplateViewTemplate is a Skin Template So should not be viewed directly. Use to see the Template source. ** Skin Templates Set VIEW_TEMPLATE=SkinTemplateVie...
TWikiCompatibilityPlugin Usage Automatically maps requests for legacy TWiki web topics to Foswiki free topics as per TopicNameMappingTable. Map TWIKIWEB to SYSTE...
" hidelink=" #9660; " linkclass="foswikiButton" remember="on"}% About the Web changes notification service Each Foswiki web has an automatic e mail notification ...
Under normal circumstances, there should be no need to rebuild your . topic. Sometimes, the . topic maintained by .TopicUserMappingContrib may not reflect the tru...
. %MAKETEXT{"Your name is also a potentially valid _1 .WikiWord WikiWord when used within a topic. However the home pages of registered users on this site ...
Raw Text link At the bottom of each page among the action links (assuming use of the default PatternSkin), there is a View wiki text link which shows how a topic ...
WebLeftBar Cookbook Instructions and tips how to use WebLeftBarPersonalTemplate. WebLeftBarPersonalTemplate is a topic template to create a personal left bar bloc...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG_EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG_EXCLUDE c...
Control table attributes with TablePlugin The TablePlugin gives extra control of table display: * Allows sorting * Changing table properties like border wid...
RSS news feed of topic changes You can use an RSS news reader to find out what is new in a Foswiki web. This complements WebChanges that shows recent changes in a...
Statistics documentation The following section namely the help text and the statistics table headings is included into each topic. If you want to tailor the...
Site Statistics Introduction Statistics of visits to pages in a web can be generated manually or automatically, on a per web basis. Statistics are compiled as a ...
GSICS Wiki Sitemap This table is updated automatically based on WebPreferences settings of the individual webs. %SEARCH{ "1" topic="" web="all" type="query" ...
User Form Help %IF{"$ BASEWEB=''" then="%IF{"istopic '.UserFormHelp'" then="This is the default user form. You have also created a customized copy at .UserForm ...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and If...
See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages. See also Developing plugins, Developer's Bible, Tec...
Template Web Purpose Template webs were created to act as templates in creating webs. It is now possible to create webs via the .ManagingWebs topic. In the not...
** Wiki admins Please replace all web's WebTopicCreator topic contents with this text: All WebTopicCreator topics on this site: %SEARCH{ "WebTopicCreator" ...
A StaticMethod is a method in a package that can be called without reference to an object of the package type. For example, package Telecoms StaticMethod defaul...
* Please bring your enhancement requests to Foswiki:Development.FeatureProposals Related Topics: * ReleaseHistory has a list of added features in Foswiki. *...
%{ Include the default edit templates from your current SKIN and COVER paths }%%{ Define the formtop container to display the form }%%{ Define the formbot...
Both users and groups can be hidden from common view and made visible only to the admin or to selected users and groups. You do this the same way as you access co...
Some questions to answer: * Perhaps the plugin is installed, but did you remember to enable it in configure? * Did the installer mention any missing depende...
Each FileAttachment in a Topic can have additional attributes. At present only the H (hidden) attribute is supported. If this attribute is set then the attachme...
Go Box The box at the top or sidebar of each page, also called Jump box. Enter a topic name to quickly jump to the topic, for example: * WebNotify to jump to ...
An ObjectMethod is a method that must be called relative to a previous constructed object of the class type. For example: package Telecoms ClassMethod new() Ob...
A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new object inst...
PublishPlugin Generates a static view of a web, as HTML files on disc, or as a PDF, or as a zip or tgz archive file, or by uploading directly to an FTP server. Or...
This is a template topic for use with PublishPlugin. It illustrates how to set up a topic in a web to simplify publishing. To use it, take a copy of the raw text ...
SafeWikiSignatures This topic can be used to allow trusted users to add Javascript signatures to the SafeWikiPlugin. If this topic or a copy in another location ...
Use this form to add new signatures and their descriptions to the above table of authorized signatures. Enter the 43 character SHA 256 signature and an optional ...
Topic Data helper plugin Helper plugin for collecting, filtering and sorting data objects, to be used by other plugins. This plugin is used by Foswiki:Extensions/...
Color scheme settings for .PatternSkin Use this topic to change the color settings of .PatternSkin. When this topic is saved, the attachment my_colors.css will be...
TinyMCE FAQs Frequently Asked Questions of the TinyMCEPlugin integration. Q: The editor takes over the standard edit screen. That's OK, but how do I get access t...
Easy Timeline Plugin As the saying goes: a picture is worth a thousand words. This is certainly true for graphical timelines. A detailed listing of events and dat...
GoUptoTocPlugin Adds a arrow to each header, which lets you jump up the TOC anchor * Set SHORTDESCRIPTION = Adds a arrow to each header, which lets you jump u...
JHotDrawPlugin This plugin encapsulates the JHot Draw Java Applet. JHot Draw is a simple drawing editor that supports diagramming in a style similar to that found...
The Go Box as a browser The go box (also called jump box) allows you to jump from page to page and search for documents. If you do not know the entire name of th...
WebChanges to see recent activity Each Foswiki web has a WebChanges topic that lists recent activity from all editors of the web. This can be useful when looking ...
E mail alert of topic changes Subscribing to WebNotify will enable Foswiki to send you details of changes made on topics in a certain web. You can choose to be no...
Creating a Table of Contents %TOC% automatically creates a table of contents based on the headings present in the topic. To exclude a heading from a %TOC% add !! ...
File attachments Files can be attached to any topic. The action of attaching a file to a topic is similar to attaching a file to an e mail use the Attach link i...
Breadcrumb The breadcrumb of a topic shows you page hierarchy. It is constructed using a topic's parent setting; for example, the breadcrumb on this page looks l...
Foswiki Skins Skins overlay regular templates with alternate layouts (and styles). You can use Skins to change the look of a Foswiki topic, for example, the layo...
Revision control In Foswiki, assuming appropriate AccessControls, anyone can change anything but those changes are logged. There is a complete audit trail with r...
Commenting with hidden text To hide sections of a Foswiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example spa...
InterwikiPlugin links The InterwikiPlugin automatically links ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic. This enab...
SpreadSheetPlugin for dynamic content Over 80 formulae are available through the SpreadSheetPlugin. For Example: * $AVERAGE() * $IF() * $REPLACE() * $...
SlideShowPlugin for presentations Use SlideShowPlugin to convert a topic with headings and bullets into a slideshow presentation. This plugin is useful when conte...
Custom rendered bullets RenderListPlugin can render bulleted lists in a variety of different ways. Use %RENDERLIST{ parameters }% before any bulleted list. More ...
Disabling links in large blocks of text You can disable automatic linking of WikiWords by surrounding the text with = noautolink = and = /noautolink = tags. Each ...
Disabling individual WikiWords Prevent a WikiWord from being linked by prefixing it with an exclamation point. Example: To escape SunOs write SunOs to get SunOs. ...
WikiWords for linking WikiWords are capitalized words, run together, such as WebPreferences and CollaborationPlatform. Using a lot of WikiWords creates a good bro...
Inline search To embed a search in a topic, use the %SEARCH{ parameters }% macro. The search macro is used by many Foswiki based applications. More Information....
SmiliesPlugin emoticons Smilies are common in e mail messages and bulletin board posts. They are used to convey an emotion, such as a smile #058; ) : ) or a frow...
Comment box with CommentPlugin The CommentPlugin allows users to quickly post comments to a page without an edit/preview/save cycle. Write %COMMENT{ attributes ...
Keyword search Interactive search is a keyword search by default. For example, to search for all topics that contain "SOAP", "WSDL", a literal "web service", but ...
Action Tracker Plugin This plugin provides support for tracking actions embedded in topics. Actions captured this way can then be searched from any topic in the w...
Footnote Plugin Support for footnotes in foswiki topics. Syntax Rules Write {{ note text }} anywhere in a topic. This will be replaced with a link to the note at...
* You are currently in the web. The color code for this web is this background, so you know where you are. * If you are not familiar with the GSICS Wiki colla...
Foswiki is a Wiki Wiki clone and has its root in JOS Wiki via TWiki . * Foswiki's home is at http://foswiki.org/ * Foswiki takes a lot of ideas from Ward Cu...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of inte...
Force new revision option Normally, if you make subsequent edits within a one hour period (configuration item ReplaceIfEditedAgainWithin), GSICS Wiki will fold to...
Use the "Minor changes, don't notify" checkbox in preview in case you only make a minor change to a topic and you do not want to inform everybody who is on the We...
Like Save but does not e mail people on the WebNotify notification list same effect as checking "Minor changes, don't notify". Related Topics: UserDocumentation...
Access Keys What are access keys? Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without ha...
Since wabi sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Ko...
Installation Guide Part 1 This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web serve...
\usepackage{amsfonts} \definecolor{Lightmaroon}{rgb}{0.6667,0,0} \definecolor{Cornflowerblue}{rgb}{0,0.4,0.8} Introduction to \Large\LaTeX \LaTeX is a complete...
LatexModePlugin This LaTeX Mode Plugin allows you to include LaTeX mark up commands within a Foswiki page. It uses external programs (specifically latex, dvipng ...
UploadPlugin This plugin provides a more flexible interface to upload one or more files to a topic. Using standard means, only one file can be uploaded at the sam...
Attachment List Plugin Displays a formattable list of topic attachments from any topic anywhere in a topic. View permissions are honored: if the user is not a...
Hide/Unhide Attachments You can hide/unhide file attachments in normal topic view. * In the FileAttachment table, click on an action link, * enable the Hide...
Shortcuts Easy ways to save some typing Some macros are just shortcuts for longer sequences of characters, to either save typing or to easily allow line breaks in...
Text Formatting Working in Foswiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created aut...
#VarBB BB bullet with line break * Line break and bullet without indentation. * Current value: BB = * Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR...
#VarTOPICURL TOPICURL shortcut to viewing the current topic * This macro always expands to an url pointing to the current base topic. * Current value: TO...
#VarVBAR VBAR vertical bar * The vertical bar macro can be used in TML tables. * Current value: VBAR = * Related: BR, BULLET, BB, BB2, BB3, BB4, CARE...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology * Book: The W...
Shorthand Basics If you can enter text, you're ready for Foswiki. With a few simple rules, you'll be able to use plain text to create well styled postings, instan...
AttachLinkPlugin Standard links to attachments Syntax Rules NOP This apparently trivial plugin turns out to be quite useful. Besides syntactic sugar, it actuall...
#VarEDITACTION EDITACTION Selects an edit template * The EDITACTION preference setting lets you define the use of an editaction template instead of the stan...
Redirect Plugin I typically use this to make easy to type shortforms/acronyms of topic names. For example: * Actual content appears under Main.LightweightDirect...
DpSyntaxHighlighterPlugin This plugin provides client side syntax highlighting using the dp.SyntaxHighlighter by Alex Gorbatchev. JavaScript needs to be enabled o...
The name you log in with A login name is a sequence of alphanumeric characters and underscores. You cannot alter your LoginName: you have to get the administrator...
External Link Plugin This plugin adds a visual indicator to external links, so users can distinguish outgoing links from site links. This will only work for force...