Doc: update the Tutorial section

Updated according to user feedback to make descriptions clearer.
Added documentation for all sections in config.xml, explained HomeDir,
and added a link to variable list.
Deleted an obsolete note.
Updated screenshots.

Change-Id: I255569f8a09c7c3b996b6e201c5469874027cf60
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>

14 files changed, 38 insertions, 19 deletions

diff --git a/doc/images/ifw-installation-finished.png b/doc/images/ifw-installation-finished.png
index a90bc330b..14e281d4c 100644
--- a/doc/images/ifw-installation-finished.png
+++ b/doc/images/ifw-installation-finished.png
diff --git a/doc/images/ifw-introduction-page.png b/doc/images/ifw-introduction-page.png
index fe428cccb..bb25947ef 100644
--- a/doc/images/ifw-introduction-page.png
+++ b/doc/images/ifw-introduction-page.png
diff --git a/doc/images/ifw-license-check-page.png b/doc/images/ifw-license-check-page.png
index 1d493c8e4..3edb3237a 100644
--- a/doc/images/ifw-license-check-page.png
+++ b/doc/images/ifw-license-check-page.png
diff --git a/doc/images/ifw-perform-installation.png b/doc/images/ifw-perform-installation.png
index 13b6ee04b..807d24c54 100644
--- a/doc/images/ifw-perform-installation.png
+++ b/doc/images/ifw-perform-installation.png
diff --git a/doc/images/ifw-ready-for-installation.png b/doc/images/ifw-ready-for-installation.png
index 1284d5ba1..f173ee23c 100644
--- a/doc/images/ifw-ready-for-installation.png
+++ b/doc/images/ifw-ready-for-installation.png
diff --git a/doc/images/ifw-select-components.png b/doc/images/ifw-select-components.png
index 019870701..3b070d495 100644
--- a/doc/images/ifw-select-components.png
+++ b/doc/images/ifw-select-components.png
diff --git a/doc/images/ifw-target-directory-page.png b/doc/images/ifw-target-directory-page.png
index 935c139e5..0ee2276fb 100644
--- a/doc/images/ifw-target-directory-page.png
+++ b/doc/images/ifw-target-directory-page.png
diff --git a/doc/images/ifw-tutorial-introduction-page.png b/doc/images/ifw-tutorial-introduction-page.png
index 0fbe97685..3e7f28a5f 100644
--- a/doc/images/ifw-tutorial-introduction-page.png
+++ b/doc/images/ifw-tutorial-introduction-page.png
diff --git a/doc/images/ifw-tutorial-license-check.png b/doc/images/ifw-tutorial-license-check.png
index dd0c341ad..73f7081a0 100644
--- a/doc/images/ifw-tutorial-license-check.png
+++ b/doc/images/ifw-tutorial-license-check.png
diff --git a/doc/images/ifw-tutorial-select-components.png b/doc/images/ifw-tutorial-select-components.png
index 25509d001..5452f9480 100644
--- a/doc/images/ifw-tutorial-select-components.png
+++ b/doc/images/ifw-tutorial-select-components.png
diff --git a/doc/images/ifw-warning-existing-installation.png b/doc/images/ifw-warning-existing-installation.png
index 95d046ab4..b787bb37c 100644
--- a/doc/images/ifw-warning-existing-installation.png
+++ b/doc/images/ifw-warning-existing-installation.png
diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc
index 8a05cf056..743fa2ab4 100644
--- a/doc/installerfw-using.qdoc
+++ b/doc/installerfw-using.qdoc
@@ -71,10 +71,10 @@
 
     \image ifw-user-flow-installing.png "Installation workflow"
 
-    This section uses the \e {Your Application Installer} example run on Windows
+    This section uses the \e {Your Application Installer} example run on OS X
     to illustrate the default workflow for end users. The installers have the
     native look and feel on each supported desktop platform, and therefore they
-    look and feel different when run on Linux and OS X.
+    look and feel different when run on Linux and Windows.
 
     The example files are stored in the \c{examples\tutorial} directory
     in the Qt Installer Framework repository. You can use the \c binarycreator
