Creating help files in Qt - qt

I have been looking at QHelpEngine and QHelpEngineCore, and I was wondering if there is a nice guide on how to start making a help file.

QAssistant was theviewer for html help files.
The new QHelp framework uses a single compiled help file and includes a set of classes to implement a viewer in your app and some standalone tools to build the help file

Ironically I find it difficult to locate this information in the Qt manual. It's under QAssistant.

Related

How to document a file that is not in a solution?

I have a need to document methods/functions in *.cpp code files that are not part of a .NET solution. Up until now my workaround has been to create a solution, but this is a time consuming step for all the different files I come across.
Does anyone know how this can be accomplished?
Scott,
Unfortunately, this is the workaround that you have to use as long as GhostDoc relies on some of the information from Visual Studio CodeDOM... The CodeDOM does not provide any info when you open just a single file.
Do you mind me asking if there is particular reason you are opening single file in VS? Other that these might be random files that are not part of a solution?
Thanks!

Creating Documentation Using QtHelp Module

Qt provides two kinds of help files: Qt Compressed Help (.qch) and Qt Help Collection (.qhc).
The first one actually contains compressed help data (html pages, images etc). The second one contains references to different compressed help files.
Both Qt Assistant and QHelpEngine are using collection files to display help. So I need at least two files to provide documentation for my application: .qch and .qhc.
I want to have a single help file to be used by Qt Help API (e.g. like a .chm help file in Windows).
Is it possible?
I don't think it is possible to create a chm file using QtHelp module since chm files are Microsoft specific and not an independent format.
But all the chm files are opened by the hh.exe application that belongs to HTML Help workshop. I have accessed chm files for opening a specified html page using hh application.
You can have a look over here in my answer.
If there are command line options provided by Microsoft to compile chm files either by hh or through HTML Help workshop command line (if any), you can do that by running the command in QProcess. You have to probe more into that.
Or you can create chm files manually using HTML Help workshop and integrate the chm files into the application.
Hope that helps in giving you a start.
I have not tried this but have a look at chm2qch, Tool for converting Windows CHM files to Qt Help format.

Compiling resource bundles in flex

I want to compile my locale, resource.properties file into a swf.
How can I do that??
The documentation on Adobe site seems to be insufficient.
Can someone please help.
Thanks
Neera
I think this post from Sönke Rohde will help you: http://soenkerohde.com/2008/07/flex-localization/
He explains how to set up the localization in Flex.
Maybe you should also have a look at BabelFX: http://babelfx.org/
http://livedocs.adobe.com/flex/3/html/help.html?content=l10n_1.html
You can't do it directly from Flash Builder, you need to write a shell, ANT or Maven build script.

Documentation of Qt in CHM format

Is it possible to find some information about Qt? I need chm file with all documentation of all classes (https://doc.qt.io/qt-5/classes.html). Does somebody knows where can I find it?
If you have installed Qt in your machine, use Qt Assistant. The help available are pretty much the same as that in the online.
Qt Assistant is just an application which requires no internet connection and useful for offline help..
You can use the script from this site: http://www.interclasse.com/scripts/chm.php in order to generate chm file from an online tutorial you find anywhere in the web. Like this one: http://doc.qt.nokia.com/nokia-qtsdk-1.0/index.html
I haven't tried it myself, but seems rather promising.
Good luck!
I've made a little script that will automatically build a CHM file out of the latest available documentation for QT. All credits to char101 for the main script that actually converts HTML docs into the CHM project, my part was only a little automation.
https://github.com/vzhd1701/qt-documentation-chm-autoupdated

Flex AIR unzip

I am a newbie to Flex AIR. I am trying to create an application that will unzip the contents of a zip file & place them in a particular directory.
How can I achieve this? Is there any unzip library available for flex? Pls help me.
Thanks in advance.
How can I achieve this?
Read the ZIP specification. Implementing it is easy.
Is there any unzip library available for flex?
Is Google down again? The first link takes me here.
For AIR projects I used airxzip from coltware (google it). It has the capability to extract single file from archive, not loading it entire archive into memory.

Resources