summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix the default installation location for all examplesLeena Miettinen2015-02-261-1/+1
| | | | | | | | Now they are all located in distinct subfolders of one common IfwExamples folder located in home. Change-Id: Ife92e8d7f7fc33bc1f941f49c75333d0e4fc72d1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Fix dependencies in static buildKai Koehne2015-02-251-1/+1
| | | | | Change-Id: Iae06c6d5a9b1c678a4ab136da145a9c69ccadb6e Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Update CopyrightKai Koehne2015-02-1814-70/+70
| | | | | Change-Id: I8dde6629cfd461104364d5cdc255cb54b58283fa Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Add a translation exampleNiels Weber2015-02-092-4/+15
| | | | | | | | | | Add an example showing how the translation of components works. Also document this. Make translated license files work again. Task-number: QTIFW-469 Change-Id: I3c13ecc9941b09370d0713b19b2683b42454c43c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Link directly to the respective tools from the overviewKai Koehne2015-02-051-3/+3
| | | | | Change-Id: Ifc67d38da7d8018348e41eac18fa23dc5da8acc0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: add defines to qdocconf to suppress doc errorsLeena Miettinen2015-01-291-0/+82
| | | | | | Change-Id: I8871a24d4b28473d7a2079debb02428abf9f8653 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix capitalizationKai Koehne2015-01-261-2/+2
| | | | | Change-Id: Ifa70b0928bd24f8b9be6f627d11d0ae79944cfd9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: update the Controller Scripting topicLeena Miettinen2015-01-231-32/+66
| | | | | | | | | Fix some style and grammar issues. Add some subtitles and some information. Change-Id: Ibf2a3b4ff2a61782b45d772754859b35c7043192 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Don't show checkbox for autodependent componentsjkobus2015-01-231-2/+14
| | | | | | Change-Id: Ia954f6337c188453f05b37725975be98a28d564f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: fix broken linksLeena Miettinen2015-01-211-14/+12
| | | | | | | | | | To get rid of some QDoc error messages. Also remove the \c command to enable automatic linking to scripting API and C++ classes. Change-Id: I317301bd0097059faf6e7696707fc1f0e3ed0beb Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Doc: add the XML requirement for escaping <Leena Miettinen2015-01-211-4/+7
| | | | | | | | | One must use the character reference "&lt;" to escape the left angle bracket within XML elements. Change-Id: I69d3683b3a3b1e9f3e62cb6199e554d13de1f58f Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com> Reviewed-by: Christoph Vogtländer <c.vogtlaender@sigma-surface-science.com>
* no longer use Version as the repository format versionChristoph Vogtländer2015-01-203-6/+5
| | | | | | | | | | | | Use the Version value defined in config.xml as the product version exclusively instead of sometimes using it as the repository format version in components.xml (which must be 1.0.0) and sometimes as the product version. Change-Id: I63864947bf131ac6e246a2aaf6febdda0555c13d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Mark "os" variable as deprecatedKai Koehne2015-01-201-1/+3
| | | | | | | | | | | Mark installer.variable("os") as deprecated, and replace it with systemInfo.productType in the examples. Change-Id: Ic86af21369cd066fc003b268f001101b642f6d2d Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: replace "sections" and "settings" with elementsLeena Miettinen2015-01-194-60/+67
| | | | | | | | | | | As we are describing XML files. "Settings" is still used where appropriate. Also use the angle brackets around element names more consistently. Change-Id: I5c7179212c90d8f2cd55e28af98e7cd785603f4a Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Fix code examples to use 'MaintenanceToolName'Kai Koehne2015-01-191-1/+1
| | | | | | | | | Commit 27390528bd renamed the <UninstallerName> tag to <MaintenanceToolName>. Fix remaining uses of <UninstallerName> to use the new tag. Change-Id: I2a397b7c23e2d3a0e8d8759f24d407cdfd4e5fa5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: add information about control scriptsLeena Miettinen2015-01-192-20/+100
| | | | | | | | Modify the Customizing Installers topic to also discuss Control scripts. Change-Id: I7a140c9bcf913ae914bf4c611f658ecc70c84fce Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Doc: make example briefs more consistentLeena Miettinen2015-01-151-0/+3
| | | | | | | | Make clear that all current examples illustrate how to use component scripts. Change-Id: Id1015912723ed2f8f982d8316c8923e47e4897bc Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Doc: add disclaimer to the C++ class referenceLeena Miettinen2015-01-151-0/+8
| | | | | | | | | | This reference is meant for Qt Installer Developers, not typical users. Change-Id: Ie256e8fceac859380434ce67c84d4024684661ae Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: Fix links to the Qt BugtrackerLeena Miettinen2015-01-131-2/+2
| | | | | Change-Id: I88a6d8de17d7c1cf28f39b39fed8f4cea8618793 Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
* Doc: use the \c command consistenlyLeena Miettinen2015-01-091-15/+15
| | | | | Change-Id: Ida48b05643850e47130cba2e49f357eedbdf41fb Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: update documentation for dynamicpage exampleLeena Miettinen2015-01-091-1/+1
| | | | | | | | | Fix issues in the example files. Use the same values in all config.xml files to be able to use a standard text to describe them. Change-Id: I3a6dae58270906f590cde0c6e234d9bbb75d34f7 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: rename "Scripting" topic "Scripting API"Leena Miettinen2015-01-094-5/+10
| | | | | | | | | To make it clearer what kind of information all the different scripting topics contain. Add a short description of the scripting API. Change-Id: Ie51714265356acaf92880bfddef85dedf8e1ad44 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* rename CreateOfflineRepository to CreateLocalRepositoryChristoph Vogtländer2015-01-081-1/+1
| | | | | Change-Id: I36d7a504b27dfff8b9d10c9d90b6ff77108b9982 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Doc: add the example topic to the browsing sequenceLeena Miettinen2015-01-073-2/+5
| | | | | | | | | Add \previouspage and \nextpage links to the topic itself and refer to it from the previous and next topic. Change-Id: If550e35f87c62a4a98512a2e9bd9aa4a6dd36374 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Add CreateOfflineRepository configuration optionChristoph Vogtländer2014-12-111-0/+6
| | | | | | | | | | Setting CreateOfflineRepository to "true" in config.xml will create a local offline repository, same functionality as "--create-offline-repository" command line option Change-Id: I51b947157ebc27800b1e9ad0b55d139ac6e164b2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: update the Tutorial sectionLeena Miettinen2014-12-1014-19/+38
| | | | | | | | | | | | Updated according to user feedback to make descriptions clearer. Added documentation for all sections in config.xml, explained HomeDir, and added a link to variable list. Deleted an obsolete note. Updated screenshots. Change-Id: I255569f8a09c7c3b996b6e201c5469874027cf60 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Add possibility to specify a control script.kh2014-12-101-1/+3
| | | | | | | | | | | | | Right now we support control scripts just as command line argument, but now we can also bundle it in the binary as well. This helps e.g. with running scripts during uninstallation, enables the possibility to modify the introduction page or enables headless installer builds. Task-number: QTIFW-495 Task-number: QTIFW-166 Change-Id: I6fee6a55db78ed28b1eeb8257a4febaa2703c04e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Introduce a setting for Wizard default height / widthNiels Weber2014-12-091-0/+8
| | | | | | | | | | | | | Setting WizardDefaultWidth / WizardDefaultHeight in config.xml allows to set a default width / height for the wizard window. Minimal size will still be set by the size of the contents. Depending on style, watermark and banner image may override this setting. Default behaviour is unchanged. Task-number: QTIFW-47 Change-Id: I5695d501b2b31ea87ea63e95de454657cfebede6 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: enable linking to qtdocLeena Miettinen2014-12-092-4/+3
| | | | | | | | Replace a fixed link with a dynamic one. Change-Id: Ie0eec3aa67510b84d450057d7dbdbe2376be419b Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Fix capitalisation in list headersNiels Weber2014-12-081-4/+4
| | | | | | Change-Id: I8a979af150322a93fae7282403ce7435acb69e6f Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* add documentation for push buttonsChristoph Vogtländer2014-12-081-1/+23
| | | | | | | | add documentation for the push buttons available on the component selection page. Additional typo fix. Change-Id: Ibb862d6ebfca3ecbaac03ed95b4f78811d47c01c Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Add some example data for RunProgramNiels Weber2014-12-082-4/+5
| | | | | | Task-number: QTIFW-481 Change-Id: I00b863093697857bafcffa7e4a2afc4feee33365 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* fix documentationChristoph Vogtländer2014-12-041-1/+1
| | | | | | | | backslash needs to be escaped in order to be shown in documentation Change-Id: I18fb9ae70b9d02d253ec9b6b0cad9f674d36cd39 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: remove template filesLeena Miettinen2014-12-0261-3594/+0
| | | | | | | | They are now fetched from qtbase/doc/global Change-Id: I6635f3d9af3fd7acf2a12f1c3ec48cf48fa7d140 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* fix documentationChristoph Vogtländer2014-12-021-3/+3
| | | | | | | | | | | Controller Scripting: added missing parentheses to "function Controller", using a script without the parentheses will result in "create Error-Exception: "Exception while loading the component script '<script>'. (SyntaxError: Expected token `(')" when running maintenance tool. Change-Id: I2e432f80ab4e85919d6b7e76fd5b3834e9d30097 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Doc: fix paths to source filesLeena Miettinen2014-11-261-3/+3
| | | | | | | The qdocconf file was moved to a subdirectory. Change-Id: I3b187c975defd260052eca944fa5441a5c52f547 Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: prepare for Qt.ioLeena Miettinen2014-11-265-61/+100
| | | | | | | | | | | | | | | | Brought back the online and offline configuration files, because they will use different templates again. Added an HTML footer needed for other docs than Qt reference docs on Qt.io. Added an HTML file with sidebar content used in the online style. Change-Id: I2f806b955fe86618af64df40db414ba82d81092d Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Allow spaces in RunProgramArgumentsNiels Weber2014-11-172-2/+5
| | | | | | | | | | | This changes the syntax of the RunProgramArguments entry in the config.xml. <Argument> sub tags need to be used to specify the RunProgramArguments now. Task-number: QTIFW-227 Change-Id: Ife007bf660cdcf4ff5e8e31bb9bb5ac2e5037616 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Update Controller documentation and dependent code.kh12014-11-124-104/+416
| | | | | Change-Id: I6f6fb88644722a6acf0d168cc481e854ff188b11 Reviewed-by: Niels Weber <niels.weber@digia.com>
* Allow to check for IFW version in codeKai Koehne2014-11-111-2/+2
| | | | | | | | | | Rename the IFW_VERSION to IFW_VERSION_STR, and add a new IFW_VERSION define that encodes the version in hex. This follows the pattern of QT_VERSION and QT_VERSION_STR, and allows easy checking of the IFW version e.g. in macros. Change-Id: I232c8aa53c9a04522810208cdd1ac595d8676879 Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* New Qt LogoAlessandro Portale2014-10-313-0/+0
| | | | | | Task-number: QTBUG-41685 Change-Id: I62b51a14e8e2f8b3dd75c651d7de577f3276af04 Reviewed-by: Niels Weber <niels.weber@digia.com>
* Add support for passing the scope to operation GlobalConfig.Christoph Vogtländer2014-10-301-1/+6
| | | | | | | | GlobalConfig now additionally accepts parameters "scope company application key value" Change-Id: I17934beff5db1096b9cc01cbc88dbbc8e5fb9d8a Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Add LGPLv3 as new licenseKai Koehne2014-10-161-14/+7
| | | | | | | Change-Id: I61158f956894e209dccf83744b4753774676099d Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Maurice Kalinowski <maurice.kalinowski@digia.com>
* Some more documentation fixes (removes more warnings).kh12014-10-152-2/+3
| | | | | Change-Id: I1efb7f98ac4cccdc4dbd1784806cce286654af9f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Fix c++ documentation creation. Add, fix inline documentation.kh12014-10-084-7/+50
| | | | | | Change-Id: Idd6805afbf5736eebf03c2d1ca6dae272c519634 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
* Set value for empty tags that should provide a default value.kh12014-09-051-1/+2
| | | | | | Task-number: QTIFW-541 Change-Id: Ib899d87be75baaa96b3b15d8a94f660c1a6544e0 Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: add image describing installer typesLeena Miettinen2014-08-152-2/+0
| | | | | | | | Illustrates differences between online and offline installers. Change-Id: I33649c37f08a9ffb809660a97dbfcb7a02dbf5d6 Reviewed-by: Niels Weber <niels.weber@digia.com>
* Doc: clarify offline and online installersLeena Miettinen2014-08-111-15/+27
| | | | | Change-Id: Ic7b88f2811f00fea3e3144e9aa789726f8cb5dbe Reviewed-by: Niels Weber <niels.weber@digia.com>
* Doc: fix syntax of EnvironmentVariableLeena Miettinen2014-07-301-1/+1
| | | | | | Task-number: QTIFW-526 Change-Id: I4de4080f6b7f4a41d5425f19bcf39f2e1e1ce7ee Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Prefer uppercase for RootDir and HomeDirNiels Weber2014-07-181-3/+3
| | | | | Change-Id: If084e32d00b1f1995a00795675b8bc0e2011d72d Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>