Doc: add docs for Component Error example

Document the example.
Edit text in the example files.
Add a screenshot.

Change-Id: Ib5c3e0d78006d81ec77c75c92b7636f358e83412
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@digia.com>

7 files changed, 15 insertions, 10 deletions

diff --git a/examples/componenterror/config/config.xml b/examples/componenterror/config/config.xml
index e9d6a9dd5..da707f228 100644
--- a/examples/componenterror/config/config.xml
+++ b/examples/componenterror/config/config.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Installer>
-    <Name>Component Error Installer Example</Name>
+    <Name>Component Error Example</Name>
     <Version>1.0.0</Version>
-    <Title>Component Error Installer Example</Title>
+    <Title>Component Error Example</Title>
     <Publisher>Qt-Project</Publisher>
-    <StartMenuDir>Qt Installer Framework Example</StartMenuDir>
-    <TargetDir>@HomeDir@/IFWComponentErrorInstallerExample</TargetDir>
+    <StartMenuDir>Qt IFW Examples</StartMenuDir>
+    <TargetDir>@HomeDir@/IfwExample</TargetDir>
 </Installer>
diff --git a/examples/componenterror/packages/root.component1/meta/installscript.js b/examples/componenterror/packages/root.component1/meta/installscript.js
index 6d76437b2..8fc0cb35a 100644
--- a/examples/componenterror/packages/root.component1/meta/installscript.js
+++ b/examples/componenterror/packages/root.component1/meta/installscript.js
@@ -44,7 +44,7 @@ function Component()
     var error = true;
     if (error) {
         installer.setValue("component_errors", installer.value("component_errors") + ";;;"
-            + "error from component: " + component.name);
+            + "Error in component: " + component.name);
     }
     installer.setValue("ComponentError", true);
 }
diff --git a/examples/componenterror/packages/root.component1/meta/package.xml b/examples/componenterror/packages/root.component1/meta/package.xml
index eac36530b..9b975093d 100644
--- a/examples/componenterror/packages/root.component1/meta/package.xml
+++ b/examples/componenterror/packages/root.component1/meta/package.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0"?>
 <Package>
-    <DisplayName>component1</DisplayName>
+    <DisplayName>Component 1</DisplayName>
+    <Description>This component contains an error that prevents it from being
+    installed.</Description>
     <Version>1.0.1</Version>
     <ReleaseDate>2013-08-21</ReleaseDate>
     <Script>installscript.js</Script>
diff --git a/examples/componenterror/packages/root.component2/meta/installscript.js b/examples/componenterror/packages/root.component2/meta/installscript.js
index 6d76437b2..8fc0cb35a 100644
--- a/examples/componenterror/packages/root.component2/meta/installscript.js
+++ b/examples/componenterror/packages/root.component2/meta/installscript.js
@@ -44,7 +44,7 @@ function Component()
     var error = true;
     if (error) {
         installer.setValue("component_errors", installer.value("component_errors") + ";;;"
-            + "error from component: " + component.name);
+            + "Error in component: " + component.name);
     }
     installer.setValue("ComponentError", true);
 }
diff --git a/examples/componenterror/packages/root.component2/meta/package.xml b/examples/componenterror/packages/root.component2/meta/package.xml
index 4caad7ad6..8898e2e6d 100644
--- a/examples/componenterror/packages/root.component2/meta/package.xml
+++ b/examples/componenterror/packages/root.component2/meta/package.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0"?>
 <Package>
-    <DisplayName>component2</DisplayName>
+    <DisplayName>Component 2</DisplayName>
+    <Description>This component contains an error that prevents it from being
+                 installed.</Description>
     <Version>1.0.1</Version>
     <ReleaseDate>2013-08-21</ReleaseDate>
     <Script>installscript.js</Script>
diff --git a/examples/componenterror/packages/root/meta/installscript.js b/examples/componenterror/packages/root/meta/installscript.js
index 7ddf7dab5..4f28d4758 100644
--- a/examples/componenterror/packages/root/meta/installscript.js
+++ b/examples/componenterror/packages/root/meta/installscript.js
@@ -49,7 +49,7 @@ function abortInstaller()
     installer.setDefaultPageVisible(QInstaller.PerformInstallation, false);
     installer.setDefaultPageVisible(QInstaller.LicenseCheck, false);
 
-    var abortText = "<font color='red' size=6>" + qsTr("The installation has failed.") + "</font>";
+    var abortText = "<font color='red' size=3>" + qsTr("Installation failed:") + "</font>";
 
     var error_list = installer.value("component_errors").split(";;;");
     abortText += "<ul>";
diff --git a/examples/componenterror/packages/root/meta/package.xml b/examples/componenterror/packages/root/meta/package.xml
index ce9b55537..a5ee2e52e 100644
--- a/examples/componenterror/packages/root/meta/package.xml
+++ b/examples/componenterror/packages/root/meta/package.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <Package>
-    <DisplayName>ROOT</DisplayName>
+    <DisplayName>Root Component</DisplayName>
+    <Description>This component handles the errors in the other components.</Description>
     <Version>1.0.1</Version>
     <ReleaseDate>2013-08-21</ReleaseDate>
     <Script>installscript.js</Script>