From bf83f72c0f1fbecd8007cad39df9b6cfdc3bd85e Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@digia.com>
Date: Thu, 10 Jul 2014 16:00:51 +0200
Subject: Doc: add docs for Change UI Example

Describe the example files.
Add example file extensions to the qdocconf file to
have all files listed on the doc page.
Fix capitalization in the configuration file.
Use more descriptive values for the component in the
package information file. Rearrange sections to be able
to use an include file for documenting all package
information files.
Add more detailed information about creating the installer.
Add image.

Change-Id: I64ffff29d08f1dff4cd92c3b796f1a0e6c2fb280
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
---
 .../installerfw-examples-configuring.qdocinc       |   8 +++---
 .../installerfw-examples-generating.qdocinc        |  18 ++++++++++---
 .../installerfw-examples-packaging.qdocinc         |   4 +--
 doc/installerfw.qdocconf                           |   2 ++
 examples/changeuserinterface/config/config.xml     |   8 +++---
 .../meta/package.xml                               |   7 ++---
 examples/doc/changeuserinterface.qdoc              |  30 +++++++++++++++++----
 .../images/qtifw-examples-changeuserinterface.png  | Bin 0 -> 41473 bytes
 8 files changed, 56 insertions(+), 21 deletions(-)
 create mode 100644 examples/doc/images/qtifw-examples-changeuserinterface.png

diff --git a/doc/includes/installerfw-examples-configuring.qdocinc b/doc/includes/installerfw-examples-configuring.qdocinc
index 681e3b9d7..b75abab8d 100644
--- a/doc/includes/installerfw-examples-configuring.qdocinc
+++ b/doc/includes/installerfw-examples-configuring.qdocinc
@@ -15,8 +15,8 @@
         \li The \c <StartMenuDir> section specifies the name of the default
             program group for the product in the Windows \gui Start menu.
         \li The \c <TargetDir> section specifies that the default target
-            directory displayed to users is \c InstallationDirectory in the home
-            directory of the current user (because the predefined variable
-            \c @HomeDir@ is used as a part of the value). For more information,
-            see \l{Predefined Variables}.
+            directory displayed to users is \c IfwExample in the home directory
+            of the current user (because the predefined variable\c @HomeDir@ is
+            used as a part of the value). For more information, see
+            \l{Predefined Variables}.
     \endlist
diff --git a/doc/includes/installerfw-examples-generating.qdocinc b/doc/includes/installerfw-examples-generating.qdocinc
index e019bd788..45ea2fc22 100644
--- a/doc/includes/installerfw-examples-generating.qdocinc
+++ b/doc/includes/installerfw-examples-generating.qdocinc
@@ -1,5 +1,17 @@
     \section1 Generating the Example Installer
 
-    \code
-    binarycreator --offline-only -c config/config.xml -p packages installer
-    \endcode
+    To create the example installer, switch to the example source directory on
+    the command line and enter the following command:
+
+    \list
+        \li On Windows:
+            \code
+            ..\..\bin\binarycreator.exe -c config\config.xml -p packages installer.exe
+            \endcode
+        \li On Linux or OS X:
+            \code
+            ../../bin/binarycreator -c config/config.xml -p packages installer
+            \endcode
+    \endlist
+
+    The installer is created in the current directory.
diff --git a/doc/includes/installerfw-examples-packaging.qdocinc b/doc/includes/installerfw-examples-packaging.qdocinc
index ec7e82b29..d3a873f2c 100644
--- a/doc/includes/installerfw-examples-packaging.qdocinc
+++ b/doc/includes/installerfw-examples-packaging.qdocinc
@@ -8,8 +8,8 @@
             the component.
         \li The \c <Description> section specifies the human-readable
             description of the component.
+        \li The \c <Version> section specifies the version number of the
+            component.
         \li The \c <ReleaseDate> section specifies the date when this component
             version was released.
-        \li The \c <Script> section specifies the file name of the JavaScript
-            file that is loaded.
     \endlist
diff --git a/doc/installerfw.qdocconf b/doc/installerfw.qdocconf
index 5873bfacd..728500d13 100644
--- a/doc/installerfw.qdocconf
+++ b/doc/installerfw.qdocconf
@@ -17,6 +17,8 @@ outputdir = $OUTDIR
 exampledirs = $SRCDIR ../examples
 
 sources.fileextensions         = "*.qdoc *.qdocinc *.cpp"
