summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config/ifw.qdocconf2
-rw-r--r--doc/examples/config.xml2
-rw-r--r--doc/includes/installerfw-examples-configuring.qdocinc13
-rw-r--r--doc/includes/installerfw-examples-packaging.qdocinc8
-rw-r--r--doc/installerfw-cpp-classes.qdoc10
-rw-r--r--doc/installerfw-examples.qdoc6
-rw-r--r--doc/installerfw-reference.qdoc4
-rw-r--r--doc/installerfw.qdoc225
-rw-r--r--doc/noninteractive.qdoc30
-rw-r--r--doc/operations.qdoc2
-rw-r--r--doc/scripting-qmlmodule.qdoc7
-rw-r--r--doc/scripting.qdoc4
-rw-r--r--doc/tutorial.qdoc33
13 files changed, 231 insertions, 115 deletions
diff --git a/doc/config/ifw.qdocconf b/doc/config/ifw.qdocconf
index 65665177d..a767ccc56 100644
--- a/doc/config/ifw.qdocconf
+++ b/doc/config/ifw.qdocconf
@@ -18,7 +18,7 @@ exampledirs = $SRCDIR ../../examples
headers.fileextensions = "*.h"
sources.fileextensions = "*.qdoc *.qdocinc *.cpp"
-examples.fileextensions = "*.js *.qs *.txt *.xml"
+examples.fileextensions = "*.js *.qs *.txt *.xml *.ui"
examples.imageextensions = "*.png"
indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
diff --git a/doc/examples/config.xml b/doc/examples/config.xml
index 147c39246..ef4598425 100644
--- a/doc/examples/config.xml
+++ b/doc/examples/config.xml
@@ -16,7 +16,7 @@
</RunProgramArguments>
<RunProgramDescription>My nice application</RunProgramDescription>
<StartMenuDir>Some Application Entry Dir</StartMenuDir>
- <UninstallerName>SDKMaintenanceTool</UninstallerName>
+ <MaintenanceToolName>SDKMaintenanceTool</MaintenanceToolName>
<AllowNonAsciiCharacters>true</AllowNonAsciiCharacters>
<Background>background.png</Background>
diff --git a/doc/includes/installerfw-examples-configuring.qdocinc b/doc/includes/installerfw-examples-configuring.qdocinc
index b75abab8d..3a29af3dc 100644
--- a/doc/includes/installerfw-examples-configuring.qdocinc
+++ b/doc/includes/installerfw-examples-configuring.qdocinc
@@ -4,17 +4,16 @@
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
- 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 <Version> element specifies the application version number.
+ \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-cpp-classes.qdoc b/doc/installerfw-cpp-classes.qdoc
index 29f1bfc44..04d077314 100644
--- a/doc/installerfw-cpp-classes.qdoc
+++ b/doc/installerfw-cpp-classes.qdoc
@@ -27,12 +27,20 @@
/*!
\contentspage {index.html}{Qt Installer Framework}
- \previouspage Scripting
+ \previouspage Scripting API
\page ifw-cpp-classes.html
\nextpage ifw-knownissues.html
\title C++ Classes
+ The class documentation is written for developers who develop the Qt
+ Installer Framework. It describes the internal API, so there is no
+ compatibility promise. Further, the documentation is a work in progress and
+ therefore parts of it are missing while other parts might be out of date.
+
+ To create customized installers, use the \l{Scripting API}, instead. For
+ more information, see \l {Customizing Installers}.
+
\generatelist{classesbymodule QtInstallerFramework}
\generatelist{classesbymodule kdupdater}
*/
diff --git a/doc/installerfw-examples.qdoc b/doc/installerfw-examples.qdoc
index 2c6795b0f..1b0bd5a0b 100644
--- a/doc/installerfw-examples.qdoc
+++ b/doc/installerfw-examples.qdoc
@@ -27,7 +27,13 @@
/*!
\group qtifwexamples
+ \previouspage ifw-customizing-installers.html
+ \nextpage ifw-reference.html
+
\title Qt Installer Framework Examples
\brief Illustrate how to customize installers.
+ These examples illustrate how to use component scripts for customizing
+ installers.
+
*/
diff --git a/doc/installerfw-reference.qdoc b/doc/installerfw-reference.qdoc
index 4fba00696..d768083c6 100644
--- a/doc/installerfw-reference.qdoc
+++ b/doc/installerfw-reference.qdoc
@@ -27,7 +27,7 @@
/*!
\contentspage {index.html}{Qt Installer Framework}
- \previouspage ifw-customizing-installers.html
+ \previouspage Qt Installer Framework Examples
\page ifw-reference.html
\nextpage ifw-globalconfig.html
@@ -43,7 +43,7 @@
\li \l{Component Scripting}
\li \l{Operations}
\li \l{Tools}
- \li \l{Scripting}
+ \li \l{Scripting API}
\li \l{C++ Classes}
\endlist
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 06e96b7b8..283537124 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -45,7 +45,7 @@
Windows, and OS X.
\note Report bugs and suggestions for the Qt Installer Framework project
- in the \l{https://bugreports.qt-project.org/browse/QTIFW}{Qt Bugtracker}.
+ in the \l{https://bugreports.qt.io/browse/QTIFW}{Qt Bugtracker}.
\list
\li \l{Overview of Qt Installer Framework}
@@ -75,7 +75,7 @@
\li \l{Component Scripting}
\li \l{Operations}
\li \l{Tools}
- \li \l{Scripting}
+ \li \l{Scripting API}
\li \l{C++ Classes}
\endlist
\li \l{Known Issues}
@@ -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
@@ -175,8 +175,9 @@
\li Name of the product being installed. This is mandatory.
\row
\li Version
- \li Version number of the repository format. This is mandatory and
- must always be set to \c 1.0.0.
+ \li Version of the product being installed in the following format:
+ [0-9]+((\\.|-)[0-9]+)* such as 1-1; 1.2-2; 3.4.7. This is
+ mandatory.
\row
\li Title
\li Name of the installer as displayed on the title bar.
@@ -191,7 +192,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 +234,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 +255,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 +291,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
@@ -297,6 +300,12 @@
\row
\li ControlScript
\li Filename for a custom installer control script. See \l{Controller Scripting}.
+ \row
+ \li CreateLocalRepository
+ \li Set to \c true if you want to create a local repository inside the installation directory.
+ This option has no effect on online installers. The repository will be automatically added
+ to the list of default repositories.
+
\endtable
*/
@@ -305,36 +314,71 @@
\contentspage index.html
\previouspage ifw-updates.html
\page ifw-customizing-installers.html
- \nextpage ifw-reference.html
+ \nextpage Qt Installer Framework Examples
\title Customizing Installers
- The following sections describe how you can extend the predefined installer
- by adding operations to the pages and by adding new pages and language
- variants.
+ You can use scripting to customize installers by:
+
+ \list
+
+ \li Adding Qt Installer Framework \e operations that are prepared by the
+ scripts and performed by the installer.
+
+ \li Adding new pages that you specify in the package.xml file and place
+ in the \c packages directory.
+
+ \li Modifying existing pages by inserting custom user interface
+ elements into them as single widgets.
+
+ \li Adding language variants.
+
+ \endlist
+
+ You can use both \e {component scripts} and a \e {control script} to
+ customize installers. A component script is associated with a particular
+ component by specifying it in the \c Script element of the package.xml
+ file of the component. The script is loaded when the component's metadata is
+ fetched. For more information about component scripts, see
+ \l{Component Scripting}.
+
+ A control script is associated with the whole installer by specifying it
+ in the \c ControlScript element of the control.xml file of the installer.
+ Control scripts can be part of the installer resources or be passed on the
+ command line. They can be used to modify the installer pages that are
+ presented to users before components are loaded. Also, you can use them to
+ modify pages in the uninstaller. For more information, see
+ \l{Controller Scripting}.
+
+ For more information about the global JavaScript objects that can be used in
+ component and control scripts, see \l{Scripting API}.
\section1 Adding Operations
- Components can use the ECMAScript scripting language to perform additional
- operations at any time during the installation process. Typically,
- components manipulate files by moving, copying, or patching them.
+ You can use component scripts to perform Qt Installer Framework operations
+ during the installation process. Typically, operations manipulate files by
+ moving, copying, or patching them. Use the
+ QInstaller::Component::addOperation or
+ QInstaller::Component::addElevatedOperation function to add operations. For
+ more information, see \l {Adding Operations to Components}.
+
+ In addition, you can implement methods to register custom installation
+ operations in the installer by deriving KDUpdater::UpdateOperation. For
+ more information, see \l {Registering Custom Operations}.
- For more information about scripting, see \l{Component Scripting}.
+ For a summary of available operations, see \l {Operations}.
\section1 Adding Pages
A component can contain one or more user interface files, which are placed
- into the installer by a script. The installer automatically loads all user
- interface files listed in package.xml. You can access the loaded widgets
- by calling \c QInstaller::Component::userInterface with the class name of
- the widget, as illustrated by the following code snippet:
+ into the installer by a component or control script. The installer
+ automatically loads all user interface files listed in the
+ \c UserInterfaces element of the package.xml file.
- \code
- component.userInterface( "MyPage" ).checkbox.checked = true;
- \endcode
+ \section2 Using Component Scripts to Add Pages
To add a new page to the installer, use
- the \c QInstaller::Installer::addWizardPage method and specify the location
+ the installer::addWizardPage() method and specify the location
of the new page. For example, the following code adds an instance of
\c MyPage before the ready for installation page:
@@ -342,13 +386,45 @@
installer.addWizardPage( component, "MyPage", QInstaller.ReadyForInstallation );
\endcode
+ You can use component scripts to access the loaded widgets
+ by calling the \l component::userInterface() method with the class name of
+ the widget, as illustrated by the following code snippet:
+
+ \code
+ component.userInterface( "MyPage" ).checkbox.checked = true;
+ \endcode
+
+ \section2 Using Control Scripts to Add Pages
+
+ To register a custom page, use the installer::addWizardPage() method
+ and the object name set in the UI file (for example, \c "MyPage"). Then
+ call the \c{Dynamic${ObjectName}Callback()} function (for example,
+ \c {DynamicMyPageCallback()}):
+
+ \code
+ function Controller()
+ {
+ installer.addWizardPage(component, "MyPage", QInstaller.TargetDirectory)
+ }
+
+ Controller.prototype.DynamicMyPageCallback()
+ {
+ var page = gui.pageWidgetByObjectName("DynamicMyPage");
+ page.myButton.click,
+ page.myWidget.subWidget.setText("hello")
+ }
+ \endcode
+
+ You can access widgets by using their object names that are set in the UI
+ file. For example, \c myButton and \c myWidget are widget object names in
+ the code above.
+
\section1 Adding Widgets
- You can also insert custom user interface elements into the installer as
- single widgets (such as a check box).
+ You can use component or control scripts to insert custom user interface
+ elements into the installer as single widgets (such as a check box).
- To insert a single widget, use the
- \c QInstaller::Installer::addWizardPageItem method.
+ To insert a single widget, use the installer::addWizardPageItem method.
For example, the following code snippet adds an instance of \c MyWidget to
the component selection page from within a script:
@@ -356,6 +432,19 @@
installer.addWizardPageItem( component, "MyWidget", QInstaller.ComponentSelection );
\endcode
+ \section1 Interacting with Installer Functionality
+
+ You can use control scripts to execute installer functions automatically in
+ tests, for example. The following snippet illustrates how to automatically
+ click the \uicontrol Next button on the target directory selection page:
+
+ \code
+ Controller.prototype.TargetDirectoryPageCallback = function()
+ {
+ gui.clickButton(buttons.NextButton);
+ }
+ \endcode
+
\section1 Translating Pages
The installer uses the Qt Translation system to support the translation of
@@ -432,11 +521,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
@@ -467,8 +556,11 @@
\li Comma-separated list of identifiers of components that this
component depends on. Optionally, you can specify version
numbers, separated by a dash (-). You can prefix version numbers
- with a comparison operator (=, >, <, >= or <=). Optional. For
- more information, see \l{Component Dependencies}.
+ with a comparison operator (=, >, <, >= or <=). Keep in mind
+ that you have to use the character reference "&lt;" to escape
+ the left angle bracket (use "&lt;" instead of "<" and "&lt;="
+ instead of "<="). Optional. For more information, see
+ \l{Component Dependencies}.
\row
\li AutoDependOn
\li Opposite of dependencies. Defines that this component should be
@@ -484,8 +576,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
@@ -500,13 +592,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
@@ -521,7 +613,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
@@ -555,8 +647,8 @@
component version. Use a dash (-) to separate version numbers from
identifiers.
- You can prefix version numbers with a comparison operator (=, >, <, >= or
- <=) to indicate that the version number of the package is compared to the
+ You can prefix version numbers with a comparison operator (=, >, &lt; (<), >= or
+ &lt;= (<=)) to indicate that the version number of the package is compared to the
required version and has to be equal to, greater than, less than, greater
than or equal to, or less than or equal to the version number specified in
the dependency. If no comparison operator is given, it defaults to =.
@@ -586,7 +678,7 @@
\contentspage index.html
\previouspage operations.html
\page ifw-tools.html
- \nextpage Scripting
+ \nextpage Scripting API
\title Tools
@@ -835,17 +927,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
@@ -961,7 +1055,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
@@ -981,7 +1075,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
@@ -1040,7 +1134,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"
@@ -1048,14 +1143,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"
@@ -1072,7 +1169,7 @@
\title Known Issues
- Check the \l{https://bugreports.qt-project.org/browse/QTIFW}{Qt Bugtracker}
+ Check the \l{https://bugreports.qt.io/browse/QTIFW}{Qt Bugtracker}
for known issues in the Qt Installer Framework project. If you cannot find
the issue there, create a bug report.
*/
diff --git a/doc/noninteractive.qdoc b/doc/noninteractive.qdoc
index f6d2d2abd..fb5663c1c 100644
--- a/doc/noninteractive.qdoc
+++ b/doc/noninteractive.qdoc
@@ -441,84 +441,84 @@
try again.
\row
- \li AuthorizationError
+ \li \c AuthorizationError
\li Abort, OK
\li Elevated permissions could not be acquired.
\row
- \li OperationDoesNotExistError
+ \li \c OperationDoesNotExistError
\li Abort, Ignore
\li An error occurred while trying to perform an operation, but the operation did not exist.
\row
- \li isAutoDependOnError
+ \li \c isAutoDependOnError
\li OK
\li An error occurred while calling a package script. It was not possible to evaluate
if the package has a auto dependency on other packages.
\row
- \li isDefaultError
+ \li \c isDefaultError
\li OK
\li An error occurred while calling a package script. It was not possible to evaluate
if the package will be installed by default.
\row
- \li DownloadError
+ \li \c DownloadError
\li Retry, Cancel
\li An error occurred while downloading a archive hash from a remote repository. End users
can select \c Retry to try again.
\row
- \li archiveDownloadError
+ \li \c archiveDownloadError
\li Retry, Cancel
\li An error occurred while downloading a archive from a remote repository. End users can
select \c Retry to try again.
\row
- \li WriteError
+ \li \c WriteError
\li OK
\li An error occurred while writing the maintenance tool.
\row
- \li ElevationError
+ \li \c ElevationError
\li OK
\li Elevated permissions could not be acquired.
\row
- \li unknown
+ \li \c unknown
\li OK
\li An unknown error occurred while removing a certain package.
\row
- \li Error
+ \li \c Error
\li OK
\li Generic error.
\row
- \li stopProcessesForUpdates
+ \li \c stopProcessesForUpdates
\li Retry, Ignore, Cancel
\li An error occurred while updating a package. Some running application or process needs
to be quit before the update can be performed. End users can select \c Retry to try
again once they have been stopped.
\row
- \li Installer_Needs_To_Be_Local_Error
+ \li \c Installer_Needs_To_Be_Local_Error
\li OK
\li The installer binary was started from a network location, but the installation over
network is not supported.
\row
- \li TargetDirectoryInUse
+ \li \c TargetDirectoryInUse
\li No
\li The installation's target directory already contains an installation.
\row
- \li WrongTargetDirectory
+ \li \c WrongTargetDirectory
\li OK
\li The installation's target directory is a file or symlink.
\row
- \li AlreadyRunning
+ \li \c AlreadyRunning
\li OK
\li Another application instance is already running.
\endtable
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index 3e3b05e7c..ed1465648 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -33,7 +33,7 @@
\title Operations
- The operations are prepared by component scripts and performed by the
+ The operations are prepared by component and controller scripts and performed by the
installer.
\note Operations are performed threaded.
diff --git a/doc/scripting-qmlmodule.qdoc b/doc/scripting-qmlmodule.qdoc
index f785d28d2..2134f1e4b 100644
--- a/doc/scripting-qmlmodule.qdoc
+++ b/doc/scripting-qmlmodule.qdoc
@@ -30,6 +30,11 @@
\previouspage ifw-tools.html
\nextpage ifw-cpp-classes.html
- \title Scripting
+ \title Scripting API
\qmlmodule scripting
+
+ \brief Scripting API reference.
+
+ The following table summarizes the global JavaScript objects that you can
+ use in controller and component scripts.
*/
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc
index 986ca87ac..e8bce396d 100644
--- a/doc/scripting.qdoc
+++ b/doc/scripting.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Installer Framework.
@@ -250,6 +250,8 @@
\row
\li os
\li Current platform: \c "x11", \c "win", or \c "mac".
+
+ This variable is deprecated: Use \l systemInfo instead.
\row
\li RootDir
\li Root directory of the filesystem.
diff --git a/doc/tutorial.qdoc b/doc/tutorial.qdoc
index 19ee8c352..4360c0125 100644
--- a/doc/tutorial.qdoc
+++ b/doc/tutorial.qdoc
@@ -86,30 +86,29 @@
\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
- repository format, and must be set to \c 1.0.0.
+ \li The \c <Version> element specifies the application version number.
- \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 +117,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 +128,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 +152,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
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-21 14:09:31 +0000