summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-19 16:03:55 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-19 16:36:11 +0100
commitbb052608fbcec1ad580660754157fa6ecc3512fc (patch)
tree7368fa40ea148f8bc86bde8087619047369d14a8 /doc
parent668e053c62d4a2dae5f38e454fac00df74eeeb03 (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')
-rw-r--r--doc/includes/installerfw-examples-configuring.qdocinc12
-rw-r--r--doc/includes/installerfw-examples-packaging.qdocinc8
-rw-r--r--doc/installerfw.qdoc75
-rw-r--r--doc/tutorial.qdoc32
4 files changed, 67 insertions, 60 deletions
diff --git a/doc/includes/installerfw-examples-configuring.qdocinc b/doc/includes/installerfw-examples-configuring.qdocinc
index b75abab8d..9f4d6161c 100644
--- a/doc/includes/installerfw-examples-configuring.qdocinc
+++ b/doc/includes/installerfw-examples-configuring.qdocinc
@@ -4,17 +4,17 @@
specifies the text and default values used in the installer:
\list
- \li The \c <Name> section specifies the application name that is added
+ \li The \c <Name> element specifies the application name that is added
to the page name and introduction text.
- \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 <Title> section specifies the installer name displayed on the
+ \li The \c <Title> element specifies the installer name displayed on the
title bar.
- \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 IfwExample 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, see
diff --git a/doc/includes/installerfw-examples-packaging.qdocinc b/doc/includes/installerfw-examples-packaging.qdocinc
index d3a873f2c..f8111629a 100644
--- a/doc/includes/installerfw-examples-packaging.qdocinc
+++ b/doc/includes/installerfw-examples-packaging.qdocinc
@@ -4,12 +4,12 @@
directory specifies the components that are available for installation:
\list
- \li The \c <DisplayName> section specifies the human-readable name of
+ \li The \c <DisplayName> element specifies the human-readable name of
the component.
- \li The \c <Description> section specifies the human-readable
+ \li The \c <Description> element specifies the human-readable
description of the component.
- \li The \c <Version> section specifies the version number of the
+ \li The \c <Version> element specifies the version number of the
component.
- \li The \c <ReleaseDate> section specifies the date when this component
+ \li The \c <ReleaseDate> element specifies the date when this component
version was released.
\endlist
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 4467eaac1..d759462b4 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -153,9 +153,9 @@
\quotefile examples/config.xml
- \section1 Supported Configuration Settings
+ \section1 Summary of Configuration File Elements
- The following table summarizes the settings in the configuration file.
+ The following table summarizes the elements in the configuration file.
\note We recommend that you place all files that you refer to in the
configuration file in the \c config directory. However, you can also use
@@ -163,11 +163,11 @@
the config.xml file.
You can use predefined variables (embedded in @ characters) as values of the
- settings. For more information, see \l{Predefined Variables}.
+ elements. For more information, see \l{Predefined Variables}.
\table
\header
- \li Setting
+ \li Element
\li Description
\row
\li Name
@@ -191,7 +191,8 @@
\li Icon
\li Filename for a custom installer icon. The actual file is looked up by attaching
a '.icns' (OS X), '.ico' (Windows) or '.png' (Unix) suffix. Deprecated,
- use InstallerApplicationIcon and / or InstallerWindowIcon instead.
+ use \c <InstallerApplicationIcon> or \c <InstallerWindowIcon>
+ instead.
\row
\li InstallerApplicationIcon
\li Filename for a custom installer icon. The actual file is looked up by attaching
@@ -232,17 +233,18 @@
the action. Provide the full path to the application.
\row
\li RunProgramArguments
- \li Arguments passed to the program specified in RunProgram. You can add several
- \c Argument elements that each specify an argument to \c {RunProgram}.
+ \li Arguments passed to the program specified in \c <RunProgram>.
+ You can add several \c <Argument> child elements that each specify an
+ argument to \c <RunProgram>.
\row
\li RunProgramDescription
\li Text shown next to the check box for running the program after
- the installation. If \gui <RunProgram> is set but no description provided,
- the UI will display \gui {Run <Name> now.} instead.
+ the installation. If \c <RunProgram> is set but no description provided,
+ the UI will display \uicontrol {Run <Name> now.} instead.
\row
\li StartMenuDir
\li Name of the default program group for the product in the Windows
- \gui Start menu.
+ \uicontrol Start menu.
\row
\li TargetDir
\li Default target directory for installation.
@@ -252,9 +254,9 @@
rights.
\row
\li RemoteRepositories
- \li List of remote repositories. You can add several \c Repository
- sections that each specify the \c Url to access the repository.
- For more information, see \l{Configuring Repositories}.
+ \li List of remote repositories. This element can contain several \c <Repository> child
+ elements that each contain the \c <Url> child element that specifies the URL to
+ access the repository. For more information, see \l{Configuring Repositories}.
\row
\li MaintenanceToolName
\li Filename of the generated maintenance tool. Defaults to
@@ -288,8 +290,8 @@
\row
\li Translations
\li List of language codes to be used for translating the user interface. To add several language
- variants, specify several Translation sections that each specify the name of a language
- variant. Optional. For more information, see \l{Translating Pages}.
+ variants, specify several \c <Translation> child elements that each specify the name
+ of a language variant. Optional. For more information, see \l{Translating Pages}.
\row
\li UrlQueryString
\li This string needs to be in the form "key=value" and will be appended to archive download
@@ -518,11 +520,11 @@
\quotefile examples/package.xml
- \section2 Summary of Package Information File Settings
+ \section2 Summary of Package Information File Elements
\table
\header
- \li Setting
+ \li Element
\li Description
\row
\li DisplayName
@@ -570,8 +572,8 @@
\row
\li Licenses
\li List of license agreements to be accepted by the installing
- user. To add several licenses, specify several \c License
- sections that each specify the license \c name and \c file.
+ user. To add several licenses, add several \c <License> child
+ elements that each specify the license \c name and \c file.
If there are translations listed for this component, the installer
will also look for translated licenses. These need to have the
same name as the original license file but with an added
@@ -586,13 +588,13 @@
For more information, see \l{Adding Operations}.
\row
\li UserInterfaces
- \li List of pages to load. To add several pages, specify several
- \c UserInterface sections that each specify the filename of a
+ \li List of pages to load. To add several pages, add several
+ \c <UserInterface> child elements that each specify the filename of a
page. Optional. For more information, see \l{Adding Pages}.
\row
\li Translations
\li List of translation files to load. To add several language
- variants, specify several \c Translation sections that each
+ variants, specify several \c <Translation> child elements that each
specify the filename of a language variant. Optional. For more
information, see \l{Translating Pages}.
\row
@@ -607,7 +609,7 @@
child components.
The boolean values are evaluated directly, while \c script is
resolved during runtime. Add the name of the script as a value
- of the \c Script setting in this file. For an example script,
+ of the \c <Script> element in this file. For an example script,
see \l{Selecting Default Contents}.
\row
\li Essential
@@ -921,17 +923,19 @@
\section1 Configuring Repositories
- The \c RemoteRepositories setting in the installer configuration file
+ The \c <RemoteRepositories> element in the installer configuration file
(config.xml) can contain a list of several repositories. Each of them can
have the following settings:
\list
- \li URL, which points to a list of available components.
- \li Enabled, with 0 disabling this repository.
- \li Username, which is used as user on a protected repository.
- \li Password, which sets the password to use on a protected repository.
- \li DisplayName, which optionally sets a String to display instead of the URL.
+ \li \c <Url>, which points to a list of available components.
+ \li \c <Enabled>, with 0 disabling this repository.
+ \li \c <Username>, which is used as user on a protected repository.
+ \li \c <Password>, which sets the password to use on a protected
+ repository.
+ \li \c <DisplayName>, which optionally sets a string to display instead
+ of the URL.
\endlist
@@ -1047,7 +1051,7 @@
\li Copy the updated content to the package directory.
- \li Increase the value of the \c{Version} setting for the updated
+ \li Increase the value of the \c <Version> element for the updated
components in the package.xml file.
\li Use the \c repogen tool to recreate the online repository with the
@@ -1067,7 +1071,7 @@
the online version number in the file is greater than the local one, the
installer displays it in the list of available updates.
- Increase the value of the \c{Version} setting for the component in the
+ Increase the value of the \c <Version> element for the component in the
package.xml file.
\section1 Recreating Repositories
@@ -1126,7 +1130,8 @@
\endcode
\section2 Adding Repositories
- To update a repository, add the following code to the RepositoryUpdate section:
+ To update a repository, add a \c <Repository> child element to the
+ \c <RepositoryUpdate> element with the following options:
\code
<Repository action="add" url="http://www.example.com/repository" name="user" password="password"
@@ -1134,14 +1139,16 @@
\endcode
\section2 Removing Repositories
- To remove a repository, add the following code to the RepositoryUpdate section:
+ To remove a repository, add a \c <Repository> child element to the
+ \c <RepositoryUpdate> element with the following options:
\code
<Repository action="remove" url="http://www.example.com/repository" />
\endcode
\section2 Replacing repositories
- To replace one repository with another, add the following code to the RepositoryUpdate section:
+ To replace one repository with another, add a \c <Repository> child element to the
+ \c <RepositoryUpdate> element with the following options:
\code
<Repository action="replace" oldurl="http://www.example.com/repository"
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