You are here: Foswiki>Development Web>WebPreferences>BasicForm>TopicClassification>DeveloperDocumentation (10 Nov 2008, RafaelAlvarez)

DeveloperDocumentation

Documentation used by developers, not usually of interest to non-developers.

Recently modified topics: UnitTests, TechnicalOverview, BuildingARelease, CompletedFeatureProposals, ReleaseProcess, ProposalsReadyForCommunityVote, AcceptedFeatureProposals, HowToStartExtensionDevelopmentInSubversion, BuildContribCookbook, UnderstandingEncodings, GitAndPseudoInstall, GuidelinesForSecureExtensions, UnicodeCollation, InternationalisationGuidelines, HowToUseGit, FoswikiBot, UsingJQueryWithFoswiki, SvnRepository, TestingWithSelenium, FoswikiCodingConventions

Results from Development web retrieved at 11:59 (GMT)

AcceptedBy14DayRule

ChangeProposals that are AcceptedBy14DayRule The following proposals have committed developers and were commited at least 14 days ago.

r3 - 02 Apr 2010 - 07:19 by CrawfordCurrie

AcceptedByReleaseMeeting

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

r3 - 12 Mar 2010 - 07:27 by CrawfordCurrie

AcceptedFeatureProposals

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

r9 - 17 Dec 2011 - 05:23 by GeorgeClark

AcceptedProposal

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

r2 - 18 Feb 2010 - 09:05 by MichaelDaum

AddToZoneFromPluginHandlers

AddToZoneFromPluginHandlers Using ADDTOZONE from certain plugin handlers This document is linked to from the standard POD documentation Warning! Take care when ...

NEW - 18 Aug 2010 - 07:02 by PaulHarvey

BugTracking

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

r2 - 02 Nov 2008 - 18:11 by UnknownUser

BuildContribCookbook

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

r15 - 16 Dec 2011 - 16:14 by GeorgeClark

BuildingARelease

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 ...

r39 - 23 Dec 2011 - 23:08 by GeorgeClark

CSSResources

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 ...

r2 - 17 Dec 2008 - 20:40 by RafaelAlvarez

ChangeProposal

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 ...

r3 - 08 Nov 2008 - 12:49 by CrawfordCurrie

ChangedFeatureProposals

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 ...

r3 - 08 Nov 2008 - 02:31 by KennethLavrsen

ChangedFeatureProposalsUncommitted

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 ...

r3 - 08 Nov 2008 - 02:29 by KennethLavrsen

CodeAttribution

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

r3 - 01 Dec 2010 - 20:11 by OliverKrueger

CodingStandards

Perl coding standards General Principles Foswiki is a large project which, over the years, has had a lot of contributors. It is also mainly written in perl, which ...

r11 - 09 Nov 2010 - 08:01 by CrawfordCurrie

CodingStandardsDiscussions

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

r6 - 24 Nov 2008 - 01:51 by SeanMcCarthy

CompletedFeatureProposals

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

r9 - 17 Dec 2011 - 05:31 by GeorgeClark

ConcernRaisedBy

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 ...

r2 - 18 Feb 2010 - 09:25 by MichaelDaum

ConsensusReached

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

r4 - 02 Apr 2010 - 07:51 by CrawfordCurrie

CopyrightAndLicense

r4 - 09 Jan 2009 - 12:56 by OlivierBerger

CopyrightAndLicenseTalk

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

r5 - 21 Mar 2009 - 15:59 by IsaacLin

CoreInternals

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 ...

r9 - 08 Apr 2011 - 00:57 by RasmusPraestholm

CurrentState

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

r6 - 02 Apr 2010 - 07:07 by CrawfordCurrie

CustomerAdvocates

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

NEW - 11 Mar 2010 - 22:42 by KennethLavrsen

DateOfCommitment

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

r2 - 02 Apr 2010 - 06:57 by CrawfordCurrie

