Template Guidelines

[doc]

Dear template developers,

we have set-up some guidelines for template developers the last couple of weeks.

The guidelines provide information about the template file structure, the level of information required within specific files (e.g. license terms, variable definitions) and lists the obligatory Website Baker template functions to be included to the index.php template file. Apart from that, the template guidelines define the quality checks which templates must pass before they are added to the official Website Baker addons repository.

Note: Only templates sticking to the template guidelines will be listed from August 2008 onwards on the Website Baker template repository. Please note that only templates which are released free of charge under a Open Source License will be taken into account for the moment.

Apart from the guidelines, two templates were created. The "master_template" shows the minmum requirements without focusing on design aspects. The template "andreas01" is a worked out example following the new guidelines.

If you have made a template according to the template guidelines, open a new thread in the WB forum board show case and attach your template as compessed file (*.zip) so your template can be reviewed by the community. If not done automatically, send Matthias Gallas (ruebenwurzel) or Klaus Weitzel (kweitzel) a PM to upload your template on the addons repository.

A Dutch version of the template guidelines can be found in this thread.
Please feel free to provide your feedback in this thread.

Best regards
Christian

[Vincent]

Very clear: professional. good work.
Hopefully it leads to more professional, good templates.

Thanks,
Vincent

[Stefek]

Very nice!

I have one additional question.

The Template "Andreas06 - Falling Leaves" provides additional HTML files, which show how to use the Template (for exemple multiple blocks). This information is good to introduce the user into the template without having installed the Template.

Will it be possible in the future to provide such HTML based informations, or do I have to remove all of them if I want my template on  the official Website Baker addons repository?

Regards,
Stefek

[doc]

Hello,

those infos should be placed via $template_description (info.php). The reworked template showcase (not finished yet) will display those additional information from the addons repsository so there is no need to install a template first.

Have a look at andreas01.zip which provides the following information:

$template_description     = 'Clean multi column layout with header and footer. News are shown in a third column, if anynews snippet is installed and news are available. Otherwise only two columns are displayed. News can be switched off in index.php (line 130). Original design by <a href="http://www.andreasviklund.com">Andreas Viklund</a>. Ported to Website Baker by Matthias Gallas, adapted by Christian Sommer.';

Christian

[Stefek]

Hello,

those infos should be placed via $template_description (info.php). The reworked template showcase (not finished yet) will display those additional information from the addons repsository so there is no need to install a template first.

Have a look at andreas01.zip which provides the following information:

$template_description     = 'Clean multi column layout with header and footer. News are shown in a third column, if anynews snippet is installed and news are available. Otherwise only two columns are displayed. News can be switched off in index.php (line 130). Original design by <a href="http://www.andreasviklund.com">Andreas Viklund</a>. Ported to Website Baker by Matthias Gallas, adapted by Christian Sommer.';

Christian

Hello Doc.
Yes, I understand and this is really cool indeed.
But if you download the Andreas 06 template you will find additional HTML Files which demonstrate more template an feauters so I have more chance to let the people know, how to handle the template, which modules to install and so on.

Please take a look at the Andreas 06.
This is how I love it. (Additional to the another minmum requirements. This part I understand and like it too).
I just need some additional space to talk to the user about the specifications of the template (if it is not a "easy one").

Regards,
Stefek

[doc]

Stefek,

the place to talk about special features is in the template description file. It will be possible to provide further information for specific templates in the new showcase by the templates team etc. Authors can add a help file to their template folder and provide a link (like mentioned in the license.txt) in the template description field for example.

Christian

P.S.: do not understand why people use the quote function if the post they want to answer is just above or below.

[zeroram]

Anyone knows if there is any Dreamweaver 8 Extension for Website Baker, i think it will help alot to create new cool themes. including myself.

[Stefek]

Stefek,

the place to talk about special features is in the template description file. It will be possible to provide further information for specific templates in the new showcase by the templates team etc. Authors can add a help file to their template folder and provide a link (like mentioned in the license.txt) in the template description field for example.

Hello Christian,
I have one additional Question about the Template Guidelines.

You stated that the preview.jpg is kind of Obligatory template files.
Could you give me a hint what behind this?
I have no posibility in the Backend to see the picture as a Template Preview.
So the Question is:
Was this meant to be a addition for the next WB Release?

P.S.: do not understand why people use the quote function if the post they want to answer is just above or below.

Can't understand what is that wrong about this... 

Best Regards and a Happy New Year.
Christian Stefan

[ruebenwurzel]

Hello,

the preview.jpg is only needed for the official template showcase on addons.websitebaker .org.

Matthias

[Stefek]

Thanks for quick reply, Matthias.

Best,
Christian Stefan

[doc]

Well,

the template "preview.jpg" file is used by the WB addons showcase so far but may also be used as popup image in upcoming WB versions to allow an better overview of the installed templates for example ...

Christian

[Stefek]

but may also be used as popup image in upcoming WB versions to allow an better overview of the installed templates for example ...

Sounds good.
Thats what I actually wantet to know asking this: "Was this meant to be a addition for the next WB Release?"

Maybe a good feature for your fileedit module too.

(Edit: The "File Edit" Admin Tool was renamed by doc into "Addon File Editor" )

Regards,
Stefek

[Luckyluke]

Hi,

It is really amazing how many templates in the official WB Template Repository doesn't meet the requirements of a good template as described by Doc.
When I test a template where 2 columns are present, you can not select it. In some templates we can select blocks but are not visible on the template.

I read on the first line of the template repositry "Since August 2008 only the following templates Website Baker Template Guide Lines are added to this site". Sorry, this is not.

I have read this document in Dutch (thanks for the Dutch translation) and probably it's only some small adjustments in the index.php but unfortunately I am not a php coder.

I hope that someone with a lot of time (euh... who has this  ) once focus on the benefits of $menu[..] and $block[..]

And something important: I don't want to attack anyone with this post. Even the creators of the beautiful templates. They did wonderful work. I only regret that they are not completely finished while they can offer a lot more.

Grtz,
Luc

[doc]

Hi Luc,

I read on the first line of the template repositry "Since August 2008 only the following templates Website Baker Template Guide Lines are added to this site".

Well the statement is not wrong. As far as I know, no template was published on the addons repository since August 2008. Guess about 99.9% of the templates listed were added before the "Template guidelines" were released.

Agree with you. Would be a nice to "update" some templates according to the "Template Guidelines" or to rework the "Template Guidelines" if required.

Regards Christian

[kweitzel]

PDF reported corrupt by joney0004@kctcs.edu ... this is NOT the case, PDF is OK! Please check your computer.

cheers

Klaus