Tags:
create new tag
, view all tags

TWiki Development Documentation

Topics which document how we develop TWiki: processes, meeting minutes, code documentation etc. Cousin to TWikiDevQuestion which is for raising questions about TWiki development.

New TWiki Development Documentation Topic:   (Use a name in WikiNotation)

Recently modified topics: BuildingARelease, ProductionReleaseChecklist, TWikiDebugging, BuildContribCookbook, TWikiFeatureProposals, TWikiReleaseProcess, SubversionReadme, SevenDayFeedbackPeriod, BulgarianTranslation, UserInterfaceLocalisation, GeorgetownRelease, TWikiTranslationStatus, TheFourteenDaysRule, UnderstandingEncodings, EmailAllTWikiUsers, TWikiVMDebianStableCreationLog, SubversionMirrorSetUp, SoYouWantToBeATWikiDeveloper, DebuggingCSS, CvsOnMacGettingStarted

Results from Codev web retrieved at 23:16 (GMT)

Module name TWiki::Access AccessDotPm Location TWIKIROOT/lib/TWiki/Access.pm Summary To provide access checking Primary Author PeterThoeny...
afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error ) \%attrHash reference to hash of attachment attribute values $topic the name of the...
afterCommonTagsHandler($text, $topic, $web ) $text text to be processed $topic the name of the topic in the current CGI query $web the name...
afterEditHandler($text, $topic, $web ) $text text that is being previewed $topic the name of the topic in the current CGI query $web the...
afterSaveHandler($text, $topic, $web, $error, $meta ) $text the text of the topic excluding meta data tags (see beforeSaveHandler) $topic...
Module name attach AttachCgiScript Location TWikiRoot/bin/attach Summary Provides functionality to update or create an attachment to a page Primary...
Module name TWiki::Access AttachDotPm Location TWIKIROOT/lib/TWiki/Attach.pm Summary File attachment functionality Primary Author PeterThoeny...
Generating Attribute Methods Using AUTOLOAD Perlcookbook:ch13 12 , i.e. http://iis1.cps.unizar.es/Oreilly/perl/cookbook/ch13 12.htm MartinCleaver 16 Oct...
beforeAttachmentSaveHandler(\%attrHash, $topic, $web ) \%attrHash reference to hash of attachment attribute values $topic the name of the topic in...
beforeEditHandler($text, $topic, $web ) $text text that will be edited $topic the name of the topic in the current CGI query $web the name...
beforeSaveHandler($text, $topic, $web, $meta ) $text text with embedded meta data tags $topic the name of the topic in the current CGI query...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Browser Bugs http://diveintomark.org/archives/2003/05/05/why we wont help you explains why you must validate your CSS Bugs in: Browser Bug list IE http...
BuildContrib Cookbook This is a cookbook of recipes for using BuildContrib. BuildContrib is a powerful, multi faceted build system, used to build TWiki extensions...
How to Build a Release Introduction It is an important principle of TWiki Release 4 and beyond that anyone can build a release of TWiki using the automatic tools...
Bulgarian User Interface for TWiki Several months ago I downloaded TWiki and played around with it. Several days ago I downloaded it again and found that it perfectly...
CVS Commands Command Abbrevs Description add ad new Add a new file/directory to the repository admin adm rcs Administration front end...
Cairo Release Summary This topic shows all features and bug fixes of the CairoRelease with topic summaries, making it easy to spot topics with missing summaries. This...
CategoryRefactoring CategoryDescription: Topic relates to refactoring of the core code without changing end user functionality.
Module name changes ChangesCgiScript Location TWIKIROOT/bin/changes Summary Presents to user recent changes made to the current web Primary Author...
A goal for CairoRelease is to get all plugins into CVS PluginsInCVS shows which plugins have moved their authoratative latest version into CVS You should read:...
A code badge is a special string used in comments to flag something in code. In the TWiki codebase, the following code badges are in common use: FIXME See FixMe...
Code Coverage tools help you analyse code to find out which sections are actually called when it is run, and which are not. It is mainly useful for determining test...
Developer Documentation Purpose This topic is the gateway for Codev topics documenting the layout of the TWiki codebase. It is important to note that many internal...
See CodevDocumentationProject Please add comments here about the effectiveness of this process Would be nice to have a plugin to extract the public methods...
We need to standardise and improve the coding environment used by TWikiContributors Educate coders: SubversionReadme, PatchGuidelines, TWikiDebugging, SVK, HowDoesTheDEVELOPBran...
Coding Guidelines To help build out TWiki`s CodingStandards, it is useful to appreciate what is being done elsewhere. That is the purpose of this topic. Coding Guidelines...
Coding Standards (Updated for Dakar by CrawfordCurrie 16 Feb 2005) Perl coding standards System Requirements Core code should be based on the TWikiSystemRequirements...
commonTagsHandler($text, $topic, $web ) $text text to be processed $topic the name of the topic in the current CGI query $web the name of...
See http://twikianalysis.mrjc.com/cvsmonitor/cvsmonitor/cvsmonitor.pl?cmd viewBrowseModule module twiki.twiki See interpretation of graph in TWikiCVSMonitor...
i want to make a autorun cd which install cygwin,apache,twiki on windows so every end user can easily install twiki on it,s personal computer. If anyone have good...
Sven said: We need to doco all the CSS tags that we are putting into TWiki It would also be beneficial to build a canonical list of class and ID names which...
CSS Coding Standards TWiki should define CodingStandards parameters e.g. that the CSS should/should not be compressed, or that there`s a compilation step such that...
Creating a Custom TWiki Skin Philosophy This skin design tries to do without tables, as I find it quite harder to place things this way. This also means there`s heavy...
CVS on Mac OS X At my work we use WinCVS and MacCVS. But after many attempts to get MacCVS to work with sourceforge, I finally took resort to X. First you must follow...
The Dakar Preference Model This does not include access control You can set variables in all the following places: 1 local site level in .TWikiPreferences...
Minutes of Dakar Release Schedule Meeting, 17 Dec 2005 Logistics and Participants Date: Saturday, 17 Dec 2005 18:00 GMT IRC Channel: #twiki dakar...
Minutes of Dakar Release Schedule Meeting, 07 Jan 2006 Logistics and Participants Date: Saturday, 07 Jan 2005 18:00 GMT IRC Channel: #twiki dakar...
Minutes of Dakar Release Schedule Meeting, 16 Jan 2006 Logistics and Participants Date: Monday, 16 Jan 2005 20:00 GMT IRC Channel: #twiki dakar Participants...
Minutes of Dakar Release Schedule Meeting, 23 Jan 2006 Logistics, Participants, IRC log Date: Monday, 23 Jan 2005 20:00 GMT IRC Channel: #twiki dakar...
Minutes of Dakar Release Schedule Meeting, 30 Jan 2006 Logistics, Participants, IRC log Date: Monday, 30 Jan 2005 21:00 GMT IRC Channel: #twiki dakar...
Dakar Release Summary This topic shows all features and bug fixes of the DakarRelease with topic summaries, making it easy to spot topics with missing summaries. This...
Dakar Release Translations Out of date. Please see UserInterfaceLocalisation, sectoin `Keeping your translation up to date`. AntonioTerceiro 09 Dec 2006
Dakar Release Upgrade Guide Please add specific upgrade information here, such as preferences settings to add. It is the base for updating the TWikiUpgradeGuide....
How to Debug CSS `Other reasons for continuing non adoption of CSS are: its complexity, inertia and authors` lack of familiarity with CSS and required techniques,...
Note: This is largely replaced by TWikiRelease04x01Process How release contents are decided How do we decide what gets into a release? There is general agreement...
Module name TWiki::Plugins::Default DefaultPluginDotPm Location TWIKIROOT/lib/TWiki/Plugins/Default.pm Summary Primary Author Main. CVS history...
The attached HTML`s show the differences between the documentation shipped with Cairo (best guess) and the documentation currently in TWiki web. To determine what...
Module name edit EditCgiScript Location TWIKIROOT/bin Summary Primary Author Main. CVS history http://cvs.sourceforge.net/cgi bin/viewcvs...
Module name TWiki::UI::Edit.pm EditDotPm Location TWIKIROOT/lib/TWiki/UI/Edit.pm Summary Implements functionality for edit Primary Author Main...
Keith Helfrich asked in EmailAllTWikiUsers: Is there a way to email all (registered) TWikiUsers in one shot regardless of whether they have registered in WebNotify...
Module name TWiki::Plugin::Empty EmptyPluginDotPm Location TWIKIROOT/lib/TWiki/Plugins/Empty.pm Summary Primary Author Main. CVS history...
What constitutes testing of extensions? Every extension has a field that indicates what major versions it has been `tested on`. If set by the author, it`s probably...
Module name TWiki::Form.pm FormDotPm Location TWIKIROOT/lib/TWiki/Form.pm Summary Handle the encoding and decoding of the TWikiForms presented at the...
Module name TWiki::Func.pm FuncDotPm Location TWIKIROOT/lib/TWiki/Func.pm Summary Stable interface from Plugins to TWiki Primary Author PeterThoeny...
Georgetown Release Released 2009 03 30 Georgetown, Guyana: Governmental administration. Introduction Georgetown Release is the code name for the TWiki Release...
Module name geturl GeturlCommandLineScript Location TWIKIROOT/bin/geturl Summary Primary Author Main. CVS history http://cvs.sourceforge...
How do I Identify and Poor man debug if Perl thinks a Specific Variable is in UTF8 Format From man perluniintro How Do I Know Whether My String Is In Unicode?...
This is intended as a reference for LynnwoodBrown to help him document the DEVELOP auth process. It`s a brain dump, so there`s no real structure to it, sorry. TWiki...
Topic made redundant by changes to SubversionReadme. Please refer to that topic instead.
How safe is the Admin Login (Sudo login)? In 4.2.0 we introduce a new sudo login feature. It is based on the Template Login method. If this login scheme has a security...
Howto: Connect TWiki to Bugzilla API Preparation Following perl moduls are needed to use the bugzilla API: SOAP Lite XML Parser Install them from cpan.org...
How to start plugin development in Subversion (SVN) Motivation I just tried to develop a new Plugin in SVN and it took me a while to figure out how to do it. There...
Module name TWiki::User::HtPasswdUser HtPasswdUserDotPm Location TWIKIROOT/lib/TWiki/User/HtPasswdUser.pm Summary This module implements Apache Htpasswd...
HTML E mail Formatting How to create html formatted e mail. Formatting Email and Using Style CSS in e mail http://alistapart.com/articles/cssemail...
Improve Support topics See this support page on WordPress: http://wordpress.org/support/topic/20654 1 Big title 1 How long ago posted 1 Resolved status This...
INCLUDE needs to process external HTML literally From Bugs:Item3123: Test on LitterTray: Bugs:LitterTray/IncludeWebpageTest The html at the h1 header looks like:...
Include should (but doesn`t) include the stuff in settings From my reading of the code, nothing in settings is included in a topic. This is a serious problem since...
initializeUserHandler( $loginName, $url, $pathInfo ) $loginName login name recovered from $ENV{REMOTE USER} $url request url $pathInfo pathinfo...
Module name installpasswd InstallpasswdCgiScript Location TWIKIROOT/bin/installpasswd Summary Installs a new password for a given user. Admins only...
Internationalisation guidelines This document is targeted at developers (core code, plugin code and user interface developers) . If you are looking for instructions...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Note: Work in progress, stay tuned TWiki Licensing and Copyright FAQ Frequently Asked Questions on Licensing What kind of license is TWiki distributed with...
Module name mailnotify MailnotifyCgiScript Location TWIKIROOT/bin/mailnotify Summary Produces periodic notifications based on whether people have added...
Module name manage ManageCgiScript Location TWIKIROOT/bin/manage Summary tools to manage the twiki using the twiki :) Primary Author PeterThoeny...
mergeHandler( $diff, $old, $new, \%info ) $text Try to resolve a difference encountered during merge. The differences array is an array of hash references, where...
Module name TWiki::Meta MetaDotPm Location TWIKIROOT/lib/TWiki/Meta.pm Summary Implements the meta data handling Primary Author Main. CVS...
Integrated Windows Authentication (SSPI) with Indigo Perl If you`ve managed to install Twiki on a Windows using Indigo Perl and would like to make use of Windows security...
This topic used to be called ScratchBranchSholdBeMoreOpen. It has been heavily refactored using DFP, to cut out the nastiness and focus on the issues. Martin`s work...
Module Name TWiki::Net, NetDotPm Location TWIKIROOT/lib/TWiki/Net.pm Summary This module handles network related functions like http access and send...
Module name TWiki::User::NoPasswdUser NoPasswdUserDotPm Location TWIKIROOT/lib/TWiki/User/NoPasswdUser.pm Summary This module implements the user...
Problem The HTML validator would be a lot more useful if it told which div it was closing at each step http://validator.w3.org/ told me there was a there is a...
Module name oops OopsCgiScript Location TWIKIROOT/bin/oops Summary Handles when something goes wrong Primary Author Main. CVS history CVS...
Funding work on TWiki When many companies benefit yet the opensource developers who write and maintain the code are not getting paid by anyone, the situation is clearly...
Module name passwd PasswdCgiScript Location TWIKIROOT/bin/passwd Summary Allows a user to change their own password. Called from ChangePassword...
Patch Release Maintenance in Subversion (SVN) Overview A patch is a release of a set of changes to a previous TWiki release that fixes one or more problems with that...
Some Perl Speed up tips Use constants rather than regexes when splitting The following was run on a large text file (TWiki.pm, to be exact). my $n 1000; my @start...
Plugins and SVN Plugin authors have two ways of working. The first is the `traditional` way of working: developing a plugin on your machine(s), building a tarball...
Plugins API Policies It`s important that authors of Plugins are able to work within an environment without shifting ground rules. Otherwise, people end up having to...
Plugins API Policy discussions Discussions refactored out of the PluginsApiPolicies Discussion on common code base I disagree strongly about using a common code...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Module name TWiki::Plugins PluginsDotPm Location TWIKIROOT/lib/TWiki/Plugins.pm Summary this is the plugin discoverer, loader and runner Primary...
postRenderingHandler( $text ) $text the text that has just been rendered. May be modified in place. NOTE : This handler is called once for each rendered...
PreRenderingHandler Handler called immediately before TWiki syntax structures (such as lists) are processed, but after all variables have been expanded. Use this handler...
Module name TWiki::Prefs.pm PrefsDotPm Location TWIKIROOT/lib/TWiki/Prefs.pm Summary TWiki preferences handling on site level, web level and user level...
Module name preview PreviewCgiScript Location TWIKIROOT/bin/preview Summary Primary Author Main. CVS history http://cvs.sourceforge.net...
Module name TWiki::UI::Preview.pm PreviewDotPm Location TWIKIROOT/lib/TWiki/UI/Preview.pm Summary Implements functionality for preview Primary Author...
Process to Handle Undocumented Functionality Background TWiki has some undocumented features. This is done for a number of reason, such as hiding legacy functionality...
Production Release Checklist Steps when preparing a new production release Release preparation Create, Test and Upload a release package BuildingARelease...
TWiki Project Resources During the recent panic on d.t.o I discovered that we don`t appear to have a list of the resources the TWiki project uses/depends on. So I...
Module name TWiki::Store::RcsFile RcsFileDotPm Location TWIKIROOT/lib/TWiki/Store/RcsFile.pm Summary Primary Author Main. CVS history http...
Module name TWiki::Store::RcsLite.pm RcsLiteDotPm Location TWIKIROOT/lib/TWiki/Store/RcsLite.pm Summary Primary Author Main. CVS history...
Unit tests for the RcsLite package RcsLiteDotPm. The Perl script tools/test/rcslisttest does a number of unit test for the RcsLite package. Most are done by comparing...
Module name TWiki::Store::RcsWrap RcsWrapDotPm Location TWIKIROOT/lib/TWiki/Store/RcsWrap.pm Summary Primary Author Main. CVS history http...
Module name rdiff RdiffCgiScript Location TWIKIROOT/bin/rdiff Summary To present a view of differences between revisions of topics Primary Author...
This script appeared in Cairo. What does it do and why is it necessary? I am concerned that it implies a requirement to duplicate every CgiScript with a parallel script...
I keep getting questions on the reasons for deprecation of certain functions in the plugins API, from people who weren`t involved in TWiki development at the time...
RecruitTechWriters On the TWikiCommunitySummitRome2007 we had the idea to re vitalise the efforts of trying to recruit tech writers to help us doing the docu work...
redirectCgiQueryHandler($query, $url ) $query the CGI query $url the URL to redirect to This handler can be used to replace TWiki`s internal redirect...
Module name register RegisterCgiScript Location TWIKIROOT/bin Summary Used to register users. Called by TWiki. TWikiRegistration Primary Author...
registrationHandler($web, $wikiName, $loginName ) $web the name of the web in the current CGI query $wikiName users wiki name $loginName...
Documentation for Codev. which is not complete Topics marked as scheduled for with a sponsor (AssignedToCore) and whose DocProgress field is not 100%: Item...
Module name rename RenameCgiScript Location TWIKIROOT/bin/rename Summary Functionality to rename a topic Primary Author PeterThoeny CVS history...
restExample($session) $text This is an example of a sub to be called by the rest script. The parameter is: $session The TWiki object associated to this...
Codev Workflow Restructuring This topic was begun after BeijingRelease to discuss changes to workflow on the Codev web. The MasterRefactor had been attempted but...
Module name save SaveCgiScript Location TWIKIROOT/bin/save Summary When user saves changes, this writes changes to the data store Primary Author...
Module name TWiki::UI::Save.pm SaveDotPm Location TWIKIROOT/lib/TWiki/UI/Save.pm Summary Implements functionality for topic save Primary Author...
Module name search SearchCgiScript Location TWIKIROOT/bin/search Summary To return HTML that represents result of a %SEARCH directive Primary Author...
Module name TWiki::Search SearchDotPm Location TWIKIROOT/lib/TWiki/Search.pm Summary This module implements all the search functionality Primary...
Module name setlib.cfg SetlibDotCfg Location TWIKIROOT/bin/setlib.cfg Summary Determine location of the LibDirectory, relative to the BinDirectory...
Seven Day Feedback Period This is part of the decision making process of the TWikiCommunity, and structures the way new feature proposals are handled. A feature proposal...
Help on getting started as a TWiki developer There are two types of TWiki developer; core developers, who are brave/stupid enough to make changes in the TWiki core...
Documentation Proposal: How to integrate extension configuration into bin/configure ...The documentation has been transferred to TWiki.SpecifyingConfigurationItemsForExtensions...
Module name statistics StatisticsCgiScript Location TWIKIROOT/bin/statistics Summary Generates the WebStatistics page. Called by cron or via web by...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Module name TWiki::Store StoreDotPm Location TWIKIROOT/lib/TWiki/Store.pm Summary This module implements the storage backend Primary Author NicholasLee...
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...
Using Subversion to track the latest TWiki developments If you wish to use the latest development versions of TWiki, you can use Subversion to keep up to date. What...
For details see CoreCVSMonitor For details see PluginsCVSMonitor NB. This second graph has a different start date. MartinCleaver 15 Dec 2003 All Codev Contributions...
Dakar TWiki.cfg File Format As of Dakar, the TWiki.cfg has a special format that allows to `type strongly` each of the settings, and to group them in sections and...
Debugging TWiki Code Let`s assume you are in one of two situations: 1 You have a problem on your install, TWiki is collapsing with an error message, and you know...
TWiki development starting kit Gateway topic for information related to TWiki development. Core Development Fundamental Topics SoYouWantToBeATWikiDeveloper...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Module name TWikiDotCfg Location TWIKIROOT/lib/TWiki/ Summary TWiki configuration file Primary Author PeterThoeny CVS history CVS:lib/TWiki...
Module name TWiki TWikiDotPm Location TWIKIROOT/lib/TWiki.pm Summary Single include library for CgiScripts containing a mishmash of functions Primary...
TWiki Feature Proposals New feature proposals are by nature for the work in progress TWiki release code named . When you add a proposal you must create a new...
Timing tests on TWikiFns branch This is on an unloaded Debian testing box, using svn and a basically virginal install. Topic TWiki4.0 Notes TWikiFns...
TWiki JavaScript refactoring A growing number of TWiki skins and plugins make use of JavaScript . TWiki provides a basic JavaScript library with twiki.js that offers...
Beta releases of earlier TWiki releases See TWikiBetaRelease for beta releases of the current TWiki release. Date Release Topic Stable...
TWiki Release Process This topic is the executive overview and gateway for documentation that describes the technical processes used to build TWiki releases. Some...
Complete TWiki File Hierarchy icon:home TWIKIROOT icon:folder bin attach changes edit geturl...
The TWikiCore is comprised of several subsystems (the following list is not complete) TWiki SubSystems CgiScripts fulfils requests from the web. Primarily...
TWiki translation process This topic is about coordinating the translation process. For information on how to make translations to individual languages, see UserInterfaceLocalisation...
Attention: this topic is autogenerated. Please see the script tools/check translations in TWiki source SVN repository. NOTE: Don`t use, this is out of date...
Creation log for TWiki vm (Debian stable) The TWiki vm based on Debian stable can be found at TWikiVMDebianStable, this is a log on its creation. The vm is based on...
Template Variable EXTRACSS This is a proposal to be added in all TWiki Layout Templates and skins. On the topic ` Using Topic to Define CSS ` we can see a lot of...
Module name testenv TestenvCgiScript Location TWIKIROOT/bin/testenv Summary Primary Author Main. CVS history http://cvs.sourceforge.net...
NOTE: This is a legacy rule, replaced by SevenDayFeedbackPeriod The 14 days rule of feature decision making Also known as the 2 week rule It is part of the decision...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 03 Oct 2004
Module name TWiki::UI::Search.pm UiSearchDotPm Location TWIKIROOT/lib/TWiki/UI/Search.pm Summary Implements UI functionality for search result Primary...
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...
Module name upload UploadCgiScript Location TWIKIROOT/bin/upload Summary Used to implement the uploading of attachments Primary Author NicholasLee...
The importance of using the use strict; pragma For normal mortals All modules, including extension modules, should have use strict; in them. It speeds up...
use versus require TWiki has always suffered from the problem of compilation time. Because perl is an interpreted language, the code has to be compiled at run time...
File Hierarchy This tree is a partial include of TWikiRoot and is part of the CodevDocumentationProject PeterThoeny 02 Feb 2004
Module name TWiki::User UserDotPm Location TWIKIROOT/lib/TWiki/User.pm Summary This module implements the user authentication Primary Author...
User Interface Localisation This document is targeted at translators . If you are looking for instructions on configuring your TWiki to work with your local language...
Module name view ViewCgiScript Location TWIKIROOT/bin/view Summary Handles viewing of Topics Primary Author PeterThoeny CVS history http...
Module name TWiki::UI::View.pm ViewDotPm Location TWIKIROOT/lib/TWiki/UI/View.pm Summary Implements functionality for view Primary Author Main...
Module name viewfile ViewfileCgiScript Location TWIKIROOT/bin/viewfile Summary Presents contents of previous versions of attachments Primary Author...
Windows Install with mod ntlm There are two different Apache modules which use NTLM for authentication. The one this page is about, is for Apache runnning on a Windows...
Number of topics: 161
Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 2006-05-04 - SamHasler
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.