Qt安装框架说明文档翻译

[TOC] 博客园文章地址 http://www.cnblogs.com/oloroso/archive/2017/02/24/6437581.html

Qt Installer Framework 使用说明

翻译这个有一段时间了，大概是去年10月份开始的吧。英文比较差，翻译的不好。后面还有一部分没有翻译，暂时没有太多时间去做这个，就先留着吧。

我的邮箱:solym@sohu.com

原文链接 http://doc.qt.io/qtinstallerframework/index.html

以下offline翻译为离线，online翻译为联机。widgets翻译为小部件。

版本 2.0.3

The Qt Installer Framework提供了一套工具和实用程序用于创建桌面Qt安装程序。支持的平台有: Linux, Microsoft
Windows, 和 OS X.

注意: 对于Qt Installer Framework中遇到的bug和错误可以通过Qt
Bugtracker(Qt错误追踪)进行反馈。

1、Qt Installer Framework概述

Qt安装程序框架提供了一组工具和实用程序，只需创建安装程序一次，无需改动源码，即可将它们部署在所有支持桌面QT的平台。 安装程序将在运行它们的平台上具有原生外观和感觉，支持：Linux，Microsoft Windows和OS X.

Qt安装程序框架工具生成安装程序，其中包含一组在安装，更新或卸载过程中指导用户的页面。 您提供可安装的内容并指定有关它的信息，例如产品和安装程序的名称以及许可协议的文本。

您可以通过向预定义的页面添加窗口小部件或添加整个页面来为用户提供其他选项来自定义安装程序。 您可以创建脚本以向安装程序添加操作。

选择安装包类型

你可以为最终用户提供一个离线(offline)或联机(online)安装包，或者同时支持。具体取决于您的使用情况。

两个安装程序都安装了一个维护工具(maintenance tool)，以后可用于添加，更新和删除组件。 离线安装程序包含所有可安装的组件，并且在安装期间 不需要网络连接 。 联机安装程序仅安装维护工具，然后从Web服务器上的联机存储库下载和安装组件。 因此，在线安装程序二进制文件的大小较小，其下载时间比离线安装程序二进制文件的大。 如果最终用户没有安装所有可用的组件，则下载和运行联机安装程序所花费的总时间也可能短于下载和运行离线安装程序。

最终用户可以在初次安装后使用维护工具从 服务器安装其他组件 ，以及在服务器上发布更新后立即接收内容的自动更新。 但是，只有在离线安装程序配置中指定存储库地址或最终用户在维护工具设置中指定存储库地址时，这才适用于离线安装。

创建离线安装程序以便用户可以直接下载安装软件包在介质上，稍后在计算机上进行安装。 例如，您还可以将安装软件包分发到CD-ROM或USB盘。
创建联机安装程序以使用户始终安装最新版本的内容二进制文件。

促进更新

使在线存储库可用于向安装产品的最终用户推广更新。 提供更新的最简单方法是重新创建存储库并将其上传到Web服务器。 对于大型存储库，只能更新已更改的组件。

提供安装内容

您可以启用其他内容提供程序将组件作为附加组件添加到安装程序。 组件提供程序必须设置包含可安装组件的存储库，并将指向存储库的URL提供给最终用户。 最终用户必须在安装程序中配置URL。 该附加组件在包管理器中可见。

2、入门指南

Qt安装程序框架是作为Qt项目的一部分开发的。 框架本身使用Qt。 但是，它可以用于创建安装所有类型应用程序的安装程序，包括（但不限于）使用Qt构建的应用程序。

支持的平台

您可以使用Qt Installer Framework为桌面Qt支持的所有平台创建安装程序。

安装程序已在以下平台上测试：

• Microsoft Windows XP及更高版本
• Ubuntu Linux 11.10及更高版本
• OS X 10.7及更高版本

从源代码构建

以下步骤描述如何自己构建Qt Installer Framework。 如果已下载框架的预构建(编译)版本，则可以跳过此步骤。
最新的2.0.3 64位linux安装包下载地址http://download.qt.io/official_releases/qt-installer-framework/2.0.3/QtInstallerFramework-linux-x64.run

支持的编译器

Qt安装程序框架可以使用Microsoft Visual Studio 2013、GCC 4.7、Clang 3.1及其更高版本进行编译。

配置Qt

如果使用静态构建Qt来构建Qt安装程序框架，则不必提供Qt库，这使您可以将安装程序作为一个文件进行分发。

所需的Qt版本最低为5.5。

Windows上配置Qt

我们建议您在Windows配置Qt时使用以下选项：

configure -prefix %CD%\qtbase -release -static -static-runtime -target xp -accessibility -no-opengl -no-icu -no-sql-sqlite -no-qml-debug -nomake examples -nomake tests -skip qtactiveqt -skip qtenginio -skip qtlocation -skip qtmultimedia -skip qtserialport -skip qtquick1 -skip qtquickcontrols -skip qtscript -skip qtsensors -skip qtwebkit -skip qtwebsockets -skip qtxmlpatterns -skip qt3d

Linux上配置Qt

我们建议您在Linux配置Qt时使用以下选项：

configure -prefix $PWD/qtbase -release -static -accessibility -qt-zlib -qt-libpng -qt-libjpeg -qt-xcb -qt-pcre -qt-freetype -no-glib -no-cups -no-sql-sqlite -no-qml-debug -no-opengl -no-egl -no-xinput -no-xinput2 -no-sm -no-icu -nomake examples -nomake tests -skip qtactiveqt -skip qtenginio -skip qtlocation -skip qtmultimedia -skip qtserialport -skip qtquick1 -skip qtquickcontrols -skip qtscript -skip qtsensors -skip qtwebkit -skip qtwebsockets -skip qtxmlpatterns -skip qt3d

OS X上配置Qt

我们建议您在OS X使用以下配置选项：

configure -prefix $PWD/qtbase -release -static -accessibility -qt-zlib -qt-libpng -qt-libjpeg -no-cups -no-sql-sqlite -no-qml-debug -nomake examples -nomake tests -skip qtactiveqt -skip qtenginio -skip qtlocation -skip qtmultimedia -skip qtserialport -skip qtquick1 -skip qtquickcontrols -skip qtscript -skip qtsensors -skip qtwebkit -skip qtwebsockets -skip qtxmlpatterns -skip qt3d

