Version 1 (modified by Andrew Boon, 14 years ago) (diff) |
---|
Boonex Market Product Requirements
Common Requirements:
Code convention
All files should be written according to the Code Convention.
Demo
Each product should be represented by screenshots, or a demo site, or any other way you can (screenshots, slideshow, portfolio, demo site).
Read Me File
Complete and structural Read Me file (file name, build, version compatibility, installation etc.).
Build-in modules installer wizard
Installation should be presented as build-in module installer. Dolphin build-in installer process the SQL queries, language files and other tasks automatically.
File naming
The software should contain the product name and version in its name(the build number, if necessary).
Version compatibility
A product marked as compatible with Dolphin 7.0, for example, should be fully compatible with the mentioned Dolphin version without any additional necessary software or procedures.
More than 1 file
Each product should have more than one file, and the package itself should be packaged properly according to Dolphin 7.0 modules structure.
Legal distribution
To be able to offer products (integration modules, Copy and Paste Scripts, etc. ) which have proprietary or other private licenses, you should have the right to distribute it. You will have to grant your resellers rights.
Extensions:
Dolphin module
Each dolphin modification need to be presented as Dolphin module, with all required module structure. Event if it is small modification - it is required to present it as Dolphin 7 module.
Admin panel
Each product offered here should have admin panel which is accessible via Dolphin 7 admin menu.
Additional functionality
Any product offered here should provide additional functionality, Not bug fixes.
Do not over-write Dolphin files
You shouldn't over-write Dolphin files and then compose your installation manuals with something like: "take this file from my package and upload it to the Dolphin directory..." etc. Your over-written files could destroy another part of the Dolphin code.
Less Modifications
Try to implement your mod my making less modifications in Dolphin code, new Dolphin 7 structure allows you to responce to Dolphin alerts and make code injections without modifications at all - try to use these features as much as possible.
Language files:
100% translated original file
The offered language file should be completely translated, manually is preferred.
UTF formatted
Dolphin is set up to work with UTF-8 encoding, and to avoid errors which may appear as different symbols the language file should be written in UTF-8 encoding.
International standard
The language should be marked with international standards marks. Language files should be named the following way: lang-country. Country and dash isn't mandatory. The language name must follow ISO 639-1 (2002) standards and country name must follow ISO 3166 standards.
Packaging
Translation must be packaged according to this manual.
Templates:
Changed Uni template
The offered template should be your own work with the structural code. The changed colors and pics of the Uni template (Dolphin default template) cannot be uploaded as a product.
Copyrighted pictures
The pictures used for the template design shouldn't be copyrighted. Be careful when choosing pictures for your products.
Dolphin original footers
BoonEx footers should be intact in your template.
File changes only
The template package should be contained completely in the tmpl_templatename folder and consist of this folder only. It shouldn't change or be part of any other files.
Structure
Your template must not contain any copy paste code from base template, declare only pages, css styles and images which are different from base template.
Tutorials:
Accessible file format
The offered file should be presented in a format that makes it possible to read it easily without the installation of any additional applications.
Completeness
The product must contain full information and should describe all the nuances of the process described. (should cover the entire installation process).
Detailed description
The tutorial description should contain complete information about its content, which product and product version this file is for, and which program can be used to view it.
No hack instructions
The offered products should provide no information on how to hack BoonEx software: licenses, links, etc.
Readme File(s)
Product owner info:
- Provider username (company name)
- Provider contact data (username, full name, email address, address)
Product info:
- Product version
- Product compatibility with Dolphin versions
- License type
- Upgrade possibilities (provide information on how your customers can get an updated versions if/when they are released)
Installation manual:
Complete set of instructions on how to install/integrate the product.
User manual:
Description of how the product works and how to manage it.