Update to the MODDB policy for phpBB3.

Discussion forum for MOD Writers regarding MOD Development.
User avatar
lefty74
Registered User
Posts: 3649
Joined: Wed Sep 14, 2005 8:26 pm
Location: NL
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by lefty74 » Sat Jun 28, 2008 3:47 pm

thanks paul
lefty74
zoocrew.eu - help us save our wildlife
My MODS | Due to lack of time I unfortunately am unable to work on my mods anymore, anyone who has ideas to improve them and would like to take any of them over, please PM me.

User avatar
primehalo
Former Team Member
Posts: 2769
Joined: Fri May 06, 2005 5:58 pm
Location: Redding, CA
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by primehalo » Thu Jul 03, 2008 6:07 pm

I am also unclear as to what an additional required xml file would be. If the instructions are required, why wouldn't they be placed in the main install file?

According to the MOD DB policy:
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/

It's also allowed to place the XSL in the contrib or xml directory.
So as I understand it, most MODs will have only a contrib directory, and not an xml directory (since almost all additional instructions are optional), unless the MOD author prefers to put the XSL file in the xml directory instead of the contrib directory.
Ken F. Innes IV
My Extensions | My MODs | My Topics | My Site: Absolute Anime
Experience the wonder of Japanese Animation!

User avatar
iEric
Registered User
Posts: 249
Joined: Mon Apr 10, 2006 10:57 pm
Location: Falköping, Sweden
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by iEric » Fri Jul 04, 2008 2:03 pm

Paul wrote:...or suggestions you can post them here.
I would like to make a suggestion to the <comments> tag.

Code: Select all

    <edit>
    <comment lang="en"><![CDATA[Before you do THIS edit. Go and get some more coffee...]]></comment>
Just like the inline-edits have different colors that shows they are not normal edits - I think <comment> should also have something, and that makes it more easy to spot.

Maybe a box of it's own:

Code: Select all

