To make theme approvals easier on both the team and the designers, we have decided to rewrite the Theme Guidelines. This is to cover some of the more common problems we see, most of which result in having to spend time correcting things that could have been prevented in the first place.
Table of Contents:
-
No Hardcoded Text-
No Copyrighted Material-
Use of SMF Artwork-
XHTML Valid-
Excess Files-
Thumbnail Size-
Thumbnails Must be a Screenshot-
Easy Readability For Quick Editing-
English Theme Descriptions-
theme_info.xml Data Must be Correct-
Multiple Variations-
No Bumping-
Error Log-
External Links-
English Replies
- No Hardcoded Text"Hardcoded text" refers to words that are typed directly into the template files and displayed to members using the theme. This makes translating the theme for use with different languages much more difficult, so it is for this reason we require that all language strings be placed into language files.
This applies even for English! This way the theme can support any languages people want - we even have a
guide that will help you support multiple languages if you would like!
Note that if you want to place a copyright into your theme, you can place this into your theme hardcoded, but it must be in English. If you also need to insert a disclaimer of some type, then it should also be in English.
- No Copyrighted MaterialUsing other people's copyrighted images and code is strictly forbidden. If you are going to use copyrighted material, then you must first obtain authorization from the copyright holders, and also send the message along to us. If we discover that you have used copyrighted material without proof of permission, we will ask to provide proof of permission. If you can't show permission, then you will need to remove the images, or we will be forced to reject the theme outright.
- Use of SMF ArtworkNaturally, you are allowed to freely use images that are included in the SMF package and cross one themes images into another. Images that are used exclusively in 2.0 and are taken back to 1.1 can be used, but they do need to actually be used in the templates. This also applies to any images in your theme - they all must be used, or should not be in the package.
As a note: If you are planning on using SMF images in other software packages, this must be approved by Simple Machines LLC first.
- XHTML ValidTemplate files must be valid to HTML or XHTML standards. Typically XHTML is more common in themes for SMF, but HTML can also be used. Remember to validate while logged in as both a user
and as a guest. (To test while logged in, you can copy and paste the source code into the Direct Input box on the W3C Validator.)
- Excess FilesSMF works slightly different from most packages on the market. If a template file for your theme is not edited, then there's no need to include it, as SMF falls back onto the default version but still retain your theme's styling.
The same applies to language files, as they too fall back onto the default versions. There is one exception, though - customising Settings.language.php with a little information about your theme can't hurt, can it?
- Thumbnail SizeWe have seen users attach theme thumbnails both on the theme site and in the package itself that are extremely huge, often full size of their resolution. This is bad because it will take up space unnecessarily and as such, we ask that authors use thumbnails that are of maximum 120x120 pixels in both locations.
- Thumbnails Must be a ScreenshotUpon theme submission please provide a thumbnail that is direct screenshot from the theme submitted. A thumbnail containing only text is unacceptable.
- Easy Readability For Quick EditingWe understand that users like to edit themes for their own purposes. In order to allow this, theme files should be easily editable. Examples that can make this difficult include things such as all style classes on one line, multiple gaps between lines of code, or using multiple spaces instead of tabs.
- English Theme DescriptionsAll themes require a description. This can be information about the features the theme has, along with other points that really make it unique. All descriptions need to at minimum be in English - other languages may be included if you so wish.
Links to demo or support sites are allowed, but a description that is nothing but links will be required to provide more information.
- theme_info.xml Data Must be Correcttheme_info.xml is a required file, as without it, themes won't be installable, much like how package-info.xml is to a mod. The information displayed in this file is important - particularly the id, package id, name, and contact information. There are two different versions of this file; one for 1.1, and one for 2.0. You can find examples of these files attached, but if you use these samples as a basis for your file, remember to remove the version number from their filename and update the information to match yours!
- Multiple VariationsMany themes now are coming out with multiple colour options. These should all be storied within the same theme site entry. Multiple theme packages are allowed, but for simplicity on the users we do recommend the use of a selection method in the theme (for example, a dropdown menu).
- No BumpingMany users believe that contacting team members will get themes approved faster, but this is not the case. It actually has the opposite effect - they will be pushed to the end of the approval queue! This also applies to the
SMF Customization Team user, so please do not send messages to it unless it is in reply to something we sent you. Remember, we are volunteers, so real life does take priority - this is just something we like to do in our spare time. If your theme has not been approved or you have not been contacted about a theme within 2 weeks, then you may send a reminder about it.
- Error LogOccasionally, themes themselves will flood a user's error log. This is no longer allowed, so you may post in the
Graphics and Templates board for support on how to fix any error log issues.
- External LinksExternal Links are not allowed, except for placement in a copyright notice. This is particularly true for illegal or adult content such as warez, pornographic items, or torrenting sites. These sites will be classified at the discretion of the team, and if you do not remove the links, your theme will be rejected.
- English RepliesIfyou are contacted by the team to fix issues with your theme, theresponse to us must be in English. If your reply is not in English, wemay contact you again for an English translation. Contact the localmoderator for your language if you need assistance. Note that anynon-English replies will place your theme at the end of the approvallist, so please remember this! If English is not your first language,don't worry, we should still be able to understand you.
Remember, we want to hear your feedback. If you have any questions or suggestions, please contact a Customize Team member, and they will do what they can to help, or pass your suggestion forward to someone who will be able to help. Thanks for your contributions, and we hope to see something you've made on the theme site soon!
Thanks,
Customization Team.
