Commit Graph

97 Commits

Author SHA1 Message Date
Mitch Curtis
636ee3e91d Doc: rename Tips and Tricks to How-tos
This is based on Qbs' how-tos documentation:

https://doc.qt.io/qbs/howtos.html

I find this format easier to follow, both because of the phrasing of
each section and the fact that it doesn't rely on the table of contents
to list the contents, which is squished into a tiny word-wrapped
section on the left of the page in the online documentation.

Change-Id: I46a0751a55e7f34458392c56e12c2e301adde234
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-10-29 10:24:04 +00:00
Leena Miettinen
99c0d3332e Doc: Add info about building apps for the web
Users have to install Qt for WebAssembly and the tool chain,
as well as add a kit.

Fixes: QTCREATORBUG-22927
Change-Id: Id22d5fb5e7d9e676d77f3f80880030cb9c1f61c7
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-09-18 06:56:04 +00:00
Leena Miettinen
526163cc16 Doc: Add info on Live Preview
The documentation was moved from the Qt Design Studio repository
and edited to make it applicable to Qt Creator, too.

Change-Id: I3072fc712b5ee002cd6e7486927de31f9117d7bc
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2019-07-11 12:51:31 +00:00
Leena Miettinen
682b3079d2 Doc: Add a link to Acknowledgements to the front page
Change-Id: I405ceb8a4490c94c5ad695f06fb902c0a3f154a2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-06-28 07:06:13 +00:00
Leena Miettinen
a0083d06fd Doc: Remove product name from headings
The context of the whole manual is Qt Creator.

Change-Id: Ie63911c136ff98dfa6b0157d17a054a91a35fb11
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-06-19 12:53:01 +00:00
Leena Miettinen
b1fcbfecce Doc: Add a link to a site map (TOC) listing all topics
Change-Id: Ibb71a67874d0146298c6bbed420549660426e0ca
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-25 09:30:31 +00:00
Leena Miettinen
03dce9a65f Doc: Use the umbrella term "device" for both mobile and embedded
Add a glossary entry for "device" to make changing the definition
easy and link the first occurrence of "device" in a topic to it,
where applicable.

Change-Id: Ia1b8b669b0000eea47d6a7b9860d3329d93a4395
Reviewed-by: Vikas Pachdha <vikas.pachdha@qt.io>
Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-08-18 14:53:27 +00:00
Leena Miettinen
0ed42f1c9f Doc: Move the TOC to a separate page that is used as indexTitle value
This fixes the problem that the whole TOC is not visible in the
Qt Creator Help mode Contents view (because it was generated based on
the \table entries, not the \list entries).

Task-number: QTCREATORBUG-10585
Change-Id: I86607e10db7172b2a7492e4ce1660c39390ef9ed
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-03-09 09:13:27 +00:00
Nikolai Kosjar
96256d1ecc Doc: Re-work clang documentation
* Remove the build instructions because they are not end user relevant
  and belong into Qt Creator's README.md.

* Restructure into the sections "About ...", "Activating ..." and
  "Configuring ...".

* Simplify/clarify here and there.

Change-Id: I7b3abd03bc4fe9215db804a4cd69e9d796b8bf9b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-11-28 12:59:29 +00:00
Leena Miettinen
49d7045cc7 Doc: Move vcs-system specific sections to separate topics
This is done in preparation for moving some Qt Creator
plugins and their documentation into their own repositories.

All the changes have to do with the structure of the documentation.
There are no content changes, except removing headings or changing
them to better fit the new structure and adding some leading
sentences or links.

