Commit Graph

164 Commits

Author SHA1 Message Date
Leena Miettinen
c044f6104b Doc: Add missing section to TOC and How To
...and fix some \brief commands.

Task-number: QTCREATORBUG-29361
Change-Id: Ic37845ed5c7a02035fcc2e140fd35ad466fff2e3
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-12 14:59:44 +00:00
Leena Miettinen
fd92781e87 Doc: Use the \generatelist command in TOC, How To, and Reference
...to automatically list the topics in each group and avoid manual
work.

Task-number: QTCREATORBUG-29361
Change-Id: I45391b548354e6499bbd0698a9da8d6f9dc77dff
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-12 13:54:13 +00:00
Leena Miettinen
78974347c5 Doc: Describe screen recorder
Fixes: QTCREATORBUG-29721
Change-Id: I19c1067b9394ff24e94be3ded4b9c20c5a01c364
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-10-12 12:43:13 +00:00
Leena Miettinen
fe6dd868c5 Doc: Describe Compiler Explorer
Fixes: QTCREATORBUG-29720
Change-Id: I1de27d01a684249cd8bd3e5e8c98a551947a4436
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-12 10:54:57 +00:00
Leena Miettinen
551dde7fa9 Doc: Describe Documentation Comments preferences
- Add a topic for setting preferences for Doxygen-style docs
- Update screenshot for Text Editor > Completion preferences, where
  the documentation settings used to be

Task-number: QTCREATORBUG-29392
Change-Id: Ifb915e78f3d2a5fb97555dd99bfaa5abf12ef14b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-11 12:05:32 +00:00
Leena Miettinen
5a715330fc Doc: Describe detaching views
Fixes: QTCREATORBUG-29636
Change-Id: I980d7c523bd40cbc7ad56696987688839baf154d
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-10-11 07:26:23 +00:00
Leena Miettinen
b0300ee48d Doc: Turn "Specifying Dependencies" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I035ff1a99790c0af8c1abe12ab42f16411f346e0
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-09-22 07:55:09 +00:00
Leena Miettinen
bd38c30759 Doc: Reorganize info on kits
Divide current topics into how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I0e64b2bbe9d4f6d403815dffe937a567eb9d4844
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:32 +00:00
Leena Miettinen
0ae0b84936 Doc: Edit "Specifying Code Style" and "Indenting Text or Code"
Turn these topics into several how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I8d6a7af2db7eff2c852c2cc491878ce29272b59b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:19 +00:00
Tim Jenssen
1a3a8ecc96 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Id242ab4ca485527defdcc1555d204e12e50ddb7a
2023-09-14 17:37:24 +02:00
Tim Jenssen
a603b65f18 Merge remote-tracking branch 'origin/11.0' into qds/dev
Change-Id: I2bf1a2a72d9765d9b4088840414b4933644db47a
2023-09-14 12:23:01 +00:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Eike Ziller
40273101c6 Doc: Update information about Qt Quick render backend
Qt 6 works different than Qt 5. Remove references to ANGLE.

Change-Id: Ie27922d7c9a26d29a1ad4a1f52daa3a1aff7b19a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-09-13 07:26:55 +00:00
Leena Miettinen
b7800d9351 Doc: Turn "Activating Kits for a Project" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I3545d29192176ba0a4377d77f51bc13155b46588
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-13 06:57:18 +00:00
Leena Miettinen
2d9aa27b61 Doc: Chop up the "Using Version Control Systems" topic
Turn the topic into Reference and How-to topics.

Task-number: QTCREATORBUG-29361
Change-Id: I2fd4050f712b61b3e4140a5bf93e968c02b36d36
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2023-09-13 06:57:07 +00:00
Leena Miettinen
097cb17af4 Doc: Replace "Getting Help" with "How To"
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 06:56:53 +00:00
Leena Miettinen
66fabd0c0d Doc: Turn some "Advanced Use" topics into how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ie675e4d72ad524e0a7a4ba4adca8a477ff579d55
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-13 06:56:40 +00:00
Mats Honkamaa
781e9dd5e3 Doc: Unify product naming
Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses
as well.

Task-number: QTBUG-116573
Change-Id: I90247956300607b852a17df96aa667bf55805e36
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:22:28 +00:00
Leena Miettinen
50b14b5046 Doc: Replace "Advanced Use" with "Reference"
Will move some topics to how-to topics in a follow-up change.

Task-number: QTCREATORBUG-29361
Change-Id: I7a7475844faafa9dfae9f2f4e3f6940959022c54
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-04 07:14:31 +00:00
Leena Miettinen
495c826c55 Doc: Rename "Adding Custom Wizards" and move it to "Reference"
- Create an "Add wizards" how-to topic

Task-number: QTCREATORBUG-29361
Change-Id: I37b1f39ba78fd1c39f4b111051f5eef1acee4caf
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-01 11:23:38 +00:00
Leena Miettinen
be6b83ec4a Doc: Split up the "Adding Libraries to Projects" topic
- Turn the topic into a how-to topic
- Turn the example into a tutorial
- Mark the information as qmake-specific
- Add links to CMake information

