Parser -> Creating .chm Files for Libraries

Hello,

once upon a time, there was a Tool called Documentation Studio (I think) with that, it was a little easier to create your own little Help-File, callable by pressing “F1” in your Project. But now I cant find it anywere on the B&R Homepage…

Is there any way to get it?

The only thing I found isa PDF describing creating a *.cfm file:
https://www.br-automation.com/de-de/downloads/creating-a-library-user-documentation-chm/?noredirect=1

Hi,

I’ll check if I can provide it.

Hi,
I’ve work a year ago on a generator of .chm files for user library.
I used hhc.exe program to generate them. I get it from HelpNDoc software.

It’s a python project with a self made library parser and a generator of :

  • html file, based on AS Help
  • Index .hhk .hhp .hhc files

It’s not finished and a bit hardcoded for design of page.

Don’t hesitate if you have an interest I will maybe share it on github

Example of final result :

Hi Florent
Your Project seems quite interesting. have you shared it on github? Where can i find it?

the help designer from b&r has some problems. for example: in the page that lists the functions of a library shows as description the text for the output-value.
or it’s not possible to organize the files with subfolders.

i would really like to try your tool.

Hi Daniel,

I will take a look where I put this project ^^’
Then I didn’t have docs about it. I keep you in touch.

Regards,
Florent

perfect. thanks for that extremely fast answer

We, too, are not satisfied with “Documentation Studio” in our company.

It would be very helpful if someone had already looked into the topic of “help files.” Developing it further as a VS Code (AS Code) extension would be an interesting task for me.

1 Like

I’m still searching where I put my code ^^’ It was a python project. I never check about creating a VS Code extension.
As far as I remember the big part of the project was the parsing of libraries.
And with the parsing there is a filestructure to generate to compile the .chm.

I keep you in touch when I found it!

Hi Daniel,

I’ve found my code, but I need to modify it a bit. I will try to have a public repository for the new year!

I keep you in touch!

Regards,
Florent

2 Likes

Hi guys,

At the moment my parser is able to parse every library that used a .fun file inside, it could be implemented in IEC or in C.
I’m wondering if I should implement or plan to implement the parsing of pure C library by parsing .h file?

Regards,
Florent

In my opinion, it depends on whether you want to do it “B&R-only”/C-world.
If you also want to make other people happy (“ST-world”/PLC Siemens, Beckhoff, etc.), the ST file (.fun) would probably be the better option.
However, I suspect that the “ST-world” still uses .chm files, while C programmers work with Doxygen and similar tools.

Regards,
Patrick

1 Like

perfect. thanks a lot

Hi everyone,

Good news! I’ve created a repository on GitHub that I’m going to share with the community!
I’ll share it after the holidays!

Have a great holiday!

Best regards,
Florent

3 Likes

looking forward to it :slight_smile:

I hope you had a nice holiday and wish you a happy new year.
I would also be interested in the solution and wanted to ask if you have published it yet?

Hi @sven.toensjost

I’m currently making some tests before release it to public :slight_smile:

I keep you inform here!

Regards,
Florent

2 Likes

Hi,

It’s finally available on github here: GitHub - br-automation-community/BRLibToHelp: This python project is used to parse B&R Automation library from Automation Studio project and generate a CHM help file

Feel free to test it, it’s a beta for the moment I’m pretty sure you will have good feedback to improve it!

Regards,
Florent

2 Likes