diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-19 16:03:55 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-19 16:36:11 +0100 |
commit | bb052608fbcec1ad580660754157fa6ecc3512fc (patch) | |
tree | 7368fa40ea148f8bc86bde8087619047369d14a8 /doc/tutorial.qdoc | |
parent | 668e053c62d4a2dae5f38e454fac00df74eeeb03 (diff) |
Doc: replace "sections" and "settings" with elements
As we are describing XML files. "Settings" is still
used where appropriate.
Also use the angle brackets around element names more
consistently.
Change-Id: I5c7179212c90d8f2cd55e28af98e7cd785603f4a
Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
Diffstat (limited to 'doc/tutorial.qdoc')
-rw-r--r-- | doc/tutorial.qdoc | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/tutorial.qdoc b/doc/tutorial.qdoc index 19ee8c352..e9fad20a0 100644 --- a/doc/tutorial.qdoc +++ b/doc/tutorial.qdoc @@ -86,30 +86,30 @@ \list - \li The \c Title section specifies the installer name displayed on the + \li The \c <Title> element specifies the installer name displayed on the title bar (1). - \li The \c Name section specifies the application name that is added to + \li The \c <Name> element specifies the application name that is added to the page name and introduction text (2). \endlist \image ifw-tutorial-introduction-page.png "Introduction page" - The other settings are used to customize the behavior of the installer: + The other elements are used to customize the behavior of the installer: \list - \li The \c <Version> section specifies the version number of the + \li The \c <Version> element specifies the version number of the repository format, and must be set to \c 1.0.0. - \li The \c <Publisher> section specifies the publisher of the software + \li The \c <Publisher> element 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 + \li The \c <StartMenuDir> element 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 + \li The \c <TargetDir> element 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, @@ -118,7 +118,7 @@ \endlist For more information about the configuration file format and the available - settings, see \l{Configuration File}. + elements, see \l{Configuration File}. \section1 Creating a Package Information File @@ -129,22 +129,22 @@ \quotefile ../examples/tutorial/packages/com.vendor.product/meta/package.xml - The sections in the example file are described in more detail below. + The elements in the example file are described in more detail below. For more information about the package information file, see \l{Package Information File Syntax}. \section2 Specifying Component Information - The information from the following sections is displayed on the component + The information from the following elements is displayed on the component selection page: \list - \li The \c DisplayName section specifies the name of the component in + \li The \c <DisplayName> element specifies the name of the component in the list of components (1). - \li The \c Description section specifies the text that is displayed when + \li The \c <Description> element specifies the text that is displayed when the component is selected (2). \endlist @@ -153,23 +153,23 @@ \section2 Specifying Installer Version - The \c Version section enables you to promote updates to users when they + The \c <Version> element enables you to promote updates to users when they become available. \section2 Adding Licenses - The \c License section specifies the name of the file that contains the text + The \c <License> element specifies the name of the file that contains the text for the license agreement (1) that is displayed on the license check page: \image ifw-tutorial-license-check.png "License check page" \section2 Selecting Default Contents - The \c Default section specifies whether the component is selected by + The \c <Default> element specifies whether the component is selected by default. The value \c true sets the component as selected. In this example, we use the value \c script to resolve the value during runtime. The name of the JavaScript script file, installscript.qs, is specified in the - \c Script section. + \c <Script> element. \section1 Creating Installer Content |