Rules to observe when programming your own pluginsYou are very welcome to provide any type of plugin for elexis. We do, however, request that you please adhere to a few rules to avoid conflicts between different plugins.
1) Name of your pluginYou may name your plugin whatever you like but we recommend that you prefix it with your name or the name of your organization. The prefix elexis- must not be used. this is reserved for our own plugins. We recommend, that you chose a name dervived from the Plugin ID (as described below).
2) Plugin ID of your puginEvery plugin must have its unique ID. It is common use that such an id consists of an inversely written url of the provider. So, all Plugins of elexis.ch have a plugin ID starting with ch.elexis. We recommend, that you use a similar naming scheme. In any case, the prefix ch.elexis must not be used.
3) Packages of your pluginAgain, it is common use to name the packages of a Java programm after its originating url. Therefore, all elexis classes reside in packages prefixed with ch.elexis. We recommend that you use a similar scheme. In any case, the prefix ch.elexis must not be used.
4) Name of your Tables
To avoid name clashes between the tables of different Plugins, it is mandatory that you prefix the names of the tables your plugin creates (if any) with the pluginID. For sql syntax reasons, every dot in the name must be replaced by an underscore. Thus the plugin ch.elexis.something will create a table like CH_ELEXIS_SOMETHING_TABLE1
5) DocumentationIt is recommended to document your work. Besides of the javadoc, we recommend that you include at least a readme.txt file in the root of your plugin that describes, what it does and what it depends on. If you want to give your users a more elaborate documentation, it should be included in a folder called doc at th root of your plugin. We use LaTeX as a default format for our documentations, but this is not mandatory.
|
