Prechádzať zdrojové kódy

Help: Show external link only once per page; explain abbreviation QtIFW.

Joachim Wuttke (o) 5 rokov pred
rodič
commit
78779c6111
2 zmenil súbory, kde vykonal 26 pridanie a 31 odobranie
  1. 16 18
      Help/cpack_gen/ifw.rst
  2. 10 13
      Modules/CPackIFW.cmake

+ 16 - 18
Help/cpack_gen/ifw.rst

@@ -3,41 +3,39 @@ CPack IFW Generator
 
 
 See :module:`CPackIFW` for details on the CPackIFW module.
 See :module:`CPackIFW` for details on the CPackIFW module.
 
 
-.. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html
-
-
 Overview
 Overview
 ^^^^^^^^
 ^^^^^^^^
 
 
 CPack ``IFW`` generator helps you to create online and offline
 CPack ``IFW`` generator helps you to create online and offline
 binary cross-platform installers with a graphical user interface.
 binary cross-platform installers with a graphical user interface.
 
 
-CPack IFW generator prepares project installation and generates configuration
-and meta information for QtIFW_ tools.
+CPack IFW generator prepares project installation and generates
+configuration and meta information for the `Qt Installer Framework
+<http://doc.qt.io/qtinstallerframework/index.html>`_ (QtIFW).
 
 
-The QtIFW_ provides a set of tools and utilities to create
+The QtIFW provides a set of tools and utilities to create
 installers for the supported desktop Qt platforms: Linux, Microsoft Windows,
 installers for the supported desktop Qt platforms: Linux, Microsoft Windows,
 and macOS.
 and macOS.
 
 
-You should also install QtIFW_ to use CPack ``IFW`` generator.
+You should also install QtIFW to use CPack ``IFW`` generator.
 
 
 Hints
 Hints
 ^^^^^
 ^^^^^
 
 
-Generally, the CPack ``IFW`` generator automatically finds QtIFW_ tools,
-but if you don't use a default path for installation of the QtIFW_ tools,
+Generally, the CPack ``IFW`` generator automatically finds QtIFW tools,
+but if you don't use a default path for installation of the QtIFW tools,
 the path may be specified in either a CMake or an environment variable:
 the path may be specified in either a CMake or an environment variable:
 
 
 .. variable:: CPACK_IFW_ROOT
 .. variable:: CPACK_IFW_ROOT
 
 
- An CMake variable which specifies the location of the QtIFW_ tool suite.
+ An CMake variable which specifies the location of the QtIFW tool suite.
 
 
  The variable will be cached in the ``CPackConfig.cmake`` file and used at
  The variable will be cached in the ``CPackConfig.cmake`` file and used at
  CPack runtime.
  CPack runtime.
 
 
 .. variable:: QTIFWDIR
 .. variable:: QTIFWDIR
 
 
- An environment variable which specifies the location of the QtIFW_ tool
+ An environment variable which specifies the location of the QtIFW tool
  suite.
  suite.
 
 
 .. note::
 .. note::
@@ -53,7 +51,7 @@ Internationalization
 Some variables and command arguments support internationalization via
 Some variables and command arguments support internationalization via
 CMake script. This is an optional feature.
 CMake script. This is an optional feature.
 
 
-Installers created by QtIFW_ tools have built-in support for
+Installers created by QtIFW tools have built-in support for
 internationalization and many phrases are localized to many languages,
 internationalization and many phrases are localized to many languages,
 but this does not apply to the description of the your components and groups
 but this does not apply to the description of the your components and groups
 that will be distributed.
 that will be distributed.
@@ -185,7 +183,7 @@ Package
  Filename of the generated maintenance tool.
  Filename of the generated maintenance tool.
  The platform-specific executable file extension is appended.
  The platform-specific executable file extension is appended.
 
 
- By default used QtIFW_ defaults (``maintenancetool``).
+ By default used QtIFW defaults (``maintenancetool``).
 
 
 .. variable:: CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
 .. variable:: CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
 
 
@@ -197,19 +195,19 @@ Package
 
 
  Filename for the configuration of the generated maintenance tool.
  Filename for the configuration of the generated maintenance tool.
 
 
- By default used QtIFW_ defaults (``maintenancetool.ini``).
+ By default used QtIFW defaults (``maintenancetool.ini``).
 
 
 .. variable:: CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
 .. variable:: CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
 
 
  Set to ``ON`` if the installation path can contain non-ASCII characters.
  Set to ``ON`` if the installation path can contain non-ASCII characters.
 
 
