SoapSealofApproval < Main

Downloads
release
dev builds
extras
themes
Documentation
manual
wiki
device status
Support
forums
mailing lists
IRC
Development
bugs
patches
dev guide
Wiki > Main > ThemeGuidelines > SoapSealofApproval
---+!! DEPRECIATED - all agreed upon changes made to ThemeGuidelines


%TOC%


---++About Soap's Seal of Approval:

Soap's seal of Approval is a proposed modification to the current theme guidelines. to make sure that WPS's on the rockbox wiki sites conform to a set of strictly defined standards, and to identify the WPS's that do not conform. 


---++Requirements for all themes:
   * must be contained in a .zip archive
   
   * all files (.zip and accompanying images) must be attached to the wiki page

   * must have author's real name and contact info attached?  (a text file in the .zip?)  

   * must not contain broken code (i.e. proper RTC code etc.)

   * must include all required fonts, images, iconsets etc.
  
   * must include a license for the theme and graphics (GPL ? )

   * must have proper directory structure<br>
<pre>
      .rockbox
               backdrops
               fonts
               icons
               themes
               wps
</pre>

   * must not include junk files 
      * examples: thumbs.db , desktop.ini, .DS_Store, .directory etc.

   * must use proper filenaming
      * a. the files themselves<pre>
        DockpodRemix.wps and
        DockpodRemix.cfg and 
        DockpodRemix.bmp</pre>
      * b. inside the .cfg ex: If your backdrop is Mybackdrop.bmp the .cfg should read:
<pre>            backdrop: /.rockbox/backdrops/Mybackdrop.bmp</pre>
and NOT<pre>            backdrop: /.rockbox/backdrops/mybackdrop.bmp</pre>
   * must set appropriate background and foreground colors <br>
  This means that the text would still be readable if somehow the backdrop was not loaded<br>
  ex. black background color for a white foreground (text)

   * must set a backdrop<br>
  if there is no backdrop specified it must be NULL in order to clear the backdrop ex:
   <pre>     backdrop: NULL</pre>

   * The following three points should be included in the .cfg and .wps as comments and be included
      in the description on the wiki
      * must contain info on the author or version and date uploaded in the .wps and in the .cfg<br>
      * must quote sources of graphics in some way, original, GPL'd, copyrighted or otherwise<br>
      * must specify which type of Rockbox the WPS is for i.e.: current, patched, or custom build<br>

---++Requirements of WPS's requiring patches:
   * must state which patches are required with appropriate FS#'s or URL's<br>

---++Examples of accepted format for info inside the .cfg and .wps
Standard build:
<verbatim>
       #Theme Name: Killers 
       #By: Rockboxuser@somedomain.net (MrCoolNick on IRC)
       #Platform: iPod Video (320x240x16) - Standard build
       #Version: 0.1 beta
       #Licenced CC-BY-SA 3.0
       #Graphics taken from mymates.com
       #Last updated: Wed, 16th May 2007 17:22 CEST
</verbatim>

Patched / Unsupported Build:
<verbatim>
       #Theme Name: Applebox
       #By: Steven Dean, modifications by Larry
       #Platform: iPod Video (320x240x16) - Unsupported
       #Patches Required: Album Art, Scrolling Margins
       #Version: 1.0
       #Licenced: CC-BY-SA 3.0
       #Graphics taken from: apple itunes
       #Last updated: Wed, 19th May 2007
</verbatim>

---++Comments?
Questions? Comments? Ideas? post them in the forum:%BR%
Relevant Threads:%BR%
Fix the themes Contest : http://forums.rockbox.org/index.php?topic=10140.0%BR%
Organizing the wiki: http://forums.rockbox.org/index.php?topic=10214.0%BR%
-- Main.GaryLight - 01 May 2007
r11 - 31 Jul 2008 - 21:52:14 - DavidHall
Parents: ThemeGuidelines