diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2014-12-19 11:22:40 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-08 17:02:30 +0100 |
commit | 5a1b61d27e7dcfc7b82d6db483f5afcac585318c (patch) | |
tree | 97ce0eb1efad7b545102235a0fe61d4f1f2674f3 /examples | |
parent | fb25c949f8e50bbd6ff6db3a4b59762d1d22c951 (diff) |
Doc: update docs for Modify Extract Installer example
Fix issues in the example files and unify some values to
make it possible to use standard text for the configuring
section.
Change-Id: I4e4236d519d075fc1f0461e3b863989ca0373cd3
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/doc/images/qtifw-examples-modifyextract.png | bin | 0 -> 27489 bytes | |||
-rw-r--r-- | examples/doc/modifyextract.qdoc | 29 | ||||
-rw-r--r-- | examples/modifyextract/config/config.xml | 8 | ||||
-rw-r--r-- | examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml | 4 |
4 files changed, 35 insertions, 6 deletions
diff --git a/examples/doc/images/qtifw-examples-modifyextract.png b/examples/doc/images/qtifw-examples-modifyextract.png Binary files differnew file mode 100644 index 000000000..d189d0b3e --- /dev/null +++ b/examples/doc/images/qtifw-examples-modifyextract.png diff --git a/examples/doc/modifyextract.qdoc b/examples/doc/modifyextract.qdoc index fd5b5ebe5..88cc45d37 100644 --- a/examples/doc/modifyextract.qdoc +++ b/examples/doc/modifyextract.qdoc @@ -32,9 +32,38 @@ \brief Using the extract archive hook to modify the target path. + \image qtifw-examples-modifyextract.png + + \e{Modify Extract Installer} illustrates how to overwrite the + \c{component.createOperationsForArchive()} function to be able to install a + component to a modified path. + \include installerfw-examples-configuring.qdocinc \quotefile modifyextract/config/config.xml + \include installerfw-examples-packaging.qdocinc + + \list + \li The \c <Default> section is set to \c true to preselect the + component in the installer. + \li The \c <Script> section specifies the file name of the JavaScript + file that is loaded to perform operations. + \endlist + + \quotefile modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml + + \section1 Modifying Target Path + + In installscript.js, we overwrite the default + \c{component.createOperationsForArchive()} implementation to be able to + register an \c Extract operation with a custom argument: + + \quotefromfile modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/installscript.js + \skipto createOperationsForArchive + \printuntil { + \skipto component.addOperation + \printuntil } + \include installerfw-examples-generating.qdocinc */ diff --git a/examples/modifyextract/config/config.xml b/examples/modifyextract/config/config.xml index 2f365dbcc..1ff8ead0c 100644 --- a/examples/modifyextract/config/config.xml +++ b/examples/modifyextract/config/config.xml @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <Installer> - <Name>Modify extract Installer Example</Name> + <Name>Modify Extract Installer Example</Name> <Version>1.0.0</Version> - <Title>Modify extract Installer Example</Title> + <Title>Modify Extract Installer Example</Title> <Publisher>Qt-Project</Publisher> - <StartMenuDir>Qt Installer Framework Example</StartMenuDir> - <TargetDir>@HomeDir@/IFWModifyExtractInstallerExample</TargetDir> + <StartMenuDir>Qt IFW Examples</StartMenuDir> + <TargetDir>@HomeDir@/IfwExample</TargetDir> </Installer> diff --git a/examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml b/examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml index ed7bce619..18f51b39a 100644 --- a/examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml +++ b/examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml @@ -1,9 +1,9 @@ <?xml version="1.0"?> <Package> - <DisplayName>modify extract operation</DisplayName> + <DisplayName>Modify extract operation</DisplayName> <Description>A component that uses a hook to modify the extract operation.</Description> <Version>1.0.1</Version> - <ReleaseDate>2013-02-27</ReleaseDate> + <ReleaseDate>2014-12-19</ReleaseDate> <Default>true</Default> <Script>installscript.js</Script> </Package> |