doc/src/snippets/code/doc_src_qthelp.qdoc
changeset 7 f7bc934e204c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/snippets/code/doc_src_qthelp.qdoc	Wed Mar 31 11:06:36 2010 +0300
@@ -0,0 +1,200 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [0]
+#include <QtHelp>
+//! [0]
+
+
+//! [1]
+CONFIG += help
+//! [1]
+
+
+//! [2]
+qhelpgenerator doc.qhp -o doc.qch
+//! [2]
+
+
+//! [3]
+<?xml version="1.0" encoding="utf-8" ?> 
+<QHelpCollectionProject version="1.0">
+    <docFiles>
+        <register>
+            <file>doc.qch</file>
+        </register>
+    </docFiles>
+</QHelpCollectionProject>
+//! [3]
+
+
+//! [4]
+qcollectiongenerator mycollection.qhcp -o mycollection.qhc
+//! [4]
+
+
+//! [5]
+...
+<docFiles>
+    <generate>
+        <file>
+            <input>doc.qhp</input>
+            <output>doc.qch</output>
+        </file>
+    </generate>
+    <register>
+        <file>doc.qch</file>
+    </register>
+</docFiles>
+...
+//! [5]
+
+
+//! [6]
+QHelpEngineCore helpEngine("mycollection.qhc");
+...
+
+// get all file references for the identifier
+QMap<QString, QUrl> links = 
+    helpEngine.linksForIdentifier(QLatin1String("MyDialog::ChangeButton"));    
+
+// If help is available for this keyword, get the help data
+// of the first file reference.
+if (links.count()) {
+    QByteArray helpData = helpEngine->fileData(links.constBegin().value());        
+    // show the documentation to the user
+    if (!helpData.isEmpty())
+        displayHelp(helpData);
+}
+//! [6]
+
+
+//! [7]
+<?xml version="1.0" encoding="UTF-8"?>
+<QtHelpProject version="1.0">
+    <namespace>mycompany.com.myapplication.1.0</namespace>
+    <virtualFolder>doc</virtualFolder>	    
+    <customFilter name="My Application 1.0">
+        <filterAttribute>myapp</filterAttribute>
+        <filterAttribute>1.0</filterAttribute>
+    </customFilter>
+    <filterSection>
+        <filterAttribute>myapp</filterAttribute>
+        <filterAttribute>1.0</filterAttribute>
+        <toc>
+            <section title="My Application Manual" ref="index.html">
+                <section title="Chapter 1" ref="doc.html#chapter1"/>
+                <section title="Chapter 2" ref="doc.html#chapter2"/>
+                <section title="Chapter 3" ref="doc.html#chapter3"/>
+            </section>
+        </toc>
+        <keywords>
+            <keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
+            <keyword name="bar" ref="doc.html#bar"/>
+            <keyword id="MyApplication::foobar" ref="doc.html#foobar"/>
+        </keywords>
+        <files>
+            <file>classic.css</file>
+            <file>*.html</file>
+        </files>
+    </filterSection>
+</QtHelpProject>
+//! [7]
+
+
+//! [8]
+...
+<virtualFolder>doc</virtualFolder>
+...
+//! [8]
+
+
+//! [9]
+...
+<customFilter name="My Application 1.0">
+    <filterAttribute>myapp</filterAttribute>
+    <filterAttribute>1.0</filterAttribute>
+</customFilter>
+...
+//! [9]
+
+
+//! [10]
+...
+<filterSection>
+    <filterAttribute>myapp</filterAttribute>
+    <filterAttribute>1.0</filterAttribute>
+...
+//! [10]
+
+
+//! [11]
+...
+<toc>
+    <section title="My Application Manual" ref="index.html">
+        <section title="Chapter 1" ref="doc.html#chapter1"/>
+        <section title="Chapter 2" ref="doc.html#chapter2"/>
+        <section title="Chapter 3" ref="doc.html#chapter3"/>
+    </section>
+</toc>
+...
+//! [11]
+
+
+//! [12]
+...
+<keywords>
+   <keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
+   <keyword name="bar" ref="doc.html#bar"/>
+   <keyword id="MyApplication::foobar" ref="doc.html#foobar"/>
+</keywords>
+...
+//! [12]
+
+
+//! [13]
+...
+<files>
+    <file>classic.css</file>
+    <file>*.html</file>
+</files>
+...
+//! [13]