Skip to content

Commit

Permalink
Document extensions and scroll behaviour on wiki, closes openscd#557
Browse files Browse the repository at this point in the history
  • Loading branch information
danyill committed Sep 24, 2022
1 parent 64f3df3 commit bd459b4
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
17 changes: 17 additions & 0 deletions public/md/Extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
OpenSCD uses extensions to provide built-in functionality and to allow additional functionality beyond the OpenSCD defaults.

Utilities, IED manufacturers, system integrators or other parties can create extensions and provide an interface for viewing or modifying SCL (including modification of private namespaces).

There are three types of extensions:

1. _Menu_ extensions - shown on the project menu after enabling them.
2. _Editor_ extensions - shown in the main window after enabling them.
3. _Validator_ extensions - ensure file compliance with a schema or design rules.

To enable extensions, open the project menu by clicking on the top three lines in the top left, scrolling to the bottom and selecting the _Extensions_ item.
Then select and deselect functionality.
If you are confident in the source of a custom extension, you can also add an extension from a URL.

> NOTE: Infrequently used or in-development extensions are disabled by default.
> NOTE: Where there are many editor extensions, scroll through them by using Shift + Wheel Mouse button.
1 change: 1 addition & 0 deletions public/md/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ You can find information related to topics like
- [Installation](https://github.com/openscd/open-scd/wiki/Install-OpenSCD)
- [Project workflow](https://github.com/openscd/open-scd/wiki/Project-workflow)
- [Validators used in OpenSCD](https://github.com/openscd/open-scd/wiki/Validators)
- [Extensions](https://github.com/openscd/open-scd/wiki/Extensions)

as well as features that allow you to manipulate or add specific information to the project covering

Expand Down
4 changes: 3 additions & 1 deletion public/md/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

## 5.4 [Conducting Equipment element](https://github.com/openscd/open-scd/wiki/Conducting-Equipment)

## 5.5 [Conducting Equipment element](https://github.com/openscd/open-scd/wiki/Power-Transformer)
## 5.5 [Power Transformer element](https://github.com/openscd/open-scd/wiki/Power-Transformer)

## 5.6 [Logical Node References (LNode)](https://github.com/openscd/open-scd/wiki/Logical-Node-Reference)

Expand Down Expand Up @@ -107,3 +107,5 @@
### 9.1 [Manipulate function type elements with OpenSCD](https://github.com/openscd/open-scd/wiki/Function)

### 9.2 [Create SPECIFICATION IED from function elements](https://github.com/openscd/open-scd/wiki/Create-Specification-IED-from-functions)

## 10. [Extensions](https://github.com/openscd/open-scd/wiki/Extensions)

0 comments on commit bd459b4

Please sign in to comment.