Change-Id: I1499187121a1a1cc3c6b635801fb540ac439fd0b
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Hugues Delorme <delorme.hugues@fougue.pro>
2016-11-23 11:07:07 +00:00
Leena Miettinen
ff4435c4da Doc: Describe the Help > System Information menu item
Change-Id: I95a179b9414a2b417d6f8d03a3dce51f8a2f733b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2016-10-24 07:48:12 +00:00
Leena Miettinen
d2e99f9e55 Doc: Add docs for SCXML Editor
Change-Id: I563a2a06b101e3954c3365baba4a596ef29517ab
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2016-10-06 14:05:26 +00:00
hjk
1e8ffa20d0 Doc: Introduce a macro \macos to adapt to upcoming renamings
Start with an initial value 'macOS' and use in uncontroversial
places in the docs. Some explicit references to older versions
are untouched in this patch.

Change-Id: Ibea4115c45fc2ff2c9a0518d92797df26fd4138f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-08-03 15:30:06 +00:00
Tobias Hunger
43800a6aa8 Update License according to agreement with Free Qt Foundation
* Update license in documentation files. Stay at FDL, but update
  URLs as well as license for examples, etc.

Change-Id: I5e8cb5a20f0e9d52fba1d937b7c73197d69dd747
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2016-01-19 13:09:03 +00:00
Leena Miettinen
50cbb30911 Doc: remove extra column from table on front page
Change-Id: I8ed573305d209f887a6e65623b5a40173493df73
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-11-20 11:12:56 +00:00
Leena Miettinen
c2a2883c4a Doc: move the "Modeling" section to end of "Coding"
Because the model editor does not generate code from the
diagrams and is therefore mainly meant for documenting code.

Change-Id: I43d2dd3436df4914f5be6f8b2f52586de1522138
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
2015-11-19 12:43:22 +00:00
Leena Miettinen
d5decff558 Doc: rearrange the table on the front page
...into two rows instead of three.

This looks more symmetrical and seems to fit on the
screen also when using a low resolution.

Change-Id: Id2f9a7182a6a260036f3d8913058fd2aa7c24c57
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-11-16 09:34:48 +00:00
Leena Miettinen
7ed574945a Doc: add docs for ISO Icon Browser
A commercial Qt Quick Designer plugin for
adding ISO 7000 icons to applications from
an icon library.

Change-Id: I96d740d63bc77da9817ce2d5ccdb1625dbc5caa6
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-10-27 14:48:02 +00:00
Leena Miettinen
c4872962cd Doc: add docs for model editor
Change-Id: I6bae6dc22de170c9f43cefe474e9b684675e4ff6
Reviewed-by: Jochen Becher <jochen_becher@gmx.de>
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2015-10-22 11:49:19 +00:00
Leena Miettinen
2108b2de6f Doc: Qt Quick Designer features are no longer commercial only
Change-Id: Ic908670b3f8be7491e2639b3a2d524382580d7e5
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2015-09-25 14:57:34 +00:00
Leena Miettinen
78d304674f Doc: developing for embedded devices
Add information about Qt for Device Creation
integration with Qt Creator. Add links to the
Qt for Device Creation documentation where
appropriate.

Change-Id: Ie9be5a65697681590e2131407432f826a5ab4f2e
Reviewed-by: Rainer Keller <rainer.keller@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-08-26 11:24:24 +00:00
Leena Miettinen
36173e25ff Doc: add UI Forms tutorial
Based on the Qt Quick Controls UI Forms example.

Change-Id: Iec42b7559161f980e4f482c63bfc40a22f5e77f8
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-06-26 13:10:30 +00:00
Tobias Hunger
5b77a3a8c1 Blackberry: Remove blackberry support
Keep QNX.

A short informal search did not turn up any more blackberry users,
even though there is interest in QNX. So this patch removes the
platform: We had no contact with the maintainers in months, there
are no changes going into the code for about as long.

I am not even aware of anybody testing the platform, so any
remaining users are probably better of with Qt Creator 3.2 or so
where the code was extensively tested.

Change-Id: Ibeda6bfd8565599918cfcc08fd01cb5ed8793dc2
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2015-04-30 11:15:53 +00:00
Leena Miettinen
8c472f2074 Doc: experimental Auto Test plugin
Commercial only.

