summaryrefslogtreecommitdiffstats
path: root/examples/doc/modifyextract.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/doc/modifyextract.qdoc')
-rw-r--r--examples/doc/modifyextract.qdoc29
1 files changed, 29 insertions, 0 deletions
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
*/