| 3 | | == Common Requirements: == |
| 4 | | |
| 5 | | '''Code convention'''[[BR]] |
| 6 | | All files should be written according to the [http://www.boonex.com/trac/dolphin/wiki/DolphinCodeConvention Code Convention]. |
| 7 | | |
| 8 | | '''Demo'''[[BR]] |
| 9 | | Each product should be represented by screenshots, or a demo site, or any other way you can (screenshots, slideshow, portfolio, demo site). |
| 10 | | |
| 11 | | '''Read Me File'''[[BR]] |
| 12 | | Complete and structural [wiki:DolphinExtensionReq#ReadmeFiles Read Me file] (file name, build, version compatibility, installation etc.). |
| 13 | | |
| 14 | | '''Build-in modules installer wizard'''[[BR]] |
| 15 | | Installation should be presented as build-in module installer. Dolphin build-in installer process the SQL queries, language files and other tasks automatically. |
| 16 | | |
| 17 | | '''File naming'''[[BR]] |
| 18 | | The software should contain the product name and version in its name(the build number, if necessary). |
| 19 | | |
| 20 | | '''Version compatibility'''[[BR]] |
| 21 | | 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. |
| 22 | | |
| 23 | | '''More than 1 file'''[[BR]] |
| 24 | | Each product should have more than one file, and the package itself should be packaged properly according to Dolphin 7.0 modules structure. |
| 25 | | |
| 26 | | '''Legal distribution'''[[BR]] |
| 27 | | 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. |
| 28 | | |
| 29 | | == Extensions: == |
| 30 | | |
| 31 | | '''Dolphin module'''[[BR]] |
| 32 | | 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. |
| 33 | | |
| 34 | | '''Admin panel'''[[BR]] |
| 35 | | Each product offered here should have admin panel which is accessible via Dolphin 7 admin menu. |
| 36 | | |
| 37 | | '''Additional functionality'''[[BR]] |
| 38 | | Any product offered here should provide additional functionality, Not bug fixes. |
| 39 | | |
| 40 | | '''Do not over-write Dolphin files'''[[BR]] |
| 41 | | 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. |
| 42 | | |
| 43 | | '''Less Modifications'''[[BR]] |
| 44 | | Try to implement your mod by 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. |
| 45 | | |
| 46 | | == Language files:== |
| 47 | | |
| 48 | | '''100% translated original file'''[[BR]] |
| 49 | | The offered language file should be completely translated, manually is preferred. |
| 50 | | |
| 51 | | '''UTF formatted'''[[BR]] |
| 52 | | 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. |
| 53 | | |
| 54 | | '''International standard'''[[BR]] |
| 55 | | 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 [http://en.wikipedia.org/wiki/ISO_639-1 ISO 639-1] (2002) standards and country name must follow [http://en.wikipedia.org/wiki/ISO_3166 ISO 3166] standards. |
| 56 | | |
| 57 | | '''Packaging'''[[BR]] |
| 58 | | Translation must be packaged according to [wiki:DolLang this manual]. |
| 59 | | |
| 60 | | |
| 61 | | == Templates: == |
| 62 | | |
| 63 | | '''Changed Uni template'''[[BR]] |
| 64 | | 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. |
| 65 | | |
| 66 | | '''Copyrighted pictures'''[[BR]] |
| 67 | | The pictures used for the template design shouldn't be copyrighted. Be careful when choosing pictures for your products. |
| 68 | | |
| 69 | | '''Dolphin original footers'''[[BR]] |
| 70 | | !BoonEx footers should be intact in your template. |
| 71 | | |
| 72 | | '''File changes only'''[[BR]] |
| 73 | | 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. |
| 74 | | |
| 75 | | '''Structure'''[[BR]] |
| 76 | | 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. |
| 77 | | |
| 78 | | == Tutorials: == |
| 79 | | |
| 80 | | '''Accessible file format'''[[BR]] |
| 81 | | The offered file should be presented in a format that makes it possible to read it easily without the installation of any additional applications. |
| 82 | | |
| 83 | | '''Completeness'''[[BR]] |
| 84 | | The product must contain full information and should describe all the nuances of the process described. (should cover the entire installation process). |
| 85 | | |
| 86 | | '''Detailed description'''[[BR]] |
| 87 | | 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. |
| 88 | | |
| 89 | | '''No hack instructions'''[[BR]] |
| 90 | | The offered products should provide no information on how to hack !BoonEx software: licenses, links, etc. |
| 91 | | |
| 92 | | == Readme File(s) == |
| 93 | | |
| 94 | | '''Product owner info:'''[[BR]] |
| 95 | | - Provider username (company name) |
| 96 | | - Provider contact data (username, full name, email address, address) |
| 97 | | |
| 98 | | '''Product info:'''[[BR]] |
| 99 | | - Product version |
| 100 | | - Product compatibility with Dolphin versions |
| 101 | | - License type |
| 102 | | - Upgrade possibilities (provide information on how your customers can get an updated versions if/when they are released) |
| 103 | | |
| 104 | | '''Installation manual:'''[[BR]] |
| 105 | | Complete set of instructions on how to install/integrate the product. |
| 106 | | |
| 107 | | '''User manual:'''[[BR]] |
| 108 | | Description of how the product works and how to manage it. |