Change-Id: Id2ee9a7765f226c32ec1595e32f4b53ee94d1207
Reviewed-by: Christian Stenger <christian.stenger@theqtcompany.com>
2015-04-08 08:13:08 +00:00
Leena Miettinen
87e01423c9 Doc: Add documentation for CPU Usage Analyzer
Change-Id: I306a009dceba74707b5802b18451c7ae912adac9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-04-02 09:05:19 +00:00
Leena Miettinen
20ad8e01c2 Doc: add an overview of commercial features
Change-Id: I6eb0a4bb415d2eb004aaabfc7572789e1eb74512
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
2015-03-25 13:11:27 +00:00
Eike Ziller
3c85058694 Update License
Change-Id: I711d5fb475ef814a1dc9d2822740e827f3f67125
Reviewed-by: Alessandro Portale <alessandro.portale@digia.com>
2015-01-16 12:37:56 +01:00
Leena Miettinen
3b86184d12 Doc: adding JSON-based custom wizards
Task-number: QTCREATORBUG-13642
Change-Id: Ie3af0d4bdef33364cc442449ccfb5e770c0c3a99
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2015-01-07 10:21:07 +01:00
Leena Miettinen
36f8765596 Doc: prepare for describing JSON-based wizards
Move XML-wizard specific information into a separate file.

Change-Id: I7fe80c28747fa20d274eae7d3bf0b65f3624fd20
Reviewed-by: Alessandro Portale <alessandro.portale@digia.com>
2014-12-12 15:08:41 +01:00
Leena Miettinen
e1fbeedcd4 Doc: use \uicontrol command instead of \gui macro
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-12-12 10:26:59 +01:00
Leena Miettinen
15a18c83d9 Doc: Qt Quick Designer extensions
Move the documentation for commercial features from a separate
manual to the Qt Creator Manual.

Change-Id: Ifc8f10bda4a2a234e4b81f812601ce2ceb104ddd
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2014-12-04 11:09:08 +01:00
Leena Miettinen
2d7af0d732 Doc: experimental Clang Static Analyzer plugin
Available in Qt Creator Enterprise.

Change-Id: I22a8ef1edb87b42a2568cf5b1f5f911663d5e5f6
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@theqtcompany.com>
2014-11-05 12:29:41 +01:00
Leena Miettinen
9a7f4cae00 Doc: using UI forms in Qt Quick Designer
New concept in Qt Creator 3.3 and  Qt 5.4.

Change-Id: I24cacd4c98bb6873625d5cda44a78d5ba0ad8f5b
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2014-10-29 14:39:48 +01:00
Leena Miettinen
8ddf682885 Doc: update changed Valgrind menu item names
Update screen shot.

Change-Id: I255f4b8c620ad89239a20c0c211ed60961db1ade
Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
2014-05-13 09:38:20 +02:00
Leena Miettinen
d59d8b568d Doc: replace "Mac OS (X)" with "OS X"
Change-Id: I77f1cbbfc17d759d1587caf2a25a53498848e2ca
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-05-06 09:35:45 +02:00
Leena Miettinen
2301025c1d Doc: update the Android tutorial to also cover iOS
Rename as "Creating a Mobile Application".
Add the steps necessary for deploying to iOS devices.
Fix the link in the Tutorials tab in the Welcome mode.

Change-Id: Ie72bf087c789d8d1299b9b5ac19ad732da534012
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2014-04-01 14:01:36 +02:00
El Mehdi Fekari
5d5e98f0db Doc: Remove unrelated Qnx details
The creator-deployment-qnx contains details about deploying
BlackBerry projects using the BAR file descriptor, which doesn't
apply for all pure Qnx plarforms.