设置Qt安装程序框架

1. 从http://code.qt.io/cgit/installer-framework/installer-framework.git仓库cloneQt安装框架工具源码。
2. 通过运行一个静态编译Qt的qmake来生成Makefile，然后通过make或nmake进行构建。

注意: 要向Qt Installer Framework提供补丁，请遵循标准的Qt流程和指南。 欲了解更多信息，请参阅贡献的Qt。

3、最终用户工作流程

离线和在线安装程序的最终用户体验类似。 与您的应用程序一起，安装程序将安装一个维护工具，该工具由程序包管理器，更新程序和卸载程序组成。 最终用户可以使用维护工具添加，更新和删除组件。 维护工具连接到外部存储库以获取要添加或更新的组件。 您可以在配置文件中指定存储库，或者最终用户可以在维护工具设置中指定它。

您可以支持以下最终用户工作流：

初次安装

下图说明了安装应用程序的默认工作流程：

本节使用在OS X上运行的应用程序安装程序示例说明最终用户的默认工作流程。 安装程序在每个受支持的桌面平台上具有原生外观，因此在Linux和Windows上运行时，它们的外观和感觉不同。

示例文件存储在Qt Installer Framework存储库中的examples\tutorial目录中。 您可以使用binarycreator工具来创建应用程序安装程序。

启动安装程序

当最终用户启动安装程序时，将打开介绍页面：

您可以在config.xml配置文件中指定安装程序的名称和要安装的产品。
当最终用户选择继续时，将打开目标目录选择页面。

选择目标目录

最终用户必须指定安装的目标目录。 您可以在config.xml配置文件中指定默认值。

当最终用户选择继续时，将打开组件选择页面。

如果该目录已存在文件，将打开如下警告页面：

选择组件

组件选择页面列出了 可用于安装的组件 以及每个组件的简短描述。 最终用户 选择要安装的组件 。 他们可以选择全选以选择所有组件，取消选择全部可取消选择它们，或选择默认以恢复为默认选择。

将可安装的组件添加到包目录中的data目录。 您可以在meta目录中的package.xml文件中指定有关组件的信息。

您可以使用布尔运算符或脚本来指定是否默认选择组件。

当最终用户选择继续时，将打开许可证检查页面。

接受许可协议

在许可检查页面上，最终用户 必须接受许可协议 的条款才能继续安装。

如果在package.xml文件中指定许可证文件并将文件复制到元目录，则会显示许可证检查页面。

选择Windows程序组

在Windows上，“开始”菜单目录选择页面 允许最终用户在Windows开始菜单中选择产品的 程序组。

您可以在config.xml配置文件中为程序组指定 默认值 。

当最终用户选择下一步时，将打开准备安装页面。

安装组件

在准备安装页面通知最终用户，当用户选择安装时，安装开始。

在安装过程中，执行安装页面显示有关安装进度的信息。 最终用户可以选择“显示详细信息”以查看更多信息。

安装完成后，将打开安装完成页面。

在此页面中，您可以添加选项以在 关闭安装程序时 启动已安装的产品。在config.xml配置文件中指定要启动的程序和显示的文本。

添加组件

如果最终用户在初次安装期间未选择可用于安装的所有组件，则可以使用软件包管理器(Package Manager)稍后从存储库安装其余组件。 软件包管理器是在初次安装期间与应用程序一起安装的维护工具的一部分。 仅当包含组件的存储库可在本地或外部可用时，此操作才有效。

下图说明了安装附加组件的默认工作流程：

本节使用由在OS X上运行的Qt 5安装程序安装的维护工具作为最终用户在初次安装后如何添加组件实现的示例。 维护工具包含程序包管理器，更新程序和卸载程序。

启动程序包管理器

当最终用户启动维护工具时，将打开介绍页面：

当最终用户选择包管理器(Package Manager)，然后单击继续时，将打开组件选择页面。

选择其他组件

组件选择页面列出了可用于安装的组件以及每个组件的简短描述。 已安装的组件在列表中显示为已选择。 最终用户选择要安装的其他组件。 他们可以选择重置以再次显示当前安装的组件。

当最终用户选择继续时，将打开准备更新页面。

安装所选组件

准备更新页面通知最终用户，在用户选择 更新(Update) 时安装组件。

更新页面显示有关安装进度的信息。 最终用户可以选择“显示详细信息”以查看更多信息。

安装完成后，将打开更新完成页面。

移除组件

下图说明了删除全部或部分已安装组件的默认工作流程：

本节使用在OS X上运行的Qt 5维护工具，作为最终用户如何删除选定或所有组件实现的示例。

删除所有组件

当最终用户启动维护工具时，将打开介绍页面：

最终用户可以选择删除所有组件(Remove all components)，然后单击继续以删除所有已安装的组件。

准备卸载页面通知最终用户，当用户选择卸载时，可以开始 卸载 。

删除所选组件

最终用户可以选择包管理器(Package Manager)，然后选择 继续 ，以在 组件选择页面 上选择要删除的组件：

当最终用户取消要删除的组件的选中状态，然后选择继续时，将打开即将更新的页面。 它通知最终用户在用户选择 更新(Update)时删除组件。

更新页面显示有关安装进度的信息。 最终用户可以选择“显示详细信息”以查看更多信息。

安装完成后，将打开更新完成页面。

更新组件

下图说明了用于更新已安装组件的默认工作流程：

本节使用在OS X上运行的Qt 5维护工具，作为最终用户如何删除选定或所有组件实现的示例。

启动更新程序

当最终用户启动维护工具时，将打开介绍页面：

当最终用户选择更新组件(Update components)，然后单击继续时，将打开组件选择页面。

选择要更新的组件

更新选择列表显示最终用户 可以选择 的 可用更新列表 。

当用户选择继续，将打开准备更新页面。

更新所选组件

准备更新页面通知最终用户，选择更新(Update)进行组件更新。

更新页面显示有关安装进度的信息。 最终用户可以选择“显示详细信息”以查看更多信息。

