From 0b8539084cf84ad3e5386341b4a93542a66f1742 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Tue, 23 Dec 2014 14:59:17 +0100
Subject: Doc: update docs for the Start Menu example

Change-Id: I861fb5fa80d7467a315c77b903d8de3b58724c54
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
---
 examples/doc/images/qtifw-examples-startmenu.png | Bin 0 -> 15605 bytes
 examples/doc/startmenu.qdoc                      |  33 +++++++++++++++++++++++
 examples/startmenu/config/config.xml             |   4 +--
 3 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 examples/doc/images/qtifw-examples-startmenu.png

(limited to 'examples')

diff --git a/examples/doc/images/qtifw-examples-startmenu.png b/examples/doc/images/qtifw-examples-startmenu.png
new file mode 100644
index 000000000..f332f2381
Binary files /dev/null and b/examples/doc/images/qtifw-examples-startmenu.png differ
diff --git a/examples/doc/startmenu.qdoc b/examples/doc/startmenu.qdoc
index 1c9c98e49..8c8aa46b7 100644
--- a/examples/doc/startmenu.qdoc
+++ b/examples/doc/startmenu.qdoc
@@ -32,9 +32,42 @@
 
     \brief Adding an entry to the Windows Start menu.
 
+    \image qtifw-examples-startmenu.png
+
+    \e{Start Menu} illustrates how to use the \gui Component function to add an
+    entry for opening a README file to the Windows \uicontrol Start menu.
+
     \include installerfw-examples-configuring.qdocinc
 
     \quotefile startmenu/config/config.xml
 
+    \include installerfw-examples-packaging.qdocinc
+
+    \list
+        \li The \c <Default> section is set to \c true to preselect the
+            component in the installer.
+        \li The \c <Script> section specifies the file name of the JavaScript
+            file that is loaded to perform operations.
+    \endlist
+
+    \quotefile startmenu/packages/org.qtproject.ifw.example/meta/package.xml
+
+    \section1 Adding Entries to Start Menu
+
+    In installscript.qs, we use the \c createOperations() function to call the
+    component::createOperations() function, which creates the \c Extract
+    operation by default:
+
+    \quotefromfile startmenu/packages/org.qtproject.ifw.example/meta/installscript.qs
+    \skipto createOperations
+    \printuntil {
+    \skipto createOperations
+    \printuntil ;
+
+    On Windows, we use the component::addOperation function to add a shortcut
+    to the \uicontrol Start menu for opening the readme file:
+
+    \printuntil /^\}/
+
     \include installerfw-examples-generating.qdocinc
 */
diff --git a/examples/startmenu/config/config.xml b/examples/startmenu/config/config.xml
index e95445d1b..8da61b26e 100644
--- a/examples/startmenu/config/config.xml
+++ b/examples/startmenu/config/config.xml
@@ -5,6 +5,6 @@
     <Title>Start Menu Shortcut Example</Title>
     <Publisher>Qt-Project</Publisher>
     <!-- Directory name is used in component.xml -->
-    <StartMenuDir>Qt Installer Framework Example</StartMenuDir>
-    <TargetDir>@HomeDir@/IFWStartMenuExample</TargetDir>
+    <StartMenuDir>Qt Installer Framework Examples</StartMenuDir>
+    <TargetDir>@HomeDir@/IfwExample</TargetDir>
 </Installer>
-- 
cgit v1.2.3