summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-26 07:31:36 +0000