安装完成后，将打开更新完成页面。

特定设置

设置页面允许最终用户指定代理设置或安装附加组件。 最终用户在介绍页面上选择以进行指定设置。

指定代理设置

默认情况下，安装程序不使用任何代理设置。 最终用户可以选择使用系统代理设置或手动指定代理设置。

安装附加组件

要安装附加组件，最终用户需选择存储库(Repositories)选项卡。

如果Web服务器需要身份验证，则最终用户可以添加其用户名和密码。 如要显示密码，最终用户可以选择显示密码。

要将其自己的存储库添加到安装程序，最终用户可以选择添加并指定指向存储库的URL。

临时存储库只能在初次安装时使用一次。 安装后，只有默认和用户定义的存储库可用。

4、教程: 创建一个安装程序

本教程介绍如何为小项目创建简单的安装程序：

本节介绍以下创建安装程序 必须 完成的任务：

1. 创建一个包(package)目录，其中将包含所有配置文件和可安装的包。
2. 创建包含有关如何构建安装程序二进制文件和联机存储库的信息的配置文件。
3. 创建包信息文件，其中包含有关可安装组件的信息。
4. 创建安装程序内容并将其复制到软件包(package)目录中。
5. 使用binarycreator工具创建安装程序。
   安装程序页面是使用您在配置和程序包信息文件中提供的信息创建的。

示例文件位于Qt Installer Framework资源库中的examples\tutorial目录中。

创建软件包目录

创建一个反映安装程序设计的目录结构，并允许将来扩展安装程序。 该目录必须包含config和packages的子目录。

有关软件包目录的详细信息，请参阅Package Directory。

创建配置文件

在config目录中，创建一个名为config.xml的文件，其中包含以下内容：

<?xml version=“1.0” encoding=“UTF-8”?>
<Installer>
    <Name>Your application</Name>
    <Version>1.0.0</Version>
    <Title>Your application Installer</Title>
    <Publisher>Your vendor</Publisher>
    <StartMenuDir>Super App</StartMenuDir>
    <TargetDir>@HomeDir@/InstallationDirectory</TargetDir>
</Installer>

该配置文件指定介绍页面上显示以下信息：

 

元素指定显示在标题栏 (下图[1]) 上的安装程序名称。
元素指定添加到页面名称和简介文本 (下图[2]) 的应用程序名称。

其他元素用于自定义安装程序的行为：

元素指定应用程序版本号。
元素指定软件的发布者（例如，在Windows控制面板中所示）。
元素指定Windows开始菜单中产品的默认程序组的名称。
元素指定显示给用户的默认目标目录是当前用户的主目录中的InstallationDirectory（因为预定义变量@HomeDir@用作值的一部分）。 有关详细信息，请参阅预定义变量。

有关配置文件格式和可用元素的详细信息，请参阅Configuration File。

创建程序包信息文件

在这种简单的情况下，安装程序只处理一个名为com.vendor.product的组件。 要向安装程序提供有关组件的信息，请创建一个名为package.xml的文件，其中包含以下内容，并将其放在meta目录中：

<?xml version=“1.0” encoding=“UTF-8”?>
<Package>
    <DisplayName>The root component</DisplayName>
    <Description>Install this example.</Description>
    <Version>0.1.0-1</Version>
    <ReleaseDate>2010-09-21</ReleaseDate>
    <Licenses>
        <License name=“Beer Public License Agreement” file=“license.txt” />
    </Licenses>
    <Default>script</Default>
    <Script>installscript.qs</Script>
    <UserInterfaces>
        <UserInterface>page.ui</UserInterface>
    </UserInterfaces>
</Package>

下面更详细地描述示例文件中的元素。
有关软件包信息文件的详细信息，请参阅Package Information File Syntax

指定组件信息

来自以下元素的信息显示在组件选择页面上：

元素指定组件列表中组件的名称 (下图[1]) 。
元素指定在选择组件时显示的文本 (下图[2]) 。

指定安装程序版本

<Versionss>元素使您能够在用户有可用更新时提醒用户进行更新。

添加许可证

<License>元素指定包含许可协议文本 (下图[1]) 的文件名称，该文本显示在许可检查页上：

选择默认内容

<Default>元素指定默认情况下是否选择组件。值为true的组件将设置为选定。 在此示例中，我们使用脚本在运行时解析值。 JavaScript脚本文件installscript.qs的名称在<Script>元素中指定。

创建安装程序内容

要安装的内容存储在组件的data目录中。 因为只有一个组件，请将数据放在packages/com.vendor.product/data目录中。 该示例已包含用于测试目的的文件，但您基本上可以将任何文件放在目录中。

有关打包规则和选项的详细信息，请参阅数据目录。

创建安装程序二进制文件

您现在可以创建您的第一个安装程序。 在命令行上切换到examples\tutorial目录。 要创建一个名为YourInstaller.exe一个安装程序，其中包含com.vendor.product标识的包，输入以下命令：

在Windows上:

....\bin\binarycreator.exe -c config\config.xml -p packages YourInstaller.exe

在Linux 或 OS 上:

../../bin/binarycreator -c config/config.xml -p packages YourInstaller

安装程序会在当前目录中创建，你可以提供给最终用户。

有关使用binarycreator工具的更多信息，请参阅binarycreator。

注意：如果在运行教程安装程序时显示错误消息，请检查是否使用静态构建的Qt创建安装程序。 有关更多信息，请参阅Configuring Qt。

5、创建安装程序 Creating Installers

创建离线和联机安装程序需要以下步骤：

1. 为可安装组件创建包目录。相关相信信息，请参阅Package Directory
2. 在config目录中创建一个名为config.xml的配置文件。 它包含有关如何构建安装程序二进制文件和联机存储库的信息。 有关文件格式和可用设置的详细信息，请参阅Configuration File
3. 在config\meta目录中创建一个名为package.xml的包信息文件。 它包含部署和安装过程的设置。 有关详细信息，请参阅Meta Directory
4. 创建安装程序内容并将其复制到软件包目录中。 有关详细信息，请参阅Data Directory
5. 对于联机安装程序，请使用repogen工具创建包含可安装内容的存储库，并将存储库上载到Web服务器。
6. 使用binarycreator工具创建安装程序。 有关详细信息，请参阅Tools

