Sednterp User Modules

Sednterp Web and Desktop can load user created modules, written in HTML and Javascript. Both Sednterp Web and Desktop provide an editable display which the user has complete control of and platform tools to help create the module in the form of developer tools. The Sednterp distribution comes with an example module which can be edited so users can use it as a base to create their own modules.

This page shall provide documentation on how to create a user module from scratch.

The basic underlying tool you will need to know is JavaScript, you should not need to be an expert but some underlying fundamentals should be enough to create your own module.

First to create your own module you will need to place it in modules/QtScript under where you have Sednterp installed on your system. If you used the windows installer to install Sednterp you will most likely be able to find it in C:\Program Files\Sednterp

Therefore you should be saving your created modules in C:\Program Files\Sednterp\modules\QtScript

Your module file will be broken up into two parts JavaScript and HTML for the UI.

Part one: JavaScript

Your JavaScript will need to include the following 6 different functions

/* Required Accessor Functions */

 function getModuleName()
 {
   return "MainScreen";
 }
 function getModuleVersion()
 {
   return "20120604";
 }
 function getModuleInteractionXml()
 {
   return "No Interactions";
 }
 function getModuleDate()
 {
   return "2010/06/22";
 }
 function getModuleUI()
 {
   return "qt_sednterp.ui";
 }
 function getModuleHTMLUI()
 {
   return "./modules/QtScript/module1.html";
 }

Part two: HTML UI