plone Create add-on Overview file-structure

Example

Minimum skeleton

mynamespace.myaddon     | The container-directory of the add-on.

    setup.py            | Register this directory to the Python-interpreter of
                        | the ZOPE-instance.

    mynamespace         | The namespace-directory of the add-on.

        __init__.py     | Makes this directory a Python-module and contains
                        | the lines for the namespace-magic.

        myaddon         | The base-directory of the add-on.

            __init__.py | Empty file, make this directory a Python-module.

            myfile.py   | Example-file: If it contained a method called
                        | 'myMethod', it would be importable of any other
                        | registered egg like this:
                        |    from mynamespace.myaddon.myfile import myMethod

Optional components

The 'mynamespace.myaddon/mynamespace/myaddon'-directory can contain:

configure.zcml  | Register all following files and directories, here.

setuphandlers.py | Make an addon available to ZOPE-instance.

profiles        | Make an addon installable to Plone-site and generally
                | hold GenericSetup-xml-files.

skins           | The "old-school"-way, where resources like templates,
                | stylesheets, etc., live.

browser         | The "new-school"-way, where resources live.

content         | Holds the Python-files for defining custom content-types.

subscriber.py   | Subscribers listen to events, describe here what to do
                | when an event happens, e.g.: "An item has been added to the
                | site, notify admin about it via e-mail-notifica."