Commit Graph

1400 Commits

Author SHA1 Message Date
Leena Miettinen
c25c54d454 Doc: Update info about using Qt Quick modules with plugins
- Some steps are not needed when developing with Qt 6.2 or later.
- Removed obsolete information.

Task-number: QDS-11794
Change-Id: Ifbfc0bacd50557892ac82658379098123f463a2b
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-04-08 08:00:11 +00:00
Eike Ziller
309a01337f Merge remote-tracking branch 'origin/13.0'
Change-Id: I12578a55fb61a3a9620c749c0b3bbbae6dcb4493
2024-04-02 14:54:30 +02:00
hjk
272cfad5b4 Doc: Don't mention qmake in a docker context
While it kind of works in principle it is very slow and therefore
practically not usable for real world projects.

Task-number: QTCREATORBUG-29585
Change-Id: Ia6357904e1ecc3e97adc77b49aa8ab7392f902c8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-28 10:32:41 +00:00
Leena Miettinen
1fdb2cbe53 Doc: Update screenshots to use the new numbers
Some writing style changes.

Change-Id: Ia0e0260b55693ef576491497fb6cbec23e37be97
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-27 03:46:44 +00:00
Tim Jenssen
8a18423175 Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: I28e2e8cacf9a20c8b2f5073f4a492862d814fb99
2024-03-26 15:59:34 +01:00
Leena Miettinen
a59c93d20b Doc: Update info about resetting the QML code model
- Add the case where you cannot see your new QML module.
- Remove obsolete use case and message.

Task-number: QTCREATORBUG-29826
Change-Id: I29c2852d32007c64e343bcbe30a1d218f9ff89d3
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-26 14:03:38 +00:00
Leena Miettinen
36fdb81aef Doc: Move "Inspect QML and JavaScript" to "Move in QML code"
...from "Check code syntax".

Remove redundant text.

Change-Id: Ida75dae0f97881437d20a0d2167e1e4afde6ed2f
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-26 12:28:57 +00:00
Leena Miettinen
4bc12d6671 Doc: Update screenshots with new number or of the Welcome mode
Change-Id: I5685c9b42e31cdad79a7f6a6a90e4754a5f76cbc
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-26 10:11:29 +00:00
Leena Miettinen
5f4a8d3130 Doc: Update the online sidebar TOC
- Fix a link
- Add Reference categories
- Move Version Control Systems up in the TOC

Change-Id: I6b6f9562c581ce8b78503d7e70ce132a0e9253a7
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-26 10:11:03 +00:00
Leena Miettinen
b97225ae64 Doc: Fix typo "speficy" > "specify"
Change-Id: I96bc2874eef6edfac3548d79b2bef6b9a687809a
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-25 12:54:01 +00:00
Leena Miettinen
5e7ba23ed6 Doc: Update more screenshots with numbers and some of the numbers
The outlines of the numbers from 8 through 10 were blurry when
copy-pasted.

Task-number: QTCREATORBUG-30209
Change-Id: I2db64931fb8f16567a8890b1aa6d91f80defc573
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-25 09:57:52 +00:00
Leena Miettinen
45f8245dd1 Doc: Describe running as root user on macOS
It was only described for Linux.

Fixes: QTCREATORBUG-30517
Change-Id: Ice1f1d227c5576775a460243ab2b126fcae7d14c
Reviewed-by: Robert Löhning <robert.loehning@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-25 09:54:41 +00:00
Eike Ziller
8500dd03bf Merge remote-tracking branch 'origin/13.0'
Conflicts:
	doc/qtcreator/src/overview/creator-only/creator-keyboard-shortcuts.qdoc

Change-Id: I2db85da9f4a0593217951313020d71d430986961
2024-03-22 15:13:34 +01:00
Leena Miettinen
aa7f711c54 Doc: Add new number icons for use in screenshots
Change-Id: Id128b889eb89153148971c9ada80d30f32560fb6
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-22 13:27:33 +00:00
Leena Miettinen
2c21ea8d06 Doc: Add links to "Adding Docker Devices" from relevant topics
The link from "Build for many platforms" I already added as a
part of another change.

Fixes: QTCREATORBUG-30299
Change-Id: I690c8f5755896a7f8c7b8e34ba6b262f6ce96bfd
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-03-22 13:02:33 +00:00
Leena Miettinen
e31942fb23 Doc: Organize the front page into four columns
Lots of the information from the first column will still
move into the How To and Reference sections in future releases.

- Remove obsolete sub-TOC topics.
- Rename the "Overview" as "Developing with Qt Creator" and place it
  first in the TOC.

Task-number: QTCREATORBUG-29361
Change-Id: I8af0460b2391f3152606e5326bb7e8f630f64531
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-22 12:54:45 +00:00
Leena Miettinen
1d086c5479 Doc: Add descriptive text for how-to and reference topic categories
- Move some topics to other categories.
- Edit some \brief text for consistency.

Task-number: QTCREATORBUG-29361
Change-Id: I37d0ff5aef6121e1c3bc552fb802188271f4b913
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-22 10:25:17 +00:00
Eike Ziller
ff08e30b0a Doc: Improve the description of default build configurations
- Consistently use emphasis and case for configuration names
- Do not promise *separate* debug information for "Profile". CMake
  doesn't have that option
