DeveloperDocumentation

nop ChangeProposals that are nop AcceptedBy14DayRule

nop ChangeProposals that are nop AcceptedByReleaseMeeting Change proposals raised according to the release process may be discussed and voted for at the release ...

Accepted Feature Proposals Proposals that have a committed owner and have been accepted according to the release process Accepted proposals waiting to be implemented ...

nop ChangeProposals that are in state nop AcceptedProposal This state is used when a proposal has been accepted according to the release process , either by ConsensusReached ...

A ChangeProposal's BugTracking field is used for linking to Bugs in the Bugs web that track it's implementation.

BuildContrib Cookbook This is a cookbook of recipes for using BuildContrib. BuildContrib is a powerful, multi faceted build system, used to build Foswiki extensions ...

This manual process describes the autoBuildFoswiki.pl script Reminder to Kenneth and Sven: Need to change the sequence below so that the Patch branch is made at feature ...

CSS Resources A list of resources for those intrepid adventurers who want to learn more about CSS. Local Topics this list is automatically generated by searching ...

Change Proposals Classification Change proposals fall in to one of the following categories, each with its own template for new topics. Go to a classification's topic ...

Changed Active Feature Proposals This topic is a helper topic that searches for feature proposals with a committed driver per our release process and displays the ...

Changed Feature Proposals without a committed developer This topic shows changes in feature proposals that do not have a committed developer and therefore do not follow ...

CodeAttribution Please discuss on the discussion page. Note copyright laws vary from jurisdiction to jurisdiction. Assuming the Foswiki association will be incorporated ...

Perl coding standards System Requirements Core code should be based on the .SystemRequirements. Avoid adding dependencies on external Perl modules not shipped with ...

CodingStandardsDiscussions Regarding TWiki Coding Conventions Are we really fixated on the camel case style for function and variable names (within code)? Most Perl ...

Completed Feature Proposals Proposals that have been completed following the release process Completed Proposals (Merged to core or to default plugin) Topic ...

Concern Raised By As described in the release process ANYONE can raise concern against a proposal for a new feature or change of existing feature. The concern ...

ChangeProposals that have reached consensus These ChangeProposals are at the stage where enough information and agreement exists to be able to start documenting and ...

CopyrightAndLicense Please discuss on the discussion page. Copyright The Foswiki product is Copyright 2008 by the Foswiki project and its contributors. Please refer ...

CopyrightAndLicenseTalk Assignment of copyright To make it easier to resolve any potential copyright disputes, and to simplify the task of attribution for any other ...

Core Internals This page aims to describe, in geek speak, what is going on in the core internals of Foswiki, and what we hope to achieve by making these changes. This ...

Current State workflow A ChangeProposal's CurrentState field is used for tracking its development status. It can take the following states: Name ...

Customer Advocates Customer advocates are members of the Foswiki community that have volunteered to monitor the FeatureProposals that are raised and evaluate them ...

Date Of Commitment As defined in the release process the 14 day auto acceptance rule does not apply unless a proposal has developers committed to implementing ...

Developer Responsibilities With every freedom comes responsibilities, and if you are able to check in you also have a responsibility to contribute to the maintenance ...

DevelopersBible This is the gateway to all documentation used day to day by developers. Follow Getting Started if you are new to the game. Basic process and ...

Developers Feature Test Checklist Background When you make code changes that can affect many features it can be difficult to systematically walk through all the features ...

This topic is a stub; you can help Foswiki by expanding the content here to describe best practices for documentation. Documentation standards for developers For ...

So, you want to help Foswiki by creating an extension? Great! Here's how to get started. First, if you want to make a simple plugin using the Plugins API, read this ...

Plugins and License This topic describes the license that applies to Foswiki extensions. The purpose is to help new extension developers to choose the correct license ...

Feature Proposals See ReleaseProcess. New feature proposals will by nature be for the first Foswiki release. When you add a proposal you must create a new topic describing ...

What is nop FoswikiBot? nop FoswikiBot is an IRC bot for the #foswiki IRC channel. The bot is a Mozbot with a few custom modules. What can nop FoswikiBot do? ...

