diff options
author | Katja Marttila <katja.marttila@qt.io> | 2018-03-09 10:21:54 +0200 |
---|---|---|
committer | Katja Marttila <katja.marttila@qt.io> | 2018-09-26 04:46:21 +0000 |
commit | 0f8d11ca8e8312fc0d0dc56e0c2a1154ff3de77c (patch) | |
tree | a0f00dbacd2c03ee3013e648464e2df61c7d1b8b /doc | |
parent | b3d140a2c899219a02c1b31efa4e36723eb71c07 (diff) |
Enable usage of categorized repositories
This change allows to categorize repositories in component selection
page. Using categorized repositories will by default show only
uncagetorized repository items in tree. Selecting one or several categories
using checkbox will update the treeview to show all selected categorized repository
content. Repository's metadata is fetched only after the category is selected.
Categorized repositories can be defined in config.xml:
<RepositoryCategories>
<RemoteRepositories>
<Displayname>category 1</Displayname>
<Repository> <Url>(url)</Url></Repository>
</RemoteReposiories>
...
<RepositoryCategories
Change-Id: I6eae9daee70b1afa322144d52c11f25d0b655ebf
Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/images/ifw-repository-categories.png | bin | 0 -> 58532 bytes | |||
-rw-r--r-- | doc/includes/installerfw-examples-generating-online.qdocinc | 18 | ||||
-rw-r--r-- | doc/installerfw.qdoc | 34 |
3 files changed, 52 insertions, 0 deletions
diff --git a/doc/images/ifw-repository-categories.png b/doc/images/ifw-repository-categories.png Binary files differnew file mode 100644 index 000000000..afed7c1b9 --- /dev/null +++ b/doc/images/ifw-repository-categories.png diff --git a/doc/includes/installerfw-examples-generating-online.qdocinc b/doc/includes/installerfw-examples-generating-online.qdocinc new file mode 100644 index 000000000..f623b1d22 --- /dev/null +++ b/doc/includes/installerfw-examples-generating-online.qdocinc @@ -0,0 +1,18 @@ + \section1 Generating the Example Installer + + To create the example installer, switch to the example source directory on + the command line and enter the following command: + + \list + \li On Windows: + \code + ..\..\bin\binarycreator.exe --online-only -c config\config.xml -p packages installer.exe + \endcode + \li On Linux or macOS: + \code + ../../bin/binarycreator --online-only -c config/config.xml -p packages installer + \endcode + \endlist + + You should now be able to run the installer and install from the repository. + diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 22a15983b..bdd99c089 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -266,6 +266,10 @@ 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 RepositoryCategories + \li Name of a category that can contain a list of \c <RemoteRepositories> child elements. + For more information, see \l{Configuring Repository Categories}. + \row \li MaintenanceToolName \li Filename of the generated maintenance tool. Defaults to \e maintenancetool. The platform-specific executable file extension is @@ -1114,6 +1118,36 @@ text. Authentication details not set here will be gotten at runtime using a dialog. The user can work around these settings at runtime. + \section1 Configuring Repository Categories + + The \c <RepositoryCategory> element in the installer configuration file + (config.xml) can contain a list of several \c <RemoteRepositories> elements. Each \c <RemoteRepositories> + element within the \c <RepositoryCagetory> element is considered a category, which has a \c <DisplayName> and can + contain several \c <Repository> elements. Repository categories are shown in the component selection page, + on the left side of the component selection widget: + + \image ifw-repository-categories.png "Component selection Page" + + By default, only repositories with no category are shown in the component selection widget. Checking one or + several repositories and pressing \uicontrol Fetch will update the widget to show content also + from the selected categorized repositories. + + Example of creating a repository category: + + \code + <RepositoryCategories> + <RemoteRepositories> + <Displayname>Category 1</Displayname> + <Repository> + <Url>http://www.example.com/packages</Url> + <Enabled>1</Enabled> + <Username>user</Username> + <Password>password</Password> + <DisplayName>Example repository</DisplayName> + </Repository> + </RemoteRepositories> + </RepositoryCategories> + \endcode \section1 Creating Installer Binaries |