DeveloperResponsibilities

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 ...

r11 - 17 Nov 2010 - 13:09 by MichaelTempest

DevelopersBible

DevelopersBible This is the gateway to all documentation used day to day by developers. Read the Project Overview and follow Getting Started if you are new ...

r37 - 25 Feb 2011 - 09:29 by CrawfordCurrie

DevelopersFeatureTestChecklist

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 ...

NEW - 27 Apr 2009 - 10:50 by KennethLavrsen

DocumentationStandards

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 ...

r5 - 31 Dec 2009 - 18:26 by MartinRowe

ExtensionDeveloperGuide

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 ...

r14 - 09 Nov 2010 - 14:46 by AntonioTerceiro

ExtensionsAndLicensing

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 ...

r3 - 20 May 2009 - 15:38 by KennethLavrsen

FeatureProposals

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 ...

r5 - 09 Mar 2010 - 15:28 by KennethLavrsen

FoswikiBot

What is FoswikiBot? FoswikiBot is an IRC bot for the #foswiki IRC channel. The bot used to be a Mozbot with a few custom modules. As of 12th of June 2011, it has been ...

r13 - 29 Sep 2011 - 13:19 by OlivierRaginel

FoswikiCodingConventions

FoswikiCodingConventions DEVELOPERS, FEEL FREE TO ADD TO THIS DOCUMENT Foswiki is a large and complex system, combining contributions from many different individuals ...

r3 - 04 Jun 2011 - 08:49 by CrawfordCurrie

FoswikiRedirectCache

FoswikiRedirectCache Design and Operation of Foswiki Redirect Cache There is some confusion on how the Foswiki Redirect Cache is supposed to work. This topic currently ...

r17 - 03 May 2010 - 08:32 by CrawfordCurrie

FoswikiStandAlone

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 ...

r19 - 15 Jan 2010 - 09:51 by PhilJ

GenPDFAddOn

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. Link ...

r7 - 09 Mar 2010 - 21:44 by GeorgeClark

GettingStarted

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 ...

r20 - 17 Mar 2009 - 17:46 by KennethLavrsen

GitAndGithub

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 ...

r5 - 16 Jun 2010 - 02:08 by SvenDowideit

GitAndPseudoInstall

git and pseudo install.pl Notes * When you try to pseudo install a missing module, pseudo install tries to clone it from the list of configured git repositories ...

r7 - 02 Nov 2011 - 01:20 by PaulHarvey

GitCookbook

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 ...

r2 - 24 Feb 2009 - 18:48 by OlivierRaginel

GuidelinesForSecureExtensions

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

r4 - 25 Oct 2011 - 01:25 by GeorgeClark

GuidelinesForTWikiCompatibleDevelopment

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

r5 - 24 Nov 2008 - 09:53 by CrawfordCurrie

GuidelinesForTWikiExtensionTransformation

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 Extensions ...

r24 - 20 Apr 2009 - 10:45 by CrawfordCurrie

HowToAddRESTAndMacroHandlersToContribs

HowToAddRESTAndMacroHandlersToContribs The Foswiki plugins architecture allows you to hook into the Foswiki flows at a very deep level. To support this, plugins are ...

r2 - 08 Apr 2010 - 06:53 by CrawfordCurrie

HowToBeAGoodExtensionDeveloper

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

NEW - 20 Nov 2008 - 11:01 by MichaelDaum

HowToIntegrateWithRequestValidation

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 ...

r7 - 06 Jun 2010 - 13:05 by CrawfordCurrie

HowToMakeSimplePlugin

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 ...

r5 - 02 Oct 2009 - 15:56 by DrewStevenson

HowToStartExtensionDevelopmentInSubversion

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

r14 - 16 Dec 2011 - 16:47 by FlorianSchlichting

HowToUseGit

HowToUseGit Here you will find details on how to use git for Foswiki development. You are assumed to know what git is, and what it's for, and you are expected to know ...