- Is ``ON`` for QtIFW_ less 2.0 tools.
+ Is ``ON`` for QtIFW less 2.0 tools.
 
 
 .. variable:: CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
 .. variable:: CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
 
 
  Set to ``OFF`` if the installation path cannot contain space characters.
  Set to ``OFF`` if the installation path cannot contain space characters.
 
 
- Is ``ON`` for QtIFW_ less 2.0 tools.
+ Is ``ON`` for QtIFW less 2.0 tools.
 
 
 .. variable:: CPACK_IFW_PACKAGE_CONTROL_SCRIPT
 .. variable:: CPACK_IFW_PACKAGE_CONTROL_SCRIPT
 
 
@@ -266,14 +264,14 @@ Components
 
 
  Additional prepared repository dirs that will be used to resolve and
  Additional prepared repository dirs that will be used to resolve and
  repack dependent components. This feature available only
  repack dependent components. This feature available only
- since QtIFW_ 3.1.
+ since QtIFW 3.1.
 
 
 Tools
 Tools
 """""
 """""
 
 
 .. variable:: CPACK_IFW_FRAMEWORK_VERSION
 .. variable:: CPACK_IFW_FRAMEWORK_VERSION
 
 
- The version of used QtIFW_ tools.
+ The version of used QtIFW tools.
 
 
 .. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE
 .. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE
 
 

+ 10 - 13
Modules/CPackIFW.cmake

@@ -5,15 +5,12 @@
 CPackIFW
 CPackIFW
 --------
 --------
 
 
-The documentation for the CPack IFW generator has moved here: :cpack_gen:`CPack IFW Generator`
-
-.. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html
-
-This module looks for the location of the command line utilities supplied
-with the Qt Installer Framework (QtIFW_).
+This module looks for the location of the command line utilities supplied with the
+`Qt Installer Framework <http://doc.qt.io/qtinstallerframework/index.html>`_
+(QtIFW).
 
 
 The module also defines several commands to control the behavior of the
 The module also defines several commands to control the behavior of the
-CPack ``IFW`` generator.
+:cpack_gen:`CPack IFW Generator`.
 
 
 Commands
 Commands
 ^^^^^^^^
 ^^^^^^^^
@@ -102,10 +99,10 @@ The module defines the following commands:
 
 
   ``DEPENDS`` | ``DEPENDENCIES``
   ``DEPENDS`` | ``DEPENDENCIES``
     list of dependency component or component group identifiers in
     list of dependency component or component group identifiers in
-    QtIFW_ style.
+    QtIFW style.
 
 
   ``AUTO_DEPEND_ON``
   ``AUTO_DEPEND_ON``
-    list of identifiers of component or component group in QtIFW_ style
+    list of identifiers of component or component group in QtIFW style
     that this component has an automatic dependency on.
     that this component has an automatic dependency on.
 
 
   ``LICENSES``
   ``LICENSES``
@@ -207,10 +204,10 @@ The module defines the following commands:
 
 
   ``DEPENDS`` | ``DEPENDENCIES``
   ``DEPENDS`` | ``DEPENDENCIES``
     list of dependency component or component group identifiers in
     list of dependency component or component group identifiers in
-    QtIFW_ style.
+    QtIFW style.
 
 
   ``AUTO_DEPEND_ON``
   ``AUTO_DEPEND_ON``
-    list of identifiers of component or component group in QtIFW_ style
+    list of identifiers of component or component group in QtIFW style
     that this component group has an automatic dependency on.
     that this component group has an automatic dependency on.
 
 
   ``LICENSES``
   ``LICENSES``
@@ -242,7 +239,7 @@ The module defines the following commands:
 
 
 .. command:: cpack_ifw_add_repository
 .. command:: cpack_ifw_add_repository
 
 
-  Add QtIFW_ specific remote repository to binary installer.
+  Add QtIFW specific remote repository to binary installer.
 
 
   ::
   ::
 
 
@@ -273,7 +270,7 @@ The module defines the following commands:
 
 
 .. command:: cpack_ifw_update_repository
 .. command:: cpack_ifw_update_repository
 
 
-  Update QtIFW_ specific repository from remote repository.
+  Update QtIFW specific repository from remote repository.
 
 
   ::
   ::