QuasarApp/installer-framework
4
0
Fork 0
mirror of https://github.com/QuasarApp/installer-framework.git synced 2025-04-28 22:44:32 +00:00
Code Issues Projects Releases Wiki Activity

Doc: update docs for Modify Extract Installer example

Browse Source 
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>
This commit is contained in:
Leena Miettinen 2014-12-19 11:22:40 +01:00
parent fb25c949f8
commit 5a1b61d27e
4 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
examples/doc/images/qtifw-examples-modifyextract.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB

29
examples/doc/modifyextract.qdoc
View File

@ -32,9 +32,38 @@
\brief Using the extract archive hook to modify the target path. \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 \include installerfw-examples-configuring.qdocinc
\quotefile modifyextract/config/config.xml \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 \include installerfw-examples-generating.qdocinc
*/ */

8
examples/modifyextract/config/config.xml
View File

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<Installer> <Installer>
<Name>Modify extract Installer Example</Name> <Name>Modify Extract Installer Example</Name>
<Version>1.0.0</Version> <Version>1.0.0</Version>
<Title>Modify extract Installer Example</Title> <Title>Modify Extract Installer Example</Title>
<Publisher>Qt-Project</Publisher> <Publisher>Qt-Project</Publisher>
<StartMenuDir>Qt Installer Framework Example</StartMenuDir> <StartMenuDir>Qt IFW Examples</StartMenuDir>
<TargetDir>@HomeDir@/IFWModifyExtractInstallerExample</TargetDir> <TargetDir>@HomeDir@/IfwExample</TargetDir>
</Installer> </Installer>

4
examples/modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml
View File

@ -1,9 +1,9 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<Package> <Package>
<DisplayName>modify extract operation</DisplayName> <DisplayName>Modify extract operation</DisplayName>
<Description>A component that uses a hook to modify the extract operation.</Description> <Description>A component that uses a hook to modify the extract operation.</Description>
<Version>1.0.1</Version> <Version>1.0.1</Version>
<ReleaseDate>2013-02-27</ReleaseDate> <ReleaseDate>2014-12-19</ReleaseDate>
<Default>true</Default> <Default>true</Default>
<Script>installscript.js</Script> <Script>installscript.js</Script>
</Package> </Package>