r57 - 02 Oct 2011 - 03:22 by PaulHarvey

HowToWriteBetterCopy

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 ...

r8 - 10 Nov 2010 - 09:52 by MichaelDaum

ImplementedAsExtension

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

r2 - 18 Feb 2010 - 09:06 by MichaelDaum

InternationalisationGuidelines

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

r6 - 04 Oct 2011 - 08:43 by CrawfordCurrie

InvestigatedFeatureProposals

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

r6 - 28 Jan 2009 - 23:02 by KennethLavrsen

JQueryLibPlugin

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

r5 - 28 Apr 2009 - 15:16 by StephaneLenclud

JavascriptCodingStandards

Javascript Coding Standards * See UsingJQueryWithFoswiki#CodingStandards * Foswiki generally contains the source code in foo.uncompressed.js, and the minified ...

r3 - 13 Nov 2010 - 12:55 by ArthurClemens

LanguageUsageGuide

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 ...

r5 - 23 Feb 2009 - 01:35 by IsaacLin

MacroSyntaxSpecification

.Macros should observe the following syntax: macro ::= '%' macro_name argList '%' ; argList ::= '{' args '}' ; args ::= cheat_args ...

NEW - 10 Nov 2008 - 10:39 by CrawfordCurrie

MakeTextWebFrameworks

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

r7 - 17 Dec 2008 - 20:42 by RafaelAlvarez

MakingExtensionsUpgradeSafe

Making extensions upgrade safe Core code already has a strong review policy, and an explicitly review period in which many eyes help avoiding non backwards compatible ...

NEW - 09 Nov 2010 - 15:20 by AntonioTerceiro

MergedToCore

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

r2 - 18 Feb 2010 - 09:05 by MichaelDaum

ModelViewController

ModelViewController Model View Controller (MVC) is a well known software architecture pattern, used in many web applications. I thought it would be interesting to ...

r2 - 09 Nov 2010 - 13:32 by CrawfordCurrie

NatSkinDev

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 editjavascript ...

r2 - 24 Mar 2009 - 15:58 by WikiGnome

NerdoMeter

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 ...

r3 - 25 Feb 2010 - 23:49 by WillNorris

NotesOnJavaApplets

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

NEW - 04 Oct 2009 - 08:53 by CrawfordCurrie

OpenSourceProjectInAWebContrib

NEW - 12 Apr 2009 - 18:09 by KennethLavrsen

ParkedFeatureProposals

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

r8 - 17 Feb 2010 - 11:32 by MichaelDaum

ParkedProposal

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

r2 - 18 Feb 2010 - 09:04 by MichaelDaum

PerlCritic

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 ...

r5 - 09 Nov 2010 - 00:19 by PaulHarvey

PerlTidy

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 ...

r4 - 12 Feb 2009 - 16:09 by WillNorris

PluginsApiPolicies

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 ...

r4 - 15 May 2009 - 14:42 by CrawfordCurrie

ProjectOverview

ProjectOverview Introduction This is an overview of the Foswiki development and release processes, without getting into the dirty details. Links in the text will ...

r2 - 18 Nov 2010 - 09:45 by CrawfordCurrie

ProposalsReadyForCommunityVote

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 ...

r7 - 17 Dec 2011 - 05:29 by GeorgeClark

ProposedFor

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 ...

r2 - 02 Nov 2008 - 18:11 by UnknownUser

ReasonForDecision

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 ...

r8 - 02 Apr 2010 - 07:48 by CrawfordCurrie

RegularExpressions

Strategy for Regular Expression Support Foswiki strives to support the rich Perl regular expression syntax wherever regular expressions are required. However, because ...

NEW - 07 Apr 2010 - 09:14 by CrawfordCurrie

RejectedFeatureProposals

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

r8 - 17 Feb 2010 - 11:31 by MichaelDaum

