Skip to content

Commit 42fd277

Browse files
authored
doc(menu/help) Document extensions and scroll behaviour on wiki, closes openscd#557 (openscd#1015)
1 parent 64f3df3 commit 42fd277

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

public/md/Extensions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
OpenSCD uses extensions to provide built-in functionality and to allow additional functionality beyond the OpenSCD defaults.
2+
3+
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).
4+
5+
There are three types of extensions:
6+
7+
1. _Menu_ extensions - shown on the project menu after enabling them.
8+
2. _Editor_ extensions - shown in the main window after enabling them.
9+
3. _Validator_ extensions - ensure file compliance with a schema or design rules.
10+
11+
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.
12+
Then select and deselect functionality.
13+
If you are confident in the source of a custom extension, you can also add an extension from a URL.
14+
15+
> NOTE: Infrequently used or in-development extensions are disabled by default.
16+
17+
> NOTE: Where there are many editor extensions, scroll through them by using Shift + Wheel Mouse button.

public/md/Home.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ You can find information related to topics like
55
- [Installation](https://github.com/openscd/open-scd/wiki/Install-OpenSCD)
66
- [Project workflow](https://github.com/openscd/open-scd/wiki/Project-workflow)
77
- [Validators used in OpenSCD](https://github.com/openscd/open-scd/wiki/Validators)
8+
- [Extensions](https://github.com/openscd/open-scd/wiki/Extensions)
89

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

public/md/_Sidebar.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

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

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

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

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

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

0 commit comments

Comments
 (0)