Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

OpenSCD add-ons are add functionality to extend the core functionality. It allows to experiment (with out commit it directly to the core) and add functionality for just a small group of users. Once an add-on is used a lot and is considered stable, it can become a part of the core functionality.

ADR

Alternatives for Add-ons are

  • Mixins
  • Wait to solve it in OpenSCD-core (thus long discussions, testing etc)

Possible Addons:

  • Setting
  • Wizarding
  • Waiting
  • Logging

Since the functionanlity is not fledged out. The idea is to start with an add-on. Once the are stabel, they can be merged into OpenSCD-core itself.





Not needed any longer With the transtion to OpenSCD next architecture some mixins are nog loger needed compared to OpenSCD monolith architecture:

...

The wizarding Addon takes care of displaying a single wizard in the workflow. The OpenSCD monolith architecture only supports opening 1 wizard. With this component it is possible to open multiple wizards in the same time.

Waiting addon

The waiting Addon is responsible for adding progress-like waiting elements to OpenSCD.

...

The logging Addon is responsible for keeping tack of log statements in OpenSCD.

Example here include the logging editing actions, errors, warnings and information.


Theming addon

Loads the theming; provides an API for a Theming plug-in. Examples here include the colors and icons.


CoMPAS specific add-ons

Since CoMPAS has backend services, it can require more addons;


Elastic addon

The Elastic Addon is responsible for sending Log statements and monitoring to the Elastic stack

...