有关如何创建使用预定义安装程序页面的简单安装程序的示例，请参阅Tutorial: Creating an Installer

以下部分介绍如何创建不同类型的安装程序：

创建离线安装程序 Creating Offline Installers

在安装期间， 离线安装程序 根本不尝试连接到联机存储库。 但是，元数据配置（config.xml）中可以设置允许用户在线添加和更新组件。

离线安装程序在公司防火墙不允许最终用户连接到Web服务器的情况下尤其有用。 网络管理员可以在网络中设置本地更新服务。

要创建离线安装程序，请使用binarycreator工具的–offline-only选项。

要在Windows中创建离线安装程序，请输入以下命令：

<location-of-ifw>\binarycreator.exe –offline-only -t <location-of-ifw>\installerbase.exe -p <package_directory> -c <config_directory>&lt;config_file> <installer_name>

译注:<location-of-ifw>表示binarycreator程序所在目录。

某些选项具有默认值，所以，可以忽略它们。例如，输入以下命令来创建名为SDKInstaller.exe的安装程序二进制文件，其中包含由org.qt-project.sdk标识的软件包及其依赖关系：

binarycreator.exe –offline-only -c installer-config -p installer-packes SDKInstaller.exe

创建在线安装程序 Creating Online Installers

联机安装程序获取一个不在二进制文件中的存储库描述(Update.xml)。创建存储库并将其上传到Web服务器。 然后在用于创建安装程序的config.xml文件中指定存储库的位置。

创建存储库 Creating Repositories

使用repogen工具创建一个软件包目录的所有软件包的联机存储库：

repogen.exe -p <package_directory> <repository_directory>

