Commit Graph

96 Commits

Author SHA1 Message Date
Leena Miettinen
cc03aff960 Doc: Split up the "Working in Edit Mode topic"
- Make topics shorter and easier to browse
- Move information around
- Delete duplicate how-to topics
- Add \sa links to how-to topics

Task-number: QTCREATORBUG-29361
Change-Id: Ie84a29993129d175bbd65143fcfc45aa8304d621
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-01 10:28:25 +00:00
Leena Miettinen
78b6306578 Doc: Split up "Using Language Servers"
Update information about changed or added features.

Task-number: QTCREATORBUG-29361
Change-Id: Ia318b987602141f0021abd561ce3aac1d405904f
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-01-11 13:15:59 +00:00
Leena Miettinen
f0fefbef06 Doc: Split up the To-Do Entries topic
Task-number: QTCREATORBUG-29361
Change-Id: I4de61d64eb1001be4c6cae917cb187e919d31e65
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-08 15:32:55 +00:00
Leena Miettinen
3f24752247 Doc: Update info about importing generic projcts
Move the topic from Build Systems to How To: Manage Projects.

Task-number: QTCREATORBUG-29361
Change-Id: Ia91ef716a2907c9ae9296852ca137d3fa1f3e4c1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-12-20 08:19:22 +00:00
Leena Miettinen
1cea4ea42e Doc: Hide links to topics not included into QDS Manual
Move a file to a creator-only folder and add conditions.

Change-Id: I8ebe71116f926dea10fa656ef17717b946ae80e2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-12-13 08:13:59 +00:00
Leena Miettinen
52eff2c6a4 Doc: Turn "Using Custom Output Parsers" into two how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: I426f0fe545a485a1932d1e59fed99c07c71f4aff
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-12-07 14:16:22 +00:00
Leena Miettinen
f708e200f9 Doc: Restructure info about build and run configurations
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-12-05 12:30:54 +00:00
Leena Miettinen
eb9c2da726 Doc: Turn Managing Sessions into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: If15556fdcb5d365b65f1f56a77ab9c21739d0854
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-13 09:05:07 +00:00
Leena Miettinen
ae4b6f9e17 Doc: Update Preferences > Environment > System screenshot
Task-number: QTCREATORBUG-29392
Change-Id: Ic8ccedfbcb3f6aeb139f969bde1c439c78720941
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-11-07 16:29:34 +00:00
Leena Miettinen
372d19f9f4 Doc: Describe CMake changes
- Divide the "Setting Up CMake" into several how-to topics.
- Rename it as "CMake" and link to all the new topics.
- Update related topics accordingly.

Task-number: QTCREATORBUG-29361
Task-number: QTCREATORBUG-29392
Change-Id: Ib8f4a1951b5ffd7eaa25a4e5cf40e7bb252f9cf4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-01 13:26:19 +00:00
Leena Miettinen
edea408026 Doc: Describe new Terminal features
Task-number: QTCREATORBUG-29392
Change-Id: I00aaf4cad1ec521e42f5c55bb236d0c3cb04a4d6
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-31 12:10:34 +00:00
Leena Miettinen
022847c852 Doc: Make the instructions for enabling plugins more consistent
- Add the following for documented plugins that are
  disabled by default: \note Enable the <name> plugin to use it
- Add \sa {Enable and disable plugins} for the above plugins and
  describe there how to find the About Plugins dialog on macOS
