Doc: add example documentation

Add initial topic skeletons. The contents will be
modified in subsequent patches.

Change-Id: I33ca4180c7070d5ae2ca20a59f75608289d76344
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

3 files changed, 42 insertions, 0 deletions

diff --git a/doc/includes/installerfw-examples-configuring.qdocinc b/doc/includes/installerfw-examples-configuring.qdocinc
new file mode 100644
index 000000000..681e3b9d7
--- /dev/null
+++ b/doc/includes/installerfw-examples-configuring.qdocinc
@@ -0,0 +1,22 @@
+    \section1 Configuring the Example Installer
+
+    The installer configuration file, config.xml, in the \c config directory
+    specifies the text and default values used in the installer:
+
+    \list
+         \li The \c <Name> section specifies the application name that is added
+             to the page name and introduction text.
+        \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 <Title> section specifies the installer name displayed on the
+            title bar.
+        \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
diff --git a/doc/includes/installerfw-examples-generating.qdocinc b/doc/includes/installerfw-examples-generating.qdocinc
new file mode 100644
index 000000000..e019bd788
--- /dev/null
+++ b/doc/includes/installerfw-examples-generating.qdocinc
@@ -0,0 +1,5 @@
+    \section1 Generating the Example Installer
+
+    \code
+    binarycreator --offline-only -c config/config.xml -p packages installer
+    \endcode
diff --git a/doc/includes/installerfw-examples-packaging.qdocinc b/doc/includes/installerfw-examples-packaging.qdocinc
new file mode 100644
index 000000000..ec7e82b29
--- /dev/null
+++ b/doc/includes/installerfw-examples-packaging.qdocinc
@@ -0,0 +1,15 @@
+    \section1 Creating the Example Package Information File
+
+    The installer package information file, package.xml, in the \c meta
+    directory specifies the components that are available for installation:
+
+    \list
+        \li The \c <DisplayName> section specifies the human-readable name of
+            the component.
+        \li The \c <Description> section specifies the human-readable
+            description 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