Developer Documentation

Application Developer Topics

Topics for normal users that want to develop Foswiki applications.

Reference

Reference Manual
Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki

Background on core functionalities

Command And CGIScripts
These scripts are located in the bin and tools directories. This topic describes the interfaces to some of those scripts
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 data and search queries are the base for building database applications
Formatted Search
Foswiki's inline search feature allows flexible formatting of search result. This is a key feature for most Foswiki applications
Format Tokens
Description of the format tokens such as $n, $quot, $percent etc used in Formatted Search and a few other macros.
If Statements
The %IF% construct gives Foswiki the power to include content in topics based on the value of simple expressions
Include Topics And Web Pages
Include Topics and Web Pages Using %INCLUDE{...}% Macro
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 simple query language
Regular Expression
A short introduction to regular expressions
Search Help
An introduction to searching
Skin Templates
Skin templates are used when composing the output from all actions, such as view, edit, and preview. This allows you to change the look and feel of all pages by editing just a few template files. This topic describes the special template directives. Both for Skin developers and for advanced wiki application development.
Template Topics
Template topics are topics that define the default text for new topics. A basic feature is most wiki applications.
Web Template Topics
A brief introduction to topic template and a list of templates in this web

Extensions, working with extensions

JQuery Plugin
JQueryPlugin enables the use of the jQuery Javascript library in wiki applications and is used by many plugins to create the user interfaces
Auto View Template Plugin
This plugin enables using special view and edit templates depending on the data form used on the topics
Comment Plugin
Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. The comment forms can be customized and form very advanced user interface for application development
Comment Plugin Template
This topic is used by the Comment Plugin as a template file
Edit Table Plugin
Edit tables using edit fields, date pickers and drop down boxes
JSCalendar Contrib
Enables smart Javascript calender for text entry fields. Users can add calendar directly in their own hand-built forms, without having to write any code.
Plain Skin
The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any markup styles. It can be used to display topic content inside an IFRAME.

Utilities

Country List
List of countries used in the User Form. Can also be used in Foswiki applications
Document Graphics
This is a Foswiki icon library. The graphics can be used in topics and by web applications
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 example in a side navigation bar
Installed Plugins
List of the plugins currently installed and enabled in this Foswiki site

Example topics and applications

FAQAn Application With Wiki Form
A simple example of a Foswiki application using data forms and a submission page made with an HTML form
Example Topic Template
An example used in Template Topics illustrating how to create a new topic based on a specific template topic
Search Pattern Cookbook
A cookbook with many examples how to use the powerful SEARCH feature in wiki applications. See examples of both regular expression searches, query searches, and the use of formatted output
Web Left Bar Example
This topic defines the default left bar in Pattern Skin. Each web has its own left bar. If you need to change it please read in Pattern Skin how to tailor the bars so they do not get overwritten when you upgrade Foswiki

Core, Skin, and Extensions Developer Topics

Topics for programmers that which to design new skins and develop new extensions for Foswiki.

Reference

Reference Manual
Documentation for webmasters, system administrators, project managers, team leaders, and all other users of Foswiki
Developing Plugins
An introduction to developing Plugins
Contribs
A short introduction to Contribs. Contribs are Extensions to Foswiki that are not plugins
Contributed Add Ons
A short introduction to Add-Ons. Add-Ons add functionality with extensions that are not based on the Foswiki scripts
Skins
An introduction to skins and skin development

Perl API

Published API
The API intended for use by plugin / contrib development, and advanced system integration.
Perl Doc
Perl package documentation dynamically generated from perl POD comments. This includes internal classes, in addition to the Published API.
Class Method
A Class Method is a method that must be called relative to the containing class object
Object Method
An Object Method is a method that must be called relative to a previous constructed object of the class type
Static Method
A Static Method is a method in a package that can be called without reference to an object of the package type

Background on functionalities

Appendix Encode URLs With UTF8
Use internationalised characters within Wiki Words and attachment names
Appendix Cascading Style Sheets
Listing of CSS class names emitted from Foswiki core code and standard extensions
Javascript Files
Foswiki Javascript support comprises a number of base Javascript files, attached to this topic, that provide support for features in the basic screens, and are used by most skins.
Skin Templates
Skin templates are used when composing the output from all actions, such as view, edit, and preview. This allows you to change the look and feel of all pages by editing just a few template files. This topic describes the special template directives. Both for Skin developers and for advanced wiki application development.
Meta Data
Additional data, Foswiki-generated or from forms, may be embedded in the topic text using META: macros

Utilities

Installed Plugins
List of the plugins currently installed and enabled in this Foswiki site. Developers can see any code errors in the plugins which is very useful during development
Language Selector
Language selection dropdown. To be included where a language selection is needed, for instance in the top bar or left bar

Skins and extensions

Pattern Skin
This is the default skin that Foswiki is shipped with. This topic is the entry point for selecting themes and doing tailoring of how your Foswiki installation looks like
Pattern Skin Css
This page is a reference for all CSS classes used in Pattern Skin.
Pattern Skin Css Cookbook
Cookbook for how to alter the appearance of PatternSkin using CSS. This includes how to change the color scheme, hide the left bar, change the height of the top bar, removing the top bar, etc.
Pattern Skin Customization
How to customize the apperance of Pattern Skin using templates. This includes how to change the site logos, how to change the features of the top and side bars, and how to hide certain user interface elements depending who the user is.
Pattern Skin Elements
This topic shows the most common elements that you can change in the Pattern Skin. Use this topic to see the result of your changes to CSS.
Pattern Skin Web Create New Topic Template
This is a template topic that defines the design and look of the page you use to create a new topic in Pattern Skin
Print Skin
The print skin, used for printable pages with a small footer. Other skins, such as Pattern Skin, may introduce their own print skin.

Other

Topic Does Not Exist View Template
This template topic defines the look of the page shown when the user has tried to view a topic that does not exist

More in-depth developer documentation can be found in the supplemental documentation.

Really detailed documentation, includigng how to get started as a core developer, can be found on the Foswiki developer site.

Related Topics

Admin Documentation Category
List of documents relevant for the installer and administrator of the Foswiki installation
Admin Tools Category
List of tools available to the Foswiki administrator
User Documentation Category
List of documents for the everyday user from beginner to advanced user
User Tools Category
List of tools the user may need for setting and resetting passwords, changing email address etc.
Topic revision: r1 - 14 Aug 2010, ProjectContributor
 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Telem? Send feedback