- For the one occurrence in the QDS Manual, add instructions for
  finding the About Plugins dialog on macOS ("Enable and disable plugins"
  is not included in the QDS Manual
- Mostly remove other kinds of references to enabling plugins

Task-number: QTCREATORBUG-29734
Change-Id: I7b12bd651c1c99e0c6b3ca6f94d3831ebe038438
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-27 06:59:11 +00:00
Riitta-Leena Miettinen
0fe891678a Doc: Use a link to "Find preferences" as value of \preferences
- Add the instructions for finding the Preferences menu to the
  "Find a particular preference" topic and rename it "Find preferences".
- Remove the "Find menu items on macOS" topic

Change-Id: I627e5c20d2c63efb4490d446608b923ac15a6aac
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-24 09:00:36 +00:00
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00:00
Eike Ziller
e51b378ac9 Core/Tr: Fix menu bar action
It is "menu bar", and use placeholder for shortcut instead of
concatenation.

Change-Id: I60094a5fac3893663180f7ef573b6dece7670111
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-18 14:11:13 +00:00
Leena Miettinen
57606dfb55 Doc: Describe how to hide and show the main menu bar
After users hide the menubar, they cannot see the keyboard
shortcut for showing it anymore.

Task-number: QTCREATORBUG-29392
Change-Id: I7a26d6bd0972457e225b33d2b041c158ad71548e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-13 13:08:31 +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
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
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
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
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
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
Eike Ziller
626378de2d Merge remote-tracking branch 'origin/11.0'
Conflicts:
	src/plugins/cmakeprojectmanager/cmakebuildstep.cpp
	src/plugins/qtsupport/examplesparser.cpp

Change-Id: I2a0808261969e8c7cef7fae86d9027a155bf9b14
2023-07-19 16:10:37 +02: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
42144afe66 Doc: Remove list of filters from Issues docs and promote tooltips
Task-number: QTCREATORBUG-29392
Change-Id: Ief101bf9a1a6a412a4649881e372eb1479d71259
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-14 11:47:11 +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
707d3dd7aa Doc: Move sidebar view docs into separate topics
- Link the topics from "Show and hide sidebars"
- Hide "Working in Edit Mode" from QDS because the Edit mode is
  hidden by default there
- Fix links to the new topics and remove links to
  "Browsing Project Contents"

Task-number: QTCREATORBUG-29361
Change-Id: Ia9ae6474bf0925a76f9ccee693369d2460b9266f
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-07-05 11:28:16 +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
95074bf2a3 Doc: Update screenshots of output views
The Next and Previous icons were changed.

Task-number: QTCREATORBUG-28996
Change-Id: Ic90a458fdc500f8978ff1d51e293928c322c3091
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-04 11:05:23 +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
6ed6946d2a Doc: Add links to YouTube videos
Task-number: QTCREATORBUG-28996
Change-Id: Ib829b67f2d91f06e0d567d5c19cad0d37bceb916
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-06-28 06:58:54 +00:00
Leena Miettinen
923e95eba6 Doc: Describe the experimental Axivion plugin
Fixes: QTCREATORBUG-29240
Change-Id: I61e068796ddfd942553c9a0b64a8bede0d1db070
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-06-15 11:57:56 +00:00
Leena Miettinen
4f3fea4baa Doc: Update Issues view docs
Task-number: QTCREATORBUG-28996
Change-Id: Icb35a36adf914b2791e405c1bed972fac40e6973
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-06-15 08:15:35 +00:00
Leena Miettinen
e973257cbc Doc: Describe moving files while renaming them
Task-number: QTCREATORBUG-28996
Change-Id: Iecf3b8e5f4d5270803a9591854a4324f8fa6016d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-06-14 12:42:50 +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
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
Eike Ziller
8e8ebc8f88 Merge remote-tracking branch 'origin/10.0'
Conflicts:
	coin/instructions/build.yaml

Change-Id: I697b0107e75c6259989247de2180437d7987ff37
2023-05-17 14:55:02 +02:00
Leena Miettinen
330a30aa5b Doc: Hide text and links that only apply to Qt Creator Manual
...from the QDS manual.

Change-Id: I24be3b656922b1c10643f6ef274f1fa91c8330df
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-05-17 05:34:28 +00:00
Tim Jenßen
feabda3aa7 Merge remote-tracking branch 'origin/10.0' into qds/dev
bigger conflicts resolved at:
  src/plugins/qmldesigner/CMakeLists.txt
  src/plugins/qmlprojectmanager/qmlprojectrunconfiguration.cpp

Change-Id: I08e2a109d8e37cbd77225129854e9e633725bfc7
2023-03-26 16:26:18 +02:00
Mats Honkamaa
c6adcb4a56 Doc: Add info about mode selectors being hidden by default
Task-number: QDS-9383
Change-Id: I4535c81328c52f1e7400f89c7f08553985519b48
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-03-09 13:34:03 +00:00
Leena Miettinen
27760c38c6 Doc: Describe Call Hierarchy view and language server button
Task-number: QTCREATORBUG-28721
Change-Id: I9275c5f0a7ca838aab29c42962e88d4b80ed8622
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-22 09:57:16 +00:00
Leena Miettinen
08e789851e Doc: Describe changing includes when renaming .ui files
Task-number: QTCREATORBUG-QTCREATORBUG-28721
Change-Id: I6508f57dd7f8634e0fb8412bc55845b24fb5af54
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-21 08:44:43 +00:00
Leena Miettinen
0cf83caa00 Doc: Add finding unused functions in Projects view context menu docs
Task-number: QTCREATORBUG-28721
Change-Id: I180028a09f51ec40d43ae99cfd474b05f5a2b69d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-20 16:44:17 +00:00
Leena Miettinen
ac252c2d49 Doc: Make the locator more visible in the other parts of the docs
Change-Id: Icdefa64f5874f14c6a9c6a24e4d73837c12b457f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-02-08 12:12:26 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00