Project Contributor Note: Please contact us at http://foswiki.org if you contributed to Foswiki and your name is not on this list! Disclaimer: Foswiki gets installed ...
Javascripts This topic contains javascript files that are included by skin templates, and may be used by skin templates and in topics. Related Topics: SkinTemplates ...
Wiki admins Please replace all web's WebTopicCreator topic contents with this text: All WebTopicCreator topics on this site: /$web/$topic?t Edit $web.$topic "} ...
Admin tools Manage your whole site from one screen. Documentation: Reference Manual Site Tools : Configure, , InterWikis, Macros, Doc Graphics, Installed ...
Developer Documentation $n $summary(100, noheader)"}% More in depth developer documentation can be found in the supplemental documentation. Really detailed ...
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 Cunningham ...
The 216 Standard Colors This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 #0000CC #0000FF #003300 #003333 #003366 ...
Access Control Restricting read and write access to topics and webs, by users and groups Access Control allows you restrict access to single topics and entire webs ...
#EncodeURLsUTF8 Appendix B: Encode URLs With UTF8 Use internationalised characters within WikiWords and attachment names Current Status To simplify use of internationalised ...
Logos The official Foswiki logo is attached to this page. Logo Artwork Logo Customization The logo can be changed by redefining the WIKILOGOIMG preference setting ...
Language selection dropdown To be included where a language selection is needed, for instance in the top bar or left bar. Note: this dropdown is only shown if localization ...
ATOM News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribed in WebNotify ...
Time Specifications Foswiki recognises the following formats for date/time strings. For all strings the time is optional. 31 Dec 2001 23:59 2001/12/31 ...
Text Editor A text editor, or text processor, handles plain text only, different from a word processor because it doesn't do display formatting like bold type, or ...
Welcome to nop Foswiki. This page assumes that you are a new user to nop Foswiki, and that you've never heard of Wiki before. Here are the most important pages you ...
This is a short introductory training course for Foswiki beginners. A Taste of Foswiki The basic function of Foswiki is a Wiki (if that helps!) A Wiki is like a web ...
Include Topics and Web Pages Using % nop INCLUDE{...}% Macro Use the % nop INCLUDE{...}% macro to embed the content of another topic or web page inside a topic ...
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 ...
Background Image for Preview Preview looks like the real page, but the links lead to an oops dialog warning users of not yet saved topics. In addition, a background ...
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 WebNotify ...
ManagingTopics can be used to move a topic from one Web to another. One specialised use of this is DeleteWeb. Related Topics: UserDocumentationCategory
#TemplateTopics Template topics Template topics are topics that define the default text for new topics. Overview There are four types of template topics: Topic ...
User Authentication Controlling who can access your site Overview Authentication, or "login", is the process by which a user lets Foswiki know who they are. Authentication ...
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 ...
Formatting Tokens Foswiki defines some standard special tokens that can be used to replace characters in some parameters notably those to FormattedSearch and IfStatements ...
Data Forms Data forms allow you to add structured data to topics. The data stored in the form fields can be used to search and filter topics. The combination of structured ...
Instant Site Enhancements These quick enhancements are aimed at improving and customising your Foswiki. New site administrators are especially encouraged to review ...
Macros Quickstart Macros are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, % nop TOPIC% ...
IF Statements The % nop IF% construct gives Foswiki the power to include content in topics based on the value of simple expressions. Syntax % nop IF{"CONDITION ...
System Requirements Server and client requirements Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across ...
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() ObjectMethod ...
nop Foswiki Site Level Preferences This topic defines site level settings that apply to all users and webs on this site. Note: This topic should be regarded as ...
CGI and Command Line Scripts Programs on the server performing actions such as rendering, saving and renaming topics. These scripts are located in the bin and ...
Foswiki Upgrade Guide This guide covers upgrading from a previous version of Foswiki or TWiki (such as Cairo or TWiki4.0) to Foswiki 1.0 Overview Foswiki is a fork ...
This site is running Foswiki version , Plugin API version Here is a list of the plugins currently installed and enabled on this Foswiki site: Administrators can ...
Installation Guide This guide describes the steps for manually installing Foswiki, with specific steps for installations on Linux with the Apache web server. If ...
%{ do not show the following elements }% #NewTopic $quot }$percnt$quot}$percnt$percntMAKETEXT{$quot(no parent, orphaned topic)$quot}$percnt" else " "}% '" then ...
RSS News Feeds Find out What's New There are several ways to find out what's new in each web: 1. Visit WebChanges to see recent changes 1. Subscribed in WebNotify ...
Developing Plugins The usual way Foswiki is extended is by writing a Plugin . Plugins extend Foswiki by providing functions that 'listen' to events in the Foswiki ...
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 ...
#VarWEB WEB name of current web % nop WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic ...
FAQ: I would like to install Foswiki on my server. Can I get the source? Answer: Foswiki is distributed under the GnuGeneralPublicLicense. You can get the source ...
Macros Special text strings expand on the fly to display user data or system info Macros are text strings % nop MACRONAME% or % nop MACRONAME{ parameter "value ...
FAQ: So what is this nop WikiWiki thing exactly? Answer: A set of pages of information that are open and free for anyone to edit as they wish. They are stored in ...
#VarWHITE WHITE start white colored text WHITE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
#VarIF IF{"condition" ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax ...
Foswiki Skins Skins overlay regular templates to give different looks and feels to Foswiki screens. Overview Foswiki uses skin templates as the basis of all ...
#VarORANGE ORANGE start orange colored text ORANGE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
#VarPURPLE PURPLE start purple colored text PURPLE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
#VarINCLUDINGWEB INCLUDINGWEB web that includes current topic The web name of the topic that includes the current topic same as % nop WEB% if there is ...
#VarRED RED start red colored text RED is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for ...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic Section boundaries are defined with % nop STARTSECTION{}% and % nop ENDSECTION ...
#VarAUTHREALM AUTHREALM authentication realm String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login templates ...
#VarYELLOW YELLOW start yellow colored text YELLOW is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
#VarMAROON MAROON start maroon colored text MAROON is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
Come to foswiki.org. Welcome to the System Web The place to learn about Foswiki features, and perform Foswiki system maintenance. This site is running Foswiki ...
Collaboration Tips Following you will find a short list of hints and recommendations that are considered basic knowledge when starting to edit existing topics. ...
Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: UserDocumentationCategory, AdminDocumentationCategory ...
Administrator Skills Assumptions Note: If you aren't already fairly well skilled in Linux/Unix/Windows, Apache, and so on, consider using a version in a pre packaged ...
#VarLANGUAGES LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is ...
Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default ...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining ...
Wiki culture, concepts and principles General concept and idea of wikis What is a wiki? "A wiki is a page or collection of Web pages designed to enable anyone who ...
Topics The basic building block of a Foswiki site is called a topic , identified by a unique, hopefully descriptive, .WikiWord title. It may seem easier just to call ...
Welcome to Foswiki Welcome to nop Foswiki! This site is a meeting place to work on common interests. Anyone can contribute using any web browser. nop Foswiki looks ...
Reference Manual Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki the Free and Open Source Wiki ...
#VarINCLUDE QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: % nop QUERYPARAMS ...
#VarHTTP HTTP get HTTP headers Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are ...
#VarTOC TOC{"Topic"} table of contents Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ...
#VarGRAY GRAY start gray colored text GRAY is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
Wiki name Your name, usually your first and last name connected without a space. For example, Tim Berners Lee's nop WikiName is TimBernersLee. Your name is also ...
FAQ: I've problems with the nop WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer: That is an indication ...
FAQ: What happens if two of us try to edit the same topic simultaneously? Answer: Foswiki allows multiple simultaneous edits of the same topic, and then merges the ...
#VarOLIVE OLIVE start olive green colored text OLIVE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in ...
#VarFORMFIELD FORMFIELD{"fieldname"} renders a field in the form attached to some topic Syntax: % nop FORMFIELD{"fieldname"}% Supported parameters: ...
#VarSILVER SILVER start silver colored text SILVER is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
#VarADDTOHEAD ADDTOHEAD You can write % nop ADDTOHEAD{...}% in a topic or template. This variable accepts the following parameters: DEFAULT optional, id ...
#VarAQUA AQUA start aqua colored text AQUA is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
Print Skin The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin, may introduce their own print skin. This skin is ...
This page provides 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 ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % nop FAILEDPLUGINS% Expands to: See Plugins#FAILEDPLUGINS ...
#VarTOPICLIST TOPICLIST{"format"} topic index of a web List of all topics in a web. The "format" defines the format of one topic item. It may include formatting ...
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 defaultColour ...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % nop SESSIONVAR% Expand to: Related: UserAuthentication ...
#VarENCODE ENCODE{"string"} encodes a string to HTML entities Encode "special" characters to HTML numeric entities. Encoded characters are: all non ...
Query Search Query searches help you search the contents of forms attached to your topics, as well as the values of other meta data attached to the topic. Using query ...
#VarURLPARAM URLPARAM{"name"} get value of a URL parameter Returns the value of a URL parameter. Syntax: % nop URLPARAM{"name"}% Supported parameters ...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology Book: The Wiki ...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as % nop TOPIC% ...
#VarBASETOPIC BASETOPIC base topic where an INCLUDE started The name of the topic where a single or nested INCLUDE started same as % nop TOPIC% if there ...
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 ...
#VarBLACK BLACK start black colored text BLACK is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
FAQ: How do I delete or rename a topic? Answer: These two questions are answered together because often when you think you want to delete a page, more often it makes ...
#VarTOPICURL TOPICURL shortcut to viewing the current topic This macro always expands to an url pointing to the current base topic. Current value: TOPICURL ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix Your % nop WIKINAME% with web prefix, useful to point to your nop Foswiki home page ...
#VarWIKIVERSION WIKIVERSION the version of the installed Foswiki engine Syntax: % nop WIKIVERSION% Expands to: Related: PLUGINVERSION, WIKITOOLNAME ...
User's Guide Documentation for users. Quick Start WelcomeGuest: A fast track intro covering all the basics BeginnersStartHere: A short introduction ...
#VarQUERYSTRING QUERYSTRING full, unprocessed string of parameters to this URL String of all the URL parameters that were on the URL used to get to the current ...
#VarICONURL ICONURL{"name"} URL of small documentation graphic or icon Generates the full URL of a DocumentGraphics image, which Foswiki renders as an image ...
#VarSCRIPTURLPATH SCRIPTURLPATH{"script"} URL path of script As % nop SCRIPTURL{"script"}% , but doesn't include the protocol and host part of the URL ...
Hierarchical Navigation Navigation block that displays the current topic, its parent and children (if any). This is intended to be included in other topics, for ...
#VarREVINFO REVINFO revision information of current topic Syntax: Date format defined as {DefaultDateFormat} in configure REVINFO{"format"} formatted ...
Formatted Search Inline search feature allows flexible formatting of search result The default output format of a % nop SEARCH{...}% is a table consisting of topic ...
Add Ons Add functionality with extensions not based on the Foswiki scripts. Overview An add on runs separately from the Foswiki scripts, e.g. for data import, export ...
#VarMETA META displays meta data Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta data (attachments ...
#VarTEAL TEAL start teal colored text TEAL is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
#VarHTTPS HTTPS get HTTPS headers The same as % nop HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can ...
#VarICON ICON{"name"} small documentation graphic or icon of common attachment types Generates the HTML img tag of a small graphic image attached to DocumentGraphics ...
#VarENV ENV{"varname"} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface ...
#VarBLUE BLUE start blue colored text BLUE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
Site Tools Utilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activity ...
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 instances ...
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 ...
#VarDISPLAYTIME DISPLAYTIME{"format"} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in ...
Glossary of Terms Term Definition Attachment Any type of file that is uploaded via browser and attached to a topic , where it can be viewed and downloaded ...
#VarUSERSWEB USERSWEB name of users web The web containing individual user topics, .WikiGroups, and customised site wide preferences. Syntax: % nop USERSWEB ...
#VarNAVY NAVY start navy blue colored text NAVY is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that ...
#VarNOP NOP template text not to be expanded in instantiated topics Syntax: % nop NOP% In normal topic text, expands to nop , which prevents expansion ...
Frequently Asked Questions This is a real FAQ, and also a demo of an easily implemented knowledge base solution. To see how it's done, view the source of this topic ...
#VarLIME LIME start lime colored text LIME is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic ...
#VarUSERNAME USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME ...
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 automatically ...
#VarICONURLPATH ICONURLPATH{"name"} URL path of small documentation graphic or icon Generates the URL path of a DocumentGraphics image, typically used in an ...
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 attachment ...
#VarTOPIC TOPIC name of current topic % nop TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name ...
Foswiki Plugins Add functionality to Foswiki with plugins Overview You can add plugins to extend Foswiki functionality without altering the core code. A plug in ...