summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config/installerfw-project.qdocconf15
-rw-r--r--doc/examples/config.xml1
-rw-r--r--doc/installerfw-getting-started.qdoc2
-rw-r--r--doc/installerfw.qdoc96
-rw-r--r--doc/noninteractive.qdoc2
-rw-r--r--doc/operations.qdoc4
-rw-r--r--doc/scripting.qdoc37
-rw-r--r--doc/tutorial.qdoc4
8 files changed, 125 insertions, 36 deletions
diff --git a/doc/config/installerfw-project.qdocconf b/doc/config/installerfw-project.qdocconf
index 3b96a00af..fc0074d8c 100644
--- a/doc/config/installerfw-project.qdocconf
+++ b/doc/config/installerfw-project.qdocconf
@@ -3,6 +3,12 @@ description = "Qt Installer Framework Manual"
headerdirs =
sourcedirs = $SRCDIR
+
+# Contains documentation for JS API
+sources = $SRCDIR/../src/libs/installer/packagemanagercore.cpp \
+ $SRCDIR/../src/libs/installer/component.cpp \
+ $SRCDIR/../src/libs/installer/messageboxhandler.cpp
+
imagedirs = $SRCDIR/images $SRCDIR/templates/images
outputdir = $OUTDIR
exampledirs = $SRCDIR $SRCDIR/examples
@@ -13,7 +19,7 @@ include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
-sources.fileextensions = "*.qdoc"
+sources.fileextensions = "*.qdoc *.cpp"
qhp.projects = InstallerFramework
qhp.InstallerFramework.file = ifw.qhp
@@ -34,3 +40,10 @@ qhp.InstallerFramework.subprojects.manual.type = manual
macro.see = "\\sa"
macro.function = "\\fn"
+
+
+# We 'misuse' QML doc commands to generate JS documentation
+# (only works with qdoc from Qt 5)
+
+outputprefixes = QML
+outputprefixes.QML =
diff --git a/doc/examples/config.xml b/doc/examples/config.xml
index c234bab25..daf212711 100644
--- a/doc/examples/config.xml
+++ b/doc/examples/config.xml
@@ -8,6 +8,7 @@
<Logo>logo.png</Logo>
<Watermark>watermark.png</Watermark>
<RunProgram></RunProgram>
+ <RunProgramArguments></RunProgramArguments>
<RunProgramDescription></RunProgramDescription>
<StartMenuDir>Some Application Entry Dir</StartMenuDir>
<UninstallerName>SDKMaintenanceTool</UninstallerName>
diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc
index 84a3c5b5e..1b21ac664 100644
--- a/doc/installerfw-getting-started.qdoc
+++ b/doc/installerfw-getting-started.qdoc
@@ -41,7 +41,7 @@
You can use the Qt Installer Framework to create installers for all
platforms supported by
- \l{http://doc.qt.nokia.com/5.0-snapshot/supported-platforms.html}
+ \l{http://qt-project.org/doc/qt-5.0/qtdoc/platform-details.html}
{desktop Qt}.
The installers have been tested on the following platforms:
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index fbcab3cd4..9cfb94d06 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -182,7 +182,15 @@
\row
\o Icon
\o Filename for a custom installer icon. The actual file is looked up by attaching
- a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix.
+ a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix. Deprecated,
+ use InstallerApplicationIcon and / or InstallerWindowIcon instead.
+ \row
+ \o InstallerApplicationIcon
+ \o Filename for a custom installer icon. The actual file is looked up by attaching
+ a '.icns' (Mac OS X), '.ico' (Windows). No functionality on Unix.
+ \row
+ \o InstallerWindowIcon
+ \o Filename for a custom window icon in PNG format for the Installer application.
\row
\o Logo
\o Filename for a logo used as \a QWizard::LogoPixmap.
@@ -190,13 +198,19 @@
\o Watermark
\o Filename for a watermark used as \a QWizard::WatermarkPixmap.
\row
+ \o Banner
+ \o Filename for a banner used as \a QWizard::BannerPixmap (only used by ModernStyle).
+ \row
\o Background
- \o Filename for an image used as \a QWizard::BackgroundPixmap.
+ \o Filename for an image used as \a QWizard::BackgroundPixmap (only used by MacStyle).
\row
\o RunProgram
\o Command executed after the installer is done if the user accepts
the action.
\row
+ \o RunProgramArguments
+ \o Arguments passed to the program specified in RunProgram.
+ \row
\o RunProgramDescription
\o Text shown next to the check box for running the program after
the installation. Defaults to \gui {Run <Name>}.
@@ -247,9 +261,15 @@
\o TargetConfigurationFile
\o Filename for the configuration file on the target. Default is components.xml.
\row
- \o Pages
- \o Custom strings for labels in the installer pages. Deprecated,
- see \l{Translating Pages} instead.
+ \o Translations
+ \o 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}.
+ \row
+ \o UrlQueryString
+ \o This string needs to be in the form "key=value" and will be appended to archive download
+ requests. This can be used to transmit information to the webserver hosting the repository.
+
\endtable
*/
@@ -425,10 +445,11 @@
\row
\o AutoDependOn
\o Opposite of dependencies. Defines that this component should be
- loaded if the specified component is loaded.
+ loaded if all of the specified components are loaded.
\row
\o Virtual
\o Set to \c true to hide the component from the installer.
+ Note that setting this on a root component does not work.
\row
\o SortingPriority
\o Priority of the component in the tree. The tree is sorted from
@@ -469,6 +490,8 @@
\o Default
\o Possible values are: \c true, \c false, and \c script. Set to
\c true to preselect the component in the installer.
+ This takes effect only on components that have no visible
+ 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,
@@ -477,7 +500,10 @@
\o Essential
\o Marks the package as essential to force a restart of the
\c UpdateAgent or \c MaintenanceTool. This is relevant for
- updates found with \c UpdateAgent.
+ updates found with \c UpdateAgent. If there are updates available
+ for an essential component, the package manager stays disabled
+ until that component is updated. Newly introduced essential components
+ are automatically installed when running the updater.
\row
\o ForcedInstallation
\o Determines that the package must always be installed. End users
@@ -488,7 +514,11 @@
\row
\o DownloadableArchives
- \o Lists the data files (separated by commas) for an online installer to download. Optional.
+ \o Lists the data files (separated by commas) for an online
+ installer to download.
+ If there is some data inside the component and the package.xml
+ and/or the script has no DownloadableArchives value, the
+ repogen tool registers the found data automatically.
\endtable
\section2 Component Dependencies
@@ -772,12 +802,12 @@
repogen.exe -p <package_directory> -c <config_directory>\<config_file> repository <repository_directory>
- For example, to create a repository that contains only com.nokia.sdk.qt and
- com.nokia.sdk.qtcreator, enter the following
+ For example, to create a repository that contains only org.qt-project.sdk.qt and
+ org.qt-project.sdk.qtcreator, enter the following
command:
\code
- repogen.exe -p packages -c installer-config\config.xml -i com.nokia.sdk.qt,com.nokia.sdk.qtcreator repository
+ repogen.exe -p packages -c installer-config\config.xml -i org.qt-project.sdk.qt,org.qt-project.sdk.qtcreator repository
\endcode
When the repository has been created, upload it to a web server. You must
@@ -834,12 +864,12 @@
\endcode
For example, enter the following command to create an installer binary
- called SDKInstaller.exe that will not contain data for com.nokia.sdk.qt and
- com.nokia.qtcreator, because those packages are downloaded from a remote
+ called SDKInstaller.exe that will not contain data for org.qt-project.sdk.qt and
+ org.qt-project.qtcreator, because those packages are downloaded from a remote
repository:
\code
- binarycreator.exe -p installer-packages -c installer-config\config.xml -e com.nokia.sdk.qt,com.nokia.qtcreator SDKInstaller.exe
+ binarycreator.exe -p installer-packages -c installer-config\config.xml -e org.qt-project.sdk.qt,org.qt-project.qtcreator SDKInstaller.exe
\endcode
\section1 Reducing Installer Size
@@ -886,7 +916,7 @@
Some options have default values, and therefore, you can omit them.
For example, enter the following command to create an installer binary
called SDKInstaller.exe that contains the packages identified by
- com.nokia.sdk and their dependencies:
+ org.qt-project.sdk and their dependencies:
\code
binarycreator.exe --offline-only -c installer-config -p installer-packes SDKInstaller.exe
@@ -976,6 +1006,42 @@
then Updates.xml. The package names include version numbers, and therefore,
end users receive old packages until the new ones are fully uploaded.
+ \section1 Changing Repositories
+
+ To have the current update repository point to other repositories, edit the
+ Updates.xml file in the current repository. You can add, replace, or remove
+ repositories.
+
+ \code
+ <RepositoryUpdate>
+ <Repository action="..." OPTIONS />
+ <Repository action="..." OPTIONS />
+ </RepositoryUpdate>
+ \endcode
+
+ \section2 Adding Repositories
+ To update a repository, add the following code to the RepositoryUpdate section:
+
+ \code
+ <Repository action="add" url="http://www.example.com/repository" name="user" password="password"
+ displayname="Example Repository" />
+ \endcode
+
+ \section2 Removing Repositories
+ To remove a repository, add the following code to the RepositoryUpdate section:
+
+ \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:
+
+ \code
+ <Repository action="replace" oldurl="http://www.example.com/repository"
+ newurl="http://www.example.com/newrepository" name="user" password="password"
+ displayname="New Example Repository" />
+ \endcode
*/
/*!
diff --git a/doc/noninteractive.qdoc b/doc/noninteractive.qdoc
index 27c802e78..230aa856b 100644
--- a/doc/noninteractive.qdoc
+++ b/doc/noninteractive.qdoc
@@ -161,7 +161,7 @@
Thus, the \a{Dynamic${ObjectName}Callback()} function is called. Widgets can
be addressed using their object names (from the UI file):
\code
- var page = pageWidgetByObjectName( "DynamicSomePage" )
+ var page = gui.pageWidgetByObjectName( "DynamicSomePage" )
page.myButton.click //direct child of the UI file's widget
page.someFancyWidget.subWidget.setText( "foobar" ) // nested widget
\endcode
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index b187a20cf..2a29a519d 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -132,13 +132,15 @@
The file is set to use UTF-8 encoding.
\row
\o InstallIcons
- \o "InstallIcons" \a directory
+ \o "InstallIcons" \a directory \a [Vendorprefix]
\o Installs the contents of \a directory into a location, as
specified by freedesktop.org. That is, into
\c {$XDG_DATA_DIRS/icons}, \c {/usr/share/icons}, or
\c {$HOME/.icons}. The files are removed from their initial
location. Make sure to add this operation after the operation
that extracts the files from the archive.
+ If you provide a \a Vendorprefix it replaces all characters up to the
+ first dash (-) in the filename of the icon with this prefix.
\row
\o Extract
\o "Extract" \a archive \a targetdirectory
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc
index 410e1645a..38fced90e 100644
--- a/doc/scripting.qdoc
+++ b/doc/scripting.qdoc
@@ -57,8 +57,8 @@
}
\endcode
- For more information, see the documentation for \a addWizardPage and
- \a userInterface.
+ For more information, see the documentation for \l QInstaller::addWizardPage and
+ \l Component::userInterface.
\section1 Installer Hooks
@@ -73,13 +73,13 @@
\o Called when the language of the installer changes.
\row
\o \a{Component.prototype.createOperations}
- \o See \a QInstaller::Component::createOperations.
+ \o See \l Component::createOperations.
\row
\o \a{Component.prototype.createOperationsForArchive}
- \o See \a QInstaller::Component::createOperationsForArchive.
+ \o See \l Component::createOperationsForArchive.
\row
\o \a{Component.prototype.createOperationsForPath}
- \o See \a QInstaller::Component::createOperationsForPath.
+ \o See \l Component::createOperationsForPath.
\endtable
\section1 Global Variables
@@ -92,25 +92,22 @@
\o Description
\row
\o installer
- \o Reference to the \a installer of the component
+ \o Reference to the \l QInstaller of the component
\row
\o component
- \o Reference to the \a Component of the component
+ \o Reference to the \l Component of the component
\endtable
- All methods marked with \a Q_INVOKABLE as well as all signals, slots, and
- properties can be used by the script.
-
\section1 Message Boxes
- You can show a \a QMessageBox from within the script by using:
+ You can show a \l QMessageBox from within the script by using:
- \code
- QMessageBox.critical
- QMessageBox.information
- QMessageBox.question
- QMessageBox.warning
- \endcode
+ \list
+ \li \l QMessageBox::critical
+ \li \l QMessageBox::information
+ \li \l QMessageBox::question
+ \li \l QMessageBox::warning
+ \endlist
For your convenience, the values for \a QMessageBox::StandardButton are made
available by using \a QMessageBox.Ok, \a QMessageBox.Open, and so on.
@@ -249,6 +246,12 @@
\row
\o os
\o Current platform: \c "x11", \c "win", or \c "mac".
+ \row
+ \o RootDir
+ \o Root directory of the filesystem.
+ \row
+ \o HomeDir
+ \o Home directory of the current user.
\endtable
The variables can be resolved by calls to \c installer.value(). If embedded
diff --git a/doc/tutorial.qdoc b/doc/tutorial.qdoc
index f4d537e49..1531922c7 100644
--- a/doc/tutorial.qdoc
+++ b/doc/tutorial.qdoc
@@ -188,6 +188,10 @@
\endlist
+ \note You have to either call \c lrelease on the included .ts file before building
+ the installer or add \c --ignore-translations as a parameter to the binarycreator
+ call.
+
The installer is created in the current directory and you can deliver it to
end users.
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-09 12:44:19 +0000