TWiki SDK Addon

This Addon is an attempt to have an "standarized" set of tools (as described in TWikiSDK) to ease development of Plugins, Addons and Patches to core.

It's build over the TWikiShellContrib foundation, but it ran independantly of a twiki distribution.

The recomended directory structure is the following. Suppose that /home/twiki is where you maintain all your twiki versions.

/home/twiki
        |
        |--- sdk     -     The script
        |
        |--- incoming   - Where downloaded zip files are stored
        |         |
        |         | - distros      - Where twiki distros zipfiles are stored
        |         |
        |         | - extension    - Where plugins/addons/contrib zipfiles are stored
        |
        |--- base  - Where unmodified versions are deployed
        |      |
        |      | - athens (example)
        |      | - cairo (example)
        |      | - MAIN (example)
        |
        |--- develop - Where modified (development) versions are keept
        |      |
        |      | - athens (example)
        |      | - cairo (example)
        |      | - MAIN (example)
        |
        |--- lib - Sdk related modules

This directory structure is not fixed in the Adddon, it will ask where the appropiate directories are.

For a list of commands, type sdk help :

    sdk uninstall - Uninstalls a distro.
    sdk test - not finished - undocumented
    sdk download - not finished - undocumented
    sdk install - Installs a distro from a zip file into the base directory
    sdk develop - Installs a distro in the develop directory.
    sdk help -  Display this help

install, develop and uninstall modify the http.conf file and TWiki.cfg file to add or changes the settings as needed. After running these commands an apache restart is needed.

Typical Usage

A tipical usage of this add-on is as follows:

1. Download a distro into the incoming directory (manually, as the download command is not finished)
2. Rename the downloaded file to something meaningful (ie: athens.zip). This is not needed but helps
3. Install the distro: sdk install distro cairo
4. Create a "working copy" of the distro: sdk develop distro cairo changeplugins
5. When you decide that you don't want the working copy anymore: sdk uninstall develop changeplugins

Using the install and develop commands it's easy to create a set of twiki installations to perform GoldenTests and AthensMarks benchmarks

Adding commands

Check TWikiShellContrib for an explanation of how to build new commands. The only change is that sdk commands are expected to reside in the TWiki::Contrib::TWikiShellContrib::Ext::Sdk package.

Add-On Info

• Set SHORTDESCRIPTION = Standarized set of tools to ease development of Plugins, Addons and Patches to core

Add-on Author:	TWiki:Main.RafaelAlvarez
Copyright:	© 2004, TWiki:Main.RafaelAlvarez
License:	GPL (GNU General Public License)
Add-on Version:	2026-02-08 (V1.000)
Change History:
08 Nov 2004:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1 (TWiki 4.0)
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Add-on Home:	http://TWiki.org/cgi-bin/view/Plugins/TWikiSDKAddOn
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TWikiSDKAddOnDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/TWikiSDKAddOnAppraisal

Related Topic: TWikiAddOns

-- TWiki:Main.RafaelAlvarez - 08 Nov 2004