- Add information about "Release with Debug Information" for CMake and
  the difference to "Profile"

Fixes: QTCREATORBUG-30581
Change-Id: Idd53b11d3dd45121a34a41f12e48ea5339fd61c1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-22 08:51:44 +00:00
Teea Poldsam
2128776e16 Doc: Add menu bar to shortcuts and ui topics
Fixes: QDS-12286
Change-Id: I8f8eb7e443ef94d54c5a9868a6f1f4c00a138832
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-03-22 07:21:48 +00:00
hjk
68772325cd Doc: Point to the pull-down menu of the debug mode button
... for starting analyzer tools. It's not very prominent in the UI.

Change-Id: I476d45b4f82a4b363fa4e33858261283850ff654
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 14:16:30 +00:00
Leena Miettinen
9e1c513167 Doc: Add direct links to reference topics to the front page
Add links to "Version Control Systems" and "Views"

Change-Id: I7a3865bde35912307be3b86fd19c2387cb755cba
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-21 12:21:14 +00:00
Leena Miettinen
78f3dfad87 Doc: Make the \page value consistent with that for other tutorials
Fix the link in the TOC sidebar online.

Change-Id: I4522c7b65be6498797e5945f3e9c6dc4b4f3966b
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-21 12:00:12 +00:00
David Schulz
550862ce51 Doc: Expand description of the python kit selector
Mention that a virtual environment is created by default and that the
global interpreter can be accessed under the details of the kit.

Change-Id: I276f1a594b0726914925b2b565eace43182342f4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 11:17:05 +00:00
David Schulz
4bebb11578 Doc: add infos to the generated requirements.txt for python projects
Change-Id: I70b0e0bdb3b026bf082294c66659d901a30954f3
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 07:33:49 +00:00
Eike Ziller
9fe7922058 Doc: Small improvement of the locator pages
It was unclear what "file type" was meant. The available filters could
depend on a lot of other things, but I guess "current document and
project" is ok as a baseline.

Clarify what list of filters is meant, that is the list that appears when
the locator input field is empty. Mention the list that is shown when
selecting the magnifying glass. The descriptions in the preferences is
not longer than what appears in the tool tips, so remove that reference.

Mention the Magnifying glass > Configure menu item as an option for
opening the preference page.

Change-Id: I7d16d3f3eed11cce0aff9dcaf7e467fe0508366e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 07:13:29 +00:00
Leena Miettinen
d644632382 Doc: Remove references to CMake from a qmake-specific topic
Fixes: QTCREATORBUG-30580
Change-Id: Ic722ca8c6cfcf570aec48eb957ebfdc2ec929011
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-20 15:59:21 +00:00
Christian Kandeler
2cacb1444c doc: Update tutorial for creating mobile app
Change the wording so it no longer suggests we are shipping an outdated
CMake.

Change-Id: Ifa1d44017eb66fffd7b3dff17b2d5af2e247cca5
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 14:35:42 +00:00
Eike Ziller
90e1d96019 Merge remote-tracking branch 'origin/13.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	doc/qtcreator/src/overview/creator-only/creator-keyboard-shortcuts.qdoc
	qbs/modules/qtc/qtc.qbs
	src/plugins/remotelinux/linuxdevicetester.cpp

Change-Id: I8434e41dcfbb50f6ed032a3e0af1591eb19b79eb
2024-03-20 15:05:58 +01:00
Marcus Tillmanns
9ed9d6fc8a Doc: Reword beginning of creator-keyboard-shortcuts.html
Change-Id: Id1f736c7855002d3ecd8c600d9897ae81c83947c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 13:56:49 +00:00
Marcus Tillmanns
dd2942d157 Doc: Improve "Manage files in CMake projects"
Change-Id: I2fa40b005f534bc71789d4fd834307c7dca1b867
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 13:53:00 +00:00
Teea Poldsam
5319fae46e Doc: Fix QDS docs warnings
Fixed some formatting issues and updated some links.

Fixes: QDS-12247
Change-Id: Ibca5791f8c2f6cbda50f604892d131787910804c
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-20 13:39:47 +00:00
Christian Kandeler
0a4b0e71d3 doc: Clarify which settings page to switch the theme in
While "Interface" is the first (and therefore default) tab, the user
might have visited a different one before, in which case it will become
the new default and the user will look in vain for the theme setting
there.

Change-Id: I66d3035d16aa75162616d08a021bc43c906a7133
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 12:26:41 +00:00
Christian Kandeler
c16e15f37b doc: Update information about main build system
Also clarify that the set of supported build systems is not fixed.

Change-Id: Ida2588c599a4fc4deadfd62b10fb47c2bbda5457
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:59:13 +00:00
Christian Kandeler
f75e26005f doc: Specify that the list of pre-configured build configs is not fixed
E.g. cmake has five of them.

