Changes: Documentation updated to match official SDK documentation.

RevBy: Olli Leppanen

doc/mainpage.dox

@@ -56,7 +56,13 @@ MDeclarativeCache.
 \section gettingstarted Getting started
 
 This section gives a quick introduction on \c invoker usage and
-boosting applications.
+boosting applications. 
+
+Note: The QML booster and single instance
+support are currently included in the Qt Quick application template
+provided by the Qt SDK. To enable these features in your application,
+select Make application boostable checkbox when creating a new project
+with the template.
 
 \subsection boostingqtquick Boosting Qt Quick applications
 
@@ -114,12 +120,14 @@ and \ref libmeegotouchboost "Using the MeeGo Touch booster".
 The \c invoker can be used to get a splash screen for the application
 and to implement single instance behaviour. If the \a exec \a booster
 is used, no modifications to the application source code are needed. 
-(Note that \a exec \a booster is meant to make splash screen and single 
-instance usage easier. If you need to reduce application startup time 
-significantly, use other boosters instead.)
-Simply specify the name of the splash image on the invoker command line as
-follows. For more details, see \ref eboost "Using the exec booster" and
+For more details, see \ref eboost "Using the exec booster" and
 \ref splash "Enabling a splash screen for an application".
+Note that the \a exec booster facilitates the use of the splash 
+screen and single instance. If you need to reduce application startup
+time significantly, use other boosters instead.
+
+Simply specify the name of the splash image on the invoker command line as
+follows.
 
 \code 
 invoker --type=e --splash=/usr/share/images/myAppSplash.jpg /usr/bin/myApp

doc/qmlboost.dox

@@ -5,6 +5,11 @@ booster provides the application with the key libraries already
 present in the process, and instances of \c QApplication and \c
 QDeclarativeView waiting in the cache.
 
+Note: This functionality is currently included in the Qt Quick application
+template provided by the Qt SDK. To enable QML booster in your application,
+select Make application boostable checkbox when creating a new project with
+the template.
+
 \section qmlboostprereq Prerequisites
 
 The launcher can start an application if the following prerequisites are met:

doc/singleinstance.dox

@@ -4,8 +4,13 @@ Usually a user wants an application to be run as a single instance. This means
 that if the launched application is already running, the existing application
 window is activated and no new application processes are started.
 
-This can be achieved by adding --single-instance to the invoker
-command in the .desktop file:
+Note: This functionality is currently included in the Qt Quick application template
+provided by the Qt SDK. To enable  single instance support for your application,
+select Make application boostable checkbox when creating a new project with the
+template.
+
+When not using the template provided by the Qt SDK, this can be achieved by adding 
+--single-instance to the invoker command in the .desktop file:
 
 \verbatim
 [Desktop Entry]

doc/splash.dox

@@ -22,8 +22,8 @@ Otherwise splash-l.jpg is shown. If only --splash is given, that
 image is shown in both orientations.
 
 The dimensions of both portrait and landscape images should be the same
-<screen width> X <screen height>; i.e. mcompositor does not rotate
-the splash image, it should be drawn rotated.
+<screen width> X <screen height>; it means that mcompositor 
+does not rotate the splash image, it should be drawn rotated.
 
 Invoker passes the splash request to the booster. The booster sends
 the splash request to the window manager by setting a window property
@@ -33,8 +33,16 @@ If the filenames do not include absolute paths, the window manager
 looks for the files from a default location.
 
 The file should be in a format recognised by QPixmap, preferably JPEG
-as it is fast to load. The size of the image should not be larger than
-the screen. If it is smaller, it is stretched.
+as it is fast to load. Splash screen is always scaled to fit the full
+screen, hiding the status bar. Thus, the recommended size for the screen
+is 854 x 480 pixels. However, the figure is displayed even if the size is
+different.
+
+Create a splash screen that resembles as much as possible the window that is
+shown when your application is launched. For instance, the splash screen
+can have the same background colour and toolbar as the application window.
+If the application window displays the status area, we recommend adding a
+black box with the same size to the splash screen of your application.
 
 \subsection splashndbus Splash and D-Bus interaction