例如，要创建只包含org.qt-project.sdk.qt和org.qt-project.sdk.qtcreator的存储库，请输入以下命令：
`

repogen.exe -p packages -i org.qt-project.sdk.qt,org.qt-project.sdk.qtcreator repository

创建存储库后，将其上传到Web服务器。 您必须在安装程序配置文件(config.xml)中指定存储库的位置。

配置存储库 Configuring Repositories

安装程序配置文件(config.xml)中的<RemoteRepositories>元素可以包含多个存储库列表。 每个存储库都可以有以下设置项：

• , 指向可用组件列表。
• , 0表示禁用此存储库。
• , 用于受保护存储库验证的用户名。
• , 用于受保护存储库验证的密码。
• , 可选，设置要显示的字符串，而不是URL。

URL需要指向列出可用组件的Updates.xml文件。 例如：

<RemoteRepositories>
     <Repository>
             <Url>http://www.example.com/packages</Url>
             <Enabled>1</Enabled>
             <Username>user</Username>
             <Password>password</Password>
             <DisplayName>Example repository</DisplayName>
     </Repository>
</RemoteRepositories>

仅当安装程序 可以访问存储库 时，安装程序才会继续。 如果在安装后访问存储库，维护工具将拒绝安装。 但是，卸载后可再次安装。 默认情况下可以启用或禁用存储库。 对于需要验证的存储库，也可以在此处设置详细信息，但在此输入密码通常不可取，因为它以纯文本保存。 若此处未设置身份验证详细信息，将在 运行时通过对话框获取 。 用户可以在运行时解决这些设置。

创建安装程序二进制文件 Creating Installer Binaries

要使用binarycreator工具创建联机安装程序，请输入以下命令：

<location-of-ifw>\binarycreator.exe -t <location-of-ifw>\installerbase.exe -p <package_directory> -c <config_directory>&lt;config_file> -e <packages> <installer_name>

例如，输入以下命令以创建名为SDKInstaller.exe的安装程序二进制文件，其中 不包含 org.qt-project.sdk.qt和org.qt-project.qtcreator的数据，因为这些软件包是 从远程存储库下载 的：

binarycreator.exe -p installer-packages -c installer-config\config.xml -e org.qt-project.sdk.qt,org.qt-project.qtcreator SDKInstaller.exe

减少安装程序文件大小 Reducing Installer Size

即使组件从Web服务器获取，binarycreator 仍然会将它们添加到安装程序二进制文件 中。 但是，当安装程序检查Web服务器上的更新时，如果新版本不可用，则最终用户可以免于下载。

或者，您可以创建不包含任何数据仅从Web服务器获取所有数据的联机安装程序。 使用binarycreator工具的-n参数，并且只将根(root)组件添加到安装程序。 通常根(root)组件是空的，因此只添加根(root)的XML描述。

更多相关选项的详细信息，请参阅Summary of binarycreator Parameters

促进更新 Promoting Updates

促进更新这是一个很别扭的翻译，这里的意思是在运行联机安装程序的时候，会去读取存储库中的Update.xml文件来判断是否需要下载更新。

创建在联机程序，以便能够向最终安装产品用户促进更新。

需要以下步骤来促进更新：

1. 复制要更新的内容到软件包目录。
2. 增加package.xml文件中已更新组件的<Version>元素的值。
3. 使用repogen工具重新创建具有更新内容的联机存储库，并在存储库的根目录中生成Updates.xml文件。
4. 将存储库上传到Web服务器。
5. 使用binarycreator工具创建安装程序。

配置更新 Configuring Updates

安装程序在启动时下载Updates.xml文件，并将安装的版本与文件中的版本进行比较。 如果联机版本号大于本地版本号，安装程序将在可用更新列表中显示它。

增加package.xml文件中组件的<Version>元素的值。

重新创建存储库 Recreating Repositories

提供更新的最简单方法是重新创建资源库，并上传到Web服务器。 有关更多信息，请参阅创建存储库 Creating Repositories

部分更新存储库

整个库完全更新可能不是最优的，如果：

• 存储库非常大，因为上传需要很长时间。
• 你想只提供更新的组件。

注意： repogen会在每次调用时重新创建7zip存档。 由于7zip存储所包含的文件的时间戳（在此过程中被移动或复制时改变），每个归档的SHA值将改变。 SHA校验和值用于验证下载的存档，因此需要匹配7zip的SHA值。 由于SHA值存储在Updates.xml文件中，因此将强制您上传完整存储库。 这可以通过使用repogen的–update选项来规避。

创建部分更新 Creating Partial Updates

在重新创建联机存储库时，请使用–update参数。 它将现有存储库作为输入，并仅更改附加参数指定的组件。 那些SHA值在全局配置中也被改变。

上传部分更新 Uploading Partial Updates

上传下列项目到Web服务器：

• 组件目录（通常类似于com.vendor.product.updatedpart）。
• 全局Updates.xml存储在联机存储库的根目录中。

注意： 上传项目的顺序非常重要。 如果在实时服务器上更新存储库，请首先更新组件，然后更新Updates.xml。 软件包名称包括版本号，因此，在新软件包完全上传前，最终用户会收到旧软件包。

更改存储库 Changing Repositories

要使当前更新存储库指向其他存储库，请编辑当前存储库中的Updates.xml文件。 您可以添加，替换或删除存储库。

<RepositoryUpdate>
  <Repository action=”…” OPTIONS />
  <Repository action=”…” OPTIONS />
</RepositoryUpdate>

添加存储库 Adding Repositories

要更新(原文是Update，猜测应该是添加)存储库，请将 具有以下选项 <Repository>子元素添加到<RepositoryUpdate>元素中：

<Repository action=“add” url=“http://www.example.com/repository" name=“user” password=“password”
             displayname=“Example Repository” />

删除存储库 Removing Repositories

要删除存储库，请将 具有以下选项 <Repository>子元素添加到<RepositoryUpdate>元素中：

<Repository action=“remove” url=“http://www.example.com/repository" />

替换存储库 Replacing Repositories

要用一个存储库替换另一个，请将 具有以下选项 <Repository>子元素添加到<RepositoryUpdate>元素中：

<Repository action=“replace” oldurl=“http://www.example.com/repository"
            newurl=“http://www.example.com/newrepository" name=“user” password=“password”
            displayname=“New Example Repository” />

自定义安装程序 Customizing Installers

您可以使用脚本通过以下方式自定义安装程序：

• 添加由脚本编译的Qt Installer Framework 操作，并由安装程序来执行。
• 在package.xml文件中指定添加的新页面，并存放到package目录中。
• 通过修改现有页面，将自定义的用户界面元素作为单个widgets小部件插入其中。
• 添加语言(variants)

您可以使用组件脚本(component scripts)和控制脚本(control script)来自定义安装程序。组件脚本在组件的package.xml文件的<Script>元素中指定，与特定组件相关联。在 获取组件的元数据时加载脚本 。有关组件脚本的更多信息，请参阅组件脚本Controller Scripting。

有关可在组件和控制脚本中使用的全局JavaScript对象的更多信息，请参阅Scripting API。

添加操作 Adding Operations

您可以使用组件脚本在安装过程中执行Qt Installer Framework操作。 通常，通过移动，复制或修补来操作文件。 使用QInstaller::Component::addOperation或QInstaller::Component::addElevatedOperation函数添加操作。 有关更多信息，请参阅向组件添加操作 Adding Operations to Components。

此外，您可以通过派生KDUpdater::UpdateOperation来实现在安装程序中注册自定义安装操作的方法。 有关详细信息，请参阅注册自定义操作 Registering Custom Operations。

有关可用操作的信息，请参阅操作Operations。

添加页面 Adding Pages

组件可以包含一个或多个用户界面文件，这些文件由组件或控制脚本放置到安装程序中(在安装程序执行时加载)。 安装程序将自动加载package.xml文件的UserInterfaces元素中列出的所有用户界面文件。

使用组件脚本添加页面 Using Component Scripts to Add Pages

要向安装程序添加新页面，请使用installer::addWizardPage()方法并指定新页面的位置。 例如，以下代码在 准备安装页面 之前添加了一个MyPage的实例：

installer.addWizardPage( component, “MyPage”, QInstaller.ReadyForInstallation );

您可以使用组件脚本通过调用component::userInterface()方法访问加载的小部件的类名，如下面的代码段所示：

component.userInterface( “MyPage” ).checkbox.checked = true;

使用控制脚本添加页面 Using Control Scripts to Add Pages

要注册自定义页面，请使用installer::addWizardPage()方法和U并文件中设置的对象名称（例如“MyPage”）。 然后调用Dynamic${ObjectName}Callback()函数（例如，DynamicMyPageCallback()）：

function Controller()
{
    installer.addWizardPage(component, “MyPage”, QInstaller.TargetDirectory)
}


Controller.prototype.DynamicMyPageCallback()
{
    var page = gui.pageWidgetByObjectName(“DynamicMyPage”);
    page.myButton.click,
    page.myWidget.subWidget.setText(“hello”)
}

您可以通过使用在UI文件中设置的对象名称来访问窗口小部件。 例如，在上面的代码中myButton和myWidget就是控件对象名称。

添加小部件 Adding Widgets

您可以使用组件或控制脚本将自定义用户界面元素作为单个窗口小部件（例如复选框）插入到安装程序中。

要插入单个窗口小部件，请使用installer::addWizardPageItem方法。 例如，以下代码片段从脚本中将MyWidget的实例添加到 组件选择页面 ：

installer.addWizardPageItem( component, “MyWidget”, QInstaller.ComponentSelection );

与安装程序功能交互

例如，您可以使用控制脚本在测试中自动执行安装程序功能。 以下代码段说明如何自动单击目标目录选择页上的 下一步(Next) 按钮：

Controller.prototype.TargetDirectoryPageCallback = function()
{
    gui.clickButton(buttons.NextButton);
}

翻译页面 Translating Pages

安装程序使用Qt Translation系统支持将用户可读输出转换为多种语言。 要向最终用户提供组件脚本和用户界面中包含的字符串的 本地化版本 ，请创建随组件一起加载的QTranslator文件。 安装程序加载与当前系统区域设置匹配的翻译文件。 例如，如果系统语言环境是德语，则会加载de.qm文件。 此外，如果找到，将显示本地化license_de.txt而不是默认的license.txt。

需要将翻译添加到激活组件的package.xml文件中：

<Translations>
    <Translation>de.qm</Translation>
</Translations>

对脚本中的文本文本使用qsTr()函数。 此外，您可以将Component.prototype.retranslateUi方法添加到脚本。 当安装程序的语言更改并加载翻译文件时调用。

当在翻译用户界面时使用qsTr或UI文件的类名,用于翻译的上下文是脚本文件的基本名称。例如，如果脚本文件被称为installscript.qs，上下文将是installscript。

注意：翻译系统也可用于自定义UI。 使用例如一个en.ts文件作为自定义英语版本替换安装程序中的任何文本。

6、Qt Installer Framework 示例

这些示例说明如何使用组件脚本来定制安装程序。

7、参考 Reference

以下部分包含有关Qt Installer Framework的详细信息：

配置文件 Configuration File

配置文件定制安装程序的用户界面和行为。 该文件通常名为config.xml并位于config目录中。

最小配置文件由<Installer>根元素和<Name>和<Version>元素组成。 其他元素都是可选的，且无顺序要求。

以下是典型的配置文件示例：

<?xml version=“1.0”?>
<Installer>
    <Name>Some Application</Name>
    <Version>1.0.0</Version>
    <Title>Some Application Setup</Title>
    <Publisher>发行公司</Publisher>
    <ProductUrl>http://www.your-fantastic-company.com</ProductUrl>
    <InstallerWindowIcon>installericon</InstallerWindowIcon>
    <InstallerApplicationIcon>installericon</InstallerApplicationIcon>
    <Logo>logo.png</Logo>
    <Watermark>watermark.png</Watermark>
    <RunProgram>@TargetDir@/YourAppToRun</RunProgram>
    <RunProgramArguments>
        <Argument>Argument 1</Argument>
        <Argument>Argument 2</Argument>
    </RunProgramArguments>
    <RunProgramDescription>程序描述文本</RunProgramDescription>
    <StartMenuDir>Some Application Entry Dir</StartMenuDir>
    <MaintenanceToolName>SDKMaintenanceTool</MaintenanceToolName>
    <AllowNonAsciiCharacters>true</AllowNonAsciiCharacters>
    <Background>background.png</Background>


<span class="nt">&lt;TargetDir&gt;</span>@HomeDir@/testinstall<span class="nt">&lt;/TargetDir&gt;</span>
<span class="nt">&lt;AdminTargetDir&gt;</span>@RootDir@/testinstall<span class="nt">&lt;/AdminTargetDir&gt;</span>
<span class="nt">&lt;RemoteRepositories&gt;</span>
    <span class="nt">&lt;Repository&gt;</span>
        <span class="nt">&lt;Url&gt;</span>http://www.your-repo-location/packages/<span class="nt">&lt;/Url&gt;</span>
    <span class="nt">&lt;/Repository&gt;</span>
<span class="nt">&lt;/RemoteRepositories&gt;</span>


</Installer>

配置文件元素的简要说明 Summary of Configuration File Elements

下表总结了配置文件中的元素。

注意： 我们建议您将配置文件中引用的所有文件放在config目录中。 但是，您也可以使用相对路径，工具相对于config.xml文件的位置进行解析。

您可以使用预定义变量 (嵌入@字符) 作为元素的值。 有关详细信息，请参阅预定义变量 Predefined Variables。

包目录 Package Directory

安装程序包含嵌入到安装程序或从远程存储库加载的组件。在这两种情况下，你需要提供组件使用的文件格式和结构，以便安装程序读取。

包目录结构 Package Directory Structure

将所有组件放在同一根目录中，这称为包目录。目录名称用作 域标识符 ，其标识所有组件。例如 com.vendor.root。

在根目录中，创建称data和meta子目录。

一个包目录可以如下所示：

-packages
    - com.vendor.root
        - data
        - meta
    - com.vendor.root.component1
        - data
        - meta
    - com.vendor.root.component1.subcomponent1
        - data
        - meta
    - com.vendor.root.component2
        - data
        - meta

元信息目录 Meta Directory

meta目录包含指定部署和安装过程设置的文件。安装程序不会提取文件(这些文件不会嵌入到安装程序中)。该目录必须至少包含程序 包信息文件 和您在程序包信息文件中所有 引用的文件 ，例如脚本，用户界面文件和翻译。

包信息文件语法 Package Information File Syntax

package.xml文件是关于组件信息的主要来源。 以下是package文件的示例：

<?xml version=“1.0”?>
<Package>
    <DisplayName>QtGui</DisplayName>
    <Description>Qt gui libraries</Description>
    <Description xml:lang=“de_de”>Qt GUI Bibliotheken</Description>
    <Version>1.2.3</Version>
    <ReleaseDate>2009-04-23</ReleaseDate>
    <Name>com.vendor.root.component2</Name>
    <Dependencies>com.vendor.root.component1</Dependencies>
    <Virtual>false</Virtual>
    <Licenses>
        <License name=“License Agreement” file=“license.txt” />
    </Licenses>
    <Script>installscript.qs</Script>
    <UserInterfaces>
        <UserInterface>specialpage.ui</UserInterface>
        <UserInterface>errorpage.ui</UserInterface>
    </UserInterfaces>
    <Translations>
        <Translation>sv_se.qm</Translation>
        <Translation>de_de.qm</Translation>
    </Translations>
    <DownloadableArchives>component2.7z, component2a.7z</DownloadableArchives>
    <AutoDependOn>com.vendor.root.component3</AutoDependOn>
    <SortingPriority>123</SortingPriority>
    <UpdateText>This changed compared to the last release</UpdateText>
    <Default>false</Default>
    <ForcedInstallation>false</ForcedInstallation>
    <Essential>false</Essential>
    <Replaces>com.vendor.root.component2old</Replaces>
</Package>

软件包信息文件元素简介 Summary of Package Information File Elements

组件依赖关系 Component Dependencies

组件可以依赖于一个或多个 真实 或 虚拟 组件。 通过使用 组件标识符 和可选的 组件版本 来定义依赖性。 使用破折号-将版本号与标识符分隔开。

您可以使用比较运算符 (=, >, &lt; (<), >= 或 &lt;= (<=))为版本号添加前缀，以指示包的版本号与所需版本进行比较，并且必须 等于，大于，小于，大于等于 或 小于等于 依赖关系中指定的版本号。如果未给出比较运算符，它将默认为=。

数据目录 Data Directory

数据(data)目录包含安装程序在安装期间提取的内容。您必须将数据打包为7zip存档(.7z)。 您可以使用随Qt Installer Framework提供的archivegen工具或其它生成7zip存档的工具。
译注：实际上并不直接打包成7z压缩包也可以，可以使用binarycreator工具直接创建安装程序。

控制脚本 Controller Scripting

对于每个安装程序，您可以指定一个控制脚本与安装程序的用户界面或功能进行某些交互。控制脚本可以对向导(Wizard)添加和删除页面，更改现有页面，做额外的检查，并通过模拟用户点击UI交互。 这允许例如 无人值守的安装 。

脚本格式必须兼容QJSEngine。

本节介绍为实现此类控制脚本而调用的函数。 它还概述了安装程序页面和每个页面上可用的小部件，例如按钮，单选按钮和行编辑。

编写控制脚本 Writing Control Scripts

最小有效脚本需要至少包含一个构造函数，它可能如下所示：

function Controller()
{
}

以下示例介绍了一个更高级的脚本，它使用gui JavaScript全局对象的方法在介绍页面上设置新的页面标题和欢迎消息，并自动单击 目标目录选择页面 上的 下一步(Next) 按钮：

function Controller()
{
}


// 介绍页面回调函数
Controller.prototype.IntroductionPageCallback = function()
{
    var widget = gui.currentPageWidget(); // 获取当前向导页面 wizard page
    if (widget != null) {
        widget.title = “New title.”; // 设置页面标题
        widget.MessageLabel.setText(“New Message.”); // 设置欢迎信息 welcome text
    }
}

// 目标目录选择页面回调函数
Controller.prototype.TargetDirectoryPageCallback = function()
{
    gui.clickButton(buttons.NextButton); // 自动单击 Next 按钮(下一步)
}

有关可以在控制脚本中使用的JavaScript全局对象的更多信息，请参阅Scripting API。

预定义安装页 Predefined Installer Pages

QInstaller JavaScript对象提供对以下预定义安装程序页面的访问：

• Introduction 介绍
• TargetDirectory 目标目录
• ComponentSelection 组件选择
• LicenseCheck 许可证检查
• StartMenuSelection 开始菜单选择
• ReadyForInstallation 准备安装
• PerformInstallation 执行安装
• InstallationFinished 安装完成

button JavaScript对象提供了一组可在安装程序页面上使用的按钮。

以下部分描述可用于与安装程序页面和 每个页面 上 可用的窗口小部件 交互的功能。(就是每个页面上具有的控件)

介绍页 Introduction Page

实现Controller.prototype.IntroductionPageCallback()函数与介绍页上的小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮

示例代码:

function Controller()
{
    var widget = gui.pageById(QInstaller.Introduction); // get the introduction wizard page
    if (widget != null)
        widget.packageManagerCoreTypeChanged.connect(onPackageManagerCoreTypeChanged);
}


onPackageManagerCoreTypeChanged = function()
{
    console.log(“Is Updater: “ + installer.isUpdater());
    console.log(“Is Uninstaller: “ + installer.isUninstaller());
    console.log(“Is Package Manager: “ + installer.isPackageManager());
}

许可协议页 License Agreement Page

实现Controller.prototype.LicenseAgreementPageCallback()函数与许可协议页面上的窗口小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮
• BackButton 后退按钮

目标目录选择页 Target Directory Page

实现Controller.prototype.TargetDirectoryPageCallback()函数与目标目录选择页面上的窗口小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮
• BackButton 后退按钮

组件选择页 Component Selection Page

实现Controller.prototype.ComponentS actionPage Callback()函数与组件选择页面上的窗口小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮
• BackButton 后退按钮

开始菜单目录页 Start Menu Directory Page

实现Controller.prototype.StartMenuDirectoryPageCallback()函数与准备安装页面上的小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮
• BackButton 后退按钮

准备安装页 Ready for Installation Page

实现Controller.prototype.StartMenuDirectoryPageCallback()函数与准备安装页面上的小部件交互。

向导按钮 Wizard Button:

• NextButton 下一步按钮
• CanceButton 取消按钮
• BackButton 后退按钮

执行安装页 Perform Installation Page

实现Controller.prototype.PerformInstallationPageCallback()函数来与执行安装页面上的窗口小部件交互。

向导按钮 Wizard Button:

• CommitButton 提交按钮
• CancelButton 取消按钮

介绍页 Finished Page

实现Controller.prototype.Finished Page Callback()函数与安装完成页面上的小部件进行交互。

向导按钮 Wizard Button:

• CommitButton 提交按钮
• CancelButton 取消按钮
• FinishButton 完成按钮

介绍页 Custom Pages

自定义页面注册为Dynamic${ObjectName}，其中${ObjectName}是在UI文件中设置的对象名。因此Dynamic${ObjectName}Callback()的调用，可以使用对象名(从UI文件)来寻址小部件。

示例代码：

function Controller()
{
    // add page with widget \c SomePageWidget before the target directory page
    // 在目标目录页之前添加具有部件\ C SomePageWidget的页
    installer.addWizardPage(component, “SomePageWidget”, QInstaller.TargetDirectory)
}


Controller.prototype.DynamicSomePageWidgetCallback()
{
    var page = gui.pageWidgetByObjectName(“DynamicSomePageWidget”);
    page.myButton.click, //指向子对象或UI文件中的小部件 direct child of the UI file’s widget
    page.someFancyWidget.subWidget.setText(“foobar”) // 嵌套小部件 nested widget
}

消息框 Message Boxes

在执行安装程序应用程序时，例如，应用程序可能会(弹出)显示一些关于发生的错误的消息框。 这在最终用户的系统上运行应用程序是很棒的，但它可能会破坏自动测试套件。为了克服这个问题，Qt安装程序框架显示的所有消息框，都可以通过特定的标识符寻址。

示例代码：

function Controller()
{
    installer.autoRejectMessageBoxes;
    installer.setMessageBoxAutomaticAnswer(“OverwriteTargetDirectory”, QMessageBox.Yes);
    installer.setMessageBoxAutomaticAnswer(“stopProcessesForUpdates”, QMessageBox.Ignore);
}

组件脚本 Component Scripting

对于每个组件，您可以准备一个脚本来指定由安装程序执行的操作。 脚本格式必须兼容QJSEngine

Construction

脚本必须包含安装程序在 加载脚本时 创建的Component对象。 因此，脚本必须至少包含Component()函数，该函数执行初始化，例如将页面放在正确的位置或连接信号和槽。

以下代码片段将ErrorPage（它是从errorpage.ui加载的用户界面文件的类名）放在 准备安装页面 的前面，并将其完整性设置为false。

function Component()
{
    // Add a user interface file called ErrorPage, which should not be complete
    // 添加UI文件调用ErrorPage，这应该是不完整的
    installer.addWizardPage( component, “ErrorPage”, QInstaller.ReadyForInstallation );
    component.userInterface( “ErrorPage” ).complete = false;
}

有关更多信息，请参阅installer::addWizardPage()和component::userInterface()的文档

安装钩子 Installer Hooks

您可以在脚本中添加以下钩子方法：

|Method|描述|
|Component.prototype.retranslateUi|当安装程序的语言更改时调用|
|Component.prototype.createOperations|参见component::createOperations()|
|Component.prototype.createOperationsForArchive|参见component::createOperationsForArchive()|
|Component.prototype.createOperationsForPath|S参见component::createOperationsForPath()|

全局变量 Global Variables

安装程序将以下符号放入脚本空间：

|Symbol|描述|
|installer|引用组件的QInstaller|
|component|引用组件的Component|

消息框 Message Boxes

您可以通过使用以下静态成员从脚本中显示QMessageBox：

• QMessageBox::critical()
• QMessageBox::information()
• QMessageBox::question()
• QMessageBox::warning()

为了方便起见，QMessageBox::StandardButton的值通过使用QMessageBox.Ok，QMessageBox.Open等提供。

添加操作到组件 Adding Operations to Components

例如，您可能需要在解压缩内容后，在复制文件或修补文件内容时添加自定义操作。 您可以使用component::addOperation()从脚本中创建和添加更新操作到安装。 如果需要运行需要管理权限的操作，请改用component::addElevatedOperation()。

操作需要在实际安装步骤之前添加。 重写component::createOperations()来注册组件的自定义操作。

每个操作都有一个用于识别的唯一键，最多可以占用五个参数。在参数值中，可以使用在installer::setValue()中设置的变量。 有关详细信息，请参阅预定义变量。

有关所有可用操作的摘要信息，请参阅操作。

注册自定义组件 Registering Custom Operations

您可以通过继承KDUpdater::UpdateOperation类在安装程序中注册自定义安装操作。
下面的代码显示您必须实现的方法：

#include <KDUpdater/UpdateOperation>

class CustomOperation : public KDUpdater::UpdateOperation
{
public:
  CustomOperation()
  {
      setName( “CustomOperation” );
  }


void backup()
  {
      // do whatever is needed to restore the state in undoOperation()
      // 恢复所有需要在undoOperation()中需要恢复的状态
  }

bool performOperation()
  {
      const QStringList args = arguments();
      // do whatever is needed to do for the given arguments
      // 获取所有需要给定的参数

      bool success = …;
      return success;
  }

void undoOperation()
  {
      // restore the previous state, as saved in backup()
      // 恢复以前的状态，保存在backup()中
  }

bool testOperation()
  {
      // currently unused
      // 当前未使用
      return true;
  }

CustomOperation* clone() const
  {
      return new CustomOperation;
  }

QDomDocument toXml()
  {
      // automatically adds the operation’s arguments and everything set via setValue
      // 自动添加操作的参数，并通过setValue设置所有
      QDomDocument doc = KDUpdater::UpdateOperation::toXml();

  <span class="c1">// if you need any information to undo the operation you did,


      // add them to the doc here
      // 如果您需要任何信息来撤消您所做的操作，请在此处将其添加到doc

      return doc;
  }

bool fromXml( const QDomDocument& doc )
  {
      // automatically loads the operation’s arguments and everything set via setValue
      // 自动加载操作参数并通过setValue设置所有
      if( !KDUpdater::UpdateOperation::fromXml( doc ) )
          return false;

  <span class="c1">// if you need any information to undo the operation you did,


      // read them from the doc here
      // 如果您需要任何信息来撤消您所做的操作，请在此处将其添加到doc

      return true;
  }
};

最后，需要注册您的自定义操作类，如下所示：

#include <KDupdater/UpdateOperationFactory>

KDUpdater::UpdateOperationFactory::instance().registerUpdateOperation< CustomOperation >( “CustomOperation” );

现在，您可以用与预定义操作相同的方式在安装程序中使用您自定义的操作。

预定义变量 Predefined Variables

您可以在脚本中使用以下预定义变量，以便直接访问：

变量可以通过调用installer::value(string key, string defaultValue = “”)来解析。如果嵌入在’@‘中，它们也可以作为安装操作的参数传递字符串的一部分：

if (installer.value(“os”) === “win”) {
    component.addOperation(“CreateShortcut”, ”@TargetDir@/MyApp.exe”, ”@StartMenuDir@/MyApp.lnk”);
}

操作 Operations

操作由组件和控制器脚本提供并由安装程序执行。

注意：操作是线性执行的。

在内部，每个操作具有包含用于安装程序的指令的DO步骤和包含用于卸载程序的指令的UNDO步骤。

操作概要 Summary of Operations

下表总结了可用的操作及其语法。

对于匹配的组建，Extract、License和MinimumProgress操作是自动添加非重写的component::createOperations()方法。另请参见component::autoCreateOperations

如果发生错误，您可以使用devtool手动测试操作。 但是，变量不会解析，因此您需要使用绝对值。

例如，要测试复制文件：

devtool –operation DO,Copy,<source>,<target>

工具 Tools

脚本API Scripting API

C++ API

Known Issues