Foswiki Stand Alone Introduction There are many ways to run web applications, including CGI, mod perl (for Perl apps), and FastCGI. Each of them has its strengths ...

Language Translated Fuzzy Untranslated % translated bg 619 3 135 81% cs 757 0 0 100% da 757 0 0 100% ...

Feedback copied from Tasks.Item1174 Here are few things from my wish list: GENPDF{"Web.Topic.Section"} Create a link for the named section of a topic. ...

Help on getting started as a developer Developers don't just write code. Translators are also developers, as are documentation authors, skin designers anyone who ...

GitAndGithub What's github Github is a social networking site for developers, using git. How to configure We made a generic user account for github called foswiki ...

GitCookbook rebase Rebase is one of the most powerful feature of git, and probably most dangerous one too. As it rewrites history, you have to ensure the history ...

Guidelines for Writing Secure Extensions A collection of guidelines on how to write secure extensions to Foswiki. Organization of scripts, data code Client ...

GuidelinesForTWikiCompatibleDevelopment Licensing issues Compatibility of licenses Presently both TWiki and Foswiki are licensed under GPLv2 or later . Any contributions ...

Guidelines for moving TWiki extensions to Foswiki Migration from TWiki to Foswiki Foswiki and TWiki share a common heritage, and with the help of the TWikiCompatibilityPlugin ...

HowToAddRESTAndMacroHandlersToContribs A problem arises sometimes when you want to add a REST or macro handler to a Contrib. It's a problem because unlike plugins ...

HowToBeAGoodExtensionDeveloper Bad behaviour is : 1 abandoning extensions (not maintaining them) 1 not listening to your user base 1 ignoring or even rejecting ...

How to integrate with request validation (strikeone) The process of request validation is described in outline in the support article on security features. This article ...

How to make a simple Foswiki Plugin Introduction This topic is written for the absolute beginner that would like to write a simple plugin for Foswiki that implements ...

How to start extension development in Subversion What is Subversion? "Subversion is a free/open source version control system. That is, Subversion manages files ...

HowToUseGit Here you will find details on how to use git to develop on Foswiki. The small tricks have been put into GitCookbook so that this page doesn't grow beyon ...

Style guide for writing better copy Everyone at some point needs to write copy (text): documentation, a proposal, or answers to support questions. This topic provides ...

nop ChangeProposals that are in state nop ImplementedAsExtension These ChangeProposals were implemented as an optional extension.

Internationalisation guidelines This document is targeted at developers (core code, plugin code and user interface developers) . If you are looking for instructions ...

Feature Proposals under Investigation Proposals that are under investigation and don't yet fulfil the basic criteria in the release process mainly Proposals must ...

JQueryLibPlugin Development page for JQueryLibPlugin Motivations I decided working on JQueryLibPlugin as at the time JQueryPlugin was not ported to Foswiki, marked ...

LanguageUsageGuide This document provides guidance on language usage in Foswiki product documentation. For a mapping of older terms to new ones introduced by the Foswiki ...

.Macros should observe the following syntax: macro :: '%' macro name argList '%' ; argList :: '{' args '}' ; args :: cheat args ...

MakeTextWebFrameworks Web based translation tools Pootle Project: http://translate.sourceforge.net/wiki/pootle/index Demo: http://pootle.locamotion.org ...

nop ChangeProposals that have made it into a Release These ChangeProposals are in a previous release, or will be in the next major release!

NatSkinDev Discussion If you want to change the behavior of your Nat editor you can take a look at jquery.natedit.js . The jquery.natedit object is created from ...

Nerdometer An tool to measure the nerd factor. 0 is the ideal. No trace of nerdiness. And 10 is an absolute disaster. This Nerdometer and its nerd factor is meant ...

Notes on Java Applets and AJAX Down and Dirty Developer Documentation I compiled the following notes while working on the JHotDrawPlugin. I wanted to be able to ...

Parked Feature Proposals Proposals that have been parked because they failed to fullfill the basic criteria in the release process mainly Proposals must have ...

