From OpenSCADAWiki
(Importing a new version from external source) |
(Importing a new version from external source) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == {{Anch|Internal|Creating new Internal | + | == {{Anch|Internal|Creating new Internal Elements and Libraries with them}} == |
| − | + | In order to post the library of the developed internal code to the [http://oscada.org/websvn/listing.php?repname=OpenSCADA OpenSCADA source tree repository], you must do the following and comply with the following requirements: | |
| − | * | + | * be the copyright holder or the Author of the module code and distribute it under any free license, GPL preferred; |
| − | * | + | * create a separate export storage in a file of the [[Special:MyLanguage/Documents/Program_manual#CfgDB|DB SQLite module]] and a library in its (depending on the Element) where to place your Elements; if it is a new library, name its accordingly, with a description as indicated below; more about manipulations with the storages you may read in the How to [[Special:MyLanguage/Documents/How_to/Transferring_project_configuration|Transfer configurations of the OpenSCADA project]]; |
| − | + | * prepare the internal code with the content requirements: | |
| − | :* | + | :* Functions, DAQ-Templates, UI-Widgets, as well as their library, must be written in the international language and contain the description itself in the description field, and general information with copyright at the end: |
<pre style="margin-left: 30px"> | <pre style="margin-left: 30px"> | ||
Author: Name Family <nick@email.org> | Author: Name Family <nick@email.org> | ||
| Line 11: | Line 11: | ||
License: GPLvN | License: GPLvN | ||
</pre> | </pre> | ||
| − | :* | + | :* the source texts of Functions, DAQ-Templates, UI-Widgets must be written and formatted according to some system where preference should be given to the [[Special:MyLanguage/Documents/API#CodeDesign|formatting style of the main OpenSCADA modules]], must not contain localised texts, but only texts in the international language wrapped with the translation function ''tr()''; |
| − | :* | + | :* IO's ID and name also must be in the international language; |
| − | :* | + | :* all the above texts can be translated into the Author's local language, or into several at his discretion, and on the [[Special:MyLanguage/Documents/Program_manual#ConfigTr|page "Translations"]]. |
| − | * | + | * for placing and documenting of the library, write a direct request in the forum topic "[http://oscada.org/en/forum/topics/openscada_development/ OpenSCADA development]", including proof of functionality from the OpenSCADA developer or a short demonstration video — you'll be granted by the Developer status and your account with the same password will be appeared in the [[Special:MyLanguage/Modules|OpenSCADA Wiki]]; |
| + | * write a short information page for the new library, or a part of an existing one, directly on the Wiki in the same way as other libraries nearby; in the information field at the end of the new library description, add a field to jump to this documentation as contextual: | ||
<pre style="margin-left: 30px"> | <pre style="margin-left: 30px"> | ||
DOC: Libs_MyLib|Libs/MyLib | DOC: Libs_MyLib|Libs/MyLib | ||
</pre> | </pre> | ||
| − | |||
Latest revision as of 12:15, 21 April 2025
Creating new Internal Elements and Libraries with them
In order to post the library of the developed internal code to the OpenSCADA source tree repository, you must do the following and comply with the following requirements:
- be the copyright holder or the Author of the module code and distribute it under any free license, GPL preferred;
- create a separate export storage in a file of the DB SQLite module and a library in its (depending on the Element) where to place your Elements; if it is a new library, name its accordingly, with a description as indicated below; more about manipulations with the storages you may read in the How to Transfer configurations of the OpenSCADA project;
- prepare the internal code with the content requirements:
- Functions, DAQ-Templates, UI-Widgets, as well as their library, must be written in the international language and contain the description itself in the description field, and general information with copyright at the end:
Author: Name Family <nick@email.org> Total complexity: N.N HD Version: N.N.N License: GPLvN
- the source texts of Functions, DAQ-Templates, UI-Widgets must be written and formatted according to some system where preference should be given to the formatting style of the main OpenSCADA modules, must not contain localised texts, but only texts in the international language wrapped with the translation function tr();
- IO's ID and name also must be in the international language;
- all the above texts can be translated into the Author's local language, or into several at his discretion, and on the page "Translations".
- for placing and documenting of the library, write a direct request in the forum topic "OpenSCADA development", including proof of functionality from the OpenSCADA developer or a short demonstration video — you'll be granted by the Developer status and your account with the same password will be appeared in the OpenSCADA Wiki;
- write a short information page for the new library, or a part of an existing one, directly on the Wiki in the same way as other libraries nearby; in the information field at the end of the new library description, add a field to jump to this documentation as contextual:
DOC: Libs_MyLib|Libs/MyLib