@@ -89,7 +89,7 @@
     You specify the name of the installer and the product to install in the
     \c config.xml configuration file.
 
-    When end users select \gui Next, the target directory selection page opens.
+    When end users select \gui Continue, the target directory selection page opens.
 
     \section1 Selecting Target Directory
 
@@ -98,7 +98,7 @@
 
     \image ifw-target-directory-page.png "Target directory selection page"
 
-    When end users select \gui Next, the component selection page opens.
+    When end users select \gui Continue, the component selection page opens.
 
     If the directory already contains files, a warning page opens:
 
@@ -121,7 +121,7 @@
     You can use a boolean operator or a script to specify whether a component is
     selected by default.
 
-    When end users select \gui Next, the license check page opens.
+    When end users select \gui Continue, the license check page opens.
 
     \section1 Accepting License Agreements
 
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 24c0a8afd..06e96b7b8 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -162,6 +162,9 @@
     relative paths, which the tools resolve relative to the location of
     the config.xml file.
 
+    You can use predefined variables (embedded in @ characters) as values of the
+    settings. For more information, see \l{Predefined Variables}.
+
     \table
         \header
             \li Setting
@@ -172,7 +175,8 @@
             \li Name of the product being installed. This is mandatory.
         \row
             \li Version
-            \li Version number of the product being installed. This is mandatory.
+            \li Version number of the repository format. This is mandatory and
+                must always be set to \c 1.0.0.
         \row
             \li Title
             \li Name of the installer as displayed on the title bar.
diff --git a/doc/tutorial.qdoc b/doc/tutorial.qdoc
index 9e77ae991..19ee8c352 100644
--- a/doc/tutorial.qdoc
+++ b/doc/tutorial.qdoc
@@ -96,6 +96,27 @@
 
     \image ifw-tutorial-introduction-page.png "Introduction page"
 
+    The other settings are used to customize the behavior of the installer:
+
+    \list
+
+        \li The \c <Version> section specifies the version number of the
+            repository format, and must be set to \c 1.0.0.
+
+        \li The \c <Publisher> section specifies the publisher of the software
+            (as shown in the Windows Control Panel, for example).
+
+        \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}.
+
+    \endlist
+
     For more information about the configuration file format and the available
     settings, see \l{Configuration File}.
 
@@ -108,13 +129,15 @@
 
     \quotefile ../examples/tutorial/packages/com.vendor.product/meta/package.xml
 
+    The sections in the example file are described in more detail below.
+
     For more information about the package information file, see
     \l{Package Information File Syntax}.
 
     \section2 Specifying Component Information
 
-    The package information file specifies the following information that is
-    displayed on the component selection page:
+    The information from the following sections is displayed on the component
+    selection page:
 
     \list
 
@@ -140,21 +163,13 @@
 
     \image ifw-tutorial-license-check.png "License check page"
 
-    \note To create installers for multiple platforms, including Windows,
-    make sure that the line endings of the license file use the CRLF
-    format, as Windows does not apply Linux line endings correctly.
-
     \section2 Selecting Default Contents
 
     The \c Default section specifies whether the component is selected by
     default. The value \c true sets the component as selected. In this example,
     we use the value \c script to resolve the value during runtime. The
-    name of the script file, installscript.qs, is specified in the \c Script
-    section.
-
-    The script file should look as follows:
-
-    \quotefile ../examples/tutorial/packages/com.vendor.product/meta/installscript.qs
+    name of the JavaScript script file, installscript.qs, is specified in the
+    \c Script section.
 
     \section1 Creating Installer Content
 
@@ -170,7 +185,7 @@
     \section1 Creating the Installer Binary
 
     You are now ready to create your first installer. Switch to the
-    \a tutorial directory on the command line. To create an installer called
+    \c examples\tutorial directory on the command line. To create an installer called
     YourInstaller.exe that contains the packages identified by
     com.vendor.product, enter the following command: