Skip to content

Commit 1908198

Browse files
committed
[DOCS] Better explanation and sorting of exporters
1 parent 303af02 commit 1908198

2 files changed

Lines changed: 29 additions & 19 deletions

File tree

.github/workflows/main.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@ jobs:
1111
- name: Contribute List
1212
uses: akhilmhdh/contributors-readme-action@v2.3.11
1313
with:
14-
image_size: 50
1514
use_username: true
16-
columns_per_row: 12
1715
commit_message: "[ROOT][DOCS] contrib-readme-action has updated readme"
1816
pr_title_on_protected: "[ROOT][DOCS] contributors readme action update"
1917
env:

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,35 @@ This repository is home to three projects:
2121

2222
Available formats
2323
--------
24-
Exhaustive list of the library's supported formats:<br>
25-
- ElectronicDataSheet [.eds]
26-
- DeviceConfigurationFile [.dcf]
27-
- CanOpenNode [.h,.c]
28-
- CanOpenNodeV4 [.h,.c]
29-
- CanOpenXDDv1.0 [.xdd]
30-
- CanOpenNetworkv1.0 [.nxdd]
31-
- CanOpenXDDv1.1 [.xdd]
32-
- CanOpenXDDv1.1stripped [.xdd]
33-
- CanOpenXDCv1.1 [.xdc]
34-
- CanOpenNetworkXDDv1.1 [.nxdd]
35-
- CanOpenNetworkXDCv1.1 [.nxdc]
36-
- CanOpenNodeProtobuf(json) [.json]
37-
- CanOpenNodeProtobuf(binary) [.binpb]
38-
- DocumentationHTML [.html]
39-
- DocumentationMarkup [.md]
40-
- NetworkPDOReport [.md]
24+
Exhaustive list of the library's supported formats sorted by category:<br>
25+
26+
### CAN in Automation official formats:
27+
| Description | Exporter | Format |
28+
|---------------------------------------|------------------------------------------------------------|--------|
29+
| Electronic Data Sheet (CiA 306-1) | ElectronicDataSheet | .eds |
30+
| Device Configuration File (CiA 306-1) | DeviceConfigurationFile | .dcf |
31+
| XML Device Description (CiA 311) | CanOpenXDDv1.0<br>CanOpenXDDv1.1<br>CanOpenXDDv1.1stripped | .xdd |
32+
| XML Device Configuration (CiA 311) | CanOpenXDCv1.1 | .xdc |
33+
34+
### Extended formats:
35+
| Description | Exporter | Format |
36+
|----------------------------------|---------------------------------------------|--------|
37+
| Network XML Device Description | CanOpenNetworkv1.0<br>CanOpenNetworkXDDv1.1 | .nxdd |
38+
| Network XML Device Configuration | CanOpenNetworkXDCv1.1 | .nxdc |
39+
| XML Profile Description | None | .xpd |
40+
41+
### CANopenNode specific formats:
42+
| Description | Exporter | Format |
43+
|------------------------------------------|----------------------------------------------------------|-----------------|
44+
| CanOpenNode Object Dictionary file pairs | CanOpenNode<br>CanOpenNodeV4 | .h,.c |
45+
| PCanOpenNode Project file | CanOpenNodeProtobuf(json)<br>CanOpenNodeProtobuf(binary) | .json<br>.binpb |
46+
47+
### Documentation formats:
48+
| Exporter | Format |
49+
|---------------------|--------|
50+
| DocumentationHTML | .html |
51+
| DocumentationMarkup | .md |
52+
| NetworkPDOReport | .md |
4153

4254
File structure
4355
--------

0 commit comments

Comments
 (0)