How to create a help system for own Xojo desktop app(WIN)

How can I create a help system for my own Xojo desktop app?
It’s only a small app.

Should I use a:

  • Compiled HTML Help File?
  • Web help? (App is online)?

How do I the call of the help sytem inside the Xojo app?

BR
Bernd

you can create an html file, store it as a constant in the app, and make a window with an htmlviewer inside just to display it if the user chooses help.

1 Like

Using html has as well the advantage that you could later put it on the internet, every one can read html these days.

For compiling the html files I’m using medics

The learning curve isn’t high and you can easily use it with GitHub.com for maintenance and it will create static html files which you can include with your app as said above.

I’m not a windows guy but im sure you will find some documentation to get you up and running on Windows.

1 Like

I made a window that mimics the xojo help window.
then a sqlite database with one table, storing the help topics
one field for the help topic id, it’s name, it’s content as markdown, then generate the html content of the markdown, store it also in the same table.
display the html of the help topic in an htmlviewer.
simple, and the table can be stored in the app, in the sqlite database, or shared in a network database.


1 Like

Yes Jean-Yves, I thought in the same direction.
Can somebody explain how to get it run in Xojo?
How do I realize a context sensitive help?

I don’t found in the Xojo help something for setting an context help ID for example.

BR
Bernd

1 Like

You could probably create a global variable, something like:

Var whereMyUserActuallyIsInTheAppBeforeClickingHelp as string

And within your Windows (or buttons etc) you are populating this variable with the current “location”.

myVariable = "mainWindow" or
myVariable = "mainWindow/buttonGenerateReport01" 

etc.

and then the user opens the help you could react on the values in this global variable.

This’ll work but it sounds like a lot of work. I like @Jean-Yves_Pochez solution very much, but it sounds like a lot of work as well. Here is a small online help I did for one customer with mkdocs (I wrote medics yesterday by mistake). There is no need to put these html files in the internet you could just deploy them with your app and show them in an own html viewer. Context would still work, as you can decide which html document should be shown first.

Mkdocs will do the templating and Markdown conversion to html for you and it is free.

BTW, the reason why the above help is put online (and of course you could make it password protected as well or put it on an intranet) is that I don’t need to provide a new version of the app after I updated the documentation. In this particular case the customer did have the admin rights to install a program and not the man power to deploy new versions very often. Hence, the need for separating the help functionality from the core app.

It’s to complex for me and for what I want to do.

Has Xojo an easy integrated possibility for a help system?

What about Help Crafter for Mac?

I use a Windows system.

I went the html route, with the html directory built into the Resources folder.

I’ve also localized this, with separate html directories inside parent folders named for the language. Then when the Help menu calls, the folderitem it’s looking for is the localized string.

1 Like

I’m all in favor for the html route (and any html editor will help you). For many reasons, some are:

  • Very flexible
  • Will run on almost any platform (you never know if one day you won’t develop for another platform than Windows
  • A user might using your app in a virtualizer, but wants to read the documentation on his or her native system.
  • Don’t try to reinvent the wheel. User know how to work with a browser, how to add favorites, create pdfs, searching, adding annotations, etc.
  • Easy to maintain
1 Like