Change-Id: Iecfc2626b0de4ed016ef937b410e439c3bdc740a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-03-25 11:09:31 +01:00
Leena Miettinen
19b52fb509 Doc: using experimental WinRT plugin
Change-Id: I669048c839dc7d78984923b21f6bfba69d551a43
Reviewed-by: Andrew Knight <andrew.knight@digia.com>
Reviewed-by: Oliver Wolff <oliver.wolff@digia.com>
2014-03-11 11:10:03 +01:00
Leena Miettinen
9bf9f165ba Doc: add docs for the Beautifier plugin
Change-Id: I0af00a27ff8b070669578a1c5158882b2e610e24
Reviewed-by: hjk <hjk121@nokiamail.com>
2014-03-05 15:32:20 +01:00
Leena Miettinen
5bd4dd7a35 Doc: experimental Clang code model plugin
Change-Id: I6a9e13a3eed055f3daa5497b7fed858f1ddad2c5
Reviewed-by: hjk <hjk121@nokiamail.com>
2014-02-17 10:46:27 +01:00
Leena Miettinen
b32e5c4ed0 Doc: make the Android setup instructions more prominent
Feedback from users indicates that they cannot find the
instructions for setting up the Android development environment.
Added links to the instructions in several high level topics.
Also, moved the Qt 5 instructions above the Qt 4 instructions
in "Connecting Android Devices".

Change-Id: Ie31bc27b959ac5a7146f00a576a900b932c07a98
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
2014-01-20 12:12:16 +01:00
Robert Loehning
746c5d8863 Incremented year in copyright info
Change-Id: Ib5423fdd064e4546f848c0b640b0ed0514c26d3a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2014-01-08 08:29:47 +01:00
Leena Miettinen
8e81367ca6 Doc: remove the Publishing topic
Qt Creator does not have publishing wizards anymore.
Left a short description in the IDE Overview topic and
removed all other information and links.

Change-Id: I3c49648779a19036d200e1dec4f46116197c18e7
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-11-06 11:46:28 +01:00
Leena Miettinen
6a7adb1745 Doc: fix link to Getting Started from front page
The link to next page pointed to the wrong page.

Change-Id: I5544df8ed2ef64aa98ae356d7e2a33c968794302
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-11-01 11:25:13 +01:00
Leena Miettinen
a2eba90b23 Doc: Debugger options in Build & Run options
Describe the new options dialog for adding debuggers.

Change-Id: Ic4f4041bb38f3e75aaa964543aaaaa7c0f7f7924
Reviewed-by: hjk <hjk121@nokiamail.com>
2013-10-31 12:00:21 +01:00
Leena Miettinen
59fd03abc3 Doc: fixing the table on the front page
The table broke when the Publishing section was removed.

Change-Id: If39dd5842a267500bc5c8ef0d39b397d06a101a2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-10-21 14:05:54 +02:00
Christian Kandeler
0ee5389017 Remove support for Madde-based platforms.
With Nokia's decision to stop support for Harmattan applications
in their app store, the last remains of a use case have disappeared.

Change-Id: Ia036112de01c8c3a866da3529b4a941db11c7358
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-10-15 10:27:28 +02:00
Leena Miettinen
6c0ef3670c Doc: reformat front page
Remove bullets from top-level items.

Change-Id: I1c8bbe55f2ce17163b6df6a75c50543e67b0d251
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-10-11 12:49:38 +02:00
Leena Miettinen
bd9c842a38 Doc: restructure UI design section
Remove graphics and combine some short topics to
put more weight on Qt Quick development instead of
generic UI development.

Change-Id: Ief2041022e0ccb407c26b0742825613223082f0a
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2013-10-08 13:02:17 +02:00
Leena Miettinen
9fbf0ac1b0 Doc: Bare Metal Devices plugin
This topic needs more information about the
necessary Qt version and the "fake Qt" mentioned.
Also, I cannot try this in practice myself, so
steps might be missing.

Change-Id: I143a54b8559840c3e9ad6dd5d293de160d67867d
Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
Reviewed-by: hjk <hjk121@nokiamail.com>
2013-10-07 21:18:46 +02:00