Task-number: QTCREATORBUG-29361
Change-Id: I42befbf15ad8a0eba7e26a0a69e6d1963d2ce5be
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2023-09-01 07:39:47 +00:00
Leena Miettinen
70f5d18fe9 Doc: Turn Opening Projects into a How-to topic
Describe the ways to open projects before the case where
one needs to re-configure the project.

Task-number: QTCREATORBUG-29361
Change-Id: I32b8676112e412fe8b4f114c54371169f478d361
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-08-31 06:56:15 +00:00
Leena Miettinen
39dfc12a9e Doc: Divide "Creating Files" into How-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ib5e31777ef1649f86525b41bcfbcac52b9dd231e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-08-30 11:26:15 +00:00
Leena Miettinen
22476fc26f Doc: Divide "Creating Projects" into an explanation and how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: I623d824e423da950df9643c42d85b485daccfe4b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-08-28 09:55:57 +00:00
Leena Miettinen
4c4719f4d0 Doc: Turn Qt for Python wizard docs into tutorials
Remove the Python instructions from Creating Projects and
turn them into Qt Quick and Qt Widgets tutorials.

Turn the Developing Qt for Python Applications topic into
a How-to.

Change-Id: Ia3b547fbefd5f8e6b67d673b9724cd6e3f0b4424
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-08-28 09:55:01 +00:00
Leena Miettinen
2172ffa33f Doc: Fix navigation links from how-to and reference topics in QDS Manual
Change-Id: Ie3ea9be3b62c6a7da91debcd9b28e422d5bc7dd6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
2023-07-18 11:25:01 +00:00
Leena Miettinen
3224743a1c Doc: Move Qt Designer keyboard shortcuts to their own section
They were mixed with Editor shortcuts.

Fixes: QTCREATORBUG-29399
Change-Id: I5f81e1c32cabd7f94bb0d2adef29ff8a0d5ca748
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-12 07:10:24 +00:00
Leena Miettinen
31386c3fa0 Doc: Add a Reference topic
For listing reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I1d0463c4bfcd826464535a377da533509d838435
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-11 07:58:51 +00:00
Leena Miettinen
03987976b1 Doc: Move output view docs to separate topics
- Move some information from "Viewing Output" to the "View output"
  how-to topic
- Add the output view topics to \ingroup creator-reference-output-views
  and \ingroup studio-reference-output-views

Task-number: QTCREATORBUG-29361
Change-Id: Ib91373015f416bf4eb6f5f5123a4ae6e5ebe8d8e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-07 12:34:32 +00:00
Leena Miettinen
ea59db0167 Doc: Edit how-to topics
- Add links to missing ones about managing plugins
- Add step lists and screenshots

Change-Id: I49446020b7d81b6ce5a5e4ad5268ef587df6d20b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-07 08:02:11 +00:00
Leena Miettinen
d9e001c50d Doc: Move keyboard shortcut instructions to how-to topics
Hide information about using features that were hidden in QDS.

Task-number: QTCREATORBUG-29361
Change-Id: I504634091c518d03d1d9e849205293bffc4955b3
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-06 06:58:38 +00:00
Leena Miettinen
72c401d9ce Doc: Add a disclaimer about disabling plugins
Change-Id: Ib75b4e88c24ad13693ef02e76de74ba23dcb9e04
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-05 11:19:17 +00:00
Leena Miettinen
a23b933308 Doc: Combine "Working with Sidebars" and "Show and hide sidebars"
- Sidebars are hidden in QDS and the views can be added to
  workspaces, so hide references to sidebars on the QDS side.

Task-number: QTCREATORBUG-29361
Change-Id: Ic468f6f818bddb391bd9514d273ecf8b6b412187
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-07-04 11:12:30 +00:00
Leena Miettinen
1956b0f698 Doc: Combine two topics about selecting modes into one
Move information from "Selecting Modes" to "Switch between modes".
Hide it from the QDS Manual because modes are hidden by default in QDS.

Task-number: QTCREATORBUG-28996
Change-Id: I6d281fe9364e191616af3a8ac484dd0a7d6a3156
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-07-04 11:12:20 +00:00
Leena Miettinen
0f409b7ae8 Doc: Move details of managing plugins into How-to topics
...from Configuring Qt Creator

Create "Enable and disable plugins" and "Install plugins" topics.

Task-number: QTCREATORBUG-29361
Change-Id: I51fdfad1cd7d210a72cf08ef3e82f08ae8c6ecac
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-04 11:06:13 +00:00
Leena Miettinen
0d75ba0293 Doc: Reorganize "User Interface" topic and move info to How-tos
Moved How-to topics into separate topics (HTML files) and
linked to them from UI Interface in QDS Manual and from How-to
in Qt Creator Manual.

Task-number: QTCREATORBUG-28996
Change-Id: I2b6defa936954c6a41085d0276f29942462ec12f
Signed-off-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-30 09:31:50 +00:00
Leena Miettinen
46cb0de54a Doc: Fix broken \previouspage link
Change-Id: Ia2e0d01833fd9f28545bfeee47c3386a96aafe0c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-15 08:28:38 +00:00
Leena Miettinen
196245c8f6 Doc: Add conditions to hide broken links in the QDS Manual
The linked topics are not included in the QDS Manual.

