OpenGDS Help Documentation

[MikaelH]

Hi,

For the LV2020 version I think it’s time to update the help in the OpenGDS tool.
What help format would you like to have?

I guess HTML format would be the best.

Accessing help files with your own browser using the file:/// protocol, works fine, but most help file formats are using iframes and that’s blocked on some browsers (i.e. Firefox).

So what should we do?
I was thinking of using HelpNDoc free version for the help file but the format they use is using iframes that isn’t working on all browsers.

I know that JKI’s VIMP is using local help files with the file:/// protocol and that format works.

The easiest is to upload all to the cloud and point the help to e.g.: http://opengds.github.io/help/OpenGDS%20Help.html

And one more question…who have time to help out?

Cheers,

Mike

[styrum]

Mikael:

Check out this review:

https://userguiding.com/blog/help-authoring-tools/

[JeroenDV]

Currently I would like to have a more detailed help file. I would like to contribute iteratively to the help file. Hosting a version on GitHub seems reasonable. That would allow me to contribute a line or two. 

Like you sain MikaelH the current help file using iFrames is blocked by some browsers so navigating through the help file is difficult at the moment. 

[MikaelH]

Anyone wants to help out?
Here is the current content:
http://opengds.github.io/help/
and can be cloned here: (under the help folder)
https://github.com/opengds/opengds.github.io.git
I can give you direct access to the repo just let me know.

[JeroenDV]

Hi MakaelH, when you normally update the helpfiles, do you use normal text editor or a special editor? Is it ok if I write some help files in plain text or Markdown and convert it later on? Cause it feels cumbersome to edit html files directly.

[MikaelH]

We used HelpNDoc when writing the first version of the help file.

[JeroenDV]

I see that HelpNDoc is free for personal/non-commercial use, so we could use that? I'll give it a try. 

[MikaelH]

In the past, I did add the HelpNDoc-Project (*.hnd) in this folder:OpenGDS/Open_GDS_Tools/HelpFiles