/* Comment Box */
div.mod-comment { background-color: #eef6ff; border: solid 1px #777; margin: 10px 0; padding: 0 10px 5px; }
div.mod-comment:hover { border: solid 1px #6699CC; }
div.mod-comment dd { color: #bd7901; }
or just make the text in another color to get more visible:

Code: Select all

/* Comment Text */
div.mod-comment dd { color: #006633; }
Of course the colors and values are only examples and can be different. But just something to make it "stick out"

User avatar
Paul
Infrastructure Team Leader
Infrastructure Team Leader
Posts: 24304
Joined: Sat Dec 04, 2004 3:44 pm
Location: The netherlands.
Name: Paul Sohier
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by Paul » Sun Jul 27, 2008 12:55 pm

The policy has been updated to include a small change for the XSL files:
XSL file

Because of a security change in firefox3, the MODX file will not displayed within firefox3 when the xsl file is in another directory.
Due to this issue we need to require the xsl be placed in all directories where a MODX xml file is. We will repack all MODs that dont have XSL files within all directories.
Starting from this moment, we will require to have the XSL in all directories where a xml file is. MODs currently in queue will be repacked to add these.
Knock knock
Race condition
Who's there?

My BlogMy Photosmy phpBB Extensionscustom phpBB work & Development

User avatar
primehalo
Former Team Member
Posts: 2769
Joined: Fri May 06, 2005 5:58 pm
Location: Redding, CA
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by primehalo » Sun Jul 27, 2008 6:06 pm

Just to clarify, the XSL can be still be in a lower-level subdirectory? So this would be okay:

install.xml
contrib/modx.prosilver.en.xsl
contrib/subsilver2.xml

And this would be okay:
install.xml
contrib/modx.prosilver.en.xsl
contrib/templates/subsilver2.xml
contrib/templates/modx.prosilver.en.xsl

But this would not:
install.xml
contrib/modx.prosilver.en.xsl
contrib/templates/subsilver2.xml
Ken F. Innes IV
My Extensions | My MODs | My Topics | My Site: Absolute Anime
Experience the wonder of Japanese Animation!

User avatar
Paul
Infrastructure Team Leader
Infrastructure Team Leader
Posts: 24304
Joined: Sat Dec 04, 2004 3:44 pm
Location: The netherlands.
Name: Paul Sohier
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by Paul » Sun Jul 27, 2008 6:24 pm

No, that will not work with firefox3. The install.xml will not be displayed. There will be a xsl also needed in the same dir as the install.xml is.
So this is the correct one:
install.xml
modx.prosilver.en.xsl
contrib/modx.prosilver.en.xsl
contrib/subsilver2.xml

I personally really dont like this, but there isnt really any other solution with firefox3
Knock knock
Race condition
Who's there?

My BlogMy Photosmy phpBB Extensionscustom phpBB work & Development

User avatar
primehalo
Former Team Member
Posts: 2769
Joined: Fri May 06, 2005 5:58 pm
Location: Redding, CA
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by primehalo » Sun Jul 27, 2008 6:40 pm

Paul wrote:No, that will not work with firefox3. The install.xml will not be displayed. There will be a xsl also needed in the same dir as the install.xml is.
So this is the correct one:
install.xml
modx.prosilver.en.xsl
contrib/modx.prosilver.en.xsl
contrib/subsilver2.xml

I personally really dont like this, but there isnt really any other solution with firefox3
Actually, that's not quite correct, as this will definitely work in Firefox 3:
./install.xml
./contrib/subsilver2.xml
./contrib/modx.prosilver.en.xsl

The Firefox 3 security issue does not allow accessing files that are in a higher level on a file system (as in, if you use "../"), as I have verified on both Windows and Linux, but it has absolutely no problem with lower level access. I have repackaged all of my MODs like this, and Firefox 3 has no trouble with it:
./installation instructions.xml
./contrib/template subsilver2.xml
./contrib/language es.xml
./contrib/language ru.xml
./contrib/xsl/modx.prosilver.en.xsl
Ken F. Innes IV
My Extensions | My MODs | My Topics | My Site: Absolute Anime
Experience the wonder of Japanese Animation!

User avatar
Paul
Infrastructure Team Leader
Infrastructure Team Leader
Posts: 24304
Joined: Sat Dec 04, 2004 3:44 pm
Location: The netherlands.
Name: Paul Sohier
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by Paul » Sun Jul 27, 2008 7:51 pm

Hmm, weird. I tested it before, and didnt work. asked bantu to test it now, and did work. I will look into it tomorrow a bit more and see if I can make a more clear way when it dont work.
Knock knock
Race condition
Who's there?

My BlogMy Photosmy phpBB Extensionscustom phpBB work & Development

User avatar
A_O_C
Registered User
Posts: 2383
Joined: Sun Jul 01, 2007 11:26 pm
Location: phpbb_

Re: Update to the MODDB policy for phpBB3.

Post by A_O_C » Sun Jul 27, 2008 10:18 pm

i can see this getting confusing anyway, so why not just leave the new policy as it stands (an XSL file in every folder that contains an XML file). i kinda like it better that way anyway.

User avatar
david63
Jr. Extension Validator
Posts: 14313
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by david63 » Mon Jul 28, 2008 7:58 am

A_O_C wrote:i can see this getting confusing anyway, so why not just leave the new policy as it stands (an XSL file in every folder that contains an XML file). i kinda like it better that way anyway.
I would go with that idea - it is far less confusing, not open to interpretation and would lead to less problems.
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
primehalo
Former Team Member
Posts: 2769
Joined: Fri May 06, 2005 5:58 pm
Location: Redding, CA
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by primehalo » Mon Jul 28, 2008 8:04 am

MOD authors that are confused could go ahead and use that method, but those who are not confused shouldn't be forced to include extra, unnecessary files in their MOD package. Plus, it is better for the end user if the XSL files are put in a separate subdirectory so that the file won't be accidentally opened.
Ken F. Innes IV
My Extensions | My MODs | My Topics | My Site: Absolute Anime
Experience the wonder of Japanese Animation!

User avatar
Highway of Life
Former Team Member
Posts: 6048
Joined: Wed Feb 02, 2005 5:41 pm
Location: Spokane, WA
Name: David Lewis
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by Highway of Life » Mon Jul 28, 2008 11:38 pm

primehalo wrote:MOD authors that are confused could go ahead and use that method, but those who are not confused shouldn't be forced to include extra, unnecessary files in their MOD package. Plus, it is better for the end user if the XSL files are put in a separate subdirectory so that the file won't be accidentally opened.
I agree with this... we will discuss, but I don’t see any reason why this would not be a problem. -- Basically, we should accept both methods (the fewer restrictions on packaging, the better).
The phpBB Weekly Podcast - Discussing the developments of phpBB4 and beyond.

New to phpBB3? Want to learn about programing?
Visit phpBB Academy at StarTrekGuide to learn how.

User avatar
Erik Frèrejean
Former Team Member
Posts: 9899
Joined: Tue Oct 09, 2007 9:09 am
Location: The Netherlands, 3.0.x Support Forum
Name: Erik Frèrejean
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by Erik Frèrejean » Wed Sep 10, 2008 10:54 am

Highway of Life wrote:
primehalo wrote:MOD authors that are confused could go ahead and use that method, but those who are not confused shouldn't be forced to include extra, unnecessary files in their MOD package. Plus, it is better for the end user if the XSL files are put in a separate subdirectory so that the file won't be accidentally opened.
I agree with this... we will discuss, but I don’t see any reason why this would not be a problem. -- Basically, we should accept both methods (the fewer restrictions on packaging, the better).
Any word on this? I'm still packing the XSL in every directory (as stated in the packaging guidelines), but I agree with primehalo that it would be better if we where able to put that file in a separate directory.
Support Toolkit | Support Request Template | Knowledge Base | phpBB 3.0.x documentation
I don't give support via PM or IM! (all unsolicited pms will be trashed!)

User avatar
nickvergessen
Former Team Member
Posts: 4397
Joined: Mon Apr 30, 2007 5:33 pm
Location: Stuttgart, Germany
Name: Joas Schilling
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by nickvergessen » Wed Sep 10, 2008 3:19 pm

Erik Frèrejean wrote:Any word on this? I'm still packing the XSL in every directory (as stated in the packaging guidelines), but I agree with primehalo that it would be better if we where able to put that file in a separate directory.
Problem is that Firefox3 so far can not load it than :x
No Support via PM

User avatar
primehalo
Former Team Member
Posts: 2769
Joined: Fri May 06, 2005 5:58 pm
Location: Redding, CA
Contact:

Re: Update to the MODDB policy for phpBB3.

Post by primehalo » Wed Sep 10, 2008 5:14 pm

nickvergessen wrote:
Erik Frèrejean wrote:Any word on this? I'm still packing the XSL in every directory (as stated in the packaging guidelines), but I agree with primehalo that it would be better if we where able to put that file in a separate directory.
Problem is that Firefox3 so far can not load it than :x
Yes it can, as long as the subdirectory is underneath the current directory. Firefox 3 only won't read it when it has to go up one directory to find the file.
Ken F. Innes IV
My Extensions | My MODs | My Topics | My Site: Absolute Anime
Experience the wonder of Japanese Animation!

Locked

Return to “[3.0.x] MOD Writers Discussion”

Who is online

Users browsing this forum: No registered users and 18 guests