We do only support files inside or in subdirs of the help project.

Task-number: 255888
Reviewed-by: kh

1 files changed, 50 insertions, 45 deletions

diff --git a/doc/src/qthelp.qdoc b/doc/src/qthelp.qdoc
index 05bf3e3339..21826067d7 100644
--- a/doc/src/qthelp.qdoc
+++ b/doc/src/qthelp.qdoc
@@ -96,7 +96,7 @@
     generation of the compressed help file.
 
     As already mentioned, the Qt compressed help file contains all
-    data, so there is no need any longer to ship all single html 
+    data, so there is no need any longer to ship all single html
     files. Instead, only the compressed help file and optionally the
     collection file has to be distributed. The collection file is
     optional since any existing collection file, e.g. from an older
@@ -211,7 +211,7 @@
     \section2 Using QHelpEngine API
 
     Instead of showing the help in an external application like the
-    Qt Assistant, it is also possible to embed the online help in 
+    Qt Assistant, it is also possible to embed the online help in
     the application. The contents can then be retrieved via the
     QHelpEngine class and can be displayed in nearly any form.
     Showing it in a QTextBrowser is probably the most common way, but
@@ -238,7 +238,7 @@
 
     Qt Commercial Edition licensees that wish to distribute applications that
     use these features of the QtHelp module need to be aware of their
-    obligations under the GNU Lesser General Public License (LGPL). 
+    obligations under the GNU Lesser General Public License (LGPL).
 
     Developers using the Open Source Edition can choose to redistribute
     the module under the appropriate version of the GNU LGPL; version 2.1
@@ -269,23 +269,23 @@
 /*!
     \page qthelpproject.html
     \title Qt Help Project
-    
+
     A Qt help project collects all data necessary to generate a
     compressed help file. Along with the actual help data, like
     the table of contents, index keywords and help documents, it
     contains some extra information like a namespace to identify
     the help file. One help project stands for one documentation,
     e.g. the Qt Assistant manual.
-    
+
     \section1 Qt Help Project File Format
-    
+
     The file format is XML based. For a better understanding of
     the format we'll discuss the following example:
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 7
-    
+
     \section2 Namespace
-    
+
     To enable the QHelpEngine to retrieve the proper documentation to
     a given link, every documentation set has to have a unique
     identifier. A unique identifier makes is also possible for the
@@ -293,10 +293,10 @@
     on its file name. The Qt help system uses a namespace as identifier
     which is defined by the mandatory namespace tags. In the example
     above, the namespace is "mycompany.com.myapplication.1_0".
-    
+
     \target Virtual Folders
     \section2 Virtual Folders
-    
+
     Having a namespace for every documentation naturally means that
     the documentation sets are quite separated. From the help engines
     point of view this is beneficial, but from the documentors view
@@ -304,84 +304,86 @@
     manual to another without having to specify absolute links. To
     solve this problem, the help system introduced the concept of
     virtual folders.
-          
+
     A virtual folder will become the root directory of all files
     referenced in a compressed help file. When two documentations
     share the same virtual folder, they can use relative paths when
     defining hyperlinks pointing to the other documentation. If a
     file is contained in both documentations or manuals, the one
     from the current manual has precedence over the other.
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 8
-    
+
     The above example specifies 'doc' as virtual folder. If another
     manual, e.g. for a small helper tool for 'My Application'
     specifies the same folder, it is sufficient to write
     'doc.html#section1' to reference the first section in the
     'My Application' manual.
-    
+
     The virtual folder tag is mandatory and the folder must not
     contain any '/'.
-   
+
     \target Custom Filters
     \section2 Custom Filters
-        
+
     Next in the Qt help project file are the optional definitions of
-    custom filters. A custom filter contains a list of filter 
+    custom filters. A custom filter contains a list of filter
     attributes which will be used later to display only the documentation
     which has all those attributes assigned to. So, when setting the
     current filter in the QHelpEngine to "My Application 1.0" only
     the documentation which has "myapp" and "1.0" set as filter
     attributes will be shown.
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 9
-    
+
     It is possible to define any number of custom filters in a help
     project file. Important to know is, that the filter attributes have
     not to be specified in the same project file; they can be defined
     in any other help file. The definition of a filter attributes
     takes place by specifying them in a filter section.
-    
+
     \target Filter Section
-    \section2 Filter Section    
-    
+    \section2 Filter Section
+
     A filter section contains the actual documentation. One Qt help project
     file may contain more than one filter sections. Every filter section
     consists of four parts, the filter attributes section, the table of
     contents, the keywords and the files list. In theory all parts are
     optional but not specifying anything there will result in an empty
     documentation.
-    
+
     \section3 Filter Attributes
-    
+
     Every filter section should have filter attributes assigned to it, to
     enable documentation filtering. If no filter attribute is defined, the
     documentation will only be shown if no filtering occurs, meaning the
     current custom filter in the QHelpEngine does not contain any filter
     attributes.
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 10
-    
+
     In this case, the filter attributes 'myapp' and '1.0' are assigned
     to the filter section, i.e. all contents specified in this section
     will only be shown if the current custom filter has 'myapp' or '1.0'
     or both as filter attributes.
-    
+
     \section3 Table of contents
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 11
-    
+
     One section tag represents one item in the table of contents. The
     sections can be nested to any degree, but from a users perspective
-    it shouldn't be more than four or five levels. A section is defined
-    by its title and reference. The reference, like all file references
-    in a Qt help project file are relative to the help project file
-    itself.
-    
+    it should not be more than four or five levels. A section is defined
+    by its title and reference. The reference, like all file references in a Qt
+    help project, are relative to the help project file itself.
+    \note The referenced files must be inside the same directory (or within a
+    subdirectory) as the help project file. An absolute file path is not supported
+    either.
+
     \section3 Keywords
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 12
-    
+
     The keyword section lists all keywords of this filter section. A
     keyword consists basically of a name and a file reference. If the
     attribute 'name' is used then the keyword specified there will appear in
@@ -389,15 +391,18 @@
     If 'id' is used, the keyword does not appear in the index and is
     only accessible via the linksForIdentifier() function of the
     QHelpEngineCore. 'name' and 'id' can be specified at the same time.
-    
+
     \section3 Files
-    
+
     \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 13
-    
+
     Finally, the actual documentation files have to be listed. Make sure
-    that all files neccessary to display the help are mentioned, i.e. 
-    stylesheets or similar files need to be there as well. All listed files
-    will be compressed and written to the Qt compressed help file. So, in the
-    end, one single Qt help file contains all documentation files along with
-    the contents and indices.
+    that all files neccessary to display the help are mentioned, i.e.
+    stylesheets or similar files need to be there as well. The file, like all
+    file references in a Qt help project, are relative to the help project file
+    itself. All listed files will be compressed and written to the Qt compressed
+    help file. So, in the end, one single Qt help file contains all
+    documentation files along with the contents and indices. \note The
+    referenced files must be inside the same directory (or within a subdirectory)
+    as the help project file. An absolute file path is not supported either.
 */