Changeset 846 for trunk/doc/src/development/assistant-manual.qdoc

Timestamp:

May 5, 2011, 5:36:53 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

Location:

trunk

Files:

• . (modified) (1 prop)
• doc/src/development/assistant-manual.qdoc (modified) (10 diffs)

trunk/doc/src/development/assistant-manual.qdoc

@@ -1 +1 @@
 /****************************************************************************
 **
-** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** Copyright (C) 201 Nokia Corporation and/or its subsidiary(-ies).
 ** All rights reserved.
 ** Contact: Nokia Corporation ([email protected])
@@ -7 +7 @@
 ** This file is part of the documentation of the Qt Toolkit.
 **
-** $QT_BEGIN_LICENSE:LGPL$
+** $QT_BEGIN_LICENSE:L$
 ** Commercial Usage
 ** Licensees holding valid Qt Commercial licenses may use this file in
 ** accordance with the Qt Commercial License Agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Nokia.
+** Software or, alternatively, in accordance with the terms contained in
+** written agreement between you and Nokia.
 **
-** 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.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
 **
 ** If you have questions regarding the use of this file, please contact
@@ -155 +141 @@
             \o -unregister <doc.qch>
             \o Unregisters the specified compressed help file from the given
-            collection file.
+            collection file.
         \row
             \o -remove-search-index
@@ -161 +147 @@
                useful in case the associated index files get corrupted.
                \QA will re-index the documentation at the next start-up.
+
+
+
+
         \row
             \o -setCurrentFilter <filter>
@@ -356 +346 @@
     The \menu{Options} page lets you specify the homepage \QA will display when
     you click the \gui{Home} button in \QA's main user interface. You can specify
-    the hompage by typing it here or clicking on one of the buttons below the
+    the hompage by typing it here or clicking on one of the buttons below the
     textbox. \gui{Current Page} sets the currently displayed page as your home
     page while \gui{Restore to default} will reset your home page to the default
@@ -639 +629 @@
             language. The icon defined by the \c{icon} tags is applied to any language.
         \row
-            \o \c{<cacheDirectory>}
-            \o Specified as a path relative to the directory given by
-            QDesktopServices::DataLocation, the cache path is used to store index files
+            \o \c{<cacheDirectory base="collection|default">}
+            \o The cache directory is used to store index files
             needed for the full text search and a copy of the collection file.
-            The copy is needed because \QA stores all its settings in the collection file;
-            i.e., it must be writable for the user.
+            The copy is needed because \QA stores all its settings in the collection file; i.e., it must be writable for the user.
+            The directory is specified as a relative path. 
+            If the \c{base} attribute is set to "collection", the path is 
+            relative to the directory the collection file resides in. 
+            If the attribute is set to "default" or if it is missing, 
+            the path is relative to the directory given by 
+            QDesktopServices::DataLocation. The first form is useful for 
+            collections that are used in a "mobile" way, e.g. carried around 
+            on a USB stick.
+            
     \endtable
 
@@ -678 +675 @@
     functionality by passing the \c{-enableRemoteControl} command line option.
 
-    \warning The trailing '\0' must be appended separately to the QByteArray,
-    e.g., \c{QByteArray("command" + '\0')}.
-
     The following example shows how this can be done:
 
@@ -690 +684 @@
 
     \snippet doc/src/snippets/code/doc_src_assistant-manual.qdoc 3
+
+
+
 
     The following commands can be used to control \QA:
@@ -728 +725 @@
             the currently displayed page.
         \row
-            \o \c{setCurrentFilter}
+            \o \c{setCurrentFilter}
             \o Selects the specified filter and updates the visual representation
             accordingly.
@@ -734 +731 @@
             \o \c{expandToc <Depth>}
             \o Expands the table of contents tree to the given depth. If depth
-            is less than 1, the tree will be collapsed completely.
+            is 0, the tree will be collapsed completely. If depth is -1,
+            the tree will be expanded completely.
+        \row
+            \o \c{register <help file>}
+            \o Adds the given Qt compressed help file to the collection.
+        \row
+            \o \c{unregister <help file>}
+            \o Removes the given Qt compressed help file from the collection.
     \endtable