Manual

[Rogier-5]

Hi,

I noticed you included a HTMLized copy of my minetestmapper manual with minetestmappergui. I don't know if that was intentional, but the images it refers to are missing, so it doesn't look as good as it could...

Obviously, the manual as included is bound to get out of date. To me, it seems more logical to just include the HTMLized manual from minetestmapper (with images) in the installation package, and have minetestmappergui refer to that ?

If you do want to include it (which is perfectly fine with me), please consider adding a clear note about which version of minetestmapper it came from (with date), so as to avoid any confusion about which version is more recent.

[adrido]

The Manual was taken from your Windows Package and I just missed the time, to get the images working. My first plan was to use that html manual as a socaled "What's This?" hint witch should be displayed by Schift+F1 but I figured out, that would be work without end. So it ended like it currently is.

You are right, the best thing is, to include the manual with the minetestmapper package and open it in default browser by pressing F1

[Rogier-5]

My first plan was to use that html manual as a socaled "What's This?" hint

Sounds like a good idea to me.

but I figured out, that would be work without end

Why ?

AFAICT, it would be some work initially, but it wouldn't have to be done all at once. After that, I think the internal links (like <a class="reference internal" href="#invocation" id="id3">) would remain pretty stable over time. Or am I overlooking something ?

Maybe there is even a way to convert the manual to individual HTML files ?

In any case, I'd still think the HTML version of the manual that comes with (the latest version of) minetestmapper should be used if possible - if that is not too inconvenient on windows. It should be doable on Linux etc. - I'd have to change the installation packages a little, but that's no problem. As for WIndows, I really have no solid idea about what works, what's convenient to do, and what is really complicated to achieve...

[adrido]

Yes of course it is doable by simply copy and paste the html text or rtf in QtDesigners Widget attributes. This would be easy, but is relay static and will blow up ui and translation files.

Another way is using QHelpEvent and QWhatsThis than the lot of handwork is, to detect witch text is displayed for witch widget. The pro is, that its easy customizable and the help text may get also parsed from native format on the fly. Another pro is the translation could be easily done by using different files e.g. manual_de.html or manual_en.html

anyway both ways require a lot of handwork.

The 3rd way is to place help links everywhere that opens the href in a popup or external window. Thats the simplest and easiest

[adrido]

Together with a url handler a simple satisfying solution could be created. Each internal link starting with "help://" could handled by it to show the correct entry of the manual.

QDesktopServices::setUrlHandler("help", this, "helpUrlHandler");