Distribution Contrib Package

Provides access to TWiki Distribution meta information

Summary of Contents

Distribution Contrib

A module to provide programmatic access to: 1 Conversion between release identifiers (e.g. %WIKINAME -> TWiki2002...) 2 Fetching of individual files of any given distribution name (excluding zip files)

Settings

• One line description:
  • Set SHORTDESCRIPTION = Provides access to TWiki Distribution meta information

• Name of the perl package
  • Set STUB = TWiki::Contrib::DistributionContrib

To Do

1. The settings in Config.pm should be made into settings on this page.

Detailed Documentation

sub wikiVersionToDistributionName($wikiVersion)

• turns '01 Feb 2003' => "TWiki20030201"

sub releaseTopicToDistributionName($releaseTopic)

• TWikiBetaRelease2004x07x30? => TWiki20040730beta
• TWikiRelease20030201? => TWiki20030201

sub fetchDistributionFile()

In: | $file | name of filename, e.g. bin/view | | $distribution | name of distribution, e.g. TWiki20020201 | | $localFileSuffix | for the downloaded file, any suffix to be added to the filename |

Out: | $location | where the local copy of the file has been placed |

NB. the localFileSuffix is a way to allow multiple downloaded files to coexist at the same time. As the FileFetcher? does not provide a way to delete the files (and TWiki does not automatically refresh its attachment table on the arrival of new attachments), I recommend you use unique names scarcely. e.g. keep using the same localFileSuffix "1", "2"

Installation Instructions

Note: You do not need to install anything on the browser to use this contrib package. The following instructions are for the administrator who installs the package on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip DistributionContrib.zip in your twiki installation directory. Content:

  File:	Description:
  ./lib/TWiki/Contrib/DistributionContrib/TWikiReleaseNames.pm
  ./lib/TWiki/Contrib/DistributionContrib/Config.pm
  ./lib/TWiki/Contrib/DistributionContrib/FileFetcher.pm
  ./lib/TWiki/Contrib/DistributionContrib/build.pl
  ./.project
  ./data/TWiki/DistributionContrib.txt
  ./pub/TWiki/DistributionContrib/
  DistributionContrib_installer.pl	Install script

• Test if the installation was successful:
  • enter samples here

Contrib Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.MartinCleaver - 23 Aug 2004