Commit Graph

45 Commits

Author SHA1 Message Date
Mats Honkamaa
69c042b6fd Doc: Add content library, texture view docs
- Document content library
- Document texture library
- Update Material browser docs

Task-number: QDS-8369
Change-Id: I162a3f105dc227a93b9cea3566996d0ab7c51eaf
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2022-12-05 13:36:05 +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
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
Eike Ziller
1b7295514c Merge remote-tracking branch 'origin/7.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri
	src/plugins/languageclient/languageclientoutline.cpp

Change-Id: I106fbde6467818368a8358d612d793313cad27e6
2022-05-02 15:06:08 +02:00
Leena Miettinen
5e6c7089d8 Doc: Describe how to declare files in projects
Including using OTHER_FILES for qmake projects.

Fixes: QTCREATORBUG-27157
Change-Id: I802000c90472464430d1335b9e962c6691cc567a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-05-02 11:27:26 +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
b0a7fe31c0 Doc: Update Options > Environment > System screenshot
- Mention "Auto-save files after refactoring" in Opening Files.
- Include the screenshot in Specifying Environment Settings.

Task-number: QTCREATORBUG-26610
Change-Id: I05eaf85244ba1f1acf870bbcd37ba81f616b17a4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-23 07:48:58 +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
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
48fafae034 Doc: Move all icon images to images/icons and fix references to them
As a first step to making the images visible in both dark and light
online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: If7da7fec69d1114201d2832b4228b4dba0f090f0
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 08:01:40 +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
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
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
916fc90b44 Doc: Describe Show Source and Header Groups filter in Projects view
Task-number: QTCREATORBUG-25642
Change-Id: Ic3243d0be5c15e1ff853b52271ba31e3c3b148b4
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-07-07 09:03:20 +00:00
Leena Miettinen
7e874544e6 Doc: Remove incorrect info about synchronizing project tree with editor
Fixes: QTCREATORBUG-25893
Change-Id: I1b5e4da53b70732d317a0786926e12ab3c81b7e6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-06-22 12:36:15 +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
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
Leena Miettinen
b3e0074126 Doc: Add links from all sidebar views to their docs
Update screenshot of Bookmarks view.

Task-number: QTCREATORBUG-25162
Change-Id: I00fc3c917ee4727e023c7f7374dbc3e31306551e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-04-26 07:53:17 +00:00
Leena Miettinen
6040adf85c Doc: Make info about menu paths on macOS more visible
We get a lot of user questions about where things are
on macOS.

Also, describe high DPI scaling after the other user
interface options.

Task-number: QDS-3407
Change-Id: If157b9afc70d82944ef9ce8d7b5fa419b3271ef2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-04-19 15:08:00 +00:00
Leena Miettinen
73459785f2 Doc: Describe switching themes on QDS side, too
Added a screenshot of the Interface options.
Moved the description of the Language field up,
because it is right below the Theme field in the tab.

Task-number: QDS-3407
Change-Id: I0bd898852a318ee87427a39c002a3ecc889e6207
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-19 13:51:37 +00:00
Leena Miettinen
dfadc17cb5 Doc: Describe Sort Alphabetically option in Outline view
And add screenshots for all sidebar views.

Task-number: QTCREATORBUG-25162
Change-Id: I7890d57adf04517c534a9b36de89170039f3de93
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-04-19 11:04:09 +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