+examples.fileextensions        = "*.js *.qs *.txt *.xml"
+examples.imageextensions       = "*.png"
 
 indexes = $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index
 
diff --git a/examples/changeuserinterface/config/config.xml b/examples/changeuserinterface/config/config.xml
index c00f6c705..bdd7e9c2a 100644
--- a/examples/changeuserinterface/config/config.xml
+++ b/examples/changeuserinterface/config/config.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Installer>
-    <Name>Change installer UI Example</Name>
+    <Name>Change Installer UI Example</Name>
     <Version>1.0.0</Version>
-    <Title>Change installer UI Example</Title>
+    <Title>Change Installer UI Example</Title>
     <Publisher>Qt-Project</Publisher>
-    <StartMenuDir>Change installer UI Example</StartMenuDir>
-    <TargetDir>@HomeDir@/IFWChangeInstallerUIExample</TargetDir>
+    <StartMenuDir>Qt IFW Examples</StartMenuDir>
+    <TargetDir>@HomeDir@/IfwExample</TargetDir>
 </Installer>
diff --git a/examples/changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/package.xml b/examples/changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/package.xml
index 04f1986d8..ad6125dea 100644
--- a/examples/changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/package.xml
+++ b/examples/changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/package.xml
@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Package>
-    <DisplayName>Change UI example</DisplayName>
-    <Description>Change license accept/reject labels text</Description>
-    <ReleaseDate>2013-01-01</ReleaseDate>
+    <DisplayName>Dummy Component</DisplayName>
+    <Description>This example does not install any components. It demonstrates
+    modifying the text on the next page.</Description>
     <Version>1.0.0-1</Version>
+    <ReleaseDate>2013-01-01</ReleaseDate>
     <Script>installscript.qs</Script>
     <Licenses>
         <License name="Beer Public License Agreement" file="license.txt" />
diff --git a/examples/doc/changeuserinterface.qdoc b/examples/doc/changeuserinterface.qdoc
index 872177b18..bc4fb9075 100644
--- a/examples/doc/changeuserinterface.qdoc
+++ b/examples/doc/changeuserinterface.qdoc
@@ -32,10 +32,13 @@
 
     \brief Changing the installer UI by using a component script.
 
-    \e {Change Installer UI} demonstrates how to add a license page to the
-    installer by using a component script.
+    \image qtifw-examples-changeuserinterface.png
 
-    \note Do not use component scripts for translations.
+    \e {Change Installer UI} demonstrates how to use the \c Component() function
+    to modify the default text for the radio button labels on the
+    \l{License Check Page}{license check page}. This example does not install
+    any components, but we specify a dummy component in the package information
+    file, because installers without components are not allowed.
 
     \include installerfw-examples-configuring.qdocinc
 
@@ -44,8 +47,8 @@
     \include installerfw-examples-packaging.qdocinc
 
     \list
-        \li The \c <Version> section specifies the version number of the
-            component.
+        \li The \c <Script> section specifies the file name of the JavaScript
+            file that is loaded to perform operations.
         \li The \c <Licenses> section specifies the \c name of the license
             agreement to be accepted by the end user and the filename of the
             \c file that contains the license.
@@ -53,5 +56,22 @@
 
     \quotefile changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/package.xml
 
+    \section1 Modifying UI Text
+
+    In installscript.qs, we call the \c Component() function to add the license
+    check page and to connect to the \c changeLicenseLabels signal when end
+    users enter the page:
+
+    \quotefromfile changeuserinterface/packages/org.qtproject.ifw.example.changeuserinterface/meta/installscript.qs
+    \skipto Component()
+    \printuntil }
+
+    We use the \c changeLicenseLabels function to change the text labels for the
+    accept and reject license radio buttons on the page:
+
+    \printuntil }
+
+    \note Do not use the \c Component() function to add translations.
+
     \include installerfw-examples-generating.qdocinc
 */
diff --git a/examples/doc/images/qtifw-examples-changeuserinterface.png b/examples/doc/images/qtifw-examples-changeuserinterface.png
new file mode 100644
index 000000000..c9bfad983
Binary files /dev/null and b/examples/doc/images/qtifw-examples-changeuserinterface.png differ
-- 
cgit v1.2.3