Documentation Generator|OPC UA Implementation: Stacks, Tools, and Samples|Forum|OPC Foundation

Avatar
Search
Forum Scope


Match



Forum Options



Minimum search word length is 3 characters - maximum search word length is 84 characters
Lost password?
sp_Feed sp_PrintTopic sp_TopicIcon
Documentation Generator
Avatar
Andy Rohr
Member
Members
Forum Posts: 3
Member Since:
10/28/2014
sp_UserOfflineSmall Offline
1
09/13/2021 - 09:16
sp_Permalink sp_Print

Hi all

Are there any known tools to turn a NodeSet XML file into a "human readable" document (docx for example) which documents the modelling in a standard way?

Avatar
Randy Armstrong
Admin
Forum Posts: 1564
Member Since:
05/30/2017
sp_UserOfflineSmall Offline
2
09/13/2021 - 09:58
sp_Permalink sp_Print sp_EditHistory

These pages are auto-generated from the nodeset:

https://reference.opcfoundatio......org/Core/

Avatar
Andy Rohr
Member
Members
Forum Posts: 3
Member Since:
10/28/2014
sp_UserOfflineSmall Offline
3
09/13/2021 - 10:00
sp_Permalink sp_Print sp_EditHistory

Which tool is used to generate these pages? Is this tool available as open source?

Avatar
Randy Armstrong
Admin
Forum Posts: 1564
Member Since:
05/30/2017
sp_UserOfflineSmall Offline
4
09/13/2021 - 10:04
sp_Permalink sp_Print

It combines a few tools and custom code including https://jekyllrb.com/

It is cumbersome to set up and run.

What are you hoping to do?

Avatar
Andy Rohr
Member
Members
Forum Posts: 3
Member Since:
10/28/2014
sp_UserOfflineSmall Offline
5
09/13/2021 - 10:10
sp_Permalink sp_Print

We have developed a nodeset generator which generates nodeset XML files based on some application configuration and models. It would be nice to have a automated way to generate a documentation based to the nodeset too.

Avatar
Randy Armstrong
Admin
Forum Posts: 1564
Member Since:
05/30/2017
sp_UserOfflineSmall Offline
6
09/13/2021 - 10:26
sp_Permalink sp_Print

Unfortunately, the tooling is not in a state where it could be released to the public.

Any companion specifications are published by the OPC-F.

Avatar
Sebastian Friedl
New Member
Members
Forum Posts: 1
Member Since:
04/26/2017
sp_UserOfflineSmall Offline
7
09/23/2021 - 02:08
sp_Permalink sp_Print

Hello together,

 

we have published a small python script to generate a docx file from a nodeset file. It is in a very early version (only ObjectTypes) but can be extended easily.

 

Please feel free to test it:

https://github.com/iswunistutt....._generator

 

Best Regards

Sebastian

Avatar
wrn
Germany, BW
New Member
Members
Forum Posts: 1
Member Since:
12/03/2023
sp_UserOfflineSmall Offline
8
08/27/2024 - 01:17
sp_Permalink sp_Print

Hello together, 

 

there is also the tool NodeDoc.

https://github.com/software-co.....rg/NodeDoc 

It is set up on Linux or WSL2 with just a few commands, but sadly still got some bugs, and I am not sure if the development is ongoing or not.
In my opinion it still got some great features even if it just for yourself. 

 

Is anybody working with a different tool for automatic documentation generation from the XML files? 

 

Best regards. 

Forum Timezone: America/Phoenix
Most Users Ever Online: 510
Currently Online:
Guest(s) 13
Currently Browsing this Page:
1 Guest(s)
Top Posters:
Forum Stats:
Groups: 2
Forums: 10
Topics: 1435
Posts: 4855