This plugin is intended to allow a user to import any number of IEDs from a free selection of template files.
Within each template file there must be only one IED with the name TEMPLATE
.
It can optionally import Communication section elements for the IEDs.
-
This is a plugin for open-scd-core, the core editor engine for OpenSCD.
-
This plugin is a web component and follows the open-wc recommendations.
-
This plugin uses the Apache License and is intended for you to use, study, share and improve.
Feel free to log issues to request fixes, improvements or new features.
Open SCD core allows plugins to be loaded from a URL.
You can click on this link to trial this plugin.
In this view it is without theming and only presents this plugin along with the open and save plugins.
-
The latest core is available at https://openscd.github.io/open-scd/.
-
Go to Menu › Add plugins…
-
Select Cancel - this is an editor plugin.
-
Select OK to required a loaded document.
-
Choose a plugin name of 'Import Templates'.
-
Choose a plugin icon of 'link'
-
Provide a plugin source URI of: https://danyill.github.io/oscd-import-templates/oscd-import-templates.js
-
Click OK on the summary, it should like similar to that shown below:
-
Open a file and enjoy!
Note
|
OpenSCD is transitioning to use of open-scd-core , these instructions will require updating at the end of this transition.
|
-
Open your OpenSCD distribution or use https://openscd.github.io.
-
Create a custom extension by going to menu › Extensions › Add Custom Extension.
-
Enter the name 'Import Templates', select 'Editor tab' and enter https://danyill.github.io/oscd-import-templates/oscd-import-templates.js as the URL.
This is the URL of the bundle built by CI and is always the latest alpha version of this plugin.
-
Click on Add.
-
Until OpenSCD is fully transitioned to open-scd-core, a conversion plugin is also required to interface between the old and new APIs.
-
Create another custom extension by going to menu › Extensions › Add Custom Extension.
-
Enter the name 'Action Translate', select 'Menu entry' and enter https://jakobvogelsang.github.io/oscd-action-translate/oscd-action-translate.js as the URL.
This is the URL of the bundle built by CI and is always the latest alpha version of this plugin.
-
You should now be able to scroll across in the menu-bar and find a tab, "Import Templates"
TipIf there are too many editor plugin, hold down shift and wheel-mouse up and down to scroll them easily.
-
Within the current OpenSCD distribution, plugins are stored in the
public/js/plugins.js
folder. Each plugin appears in the following form:{ name: 'Import Templates', // (1) src: 'https://danyill.github.io/oscd-import-templates/oscd-import-templates.js', // (2) icon: 'link', // (3) default: true, // (4) kind: 'editor', // (5) requireDoc: true, // (6) position: 'middle' // (7) }
-
Name of the plugin which appears in the editor menu at top of screen
-
URL which can be a local or remote resource. For a local resource, begins without a forward slash, e.g.
plugins/oscd-import-templates/dist/oscd-import-templates.js
. In this case what is shown is loading a plugin from the build process. -
A material icon, see others at Material Symbols and Icons
-
Whether the plugin is enabled by default or has to be enabled in the plugins menu
-
The type of plugin, either
menu
oreditor
. This is aneditor
plugin. -
Whether a document must be loaded for this plugin to be available
-
A string, either
top
,middle
orbottom
to give a location in the menu. Otherwise inferred from the order in the file relative to other plugins.
-
-
You need to copy an entry like the above, ensure the
src
URL resolves and the plugin should be loaded when the distribution is built. -
If you are building locally you likely need to run an
npm run bundle
command in each plugin to make thedist
folder, containing a single JavaScript file with the plugin available to OpenSCD.
Within an OpenSCD core distribution, plugins are also loaded from a json file with a slightly different schema.
-
Typically the distribution will be served from a static web page and within the web page there will be a plugins property declared on an
open-scd
object, for instance:<open-scd plugins='{ "menu": [ {"name": "Open File", "icon": "folder_open", "active": true, "src": "https://openscd.github.io/oscd-open/oscd-open.js"}, {"name": "Save File", "translations": {"de": "Datei speichern"}, "icon": "save", "active": true, "src": "https://openscd.github.io/oscd-save/oscd-save.js"} ], "editor": [ {"name": "Import Templates", "icon": "link", "active": true, "requireDoc": true, "src": "/plugins/oscd-import-templates/dist/oscd-import-templates.js"} ] }' ></open-scd>
-
This plugin is an editor plugin, editor plugins are an array of JSON of the following form:
{ "name": "Import Templates", // (1) "icon": "link", // (2) "active": true, // (3) "requireDoc": true, // (4) "src": "https://danyill.github.io/oscd-import-templates/oscd-import-templates.js" // (5) }
-
Name of the plugin which appears in the editor menu at top of screen
-
A material icon, see others at Material Symbols and Icons
-
Whether the plugin is enabled by default or has to be enabled in the plugins menu
-
Whether a document must be loaded for this plugin to be available
-
URL which can be a local or remote resource. For a local resource, begins without a forward slash, e.g.
plugins/oscd-import-templates/dist/oscd-import-templates.js
. In this case what is shown is loading a plugin from the internet using the continuous integration build process.
-
-
You need to copy an entry like the above, ensure the
src
URL resolves and the plugin should be loaded when the distribution is built. -
If you are building locally you likely need to run an
npm run bundle
command in each plugin to make thedist
folder, containing a single JavaScript file with the plugin available to OpenSCD.
This plugin uses Node.js and the npm package ecosystem and is verified to work on Linux.
For development, you’ll need Node.js (including npm, which is bundled with Node.js) on your system.
To check whether you have Node.js installed, and which version, open a terminal and type:
$ node -v
A good way to install Node.js is to use nvm (Node Version Manager), however system-wide installations may also work.
If you’re using Linux or macOS, follow the nvm installation instructions to set up nvm on your machine.
Once you’ve installed nvm, open a new terminal and install the active Node.js LTS release using:
$ nvm install --lts
Now that you have Node.js installed, you can install this plugin.
Clone this repository using:
$ git clone https://github.com/danyill/oscd-import-templates
Now, install dependencies
$ npm i
Start up a demo server
$ npm run start
Now open in your browser locally to http://localhost:8000/demo/ to use the plugin.
To scan the project for linting and formatting errors, run
$ npm run lint
To automatically fix linting and formatting errors, run
$ npm run format
To execute a single test run:
$ npm run test
To run the tests in interactive watch mode run:
$ npm run test:watch
For most of the tools, the configuration is in the package.json
to reduce the number of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
© 2023 OpenSCD Daniel Mulholland