diff options
Diffstat (limited to 'src/assistant/help/doc/snippets/doc_src_qthelp.qdoc')
| -rw-r--r-- | src/assistant/help/doc/snippets/doc_src_qthelp.qdoc | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/src/assistant/help/doc/snippets/doc_src_qthelp.qdoc b/src/assistant/help/doc/snippets/doc_src_qthelp.qdoc new file mode 100644 index 000000000..c8f2ed960 --- /dev/null +++ b/src/assistant/help/doc/snippets/doc_src_qthelp.qdoc @@ -0,0 +1,175 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [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] + + +//! [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] |