[rant] Please use existing CSS classes in your MOD blocks !

Discussion forum for MOD Writers regarding MOD Development.
Locked
User avatar
Ishimaru Chiaki
Registered User
Posts: 179
Joined: Thu Nov 15, 2007 4:39 am
Location: Baie-Comeau, Québec, Canada
Name: Caroline
Contact:

[rant] Please use existing CSS classes in your MOD blocks !

Post by Ishimaru Chiaki »

Hello,

As a Style author, I come here for a little rant : For the sake of style authors and phpBB users, please use existing CSS classes in your blocks that are added by your MODs.

Why, you'd ask me ? Because when these classes (.panel, .bg1, .bg2, .bg3, …) aren't used in your Mods, the blocks colors cannot adapt themselves to the style changes and thus, cause colour bugs that might make some texts unreadable, especially for styles that use a dark background with light-coloured blocks like my pro_ubuntu_lucid does !

Examples of MODs with the problems :
- Social Network
- MChat
- board3portal

Because of this, especially in the case of Social Network, a LOT of adaptation is needed to make this MOD compatible with the styles such as pro_ubuntu_lucid, because this MOD only uses custom classes for its blocks ! If this continues like this, I'll have to create GitHub repos just for adaptations because not all phpBB users are HTML/CSS cracks !

So please, use custom classes for CSS properties that aren't related to colours, and existing CSS properties (.panel, .bg1, .bg2, .bg3, .forumbg, .forabg) for colour scheme ! By doing this, your MOD will be more flexible towards style change !

And for MOD validators, I suggest this to be added as a good practice advice.

That was my two cents.

Ishimaru
Find my phpBB3 and GIMP tutorials on http://ishimaru.pingveno.net (New address)
My DeviantArt gallery

User avatar
tbackoff
Former Team Member
Posts: 7035
Joined: Thu Jun 04, 2009 1:41 am
Location: cheerleading practice
Name: Tabitha Backoff

Re: [rant] Please use existing CSS classes in your MOD block

Post by tbackoff »

I don't speak for the MOD team, but I know that MODs are validated with the default prosilver (and subsilver if instructions are included?). It's not required to work with other styles. That being said, I do see some benefit to using the classes already shipped with phpBB (and I wonder why some MOD Authors don't use them - it's just more work for them). I just thought I'd pop in and mention that. ;)
Flying is the second best thrill to cheerleaders; being caught is the first.

!karolis
Registered User
Posts: 133
Joined: Sun Jun 13, 2010 9:54 am

Re: [rant] Please use existing CSS classes in your MOD block

Post by !karolis »

Very good rant.

User avatar
doktornotor
Registered User
Posts: 608
Joined: Fri Sep 09, 2011 7:41 am

Re: [rant] Please use existing CSS classes in your MOD block

Post by doktornotor »

Thanks to the OP for the post. I am using a custom style for everyone on my board; so, I am modifying every single mod install to include edits for that style. This is extremely annoying thing indeed.
Support requests via PM go straight to /dev/null!

User avatar
javiexin
Code Contributor
Posts: 1157
Joined: Wed Oct 12, 2011 11:46 pm
Location: Madrid, Spain
Name: Javier
Contact:

Re: [rant] Please use existing CSS classes in your MOD block

Post by javiexin »

I think one of the major reasons for this is, probably, the lack of proper documentation and tutorials/guides to help new mod writers to do it with the most appropriate guidelines in mind to facilitate this cross-style development.

Good tutorials would probably help... As on a lot of other phpbb modding aspects.

-javiexin

User avatar
Ishimaru Chiaki
Registered User
Posts: 179
Joined: Thu Nov 15, 2007 4:39 am
Location: Baie-Comeau, Québec, Canada
Name: Caroline
Contact:

Re: [rant] Please use existing CSS classes in your MOD block

Post by Ishimaru Chiaki »

javiexin wrote:I think one of the major reasons for this is, probably, the lack of proper documentation and tutorials/guides to help new mod writers to do it with the most appropriate guidelines in mind to facilitate this cross-style development.

Good tutorials would probably help... As on a lot of other phpbb modding aspects.

-javiexin
After I read your post, I started working on a doc about cross-style compatibility. Here's a draft of it : http://ishimaru-design.servhome.org/tes ... 0&p=51#p51
Don't hesitate to report me spelling/grammar/whatever error, for English isn't my mother tongue.
Find my phpBB3 and GIMP tutorials on http://ishimaru.pingveno.net (New address)
My DeviantArt gallery

User avatar
javiexin
Code Contributor
Posts: 1157
Joined: Wed Oct 12, 2011 11:46 pm
Location: Madrid, Spain
Name: Javier
Contact:

Re: [rant] Please use existing CSS classes in your MOD block

Post by javiexin »

Great tutorial on colour cross-compatibility. I think this should be well publicized.

One more thing: I would recommend to give specific examples of "correct" reuse of the default classes in certain MODs, and corresponding incorrect examples. But anyhow, even as it is, should be recommended reading :)

Thanks!
-javiexin

User avatar
Ishimaru Chiaki
Registered User
Posts: 179
Joined: Thu Nov 15, 2007 4:39 am
Location: Baie-Comeau, Québec, Canada
Name: Caroline
Contact:

Re: [rant] Please use existing CSS classes in your MOD block

Post by Ishimaru Chiaki »

javiexin wrote:Great tutorial on colour cross-compatibility. I think this should be well publicized.

One more thing: I would recommend to give specific examples of "correct" reuse of the default classes in certain MODs, and corresponding incorrect examples. But anyhow, even as it is, should be recommended reading :)

Thanks!
-javiexin
I can use my "introduce yourself" MOD (not yet published - still under evaluation for phpBB-fr.com's latest MOD contest) for the example. In this MOD, I used the .rules class for the warning message to users who haven't introduced themselves.

EDIT : Done !
Find my phpBB3 and GIMP tutorials on http://ishimaru.pingveno.net (New address)
My DeviantArt gallery

User avatar
Sajaki
Registered User
Posts: 1360
Joined: Mon Mar 02, 2009 1:41 pm
Location: Acidalia Planitia, Mars
Contact:

Re: [rant] Please use existing CSS classes in your MOD block

Post by Sajaki »

webdesigners <> php coders (speaking for myself actually). So thanks for the hints. a prosilver css guide would be most welcome actually.

Locked

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