summaryrefslogtreecommitdiffstats
path: root/src/assistant/tools/qhelpconverter/doc/filterpage.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/assistant/tools/qhelpconverter/doc/filterpage.html')
-rw-r--r--src/assistant/tools/qhelpconverter/doc/filterpage.html13
1 files changed, 13 insertions, 0 deletions
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>