Change-Id: If2bfb1dbc4478a924e56f6dcce840a80c83f19e8
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-06-14 06:53:07 +00:00
Leena Miettinen
590cdf4f61 Doc: Describe managing packages with vcpkg
Fixes: QTCREATORBUG-29221
Change-Id: I2b06e9b0c3641b021309afc7546e7f92a52a201f
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-06-13 11:39:26 +00:00
Leena Miettinen
daad58175b Doc: Describe what to do if Ctrl+Shift+U stops finding references
Task-number: QTCREATORBUG-29134
Change-Id: I7c6816b692ae9decdad42c1a8ec73418735d0019
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-06-09 08:20:35 +00:00
Leena Miettinen
d11b50ec35 Doc: Describe setting the toolbar style
In Preferences > Environment > Interface > Toolbar style.

Task-number: QTCREATORBUG-28996
Change-Id: Ia382f506432bf1b0a499df5c168d5bc3b69477bc
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-08 12:23:56 +00:00
Leena Miettinen
e4dad9547f Doc: Describe the Terminal output pane
Fixes: QTCREATORBUG-29220
Change-Id: I407a7de1be7f485da99b445b967c768373c8c7f5
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-06-07 07:22:23 +00:00
Tim Jenssen
1b6c0ff56c Merge remote-tracking branch 'origin/qds/dev'
Conflicts:
  coin/instructions/build.yaml
  doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc
  share/qtcreator/qmldesigner/studio_templates/projects/common/CMakeLists.main.txt.tpl
  src/libs/CMakeLists.txt
  src/libs/advanceddockingsystem/dockmanager.cpp
  src/libs/advanceddockingsystem/workspacedialog.cpp
  src/plugins/coreplugin/manhattanstyle.cpp
  src/plugins/qmldesigner/CMakeLists.txt
  src/plugins/qmldesigner/components/formeditor/toolbox.cpp
  src/plugins/qmldesigner/components/itemlibrary/itemlibraryassetimporter.cpp
  src/plugins/qmldesigner/components/toolbar/toolbarbackend.cpp
  src/plugins/qmldesigner/designercore/projectstorage/qmltypesparser.h
  src/plugins/qmldesigner/qmldesignerexternaldependencies.cpp
  src/plugins/qmldesignerbase/qmldesignerbaseplugin.cpp
  src/plugins/qmldesignerbase/qmldesignerbaseplugin.h
  src/plugins/qmlprojectmanager/qmlproject.cpp
  src/tools/qml2puppet/CMakeLists.txt
  tests/unit/unittest/CMakeLists.txt

Change-Id: I2c5f18c4fca49471d02713ce5859032232cf7756
2023-05-22 21:13:40 +02:00
Orgad Shaneh
a11800ca16 Doc: Update shortcut descriptions
Follow-up commit 27966a17499a23f2d681f4318787eb49c938d6b1.

Task-number: QTCREATORBUG-10170
Change-Id: Ifbb370ee6500e0cfdc63772c05bf33cae4b957c9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-05-08 07:29:51 +00:00
Tim Jenßen
9c2a73b1c8 Merge remote-tracking branch 'origin/10.0' into qds/dev
Change-Id: I51801c3bec7e29f7c7384d86d79b4fcabb4f99c1
2023-04-27 20:30:00 +02:00
Leena Miettinen
e7b5e64a70 Doc: Remove detailed info about wizard templates
Improve descriptions of some wizard templates.

Task-number: QTCREATORBUG-28996
Change-Id: Ib53fa38918120af60a03f3850fed7db1e6f0c391
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-26 12:18:57 +00:00
Esa Törmänen
79fee70ed2 Doc: Add Qt Design Studio on MCUs intro topic
Added the Add Qt Design Studio on MCUs intro topic and modified the
related topics (index, toc, and external resources) accordingly.

Task-number: QDS-9284
Change-Id: Ibdf27111170b2931511e2ab349ec07210a02e70b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-04-25 06:10:59 +00:00
Eike Ziller
c9696fbabb Merge remote-tracking branch 'origin/10.0'
Change-Id: I8b36c1812b61dbe08fe3e7930f950e6b8e8a7079
2023-04-24 08:52:35 +02:00
Leena Miettinen
51d6b75fb0 Doc: Fix references to locator screenshots in How-tos
They are now in WEBP format.
Also, move some text and images around and add a reference to
screenshot that shows a list of found files.

Change-Id: I219e2b94fe22ffc6d36b0de34529d3849a76ff1b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-21 12:45:41 +00:00
Leena Miettinen
e441648259 Doc: Replace libSM-dev with libsm-dev
Which is the correct way to write the name of the package.

Fixes: QTCREATORBUG-29031
Change-Id: I860051b8e5f94a800d6f7b448daf02ae01611f9d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-19 07:24:13 +00:00