Fork me on GitHub
Last edit 2008-06-19 07:55:53 by Operator [ Minor edits (quick review to catch and update PN references of all sorts. ]

Additions
In order to improve the overall quality of Zikula modules we would like to give some guidelines for module devs which (hopefully) make everyone's life easier - both the devs and of course the users too (with users being the site admin and the final website users).
Make sure that your modules zip or tar.gz can be extracted directly into the Zikula root folder. This means the top level folder should by modules/, not html/modules and also not the modulename itself.
This kind of onload handler takes care of several onloads per page, internally an array of onload functions is used which are called one by one. The normal use of window.onload replaces an existing handler with a new one which means that only the last one added will be executed. This might break some sites that make heavy use of JavaScript? in several parts of the display.

Deletions
In order to improve the overall quality of Zikula modules we would like to give some guidelines for module devs which (hopefully) make everyones life easier - both the devs and of course the users too (with users being the site admin and the final website users).
Make sure that your modules zip or tar.gz can be extracted directly into Zikula root folder. This means the top level folder should by modules/, not html/modules and also not the modulename itself.
This kind of onload handler takes care of several onloads per page, internally an array of onload functions is used which are called one by one. The normal use of window.onload replaces an existing handler with a new one which means that only the last one added will be executed. This might break some sites that make heavy use of javascript in several parts of the display.

Oldest known version of this page was edited on 2007-05-04 07:52:14 by AllKnightAccess [ Corrected typo. => "foldee" to "folder" ]

Guidelines for module developers


In order to improve the overall quality of Zikula modules we would like to give some guidelines for module devs which (hopefully) make everyones life easier - both the devs and of course the users too (with users being the site admin and the final website users).

This should become a collection of useful hints and code snippets, tipps and tricks, possible pitfalls and how to avoid them.


General guidelines



Naming


Please, please please: Avoid using the pn-Prefix for module names. We already have enough pn* modules which blow up the alpha list for P in the modules list.

Packaging the module


Correct packaging is important for automatic release builds using EasyDist?, a simple interface to create any preconfigured package, ehich is currently under development.
Make sure that your modules zip or tar.gz can be extracted directly into Zikula root folder. This means the top level folder should by modules/, not html/modules and also not the modulename itself.


Module



Templates



Naming scheme


Use a naming scheme like {modulename}_{type}_{function}.html, eg. permissions_admin_view.html or memberslist_user_recent.html. Its obvious where these templates belong to.


Plugins



Javascript


When using javascript try to make use of prototype.js where ever possible.

Example: Instead of

var obj = document.getElementById('mydiv');
window,onload(function() { init_the_system(); });


better use

var obj = $('mydiv');
Event.observe(window, 'load', function() { init_the_system(); }, false);

This kind of onload handler takes care of several onloads per page, internally an array of onload functions is used which are called one by one. The normal use of window.onload replaces an existing handler with a new one which means that only the last one added will be executed. This might break some sites that make heavy use of javascript in several parts of the display.


CSS

Last edit: 2008-06-19 07:55:53
Latest author: Operator
Owner: Landseer