nop ChangeProposals that are in state nop ParkedProposal A proposal which may have been discussed but there was never a committed developer that came forward, or ...

PerlCritic Perl::Critic is an extensible framework for creating and applying coding standards to Perl source code. Essentially, it is a static source code analysis ...

PerlTidy Perltidy is a Perl script which indents and reformats Perl scripts to make them easier to read. If you write Perl scripts, or spend much time reading them ...

Plugin API Policies Introduction It's important that authors of Plugins are able to work within an environment without shifting ground rules. Otherwise, people end ...

Feature Proposals taken for Community Vote A Feature proposal is ready for community vote per release process when Proposals that have a committed developer willing ...

Which release was/is this targeted for, Anyone can set this but that does not mean it will actually be done for that release; that will be decided by the priorities ...

Reason For Decision This field is used to identify the reason behind a decision taken by the Foswiki Community in relation to new feature proposals according to the ...

Rejected Feature Proposals Proposals that have been rejected following the release process Proposals that have been rejected can be put back in UnderInvestigation ...

nop ChangeProposals that are in state nop RejectedProposal This state is used when a proposal has been rejected according to the release process .

ReleaseNumbering This topic is about release numbering as it applies to extensions. For information about release numbering of Foswiki releases, see another topic ...

Process There are two levels of feature acceptance/tracking: Feature proposal acceptance Minor feature tracking bug fixes Feature proposal acceptance ...

Want access to change the MAIN (Core) branch or extensions? Before you obtain access to submit changes to Foswiki, we would like to know more about you: your background ...

SVK SVK is a decentralized version control system written in Perl. It uses the Subversion filesystem but provides additional, powerful features. SVK inherits the features ...

SVN Subversion code repository for Foswiki. See SvnRepository.

How to integrate extension configuration into bin/configure Introduction Simple plugins can embed configuration data in the 'Plugin' topic added to the System web ...

StepByStepRenderingOrder Order of plugin handler calls Here's an annotated example of the plugin handler calls during the view of a simple page (no skin, page contains ...

Foswiki Installation based on Subversion Once you have followed the instructions in SvnRepository you can run a Foswiki from this checkout area simply by pointing ...

Subversion Branching and Tagging Overview A major release is a release where the first digit in the version number changes. A minor release is a release ...

How to set up your local SVN mirror (with svk) Method 1: To have a local subversion repository The goal is to have one's own subversion repository in order to add ...

Subversion We maintain our code using Subversion, SVN in short. If you are user or admin using Foswiki, you can download the latest code using the instructions ...

Technical Overview Describing what nop Foswiki is, and how it works, in 3,000 metre terms, for developers. Apologies in advance that the some of the language in ...

The 14 days rule of feature decision making It is part of the decision making process of the community, and structures the way new feature proposals are handled. The ...

Thin Prefs GilmarSantosJr 11 May 2009

Topic Structure For Foswiki Extensions Please discuss on the discussion page. Overview Summary Each extension has a topic with the same name as the extension ...

TranslationUserInterface TranslationUserInterface This document is targeted at translators . If you are looking for instructions on configuring your Foswiki to work ...

nop ChangeProposals that are in state nop UnderConstruction These ChangeProposals are at the stage where documentation and/or coding has started; these are LiveProjects ...

nop ChangeProposals that are in state nop UnderInvestigation Basic proposal, concept or report, anything which hasn't entered the workflow proper. Examples are: a ...

Understanding Encodings Why do we have such a hard time with international character sets? As more of us start to understand how they work, the implications of support ...

Test Cases Tutorial optionsau Introduction Foswiki is written in Perl. Like all large and complex software projects, it requires developers to be disciplined and ...

User Interface Internationalisation Introduction This document is targeted at developers (core and plugin code and user interface developers) . If you are looking ...

WORK IN PROGRESS please feel free to contribute Introduction jQuery is an industry standard Javascript framework, used by a lot of Foswiki extensions and many foswiki ...

VimEditor Configuration For Development To configure vim as per the CodingStandards, put the following in your .vimrc set shiftwidth 4 set expandtab set tabstop 4 ...