3
I think it's an excellent idea, banned.
Jan304 (from the Dutch XOOPS community) made a sample module last year
which is in the module repository here.
Using that sample module would be a good place to start. There are plenty of things that need to be updated and added though. What I'd like to see is sample documentation included, like you said, plus:
1. expanding the xoops_version.php details to include examples for onInstall, onUpdate, onUnistall, for a start (details in
the dev wiki)
2. A 'class' directory, with a sample class which extends the XoopsObject class, and has the proper header comment and phpdoc comments throughout.
3. A sample sql file
4. Sample language files, including modinfo.php, main.php, admin.php, blocks.php
5. maybe a sample admin directory, with index.php, menu.php files...? That would help with explaining the admin.php example language file.
6. maybe include the
template for the admin icons...?
Making a standards-compliant sample module would be very helpful, not only to give module developers a good starting point but also to illustrate the standards we have, such as they are. It'd also be a great way for us to see the standards in action, and give feedback as you make the sample module. It might encourage more participation and discussion about standards than a dry Word document can
Great idea!