Update to the MODDB policy for phpBB3.

[Paul]

Hello all,

Due to the recent comments on our packaging rules in MOD writers discussion the phpBB MODifications team has decided to update the phpBB3 MODification database policy.
These updates include several changes to the policy:

• The packaging rules have been updated to a cleaner standard
• Usage of the latest MODX version and the latest XSL version is required
• Clearer reasons for why MODs can be denied (like coding guidelines, insta-deny, MODX packaging rules)

The new policy comes into effect right away, and is required for all new submitted MODs. Already submitted MODs don't fall under the new policy, and will not be denied if they don't fit the new criteria.

We still appreciate feedback on our policy. Questions and feedback can be asked/given in this topic.

Thank you,

The phpBB MODifications Team

[primehalo]

I think that files which are to be copied to the board should all be kept in the root/ directory to make it easier for users who want to copy all the files and not pick and choose. With this method, those who like to pick and choose can still do so.

I think that optional one-time-use installation files that need language strings should not be required to include a separate language file (or make edits to an existing language file). Since the file is optional, this should be optional.

I think the "templates/" directory should be renamed to "styles/".

I think the MODX security disclaimer should be updated to be more accurate (see here).

I think MOD authors should have the option of renaming "modx.prosilver.en.xsl" to "modx.xsl". The long name draws the eye to it, making it more likely that it will be opened instead of the instructions (I still make this mistake even after all this time ).

[Paul]

I think that files which are to be copied to the board should all be kept in the root/ directory to make it easier for users who want to copy all the files and not pick and choose. With this method, those who like to pick and choose can still do so.

No, we have choosen to have each directory his own root directory. this to prevent confusion by the end user.

I think that optional one-time-use installation files that need language strings should not be required to include a separate language file (or make edits to an existing language file). Since the file is optional, this should be optional.

No, all files should follow the code guidelines, including install files. For several things (Like adding permissions), they are required.

I think the "templates/" directory should be renamed to "styles/".

No, MODx isnt only used for phpBB3. Its actually not written for any phpBB version, so it doesnt care how the directory is named.

I think the MODX security disclaimer should be updated to be more accurate (see here).

This is already discussed internal. A bug report is enough next time.

I think MOD authors should have the option of renaming "modx.prosilver.en.xsl" to "modx.xsl". The long name draws the eye to it, making it more likely that it will be opened instead of the instructions (I still make this mistake even after all this time ).

I nowhere see its not allowed. Its only not prefered to prevent confusion.

[Desdenova]

phpBB3 MODDB Policy page is a 404 error.

[Paul]

phpBB3 MODDB Policy page is a 404 error.

We know about this, we are currently updating the documentation and this is in documentation. It will be back online soon.

[Desdenova]

Okiedoke, just was trying to get to it through several means to get that same blasted page.

Will it be up by the end of the week?

[Paul]

Okiedoke, just was trying to get to it through several means to get that same blasted page.

Will it be up by the end of the week?

I hope, I need to write it down again, and dont have really much time this week. I hope it will be online by the end of this weekend.

[Desdenova]

Your repetitive use of "I hope" frightens thee.

Anyways, one thing that I NEED to see in there is the MODX packaging policy. I've really got to look over that again so I can prep Silverbar for it's next version, and maybe begin the RC's shortly thereafter.

[Paul]

Your repetitive use of "I hope" frightens thee.

Anyways, one thing that I NEED to see in there is the MODX packaging policy. I've really got to look over that again so I can prep Silverbar for it's next version, and maybe begin the RC's shortly thereafter.

We are all volenteers . I have besides phpBB afulltime job, and school stuff. Writing the policy isnt something you do in a lost hour or something, it will take some time.
If you use google you probarly find a old cached version of the policy.

[Desdenova]

I understand. We're all human.

Thanks for the Google Cache tip, though, I hadn't thought of that. <.<;;

[Paul]

Hello all,

With the new release of MODX 1.2.0 we have also updated our MODDB policy.
You can find our new policy here: http://www.phpbb.com/mods/policies/general.php

If you have any questions or suggestions you can post them here.

[Desdenova]

Okay, great! Thanks paul.

Also, it's okay to have the XSL file in each directory with an XML file, right?
I've encountered a bug in Firefox 3 before where it doesn't like relative paths for XML stylesheets, so I'd included the XSL file in each directory with an XML file.

[Paul]

yes, thats okay (But not prefered, better have just 1 xsl in your zip.).

[lefty74]

Hi, rather then changing all my packaging to find out I did it wrong, I thought I better ask

Optional install files or instructions should be placed within the contrib directory. Additional required instructions should be placed in the root directory or in directory called named xml/

Does this mean it should look like this for example?

Code: Select all

contrib/subsilver2.xml
contrib/anotherstyle.xml
contrib/de.xml
root/styles/prosilver
root/styles/subsilver
root/styles/anotherstyle
root/language/en/
root/language/de/
xml/modx.prosilver.en.xsl
install.xml
licence.txt

not quite sure what an additional required xml file would be?

thanks very much, this i always am unsure of and I thought rather then wasting people's time when submitting the mods one at a time, i do it now once ;P

[Paul]

yes thats correct. But its also allowed tp place the subsilver2.xml in the xml/ directory.

Lastly, its prefered to add the prosilver changes to the main modx file.