xoops forums

Mamba

Moderator
Posted on: 2013/1/9 15:05
Mamba
Mamba (Show more)
Moderator
Posts: 10770
Since: 2004/4/23
#1

Module Standardization Team - looking for volunteers

I would like to set up a team of people to help us with creating Guidelines for XOOPS Module Development for XOOPS 2.6.0

There will be two parts to it:

1) To identify common features among XOOPS modules (e.g. Rating, Breadcrumb, editor selection, etc.), and then define the "Best Practice" for it, that could be used consistently across all modules in XOOPS 2.5.5

This will also include common module structure (i.e. which files are going to which folder, and how we name the files, e.g. file dealing with Permissions should be called "permissions.php" and should be in /admin folder, or all module tables should start with mod_ , as suggested by Alain01 here)

Right now we have too many ways of doing the same thing, and we need to provide some standardization, which will make maintenance of the modules in the future much easier!

And there are some really good ideas in some of the modules that I've seen so far, that actually should be incorporated in all of our modules.

2) Convert those features for XOOPS 2.6.0, and provide conversion guidelines for module developers, so we can have a very quick conversion of the "Basic Module Pack" to XOOPS 2.6.0.

The sooner we start, the more successful will be our XOOPS 2.6.0 release.

Couple of starting points for us:

1) XOOPS Coding standards

2) XOOPS Module Development Quality Checklist (please note that there are tabs at the bottom to different sections of the document)

If anybody is interested, please let us know.
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

zyspec

Module Developer
Posted on: 2013/1/9 15:53
zyspec
zyspec (Show more)
Module Developer
Posts: 1042
Since: 2004/9/21
#2

Re: Module Standardization Team - looking for volunteers

Sure... I'll help.

alain01

Quite a regular
Posted on: 2013/1/9 16:52
alain01
alain01 (Show more)
Quite a regular
Posts: 279
Since: 2003/6/20
#3

Re: Module Standardization Team - looking for volunteers

1st, for modules :

- standard table name : see this post

- Images module :
-- all images will be on this directory : /modules/the-module/images
Why : for the 'template overloaded' (?) (template surcharge in french language)
much easier to customize template overloaded

- standard images name :
-- the search image name (for the module) is never with the same name (ex : search.png)
- standard button image : for homogene administration, it would be nice if the "Add new xxxx" "Add news categorie" etc were the same image in all modules?

May be a designer could work on making a lot of buttons and images, with free use, in order to have an homogene administration. When it would be ok, the module's developper should use by default this images for the administration managed.

Better : an xoops admin images 'library !!!
With this, modules could just used the images library (better for cache).

Sorry for my english.

Mamba

Moderator
Posted on: 2013/1/9 17:05
Mamba
Mamba (Show more)
Moderator
Posts: 10770
Since: 2004/4/23
#4

Re: Module Standardization Team - looking for volunteers

Quote:
- Images module :
-- all images will be on this directory : /modules/the-module/images
[...]
Better : an xoops admin images 'library !!!

We have it already in XOOPS 2.5.5 the preliminary image library at:

/Frameworks/moduleclasses/icons

That was the purpose for it. The plan was to expand it to full set of icons in 16/32 sizes for all modules to use it. XOOPS 2.6.0 will change the location, but it is secondary, as long as the modules can find it. Currently we have "pathIcon16" and "pathIcon32" links to them.

I hope, in XOOPS 2.6.0 we'll be able to combine all the standard icon images as "sprites", which will make things even easier, and will provide a better performance.
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

alain01

Quite a regular
Posted on: 2013/1/9 17:11
alain01
alain01 (Show more)
Quite a regular
Posts: 279
Since: 2003/6/20
#5

Re: Module Standardization Team - looking for volunteers

Quote:

Mamba wrote:
I hope, in XOOPS 2.6.0 we'll be able to combine all the standard icon images as "sprites", which will make things even easier, and will provide a better performance.


You mean "sprites", like that : Resized Image

using CSS background-position property ?
Great !

Mamba

Moderator
Posted on: 2013/1/9 17:24
Mamba
Mamba (Show more)
Moderator
Posts: 10770
Since: 2004/4/23
#6

Re: Module Standardization Team - looking for volunteers

Yes, I would love to see it. There are tons of article about it, like this one, and every performance tool is saying that we should combine images.

For example, we have already combined the small flags here on the Website into a sprite:

Resized Image

Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

bitcero

Quite a regular
Posted on: 2013/1/9 18:56
bitcero
bitcero (Show more)
Quite a regular
Posts: 318
Since: 2005/11/26
#7

Re: Module Standardization Team - looking for volunteers

About images, I think that modules must avoid the use of language in images, I mean, images with text.

Buttons and other kind of components that require text, must be created with CSS and HTML for consistency, accessibility and standardization.

Tarik

Not too shy to talk
Posted on: 2013/1/9 20:37
Tarik
Tarik (Show more)
Not too shy to talk
Posts: 170
Since: 2010/2/3 1
#8

Re: Module Standardization Team - looking for volunteers

we could just have icons and generate buttons like this
http://www.red-team-design.com/just-another-awesome-css3-buttons

Mamba

Moderator
Posted on: 2013/1/9 20:51
Mamba
Mamba (Show more)
Moderator
Posts: 10770
Since: 2004/4/23
#9

Re: Module Standardization Team - looking for volunteers

We have Twitter's Bootstrap included in XOOPS 2.6.0, so you can create buttons directly in Bootstrap.

See Bootstrap Buttons here

And you can include icons in the buttons as well.
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

Tarik

Not too shy to talk
Posted on: 2013/1/9 20:54
Tarik
Tarik (Show more)
Not too shy to talk
Posts: 170
Since: 2010/2/3 1
#10

Re: Module Standardization Team - looking for volunteers

Quote:

Mamba wrote:
We have Twitter's Bootstrap included in XOOPS 2.6.0, so you can create buttons directly in Bootstrap.

See Bootstrap Buttons here


exactly what i had in mind, this will simplify things by allot and we can even just use the predefined glyphs with out the need to any media icons