Skip to content

Commit

Permalink
Fix typos in Markdown files (#1197)
Browse files Browse the repository at this point in the history
* Fix typos in Markdown files

Signed-off-by: Aurélien Pupier <apupier@redhat.com>

* Improve wording in Markdown doc files

applying suggestions from code review from @danyill

Co-authored-by: danyill <danyill@users.noreply.github.com>

* Improve wording in Markdown doc files

applying suggestions from code review from @danyill

Co-authored-by: danyill <danyill@users.noreply.github.com>
Signed-off-by: Aurélien Pupier <apupier@redhat.com>

---------

Signed-off-by: Aurélien Pupier <apupier@redhat.com>
Co-authored-by: danyill <danyill@users.noreply.github.com>
  • Loading branch information
apupier and danyill authored Mar 22, 2023
1 parent 5bded32 commit b7f1b02
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 14 deletions.
4 changes: 2 additions & 2 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Feature Wishes

Feeature ideas for the OpenSCD project. They are currently not prioritized.
Feature ideas for the OpenSCD project. They are currently not prioritized.

- Add the remaining [process elements to the substation editor](https://github.com/openscd/open-scd/projects/1)
- [Edit wizard for `Services` element](https://github.com/openscd/open-scd/projects/17)
- General purpose [SCL diffing tool](https://github.com/openscd/open-scd/projects/16)
- Finish the [Publisher Plugin](https://github.com/openscd/open-scd/projects/14)
- Improve [IED Editor](https://github.com/openscd/open-scd/projects/11) user experience
- Implement a more featureful [Single Line Diagram](https://github.com/openscd/open-scd/projects/7) editor that can make changes
- Implement a more fully-featured [Single Line Diagram](https://github.com/openscd/open-scd/projects/7) editor that can make changes
- Implement [Log Control Block manipulation](https://github.com/openscd/open-scd/issues/148)
- Implement [Setting Group manipulation](https://github.com/openscd/open-scd/issues/149)
- Implement [Role Based Access](https://github.com/openscd/open-scd/issues/167) Control
Expand Down
1 change: 0 additions & 1 deletion public/md/All-template-editor-wizards.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ The **template editor** allows you to create the elements that combined is the d

- [EnumType](https://github.com/openscd/open-scd/wiki/Enumeration-EnumType)
- [EnumVal](https://github.com/openscd/open-scd/wiki/Enumeration-EnumVal)
- [EnumVal]()
2 changes: 1 addition & 1 deletion public/md/Create-GOOSE-Control-Blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This page allows do define all communication related setting for the GOOSE. Thes
1. `MAC-Address`: The destination MAC address of the GOOSE
2. `APPID`: The APPID of the GOOSE. This is recommended to be unique though out the complete project.
3. `VLAN-ID`: The virtual LAN ID the GOOSE shall be limited to.
4. `VLAN-PRIORITY`: The priority of the GOOSE message. Can be used to priories time critical messages like trip signals over non time critical messages.
4. `VLAN-PRIORITY`: The priority of the GOOSE message. It can be used to prioritise time-critical messages like trip signals over non-time-critical messages.
5. `MinTime`: The minimum time between two occurring GOOSEs when a e.g. a trip occurs
6. `MaxTime`: The maximum time between two occurring GOOSEs in case there is not trip.

Expand Down
2 changes: 1 addition & 1 deletion public/md/Create-Sampled-Values-Control-Blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ This page allows do define all communication related setting for the Sampled Val
1. `MAC-Address`: The destination MAC address of the Sampled Value: `01-0C-CD-04-00-00` to `01-0C-CD-04-01-FF`
2. `APPID`: The APPID of the Sampled Value. This is recommended to be unique though out the complete project.
3. `VLAN-ID`: The virtual LAN ID the Sampled Value shall be limited to.
4. `VLAN-PRIORITY`: The priority of the Sampled Value message. Can be used to priories time critical messages like trip signals over non time critical messages.
4. `VLAN-PRIORITY`: The priority of the Sampled Value message. It can be used to prioritise time-critical messages like trip signals over non-time-critical messages.

&nbsp;

Expand Down
4 changes: 2 additions & 2 deletions public/md/DataTypeTemplates.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ The difference between a signal list and the data model defined in the IEC&#8239
3. Data attribute
4. (Enumeration)

This hierarchical structure can be defined in the `DataTypeTemplates` section of a SCL file by defining and referencing four elements `LNodeType`, `DOType`, `DAType` and `EnumType`. One builds upon the other. In other terms, if you want ot define a `LNodeType` or lets say a LLN0 logical node class you need already some defined `DOType`s and for those you need already some `DAType`s and for some of those - ENx - you also need some `EnumType`s.
This hierarchical structure can be defined in the `DataTypeTemplates` section of a SCL file by defining and referencing four elements `LNodeType`, `DOType`, `DAType` and `EnumType`. One builds upon the other. In other words, if you want to define a `LNodeType` or let's say a LLN0 logical node class you need some already defined `DOType`s and for those you need some already existing `DAType`s and for some of those - ENx - you also need some already existing `EnumType`s.

This is why this process is so hard for beginners to wrap their mind around. To help users that are not so experienced with this part of the standard as well as others that you need to know, e.g. 7-4, 7-3, 8-1, OpenSCD offers so-called templates.

The template database is nothing else than a pre-define data model. Here a lot and a growing number of logical node classes are defined with its proper references to `DOType`, `DAType` and `EnumType`.

You can see, if OpenSCD does have a template for a logical node class you need in the **Add LNodeType** wizard (_Pre-defined lnClasses from templates_). For more detail please refer to [start from templates](https://github.com/openscd/open-scd/wiki/Start-from-template)

If this option is disabled you have to start the precess [from scratch](https://github.com/openscd/open-scd/wiki/Start-from-scratch)
If this option is disabled you have to start the process [from scratch](https://github.com/openscd/open-scd/wiki/Start-from-scratch)

In addition to that you can read/manipulate any element and their attributes using the wizards for

Expand Down
2 changes: 1 addition & 1 deletion public/md/Edit-GOOSE-Control-Blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This page allows do define all communication related setting for the GOOSE. Thes
1. `MAC-Address`: The destination MAC address of the GOOSE
2. `APPID`: The APPID of the GOOSE. This is recommended to be unique though out the complete project.
3. `VLAN-ID`: The virtual LAN ID the GOOSE shall be limited to.
4. `VLAN-PRIORITY`: The priority of the GOOSE message. Can be used to priories time critical messages like trip signals over non time critical messages.
4. `VLAN-PRIORITY`: The priority of the GOOSE message. It can be used to prioritise time-critical messages like trip signals over non-time-critical messages.
5. `MinTime`: The minimum time between two occurring GOOSEs when a e.g. a trip occurs
6. `MaxTime`: The maximum time between two occurring GOOSEs in case there is not trip.

Expand Down
2 changes: 1 addition & 1 deletion public/md/Edit-Sampled-Value-Control-Blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This wizard allows do define all communication related setting for the Sampled V
1. `MAC-Address`: The destination MAC address of the Sampled Value: `01-0C-CD-04-00-00` to `01-0C-CD-04-01-FF`
2. `APPID`: The APPID of the Sampled Value. This is recommended to be unique though out the complete project.
3. `VLAN-ID`: The virtual LAN ID the Sampled Value shall be limited to.
4. `VLAN-PRIORITY`: The priority of the Sampled Value message. Can be used to priories time critical messages like trip signals over non time critical messages.
4. `VLAN-PRIORITY`: The priority of the Sampled Value message. It can be used to priorities time-critical messages like trip signals over non-time-critical messages.

&nbsp;

Expand Down
4 changes: 2 additions & 2 deletions public/md/Enumeration-EnumType.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ OpenSCD templates contains all enumerations from IEC&#8239;61850&#x2011;7&#x2011

*User-defined*

Do defined a user-defined from scratch open **Add EnumType** wizard and make sure to NOT select the value. Be careful with this option as this add a blanc `EnumType`.
Do defined a user-defined from scratch open **Add EnumType** wizard and make sure to NOT select the value. Be careful with this option as this adds a blank `EnumType`.

&nbsp;

<img align="right" src="https://user-images.githubusercontent.com/66802940/132069240-5b7cf7ba-15ea-49d0-8bbf-a48027c3252b.png" alt="alt text" width="250">

**Edit EnumType**

1. Vavigate to the `EnumType` list in the **Template editor** and click on the `EnumType` you want to edit
1. Navigate to the `EnumType` list in the **Template editor** and click on the `EnumType` you want to edit

*Settings*:

Expand Down
2 changes: 1 addition & 1 deletion public/md/Generic-Substation-Event-Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The Generic Substation Event is a service class that has been designed to transm

The GOOSE is defined in the part IEC 61850-8-1. It is often applied to communicate between servers such as bay controller and switch gear control unit.

GOOSE does not use TCP/IP but uses multicast mechanist instead to be send to all communication participants in the same LAN/VLAN. Its sending or publishing and its use or subscription are therefore completely separated. Tha has its effect also on the configuration of GOOSE related communication in the SCL.
GOOSE does not use TCP/IP but uses a multicast mechanism instead to send to all communication participants in the same LAN/VLAN. Its sending (or publishing) and its use (or subscribing) are, therefore, completely separated. This has an impact on the way GOOSE-related communications are configured in the SCL.

**Publishing: GOOSE Control Block (GSEControl)**

Expand Down
2 changes: 1 addition & 1 deletion public/md/Validators copy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Validators are the backbone of this editor. It is very tricky to handle the complexity of an SCL file without it. This is ecpecially true for people just starting to work with SCL file and or with OpenSCD. In most cases we try to avoid producing invalid files but especially in **expert mode** with is not always possible.
Validators are the backbone of this editor. It is very tricky to handle the complexity of an SCL file without it. This is especially true for people just starting to work with SCL files and OpenSCD. In most cases, we try to avoid producing invalid files, but especially in **expert mode**, it is not always possible.

There are two validation functions implemented at the moment. Both are triggered on opening an project or creating a new project. So every time the project basis change. And all validators are triggered on every editor action. That means every time there are changes in the project basis. All results are displayed in the **diagnostics** pane (Ctrl D) and are group by the validation function

Expand Down
2 changes: 1 addition & 1 deletion public/md/Validators.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Validators are the backbone of this editor. It is very tricky to handle the complexity of an SCL file without it. This is ecpecially true for people just starting to work with SCL file and or with OpenSCD. In most cases we try to avoid producing invalid files but especially in **expert mode** with is not always possible.
Validators are the backbone of this editor. It is very tricky to handle the complexity of an SCL file without it. This is especially true for people just working with SCL files and OpenSCD. In most cases, we try to avoid producing invalid files, but especially in **expert mode**, it is not always possible.

There are two validation functions implemented at the moment. Both are triggered on opening an project or creating a new project. So every time the project basis change. And all validators are triggered on every editor action. That means every time there are changes in the project basis. All results are displayed in the **diagnostics** pane (Ctrl D) and are group by the validation function

Expand Down

0 comments on commit b7f1b02

Please sign in to comment.