RejectedProposal

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

r2 - 18 Feb 2010 - 09:02 by MichaelDaum

ReleaseNumbering

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

r13 - 11 Mar 2009 - 14:53 by OlivierRaginel

ReleaseProcess

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

r14 - 17 Dec 2011 - 05:30 by GeorgeClark

RequestAccessToSubversion

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 ...

r12 - 13 Mar 2009 - 19:24 by MartinSeibert

SVK

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 ...

r6 - 13 Feb 2009 - 00:46 by WillNorris

SVN

SVN Subversion code repository for Foswiki. See SvnRepository.

r6 - 01 Mar 2009 - 16:48 by ArthurClemens

SortingDocumentation

Sorting with Sort::Maker Perl Best Practices writes "Consider building your sorting routines with Sort::Maker". As of version 1.1, Foswiki ships CPAN:Sort::Maker with ...

NEW - 03 Apr 2010 - 14:09 by ArthurClemens

SpecifyingConfigurationItemsForExtensions

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

r6 - 06 Jan 2010 - 06:31 by WillNorris

StepByStepRenderingOrder

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 ...

r2 - 24 Nov 2008 - 11:19 by CrawfordCurrie

SubversionBasedInstall

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 ...

r22 - 28 Apr 2011 - 00:34 by LeilaPearson

SubversionBranchingAndTagging

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 ...

r6 - 08 Feb 2009 - 13:16 by MartinRaabe

SubversionMirrorSetUp

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 ...

r4 - 12 Feb 2009 - 21:10 by WillNorris

SvnRepository

Subversion See ProjectOverview for an overview of the development process, and how we do revision control. This document is all about the nitty gritty details of how ...

r41 - 28 Aug 2011 - 19:26 by ArthurClemens

TechnicalOverview

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

r25 - 10 Jan 2012 - 12:49 by KipLubliner

TestingWithSelenium

TestingWithSelenium Testing Foswiki with Selenium Selenium "... is a suite of tools to automate web app testing across many platforms." Extensions.UnitTestContrib ...

r10 - 11 Aug 2011 - 16:18 by ArthurClemens

TheFourteenDaysRule

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 ...

r4 - 02 Apr 2010 - 06:55 by CrawfordCurrie

ThinPrefs

Thin Prefs Main.GilmarSantosJr 11 May 2009

NEW - 11 May 2009 - 02:50 by GilmarSantosJr

TopicStructureForFoswikiExtensions

Topic Structure For Foswiki Extensions Please discuss on the discussion page. Overview Update the instructions on this page with your extension: Extension Name: ...

r6 - 22 Mar 2010 - 05:56 by WillNorris

TranslationUserInterface

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

r7 - 09 Mar 2011 - 21:56 by KennethLavrsen

UnderConstruction

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

r2 - 18 Feb 2010 - 09:05 by MichaelDaum

UnderInvestigation

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

r2 - 18 Feb 2010 - 09:00 by MichaelDaum

UnderstandingEncodings

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 ...

r12 - 29 Nov 2011 - 08:42 by CrawfordCurrie

UnicodeCollation

Unicode collation Unicode has support for specific collation rules, used when sorting data see the Unicode documentation and CPAN:Unicode::Collate. This may be ...

r4 - 21 Oct 2011 - 09:54 by MichaelDaum

UnitTests

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

r21 - 12 Feb 2012 - 13:18 by JayenAshar

UserInterfaceInternationalisation

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

r8 - 12 Mar 2011 - 17:24 by GeorgeClark

UsingJQueryWithFoswiki

Introduction jQuery is an industry standard Javascript framework, used by a lot of Foswiki extensions and many foswiki developers. jQuery is the "javascript framework ...

r17 - 28 Sep 2011 - 10:32 by CrawfordCurrie

VimEditor

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 ...

r3 - 21 Nov 2008 - 01:00 by NathanDye

Number of topics: 103