Commit Graph

53 Commits

Author SHA1 Message Date
Leena Miettinen
5a1e5ce058 Doc: Split up "Searching with the Locator"
Hide the locator docs from the QDS Manual because the
locator is not visible in the Code view.

Task-number: QTCREATORBUG-29361
Change-Id: Iecbbaece78b0cd6a496289fd9a00acfdd054d41f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-05 13:37:04 +00:00
Leena Miettinen
c28a388b1f Doc: Turn "Running on Multiple Platforms" into how-to topics
- Update screenshots of kit selector and Devices preferences,
  which now show the device status
- Turn running on QML and Linux into their own topics
- Remove conditions because the projects folder is excluded from
  QDS Manual

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: I869f6b577016c6712c6b37170dbee2249ded1f8e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-02-19 12:33:24 +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
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
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
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 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
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
Leena Miettinen
ce0f48e0f9 Doc: Replace "contain" with "have" to simplify language
This follows the ComplexWords rule in vale.

Change-Id: Ie5dbb7ac1eff1546dcfbe2bf5da6cc3ed18b7a20
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-03 15:06:17 +00:00
Leena Miettinen
b59ad8b0a9 Doc: Use active voice instead of passive voice
This fixes issues found by vale.

Change-Id: Ic3495633cc3aabd000e53b4a4107b9bccde28005
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2022-11-11 09:43:32 +00:00
Leena Miettinen
4c936be3a9 Doc: Update Image Viewer snapshot and add icons to instructions
Arranged the feature list according to the order of icons on the
toolbar and added icons.

Edited some text.

Task-number: QTCREATORBUG-27876
Change-Id: I4357329fbc137ea39b87e3630de507981d1611e5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-10-20 12:31:00 +00:00
Leena Miettinen
0e2409b0d6 Doc: Describe image viewer Set as Default option
Task-number: QTCREATORBUG-27876
Change-Id: Ibe2b7f39c23b60df13debab7de21d7e999f51448
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-10-11 11:00:30 +00:00
Leena Miettinen
49378ced3c Doc: Describe Squish plugin
Fixes: QTCREATORBUG-27890
Change-Id: Icc203a96f08c785f016130480c45c988d26ac371
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-10-06 07:07:56 +00:00
Leena Miettinen
65d6c663e3 Doc: Describe the Help > Change Log option
Task-number: QTCREATORBUG-27876
Change-Id: I484070f77695652642c6b2a12a57b2d0ec691708
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-09-30 07:14:43 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Leena Miettinen
86c6d1d09d Doc: Describe new way to access global settings
From project-level To-Do and Clang Tools settings.

Task-number: QTCREATORBUG-27560
Change-Id: If91dfe81a87af3de3f6b52c160b8b1df4789c20b
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-13 13:41:07 +00:00
Leena Miettinen
226abd4de7 Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 10:39:52 +00:00
Leena Miettinen
89be4d7d17 Doc: Replace "options" with "preferences"
...when referring to Preferences dialog.

Task-number: QTCREATORBUG-27560
Change-Id: I2f41420b0ec5955d84ad715d239209adddff0529
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 07:30:49 +00:00
Leena Miettinen
750c50a00f Doc: Describe copying an image as a data URL in Image Viewer
Task-number: QTCREATORBUG-27560
Change-Id: I2a09e938b556b9998003a2c6732f0174c5c7091a
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-01 10:20:48 +00:00
Leena Miettinen
b5066d71b8 Doc: Replace "Tools > Options" with "Edit > Preferences"
The menu was moved and renamed. The Options dialog was
also renamed "Preferences".

Change-Id: I05d187915382b3ce49699d91304cd447c87e2bd6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-06-28 08:32:44 +00:00
Cristian Adam
1a20495400 Doc: Update Windows paths to settings files
This way it looks less scary and easier to remember.

Change-Id: If8ccd37d85647f3ae26c615556c78ae99c992c13
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-04-05 15:04:55 +00:00
Leena Miettinen
71d858f2d2 Doc: Fix changed string
Change-Id: If429e6721bc5086d354579dbcd8638aed7dc2c50
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-14 10:17:35 +00:00
Leena Miettinen
09804a65e4 Doc: Do not use the term "Output pane" in docs
When necessary, replace it with "view". When possible,
rephrase to omit the term. Link to descriptions of the
output views.

