summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Doc: add docs for Change UI ExampleLeena Miettinen2014-07-154-9/+23
| | | | | | | | | | | | | | | | Describe the example files. Add example file extensions to the qdocconf file to have all files listed on the doc page. Fix capitalization in the configuration file. Use more descriptive values for the component in the package information file. Rearrange sections to be able to use an include file for documenting all package information files. Add more detailed information about creating the installer. Add image. Change-Id: I64ffff29d08f1dff4cd92c3b796f1a0e6c2fb280 Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: Added doc URL and set the homepage for the navigation bar.Jerome Pasion2014-07-101-0/+3
| | | | | | | -homepage link goes to the index.html page Change-Id: I33b86ce757e63f7bc1f9e9c96cd4f2b12fd0c726 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: remove obsolete doc build variablesLeena Miettinen2014-07-101-14/+1
| | | | | | | | | The HELP_DEP_FILES variable is not used by QDoc for Qt 5. Also changed the app name to IFW. It seems only to be used for the help file. Change-Id: Ib8e1ceeacf55c2aa5f71b67446de0ceb8586a2f6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: add example documentationLeena Miettinen2014-07-096-3/+80
| | | | | | | | Add initial topic skeletons. The contents will be modified in subsequent patches. Change-Id: I33ca4180c7070d5ae2ca20a59f75608289d76344 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Rename settings in config.xml filejkobus2014-07-071-6/+6
| | | | | | | | | | | Rename UninstallerName to MaintenanceToolName (change its default value to "maintenancetool"). Rename UninstallerIniFile to MaintenanceToolIniFile. Change-Id: Ic8ceae80b43c6793ae9b0baacea2ea374a0f90d1 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com> Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: replace \a with \c in .qdoc filesLeena Miettinen2014-07-024-101/+101
| | | | | | | | | | The \a command should only be used in code documentation (in .cpp files), where QDoc uses it to check that all formal parameters are documented and emits warnings if they are not or if they are misspelled. Change-Id: I37710afcd860f9baa3042337aca98fac6701b997 Reviewed-by: Niels Weber <niels.weber@digia.com>
* Add optimized Qt configure flagsKai Koehne2014-07-021-3/+4
| | | | | | | | | Add -skip statements for unneeded modules. Also disable Qt features we don't need, including -developer-build. Change-Id: Ic82d8c0ef9f8cf172a1623268322b028fc74853c Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Christian Stenger <christian.stenger@digia.com>
* Doc: add the list of C++ classes also to front pageLeena Miettinen2014-07-021-0/+1
| | | | | Change-Id: Ic4eb6378f6010cdaa014ea4b8e9ce3f07818eae3 Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com>
* Doc: update copyright year to 2014 in doc filesLeena Miettinen2014-07-016-6/+6
| | | | | Change-Id: I72e840dfb737f8e96edf09e2dce74b29c255c326 Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com>
* Doc: update end user workflow sectionsLeena Miettinen2014-07-0112-21/+34
| | | | | | | | | | | Try to make it clearer what "adding components" means and that the Qt 5 installer is used as an example implementation in these sections. Update Qt 5 installer screenshots. Change-Id: I43f104b3a827b4e69313e01405bb088c52c46817 Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com>
* Drop '-no-opengl' Qt configure argument for OS XKai Koehne2014-07-011-1/+1
| | | | | | | | Compilation for -no-opengl on Mac OS X only got fixed in 5.4, qtbase commit a12ba316161b23b . Change-Id: I74d2cfd6b42c673ee72fbd4977eda92a82618748 Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Linux: Add -qt-xcb to recommended configure flagsKai Koehne2014-07-011-4/+11
| | | | | | | | Also drop trailing './' in command line, and adapt to new Mac naming conventions: The OS is just "OS X", not "Mac OS X" anymore. Change-Id: I95c18080261e54ed8abe1b9307340e834934fb61 Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Doc: generate list of C++ classes and QML typesLeena Miettinen2014-06-204-9/+43
| | | | | | Change-Id: I56e1f94faff2cb8d9817daff4f61958aa53d6d78 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Doc: fixed links to QMessageBox documentationLeena Miettinen2014-06-172-6/+9
| | | | | | | | | | | In Qt 5, you have to specify the index files for the Qt 5 modules that you want to link to for QDoc to find them. If you add the brackets in the end of the method name, QDoc creates the links automatically and you do not need the \l command. Change-Id: Ia3dd78bb17e9c176747d406216930295c9fa02a8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: fixed a broken tableLeena Miettinen2014-06-171-7/+14
| | | | | | | | | | Each row in a table must have the same amount of \li commands, or the table formatting breaks. Use line breaks and empty lines if you want to add several text paragraphs to a table cell. Change-Id: I7a19bc883c0de18c247ca6c550dd37dba64c89d5 Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: replace "Max OS X" with "OS X"Leena Miettinen2014-06-176-13/+13
| | | | | | | | According to Apple naming conventions. Change-Id: I4e7e5334987543118ae18d8547f58d01260f2493 Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com> Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: replace \o with \liLeena Miettinen2014-06-178-374/+374
| | | | | | | | | The \o QDoc command has been deprecated in QDoc for Qt 5 and using it prints a QDoc warning. Change-Id: Ibf0be59f3953bd731c2133cee3ec399e51df84a5 Reviewed-by: Kai Koehne <kai.koehne@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Remove some Qt 4 stuff from docs.Niels Weber2014-06-1712-664/+53
| | | | | | Change-Id: Iaef27f4a9e069f2bb4aa2fa1824be77af264d921 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix tutorial examplejkobus2014-06-062-5/+1
| | | | | | | | | | | | - remove translations part - replace installation dir (root) with home in order to properly finish the installer wizard with default values - AllowSpaceInPath is now true by default (ChangeLog updated) Change-Id: I84e372ac4da05964d90851bf592fc87ee9409e3b Reviewed-by: Kai Koehne <kai.koehne@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Fix Qt configure line to make a non-install buildKai Koehne2014-06-051-2/+2
| | | | | | | | | | | | You almost never want to have the default installation path for your static Qt. Also remove the '-opensource' part, so people are asked which license they have / use. Change-Id: Ifefe9c7256aaf7aafa8104bff8adac02584d0a81 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* Improve documentation on how to build the Installer FrameworkKai Koehne2014-06-051-10/+16
| | | | | | | | | Make it clear that you only need to build Qt statically if you want to compile the Installer Framework on your own. Change-Id: I45555679197e2cb7143934e9e37ac5afcb9a71cc Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com>
* Update configure options for Windows (Qt 5)Kai Koehne2014-06-031-3/+3
| | | | | | | | Fix the configure options for Windows. Also update the options in the documentation according to the latest changes to INSTALL. Change-Id: If9f4cd7b954fabecd80d0e38615790342367600e Reviewed-by: Niels Weber <niels.weber@digia.com>
* Cleanup to support Qt5 only.kh12014-06-021-9/+2
| | | | | Change-Id: Ib8f61229ce2f07e52c22a15e10dc817aca860ead Reviewed-by: Niels Weber <niels.weber@digia.com>
* Initialize {All}UserStartMenuDir and DesktopDir earlier.kh12014-04-241-2/+12
| | | | | | | | Task-number: QTIFW-346 Change-Id: I641d6c2eb6b74f674b61ccf335885d4577dfcfe4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Make the installer binary paths available for scripts.kh12014-04-091-0/+6
| | | | | | | Task-number: QTIFW-424 Change-Id: I36e22323cac9991982f3f85481700c75371eab3a Reviewed-by: Niels Weber <niels.weber@digia.com>
* Merge remote-tracking branch 'origin/1.5'Oswald Buddenhagen2014-03-272-11/+8
|\ | | | | | | | | | | | | Conflicts: installerfw.pri Change-Id: I8bd85997fef0fcfa21a4dd28a6362748a54a4a3b
| * Fix typos in comments and documentationSergio Ahumada2014-03-052-2/+2
| | | | | | | | | | | | Change-Id: I03d99ae5eb9266195ff9ab1c73b5ebd8e548e6bc Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
| * doc: More fixes for repogen documentationSergio Ahumada2014-02-111-5/+2
| | | | | | | | | | | | | | | | | | - Remove '-c config' from docs - Remove '--updateurl' from docs Change-Id: I2a7a6d3ffd370527ab3d72a2db7c120355f1931f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
| * doc: Fix minor typosSergio Ahumada2014-02-111-4/+4
| | | | | | | | | | | | | | | | - config.xml -> package.xml - Update.xml -> Updates.xml Change-Id: I94cd1b316a8591f24cea50153f071976800ed771 Reviewed-by: Niels Weber <niels.weber@digia.com>
* | Merge remote-tracking branch 'origin/1.5'Tim Jenssen2014-02-073-18/+15
|\| | | | | | | Change-Id: I75a37b5dce14d454c404eda4f0c7b0b61ca66cf7
| * doc: Discourage use of '-c config' for repogen toolSergio Ahumada2014-02-071-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | '--config file' was deprecated in 9561e4cd6185b461646d1910e80bc849b677711d but not reflected in the documentation, so removing the references to it. Also fixing a typo where the 'repository' parameter was duplicated repogen.exe ... repository <repository_directory> leaving only <repository_directory> as follows: repogen.exe -p <package_directory> <repository_directory> Change-Id: I547e7fd68b19ef42afdd096572216c8e2261f03a Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * doc: Fix directory structure for 'packages' dirSergio Ahumada2014-02-051-11/+11
| | | | | | | | | | | | | | | | | | Indent the subdirectories a bit to get a better idea what they should look like. Change-Id: I0d4e4e32723e7e00148956123241ed4f818c16f3 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * config.xml: Discourage use of <Icon>Sergio Ahumada2014-02-051-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | <Icon> is deprecated according to the documentation, so better tell people to use <InstallerApplicationIcon> and/or <InstallerWindowIcon> instead. Also moving up the settings to the same position they appear in the documentation. Change-Id: I8fe468ba9c362f1abbeb69809eb25e2c51204b25 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
| * tutorial: Fix typoSergio Ahumada2014-02-041-1/+1
| | | | | | | | | | | | | | | | | | Using backslash on Linux you get the following error: Error: Config file configconfig.xml not found at the specified location Change-Id: I0d48df0c7be2d186c83da0740d50c8f7a06215d2 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
* | Merge remote-tracking branch 'origin/1.5'Tim Jenssen2014-01-174-19/+31
|\| | | | | | | Change-Id: I64c405bdefa700e614b9a9d8f24f490856322d04
| * Add a line to documentation that operations are threaded.Niels Weber2013-12-061-0/+1
| | | | | | | | | | | | | | Task-number: QTIFW-251 Change-Id: I51488889e3d68a10d5f54856f538eeb50eb00ff1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
| * Document the existence of addElevatedOperation.Niels Weber2013-11-221-0/+2
| | | | | | | | | | | | | | | | Task-number: QTIFW-407 Change-Id: I885cc8432ceffae48e94f165f415baa0e54155c2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
| * Introduce ApplicationsDir variable.kh12013-11-061-1/+4
| | | | | | | | | | | | | | Task-number: QTIFW-258 Change-Id: Ie08884c01c62e40104dce0dba8ef85c5194d7207 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * Build installers with accessibility pluginTim Jenssen2013-10-251-2/+2
| | | | | | | | | | | | | | | | | | This change makes the installers work with screen readers. Task-number: QTBUG-34296 Change-Id: I87cf313657d9eaa31f4cd89729b4e298880ae99e Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
| * Doc: Add note that root component can't be virtual.Niels Weber2013-09-231-0/+1
| | | | | | | | | | | | | | Task-Number: QTIFW-274 Change-Id: Ia5558c3ac60d1d01183cb4397f7e2c000b61a1c9 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * Clarify wizard usage of Banner and Background.Niels Weber2013-09-171-2/+2
| | | | | | | | | | Change-Id: Ia9e994cec8e94a517331c1c2b4b9dc2afde21570 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * Add support to pass a query string when downloading archives.Niels Weber2013-09-131-0/+4
| | | | | | | | | | | | | | Task-number: QTIFW-329 Change-Id: I645370f03958164905c064d1dcf0be97fd8dc039 Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
| * improve RepositoryUpdate docTim Jenssen2013-09-111-14/+15
| | | | | | | | | | | | | | | | - make clear that there is only one RepositoryUpdate section Change-Id: Ia2c2ea8d97f706c6318747745a327e4c07c9bbeb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
* | Allow setting the color of page titles and subtitlesDavid Kaye2014-01-091-0/+4
| | | | | | | | | | Change-Id: I826e35536b4c337e0008fed82cfea4c3cf5cb080 Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
* | Allow users to select installer styleDavid Kaye2013-10-081-0/+3
|/ | | | | | | | Add a "WizardStyle" tag to config.xml that takes values "Modern", "Classic", "Aero" or "Mac" to force the style. Change-Id: Ibd6c329a6b159c202fa7a7aa535b36e00c544079 Reviewed-by: Kai Koehne <kai.koehne@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>