Improved documentation Qt for the Symbian platform

By Janne Anttila:
- Switched links/references from 'S60' to 'Symbian'
- Added collection page for Symbian specific documentation
- Added page about application deployment for Symbian
- Update supported compiler list for Symbian to more specific one
- Added bullet about dev env. setup to Symbian installation page
- Commented that SBSv2 is not offically supported by current S60 SDKs
- Moved S60 3rd FP1 special patching note after SDK installation bullet
- Recommedation to look into Qt quick start guide from Symbian Forum
- Added Symbian bullet to known issues page and link to wiki
- Added link to "state of support" document from symbian docs main page

By aportale:
- Rephrasing
- More consistent naming of 'Qt for the Symbian platform'
- Implementation of suggestions from other Nokians

Reviewed-By: Janne Anttila

6 files changed, 88 insertions, 39 deletions

diff --git a/doc/src/platforms/compiler-notes.qdoc b/doc/src/platforms/compiler-notes.qdoc
index 4577bf0..e27a9dc 100644
--- a/doc/src/platforms/compiler-notes.qdoc
+++ b/doc/src/platforms/compiler-notes.qdoc
@@ -287,4 +287,9 @@
     Make sure you have the
     \l{http://www-1.ibm.com/support/search.wss?rs=32&tc=SSEP5D&dc=D400}{latest upgrades}
     installed.
+
+    \section2 GCCE (Symbian)
+
+    GCCE cannot be used to compile Qt libaries for the Symbian platform, but GCCE is supported
+    when compiling Qt applications for Symbian platform.
 */
diff --git a/doc/src/platforms/qt-embedded.qdoc b/doc/src/platforms/qt-embedded.qdoc
index b38c94f..afed540 100644
--- a/doc/src/platforms/qt-embedded.qdoc
+++ b/doc/src/platforms/qt-embedded.qdoc
@@ -67,10 +67,9 @@
     Applications use the appropriate style for the embedded
     environment and use native features, such as menus, to conform
     to the native style guidelines.
-    \o \l{Symbian Platform - Introduction to Qt}{Qt for the Symbian
-    platform} is used to create applications running in existing Symbian
-    platform environments. Applications use the appropriate style for the
-    embedded environment and use native features, such as menus, to conform
-    to the native style guidelines.
+    \o \l{Qt for the Symbian platform} is used to create applications running
+    in existing Symbian platform environments. Applications use the appropriate
+    style for the embedded environment and use native features, such as menus,
+    to conform to the native style guidelines.
     \endtable
 */
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index 560ddfe..d1affe2 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -89,8 +89,8 @@
                                      \o gcc (\l{http://www.codesourcery.com/}{Codesourcery version)}
     \row    \o Windows CE 5.0 (ARMv4i, x86, MIPS)
                                      \o MSVC 2005 WinCE 5.0 Standard (x86, pocket, smart, mipsii)
-    \row    \o Symbian (S60 3.1, 3.2 and 5.0)
-                                     \o RVCT, GCCE, WINSCW
+    \row    \o Symbian (Symbian/S60 3.1, 3.2 and 5.0)
+                                     \o RVCT 2.2 [build 686 or later], WINSCW 3.2.5 [build 482 or later], GCCE (for applications)
     \endtable
 
     \section1 Tier 2 Platforms
diff --git a/doc/src/platforms/symbian-exceptionsafety.qdoc b/doc/src/platforms/symbian-exceptionsafety.qdoc
index 88f4d03..99bd2d8 100644
--- a/doc/src/platforms/symbian-exceptionsafety.qdoc
+++ b/doc/src/platforms/symbian-exceptionsafety.qdoc
@@ -42,7 +42,7 @@
 /*!
     \page symbianexceptionsafety.html
     \title Exception Safety with Symbian
-    \ingroup qts60
+    \ingroup qtsymbian
     \brief A guide to integrating exception safety in Qt with Symbian.
 
     The following sections describe how Qt code can interoperate with Symbian's
diff --git a/doc/src/platforms/s60-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc
index 0581982..c0c4fb3 100644
--- a/doc/src/platforms/s60-introduction.qdoc
+++ b/doc/src/platforms/symbian-introduction.qdoc
@@ -40,39 +40,73 @@
 ****************************************************************************/
 
 /*!
+    \group qtsymbian
+    \title Qt for the Symbian platform
+    \ingroup qt-embedded
+    \brief Documents related to Qt on the Symbian platform
+
+    Qt for Symbian is a C++ framework for GUI and application development
+    for embedded devices running Symbian. Qt for Symbian provides all
+    functionality required to develop rich end-user applications for devices
+    running S60 3.1 and later.
+
+    \table 100%
+    \header \o Getting Started \o Reference \o Development
+    \row
+    \o
+     \list
+        \o \l {Qt for the Symbian platform Requirements}
+        \o \l {Installing Qt on the Symbian platform from a Binary Package}
+        \o \l {Installing Qt on the Symbian platform}
+        \o \l {The Symbian platform - Introduction to Qt}{Introduction to using Qt}
+    \endlist
+    \o
+    \list
+        \o \l {Exception Safety with Symbian}
+        \o \l {Platform Notes - Symbian} {Qt for the Symbian platform - state of support}
+        \o \l {qmake Platform Notes#Symbian platform} {Qt for Symbian extensions for qmake}
+    \endlist
+    \o
+    \list
+        \o \l {Deploying an Application on the Symbian platform}{Deploying Applications}
+    \endlist
+    \endtable
+*/
+
+/*!
     \page symbian-with-qt-introduction.html
 
-    \title Symbian Platform - Introduction to Qt
-    \brief An introduction to Qt for Symbian platform developers.
+    \title The Symbian platform - Introduction to Qt
+    \brief An introduction to Qt for the Symbian platform developers.
     \ingroup howto
-    \ingroup qts60
+    \ingroup qtsymbian
 
     \tableofcontents
 
     \section1 Required tools
 
-    See \l{Qt for Symbian Platform Requirements} to see what tools are
-    required to use Qt for Symbian platform.
+    See \l{Qt for the Symbian platform Requirements} to see what tools are
+    required to use Qt for the Symbian platform.
 
     \section1 Installing Qt and running demos
 
     Follow the instructions found in \l{Installing Qt on the Symbian platform from a Binary Package}
     to learn how to install Qt using a binary package and how to build and run Qt demos.
 
-    Follow the instructions found in \l{Installing Qt on the Symbian Platform} to learn how to install Qt using
+    Follow the instructions found in \l{Installing Qt on the Symbian platform} to learn how to install Qt using
     using source package and how to build and run the Qt demos.
 
     \section1 Building your own applications
 
-    If you are new to Qt development, have a look at \l{How to Learn Qt}. 
+    If you are new to Qt development, have a look at \l{How to Learn Qt}.
     In general, the difference between developing a
     Qt application on the Symbian platform compared to any of the other platforms supported
     by Qt is not that big.
 
     Once you have created a \c .pro file for your project, generate the
-    Carbide specific \c Bld.inf and \c .mmp files this way:
+    Symbian specific \c Bld.inf and \c .mmp files this way:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 0
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 0
 
     For more information on how to use qmake have a look at the \l
     {qmake Tutorial}.
@@ -97,56 +131,67 @@
     The following lines perform a debug build for the emulator
     and deploy all the needed files:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 1
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 1
 
     To work on your project in Carbide, simply import the \c .pro file
     by right clicking on the project explorer and executing "Import...".
 
     \section1 Installing your own applications
 
-    To install your own applications on hardware, you need signed \c .sis file.
+    To install your own applications on hardware, you need a signed \c .sis file.
+    (Refer to the \l{http://developer.symbian.org/wiki/index.php/Platform_Security_%28Fundamentals_of_Symbian_C%2B%2B%29#Self-Signed_Applications}
+    {Platform Security Article} for more informations about self-signing.)
     The signed \c .sis file can be created with \c make \c sis target. \c sis target
     is only supported for executables or projects with \c DEPLOYMENT statements.
     By default the \c sis target will create signed \c .sis file for last build
-    target. For example, the following sequence will generate the needed makefiles, 
-    build the project for \c debug-winscw and \c release-armv5, and create 
+    target. For example, the following sequence will generate the needed makefiles,
+    build the project for \c debug-winscw and \c release-armv5, and create
     self-signed \c .sis file for \c release-armv5 target:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 2
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 2
 
     If you want to use different certificate information or override the default
-    target for \c .sis file creation you can use the environment variables as 
+    target for \c .sis file creation you can use the environment variables as
     shown in the table below:
 
     \table
-    \row \o \c QT_SIS_OPTIONS      \o Options accepted by \c .sis creation. 
-                                       -i, install the package right away using PC suite.
-                                       -c=<file>, read certificate information from a file.
-                                       Execute the \c{createpackage.pl} script without any 
-                                       parameters for more information about options.
-                                       By default no otions are given.
+    \row \o \c QT_SIS_OPTIONS      \o Options accepted by \c .sis creation. See
+                                   \l{Supported options for QT_SIS_OPTIONS}{Supported options}
+                                    below. By default no otions are given.
     \row \o \c QT_SIS_TARGET       \o Target for which \c .sis file is created.
-                                       Accepted values are build targets listed in 
+                                       Accepted values are build targets listed in
                                        previous table. By default last build target.
     \row \o \c QT_SIS_CERTIFICATE  \o The certificate file used for signing.
-                                       By default self-signed certificate. 
+                                       By default self-signed certificate.
     \row \o \c QT_SIS_KEY          \o The certificate's private key file.
-                                       By default key is associated to self-signed certificate. 
+                                       By default key is associated to self-signed certificate.
     \row \o \c QT_SIS_PASSPHRASE   \o The certificate's private key file's passphrase.
-                                       By default empty. 
-    \endtable    
+                                       By default empty.
+    \endtable
+
+    The suppported options for \c QT_SIS_OPTIONS:
+
+    \target Supported options for QT_SIS_OPTIONS
+    \table
+    \row \o -i                  \o Install the package right away using PC suite.
+    \row \o -p                  \o Only preprocess the template \c .pkg file.
+    \row \o -c=<file>           \o Read certificate information from a file.
+    \endtable
+
+    Execute the \c{createpackage.pl} script without any
+    parameters for detailed information about options. By default no otions are given.
 
     For example:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 4        
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 4
 
     The environment variables for \c make can also be given as parameters:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 3        
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 3
 
     If you want to install the program immediately, make sure that the device
     is connected to the computer in "PC Suite" mode, and run \c sis target
     with the \c QT_SIS_OPTIONS=-i, like this:
 
-    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 5
+    \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 5
 */
diff --git a/doc/src/platforms/winsystem.qdoc b/doc/src/platforms/winsystem.qdoc
index 72e7da6..2f43a74 100644
--- a/doc/src/platforms/winsystem.qdoc
+++ b/doc/src/platforms/winsystem.qdoc
@@ -102,9 +102,9 @@
     When compiling for this platform, the macro \c{Q_WS_WINCE} is defined.
     See the \l{Qt for Windows CE} documentation for more information.
 
-    \section1 Qt for Symbian Platform
+    \section1 Qt for the Symbian platform
 
     When compiling for this platform, the macro \c{Q_WS_S60} is defined.
-    See the \l{Symbian Platform - Introduction to Qt} documentation for
+    See the \l{The Symbian platform - Introduction to Qt} documentation for
     more information.
 */