Update screenshots.

Change-Id: I80ccd12f5a10f221bbea6de994a15ddd07d20842
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-09 15:30:36 +00:00
Leena Miettinen
659d82c499 Doc: Fix broken links when building with Qt 6
Some section titles have changed in Qt 6 and some
platforms and modules are not supported. Where necessary,
use fixed links to Qt 5 docs.

Fixes: QTCREATORBUG-27015
Change-Id: I469a630731f9c37deffe5ca454f5365310aaf713
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-02-28 16:05:01 +00:00
Mats Honkamaa
741a2de6b9 Doc: Document toggling visibility of menu items
Debug, Analyze, and Build menu items are invisible by default.
Visibility can be toggled from Options.

Task-number: QDS-6372
Change-Id: I5134868e8cd08c229b6c3a8ff3c53a1cc67949ab
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-02-28 15:08:45 +00:00
Leena Miettinen
7e00d5f662 Doc: Describe applying context menu actions to multiple issues
...in the Issues pane.

Task-number: QTCREATORBUG-26610
Change-Id: I5ad148b7f8e1696aa0f3b494f05b068df9d2210d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-10 09:49:09 +00:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Mats Honkamaa
06e1182574 Doc: Split the Examples and Tutorials Section into two pages
Splitting Examples and Tutorials to own separate pages.

Task-number: QDS-5495
Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-12-01 13:15:28 +00:00
Leena Miettinen
4c82d69779 Doc: Update info about opening output panes
- Describe additional ways to open output panes.
- Add a screenshot of the taskbar.
- Add descriptions of related icons.
- Fix the Maximize Output Pane command keyboard shortcut.

Task-number: QTCREATORBUG-26278
Change-Id: I92712d1542871119e4402df18bd10c9563a335d3
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-29 15:30:50 +00:00
Leena Miettinen
1e9e61e4bf Doc: Update info about sidebar views and output panes
Add icons for toolbar buttons.

Task-number: QTCREATORBUG-26278
Change-Id: I92f34775142ebba0489944f90fb956494d0a3174
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-12 10:35:16 +00:00
Leena Miettinen
1a84cdab84 Doc: Hide ADS (workspaces) information from Qt Creator Manual
ADS is used only in Qt Design Studio, even though the Debug mode
also has "workspaces".

Move the topic source file and image files to doc\qtdesignstudio\.

Task-number: QTCREATORBUG-26321
Change-Id: I72b0011a6c8258df8a5e938f3f33d44c39ccfa4c
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-10-27 13:30:24 +00:00
Leena Miettinen
73fa76f776 Doc: Remove info about Qt Quick Designer plugin from Qt Creator Manual
Fixes: QTCREATORBUG-26321
Change-Id: I8738cbdc56d6469a4d133b17741871787e0cba9f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-10-18 07:21:39 +00:00
Leena Miettinen
2af03178ae Doc: Fix typo
Change-Id: I2ccc0e7d1975c5e2ebc90a3c906df3cd2e693b63
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-06-21 14:31:46 +00:00
Leena Miettinen
6a9a58941e Doc: Restructure the QDS Manual Getting Started chapter
- Add the Use Cases topic
- Move text from other topics as necessary
- Fix the navigation links to match the new structure

Fixes: QDS-4468
Change-Id: Ic67dbe073c5be2420795c1f5049217319ab0a202
Reviewed-by: Jarko Vihriala <jarko.vihriala@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-06-11 10:48:46 +00:00
Leena Miettinen
c1c638658e Doc: Describe QDS installation options
Fixes: QDS-4441
Change-Id: Ibb602ecc646117ffc4e09af2409f1f5996d01491
Reviewed-by: Jarko Vihriala <jarko.vihriala@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2021-06-03 09:46:08 +00:00
Johanna Vanhatapio
f4ccb56976 Doc: Fix some uicontrol commands
Task-number: QDS-3407
Change-Id: I7491960f5e441b412d03d92039e4d9a55c51cd18
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-27 13:07:57 +00:00