Re: Update / extend RFCs please

Andy

You are correct in that most, but not all, of the RFCs badly need
updating. Some are worse than others, and some are just redundant. I'd
expect that once some of the changes settle down with relase 1.0,
people might have more time for documentation, or at least be more
encouraged to document with the code stablized longer term.

You may already be aware of this, but for others that might be
reading,  the Example module and Dyn_Example module have code and
templates that are both fairly well documented and may be kept more up
to date in parts that some of the RFCs. They are a good place to start
with module writing.

There is also a Module Wizared - modwizard  - in the tests directory
that can be used to generate most of the standard modules files and
repetitive content.

Jo


"Andy Staudacher" <[email protected]> wrote in message
news:opsb1tautbgzk32i-hMO2MehxN5XQJgi6DCjdj61cXZ9k6wlg@public.gmane.org
> I'm trying to write my own module.
> IMO ATM the XarayaMDG.pdf + RFC are not sufficient documentation.
> Please update the RFCs to the present state (i.e. RFC0007, xaraya
doesn't
> have a group and user table, but a role table)
> i.e. the file modules\modulename\xarversion.php
> There's the RFC 0013 on
> http://www.xaraya.com/documentation/rfcs/rfc0013.html
> What the RFC lacks is a list of all allowed properties and their
> description.
> i.e. what do these attributes mean? which one is optional etc.
> $modversion['official']       = 1; // my guess: if it's from the
xaraya dev
> team, then 1
> $modversion['admin']          = 0; // my guess: if it has admin
API/views,
> then 1
> $modversion['user']           = 1; // my guess: if it has user
API/views,
> then 1
> $modversion['securityschema'] = array('ModuleName::' => '::'); //
there
> should be a link from RFC0013 to section 7 of RFC0030 on
> http://www.xaraya.com/documentation/rfcs/rfc0030.html
> $modversion['dedication'] = 'some string'; // my guess: optional
> $modversion['requires'] = array(); // depricated?
> $modversion['dependency'] = array(); // documented, but listed
because of
> possible redundancy with 'requires'
>
>
>
>