search

opensourceautomation / Open-Source-Automation

Open Source Automation is a home and commercial automation engine
www.opensourceautomation.com
GNU Lesser General Public License v3.0
97 stars 62 forks source link

OSA Help System #356

Open KHerron opened 7 years ago

KHerron commented 7 years ago

I would like to start on a HELP system for OSA.

However, unlike a standard EXE application, OSA is browser based and also has plugins. So the help system will need to be able to accept additional help files from plugin developers. These help files could be included in the plugin package, and copied to their folder during installation.

I have several Ideas of how to accomplish this, but wanted to get some insight from other users and developers before I put in the time and work!

  1. XML file (Could create a small application that creates the xml file, to make this easier for developers.)
  2. CHM file that displays all the help for a particular object, plugin, etc....
  3. Simple Text file that displays in a Pop-Up.
  4. ScrewTurn Wiki, a .net Wiki application that could be linked to OSA. (example: localhost:8081/Help/Objects)
VaughnRupp commented 7 years ago

Couldn't the help files be on the main OSA wiki and then we just link to them so everyone is always looking at the most current help files without updating their system to get them?

Also, this is probably a different topic/project, but a big part of "help" to me it tooltips. I think we need to go screen by screen in all applications and web pages and see if the tooltips are complete and if they can be enhanced.

KHerron commented 7 years ago

The Wiki would work for the most part or for the initial setup of the system, but then linking each aspect could be quite difficult for the plugins, and would put more work on plugin developers.

I was really on the same page as you with the "ToolTips" you mentioned above. And Yes, I was going to do ALL pages. For example; On the Objects page, if they hover over any dropdowns it would show a tooltip with help text. I could even go as far as the STates, Methods, Events and Properties, and display tooltips for each.

If we went with the XML file, I could create a small application like the DescriptionEditor but call it Help Editor, that would build the XML files. Developers would simply enter the State, Method, Event or Property name, then enter the Help text to be displayed. Then the application would build the XML file, and all they have to do is include it when they create their plugin package. As for the rest of the system, I would have an XML file for each WebUI page...

KHerron commented 7 years ago

This has been implemented and is undergoing testing. I changed the Milestone to 049, as it will go out with the next release. This issue can be closed once you are satisfied with your testing.