diff options
Diffstat (limited to 'src/assistant/tools/qhelpconverter/doc')
7 files changed, 70 insertions, 0 deletions
diff --git a/src/assistant/tools/qhelpconverter/doc/filespage.html b/src/assistant/tools/qhelpconverter/doc/filespage.html new file mode 100644 index 000000000..a7aac18da --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/filespage.html @@ -0,0 +1,8 @@ +<html> +<body> +<p>Sometimes it can happen that the previously specified paths contain +more or other files than actually needed for the documentation.</p> +<p>This page lists all files which are likely to be unused because they +are neither referenced by any keyword nor be the TOC.</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/filterpage.html b/src/assistant/tools/qhelpconverter/doc/filterpage.html new file mode 100644 index 000000000..7b3781bd5 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/filterpage.html @@ -0,0 +1,13 @@ +<html> +<body> +<p>The help system offers the possibility to filter all installed documentations +for certain <b>attributes</b>. Commonly specified attributes are e.g. the company +and product name as well as the product version.</p> +<p>The help engine and Assistant use <b>custom filters</b> to do the actual +documentation filtering. A custom filter is basically just a alias name for a +list of filter attributes. So, if e.g. the custom filter "MyFilter" lists +the attributes "mycompany, myproduct" then only the documentation with those +attributes will be shown.</p> +<p><b>Warning:</b> The filter attributes are case sensitive!</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/generalpage.html b/src/assistant/tools/qhelpconverter/doc/generalpage.html new file mode 100644 index 000000000..8d106bec1 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/generalpage.html @@ -0,0 +1,10 @@ +<html> +<body> +<p>The <b>namespace</b> is needed to identify this documentation when having +several documentation sets installed in a collection.</p> +<p><b>Virtual</b> folders are used to enable file references between all +documents. Thereby, the virtual folder acts as the root path of all +documents, even if those are part of different documentation sets, +meaning listed under different namespaces.</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/identifierpage.html b/src/assistant/tools/qhelpconverter/doc/identifierpage.html new file mode 100644 index 000000000..952b88de8 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/identifierpage.html @@ -0,0 +1,17 @@ +<html> +<body> +<p><b>Identifiers</b> are mostly used to make keywords unique, but they can also +be used to specify keywords which should not be shown in the index. Identifiers +are especially help full when using context sensitive help and one keyword has +more links assigned to it.</p> +<p>E.g. consider the keyword "replace" in Qt. It is +included, among others, in QString and QList. To be able to retrieve the proper +documentation, there is an identifier "QString::replace" and one +"QList::replace".</p> +<p>A <b>global prefix</b>, e.g. "MyApp::" is set for all keywords independent +where they are located. When <b>inheriting</b> the prefix from the file name, +the keywords get the prefix "[filename]::" where the file name is taken from the +reference of the keyword. The file name is just the base name, i.e. without any +directory or extension.</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/inputpage.html b/src/assistant/tools/qhelpconverter/doc/inputpage.html new file mode 100644 index 000000000..4054c5472 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/inputpage.html @@ -0,0 +1,7 @@ +<html> +<body> +<p>Both, a .adp or .dcf file can be specified. If an .adp file is detected, +the wizard generates a Qt help collection file in addition to the help +project file.</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/outputpage.html b/src/assistant/tools/qhelpconverter/doc/outputpage.html new file mode 100644 index 000000000..332ef69fc --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/outputpage.html @@ -0,0 +1,7 @@ +<html> +<body> +<p>The specified output files will be located in the same directory as the +.adp or .dcf file. The collection file will only be generated if the input +file was an .adp file.</p> +</body> +</html> diff --git a/src/assistant/tools/qhelpconverter/doc/pathpage.html b/src/assistant/tools/qhelpconverter/doc/pathpage.html new file mode 100644 index 000000000..95449b3c3 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/doc/pathpage.html @@ -0,0 +1,8 @@ +<html> +<body> +<p>The new help system uses, in contrast to the old Qt Assistant, compressed +help files containing all files (html files, images, stylesheets, ...) +necessary to display the documentation correctly.</p> +<p>To be able to find all those files, the source paths have to be given.</p> +</body> +</html> |