A full explanation of a Box's File Structure is presented here.
| html | Folder that contains all the necessary files to build the javascript file |
| start.html | Code that starts a Box without a Title |
| start_title.html | Code that starts a Box with a Title |
| mid.html | Code that closes a Title, and starts the Contents |
| end.html | Code that closes a Box |
| script.html | List of extra javascript files to be included for Box construction, separated by spaces |
| res | Folder that contains all the necessary files to build the box (image files, and extra javascript files) |
| id | Box ID |
| *.png, *.jpg, *.gif |
Image files needed to construct your Box. Not limited to these image file extensions. |
| *.js |
Extra javascript files to be included for Box construction |
| style.css | CSS file for the Box |
| map.jpg | Image file that contains technical specifications of a Box |
| theboxesparadise_id.inc | Drupal Panel Style file for a Drupal Solution |
| theboxesparadise_id.js | System automatically generated file, you need not create it. |
Html Files
All Html Files are compulsory. You must be able to render a Box with Title or without Title. Even if your Box doesn't need any special markup for the Title text, you must still create the mid.html, which in this case, will be empty. start_title.html must then contain duplicated contents from start.html. The rationale is that, in the case where the user does not know your Box support a Title, he must still be able to call out the standard set of API calls without any error.
The attribute values of your Html tags must be double-quoted. For example, <table width=100%> and <table width='100%'> are both wrong. <table width="100%"> is correct. TBP does not guarantee that your code will be rendered correctly if you do not adhere to this policy.
Even if your code here uses functions from extra javascript files, you should use it as though the functions were already available. This is because tbp_id_getHeader() will render the necessary extra javascript files to load on the actual web page where this Box is used, which will then expose those functions for you to use.
Res Files
style.css is compulsory. You are not restricted to the number of image files or javascript files. Most techiques do not need any extra javascript files, and just rely on CSS coding. JS files are entirely optional. If you do use, do remember to include them in scripts.html, delimited by spaces.
Root Level Files
map.jpg is compulsory.
The INC file is used for a Drupal Solution, and Box Developers are strongly encouraged to provide it. The JS file is a system automatic generated file. It uses information from the Html files to generate this file. This is the only file that a Box user needs to include in his web page to construct your Box. The file naming convention here follows theboxesparadise_id, where id represents your Box ID.
File sizes
The maximum disk space your Box can use is 5MB, which in most cases, is more than enough. If you feel that your Box needs more than 5MB in exceptional cases, email your case to our Review Team here, and TBP will get back to you asap.
Printer-friendly version