View of /contrib/README.txt

MOODLE CONTRIB
==============

This directory is for user-contributed tools and other useful
code that is not yet integrated into the main Moodle distribution.

Code here may not be tested - so there are no guarantees as 
to the quality of the code in here, even if part of a stable 
Moodle release.

We have recently moved all these files around into a new structure:

   http://tracker.moodle.org/browse/MDLSITE-78

(if you have problems, please file new bug reports in the tracker!)


DIRECTORY STRUCTURE
===================

plugins   -- for all discrete Moodle plugins that follow the API
 |..auth
 |..blocks
 |..course
    |----format
 |..enrol
 |..filter
 |..mod
    |----assignment
    .....|----type
    |----data
    .....|----field
    .....|----preset
    |----quiz
    .....|----report
    |----resource
    .....|----type
 |..question
    |----format
    |----type
 |..theme


patches  -- for all hacks to Moodle that require changing one or more files

tools   -- separate tools and scripts that might be useful 

old   -- various old code that may not be useful any more


NOTES ON PLUGINS
================

Languages
---------

Note that language directories should be embedded within the module itself,
as Moodle generally supports such language files directly.  

  eg   the default (English) language file for a block called widget:

       plugins/blocks/widget/lang/en_utf8/block_widgets.php

This means that users should be able to just unzip a plugin in a single into the
correct location and expect it to work.   Plugins should never require putting 
files in different locations (if you need to do that, it should be in "patches").

Branches/versions
-----------------

If you are maintaining different versions of the same code, please do NOT 
create new directories for each version.

The contrib area now has branches, just like the main Moodle code, such 
as MOODLE_16_STABLE, MOODLE_17_STABLE and MOODLE_18_STABLE etc.  Please
use these branches.

See http://docs.moodle.org/en/CVS_for_Developers#Working_with_branches for details.

Automatic download packages
---------------------------

All directories under plugins, patches and tools are being packaged on a 
daily basis and being made available from download.moodle.org using the same
directory structure, like this:

   contrib/plugins/mod/resource/type/widget        becomes

   For the current development (HEAD) version:
   http://download.moodle.org/download.php/plugins/mod/resource/type/widget.zip

   For recent stable versions:
   http://download.moodle.org/download.php/plugins16/mod/resource/type/widget.zip
   http://download.moodle.org/download.php/plugins17/mod/resource/type/widget.zip