Commit Graph

21 Commits

Author SHA1 Message Date
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
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
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
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
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
ccd7365d7e Doc: Fix link to image in QDS Manual
The image format changed from PNG to WEBP.

Change-Id: I0b24fee9687f36ae38d5a0377fb79627cc4ca926
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-11-24 09:07:43 +00:00
Leena Miettinen
be1aa6abed Doc: Fix typos
Change-Id: I22b610a6dcab73867f915f877d7b7b844da5dc22
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-11-16 10:39:24 +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
fe376af66b Doc: Update File System view screenshot to show the number
...that is referred to in the text.

Change-Id: If5f343d2b25ecf5cfc4761f2a1326903f8925f36
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-11-08 09:13:26 +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
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
Leena Miettinen
3bd96e7e73 Doc: Move creating files into a separate topic
"New File" is now a separate menu item in the "File" menu.
This way the topics are a bit shorter.

Task-number: QTCREATORBUG-26610
Change-Id: Iedfc79f196fc9c3b28f8613f7d8a5ed057770b9a
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-09 15:29:01 +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
Leena Miettinen
b19f236c24 Doc: Describe new Project and File System menu commands
- Show some accidentally hidden information in Qt Creator
  Manual

Task-number: QTCREATORBUG-26278
Change-Id: Ia611633d52e4b012a40d7be548313e62f8ce3683
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-05 10:01:30 +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
d41d523d7b Doc: Describe file properties added to File Properties dialog
Task-number: QTCREATORBUG-25642
Change-Id: I4901e65e16fddac864cabfded1e3ef9d3d35881b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-06-22 09:25:36 +00:00
Leena Miettinen
03c48cfe2a Doc: Create topics for Projects, File System, and Open Documents
Move the information about these views to separate topics and
describe the differences between using them in Design mode or
in the sidebar.

Change-Id: Ie71edb7d270bf5c4e020f2818f9f8e0e9e505094
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-12 07:06:01 +00:00