Change-Id: I8521c99335b9b31a7ab5f9691de9639394450fd1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:51:01 +00:00
David Schulz
a3668827aa Doc: improve create python project tutorials
Use consistent paths in screenshots and instructions. The paths from the
screenshots are preferable since they are not inside a default Qt
installation location.

Change-Id: If9f0bca58a13a66559eae953ccaf19abb2dc7e14
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:14:41 +00:00
Eike Ziller
3ad0f8900b Doc: Improve iOS documentation
- make it clearer that the restrictions are only for iOS 17 devices
- refer to Xcode 15 instead of 7
- remove wrong and not very useful section for checking/changing Xcode
  version
- fix screenshots

Change-Id: I1d574ee775c6e1a9db1df8b60b6e5b8aa9dd057f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 10:48:55 +00:00
hjk
5eca9c5614 Doc: Rename "Export SVG images" to "Create pixmaps from SVG images"
Also switch the order with 'View Images', which is likely the more
common use case.

Change-Id: I2a047141976b7ec7a45cf930be5bf972a766d183
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 08:35:23 +00:00
Leena Miettinen
9884620724 Doc: Remove "Coding", "Finding", and "Configuring the Editor"
- In the QDS Manual, edit the "Code" view docs
- In the QDS Manual, add topics related to coding to the "Code"
  view docs by using \ingroup and \generatelist commands

Task-number: QTCREATORBUG-29361
Change-Id: I0966986a3b01b3551e8b68265e22fe86d1d5933d
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-19 12:37:53 +00:00
Leena Miettinen
05b640abc0 Doc: Turn "Checking Code Syntax" into how-to and reference topics
Task-number: QTCREATORBUG-29361
Change-Id: I96c4384dbde04189be3c80c3b21ee09ca33fb90c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 12:37:45 +00:00
Leena Miettinen
fadfb93b8e Doc: Fix broken links
- Add a dependency to qtqmltest (Qt Quick Test)
- Fix an internal link
- Fix capitalization in links to Qt docs, which now
  seems to matter
- Add the "Qt Qml" link as an external resource, so it works
  regardless of the Qt version used

Change-Id: I0550973237b0df7b328ca202a4188d970af3417d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 10:58:21 +00:00
Leena Miettinen
85b3413daf Doc: Fix the value of \page for "Link projects with GitLab"
Using the same value for two topics hides the old topic, but
QDoc did not complain during local builds.

Change-Id: Id5d927cca60c9d288323429c99969475c9ecd15b
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2024-03-18 10:34:11 +00:00
Leena Miettinen
10858b1f68 Doc: Fix minor language issues in Axivion docs
Some text had gone missing.

Change-Id: I9b699f8b47d5897b11dae7aafa8c738f95774abf
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-03-18 09:28:28 +00:00
Leena Miettinen
e7351a8024 Doc: Add links to docs for project-specific settings
...to "Configuring Projects"

Turn "Linking Projects with GitLab" to a separate how-to
topic.

Some style edits.

Change-Id: I3fd68b303126770965c7ca68ca2e041daf593d74
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2024-03-18 07:39:15 +00:00
Leena Miettinen
4fa5422026 Doc: List Tutorials as a separate category on the front page
Add the following topics to the creator-tutorials group:

- Building and Running an Example
- Debugging a C++ Example Application

Task-number: QTCREATORBUG-29361
Change-Id: Ib6de92e99caf552ee8337b49af48bd04d6760474
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:17:06 +00:00
Leena Miettinen
9fa1dbcd3c Doc: Turn "Semantic Highlighting" into how-to topics
And move the general information to the Overview (or the Code
view docs in the QDS Manual).

Task-number: QTCREATORBUG-29361
Change-Id: Ib1d13f3d81d707691c84aa4241ed28662e2bc8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:37 +00:00
Leena Miettinen
ebb3ad8d47 Doc: Turn "Using Qt Quick Toolbars" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I5ed2aa9322f2d83dc8c58a6254a7cde5186252be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:09 +00:00
Tim Jenssen
9ce7aaccc5 Merge remote-tracking branch 'origin/qds/dev' into HEAD
Change-Id: I9d13aa050b1c7fb0954e2b63d13da2922d8f7218
2024-03-14 16:13:25 +01:00
Leena Miettinen
63cbd5761e Doc: Update info about code pasting
- Pastecode.xyz has been replaced with DPaste.com
- The process has changed

Task-number: QTCREATORBUG-30209
Change-Id: I1c52923ada597bd741787a8c7ad66425ed5168f9
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
2024-03-14 12:41:15 +00:00
Leena Miettinen
d5c357e67b Doc: Add path to "Initial Configuration"
It is not in the dialog described in the topic.

Change-Id: Ia0d1a399a2926e78cb8a0cc772abb7e2adc14840
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-03-14 08:57:04 +00:00
Leena Miettinen
f6c3318e94 Doc: Turn "Running on Multiple Platforms" into how-to topics
And hide it from the top level TOC in the manual.
Link to "How To: Build with CMake" from CMake topics.

Task-number: QTCREATORBUG-29361
Change-Id: If0522cdd9636ac075e8bdeafa0fc7248199aaf2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-14 08:56:36 +00:00