Commit Graph

58 Commits

Author SHA1 Message Date
Leena Miettinen
a3fbc85ced Doc: Create a Prototyping chapter
Restructure existing information and fix navigation links.

Fixes: QDS-4470
Change-Id: I4a1118a4620527b461b99bf05b8b06d947018c80
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-06-24 07:54:20 +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
Johanna Vanhatapio
d473c70c4b Doc: Add a note to Reporting Crashes
.... about Crashpad not working in Linux.

Task-number: QDS-4456
Change-Id: I3c7a3b2ce5389089a10b179db61006c0fcf9bcc4
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-06-07 07:06:18 +00:00
Christian Stenger
018dfc533c AutoTest: Sort tests case insensitive inside Tests view
Change-Id: Idd4fb818e5bac8e036dd50dbaec7db843b3cfca4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-06-03 04:48:39 +00:00
Johanna Vanhatapio
5bf5cc0d50 Doc: Add info about the user feedback prompt
Fixes: QDS-3601
Change-Id: Ie7ceb09f142d233c4335e1445dac1618c8b00211
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-16 12:20:58 +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
Leena Miettinen
8215518279 Doc: Describe opening terminal windows from Projects view context menu
Task-number: QTCREATORBUG-25162
Change-Id: I0f0939ce98c1de54577b4a67c9097bad9fafecf4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-04-07 09:24:49 +00:00
Leena Miettinen
857ffe457c Doc: Restructure information about Timeline view
- Add a new topic that describes the view, toolbar buttons,
  keyframe track icons, and context menu commands
- Add a link to a video about using the Timeline view
- Move Curve Editor info to a separate topic
- Move Easing Curve Editor info to a separate topic
- Update information about specifying Timeline Settings
- Update terminology to use "component" instead of "item" or "type"

Task-number: QDS-3771
Change-Id: I768aa171a6de962b65b1bdc7842cdd8d004b1e69
Reviewed-by: Knud Dollereder <knud.dollereder@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-03-09 12:33:20 +00:00
Leena Miettinen
f51387fb8e Doc: Describe new context menu commands in Type Hierarchy view
Users can navigate in the type hierarchy and move to the class
definition in the editor.

Task-number: QTCREATORBUG-25162
Change-Id: I608538b24a3d6db25a0ed83d743a42e2d133dae4
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2021-02-25 08:53:57 +00:00
Leena Miettinen
3dfb866bab Doc: Fix broken links
By hiding them if the link target is not part of the manual
or by fixing the link target if the section heading changed.

Change-Id: Ib72c71852ea3f8dacbfedb71a94d64d3eb5378fb
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-02-23 11:53:12 +00:00
Leena Miettinen
beebf9389b Doc: Describe "Text codec for tools" Environment option
Task-number: QTCREATORBUG-25162
Change-Id: I5a5e18cec9f2a1f5479b997c705517b07b794458
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-02-23 09:41:24 +00:00
Leena Miettinen
e34bdf8c4d Doc: Rename and restructure Editing QML Files in Design Mode topic
Add a table that lists the views and links to their documentation
and to the documentation for the tasks that users can perform in
the views.

Change-Id: I96748b62163613aff1bb5f71782af007299b02ce
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-02-23 08:04:26 +00:00
Leena Miettinen
c6493e170f Doc: Describe the Zoom field in Help Options
Task-number: QTCREATORBUG-25162
Change-Id: I11842989df9bab1c5ba1f3e553b486b6cbe88239
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-02-22 09:15:52 +00:00
Leena Miettinen
adce958d5c Doc: Describe the global setting for system environment
Used when determining the build and run environment and
the environment for running external tools.

Task-number: QTCREATORBUG-25162
Change-Id: I6ddf4952bed5ae9190b65bbac8f0c17404be0538
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-02-22 07:32:18 +00:00
Leena Miettinen
89695402c5 Doc: Update the Concepts and Terms topic
Task-number: QDS-3475
Change-Id: I9486ac0cebeca927dcaafb78dbc5e624fa27d03a
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
2021-02-16 12:11:57 +00:00
Christian Stenger
ba667a342b AutoTest: Restructure settings documentation
This patch restructures the settings part of the
documentation to have all related information is
at one location instead of scattered across the
whole page.
Additionally added some information for so far
undocumented features and fix URLs to referenced
googletest web pages.

Change-Id: Ic897237ea67e9cc11f7d0b55059c47108a6e0f3a
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-01-28 12:15:59 +00:00
Eike Ziller
aae3bf4ef7 Merge remote-tracking branch 'origin/4.14'
Change-Id: I516e87eed1b716ec085095c9dd4f47f04a99de7c
2021-01-25 09:06:36 +01:00
Leena Miettinen
23d5a28968 Doc: Add docs for Conan package manager plugin
Task-number: QTCREATORBUG-21785
Change-Id: I616fdfe808fdc5490ac17e95c1554a74524b0444
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2021-01-21 17:44:14 +00:00
Christian Stenger
0ed99a954b AutoTest: Document CTest support
Fixes: QTCREATORBUG-25221
Change-Id: Ie9424cc932db3eb831145b29657353a32f88e5be
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-01-20 08:33:02 +00:00
Leena Miettinen
d8acff46ff Doc: Update screenshot and add info about variables button
- Updated the screenshot in the "Using External Tools" topic to
  show currently available variables and the Variables button.
- Added a link to where the variables are described in more detail.

Fixes: QTCREATORBUG-25233
Change-Id: I1a023d478f239a2fa5a648b36fe22e99435c65b3
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-01-14 11:50:46 +00:00
Johanna Vanhatapio
598bcc8f1e Doc: Fix a typo in the telemetry topic
Change-Id: I79cc32baefad3c80f31a7ce27dda373499571ece
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-11 08:38:26 +00:00
Johanna Vanhatapio
2b1de0c084 Doc: Add information about Telemetry and Crashpad settings
Change-Id: I94af94cd99537cc5fe15f3bd33b5edcafe0b33e2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-12-08 19:01:06 +00:00
Johanna Vanhatapio
ca405966d9 Doc: Describe data collection
Task-number: QDS-3197
Change-Id: Ic8f32b4ffe378b9baa2c354a57b6d387f82fa790
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-12-03 13:56:46 +00:00
Leena Miettinen
3daf838cc3 Doc: Describe "Get Qt" option in Welcome mode
Update screenshot.

Change-Id: Ia209ba65a27f213c3248d4d2535eac6cebd03774
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-11-19 14:48:24 +00:00
Christian Stenger
dbe280cd14 Doc: Mention re-running failed tests
Change-Id: Ief2b7ebbee89a23b77259f65207d641af3ed2623
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-16 05:29:36 +00:00
hjk
289a18f56f FakeVim: Change shortcuts from Alt-V,X to Alt-Y,X
Alt-V is taken by the Views menu nowadays.

Also, fix the instruction to quit FakeVim on Mac.

Fixes: QTCREATORBUG-24694
Change-Id: I5268760f45e34f973b3b38b19d2577c0c655b000
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-11-10 12:29:14 +00:00
Leena Miettinen
fff49421ce Doc: Describe new keyboard shortcut for function tooltips
Task-number: QTCREATORBUG-24529
Change-Id: I34237f0f4c0d47588bfebc368a712eb38f205b60
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-10-08 09:16:33 +00:00
Leena Miettinen
4c76553273 Doc: Update info about default help viewer backend
It is now litehtml. Update screenshots to show the help using
the litehtml backend and to use the Design Dark theme.

Task-number: QTCREATORBUG-24529
Change-Id: I7e230e7e0a154161f525ba37d0965ac1c50d2ea6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-10-08 06:52:39 +00:00
Leena Miettinen
b42c0f74f9 Doc: Describe "Ask for confirmation before exiting" option
Update screenshot of the Environment > System tab that
contains the new option.

Task-number: QTCREATORBUG-24529
Change-Id: Ia8a3f048ee492b2a5d37138b2d82638b5bf91c6f
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-10-07 06:52:28 +00:00
Leena Miettinen
49d20960b9 Doc: Show "Managing Sessions" topic in QDS Manual
- Moved the topic from the creator-only folder to the
  howto folder root to have it included in the doc builds.
- Added the topic to the toc and fixed the navigation links
  around it.
- Used defines to hide text that does not apply to QDS.

Fixes: QDS-2805
Change-Id: I583324a1d0bc60c1b6448a52e48b3f09b1039b7f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-09-21 14:04:04 +00:00
Leena Miettinen
2c36c737b7 Doc: Use \MinGW to prevent broken automatically generated links
Change-Id: Ib576e3be1035448905cc8c5bf23960450cf10057
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-09-02 06:18:29 +00:00
Leena Miettinen
470278dfe7 Doc: Fix some typos
Change-Id: Ice19099cb58acaef81cec5e34c62e61f54c0d13e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-08-24 15:18:46 +00:00
Leena Miettinen
048d6164cc Doc: Describe exporting and importing workspace settings
There are Import and Export buttons in View > Workspaces > Manage.
Update screenshots and add one of New Workspace Name dialog.

Change-Id: I679b7952e498576a58ebb4134d08c21fe2555fc7
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-08-24 15:00:37 +00:00
Leena Miettinen
ed95b3e6a1 Doc: Add info about IncrediBuild plugin
Fixes: QTCREATORBUG-24217
Change-Id: I3e9023933db508f14139b719eae0191d4615eab7
Reviewed-by: hjk <hjk@qt.io>
2020-08-11 07:53:36 +00:00
Johanna Vanhatapio
784420e911 Doc: Describe converting projects from Qt 3D Studio to Qt Design Studio
Draft of the migration guide describing the best practices and including
a step-by-step guide for the converting process.

Fixes: QDS-2252
Change-Id: I501b57450525cd3122510d5f9d784804996dd70f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-07-01 12:50:48 +00:00
Eike Ziller
5a97e8ceb9 Merge remote-tracking branch 'origin/4.13'
Conflicts:
	src/plugins/android/androidsettingswidget.cpp

Change-Id: Iadf1d58a1e867ae7bb2dca55d3951613cfcc3d07
2020-07-01 09:01:26 +02:00
Leena Miettinen
af69612daf Doc: Describe moving types and symbols in Outline view
Task-number: QTCREATORBUG-21993
Change-Id: I2a156549e8eb8c5f31e505edeb3ab5f741be0245
Reviewed-by: Fawzi Mohamed <fawzi.mohamed@qt.io>
2020-06-30 10:35:31 +00:00
Leena Miettinen
a8cfe3d560 Doc: Fix menu paths to submenus and items that moved to View menu
The Views and Workspaces menus as well as some menu items were moved
from Windows to View.

Change-Id: I2e196c09f0e9e2bf8ef1623167ec3e87ed1f77f5
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-30 10:35:07 +00:00
Leena Miettinen
351cb8a028 Doc: Describe help filtering from Qt 5.15
Fixes: QTCREATORBUG-24239
Change-Id: Ib91b6ea8df7d3724956d6cad932a0b6d6f9bf1bc
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2020-06-24 10:21:27 +00:00
Leena Miettinen
c7cde7126f Doc: Describe adding multiple keyboard shortcuts for a function
Task-number: QTCREATORBUG-72
Change-Id: I528a77594af1429e92cd65db8c6b4de1eea0126c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-23 06:27:50 +00:00
Leena Miettinen
891524d4c4 Doc: Hide advanced information from Qt Design Studio Manual
Replace references to "developers" and "designers" with "you"
where the difference is not important.

Hide some complexity by removing references to features designers
might not use very often, such as the locator and debugger.

Fixes: QDS-2159
Change-Id: Ifcda176c5c429a4d90f37138d861cb971932e626
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Soili Väinämö <soili.vainamo@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-06-04 10:30:08 +00:00
Eike Ziller
20ef5c6de3 Merge remote-tracking branch 'origin/4.12'
Change-Id: Ibbf9f16677a58bdcdd3ce63701ffa34db6f44916
2020-05-11 11:36:22 +02:00
Leena Miettinen
c370d345f1 Doc: Remove obsolete \contentspage command
This prints a QDoc warning when building with QDoc 5.15.

Change-Id: Id6f4646738f3e09956a243dc0da639f5567470f3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-11 08:43:31 +00:00
Christian Stenger
4aa2598790 Doc: Add information on using Catch2 tests
Add information on creating and specifying settings for
Catch2 tests.

Change-Id: I6d658f670aa9c066076cf33315ab17302d9cf36c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-29 10:31:07 +00:00
Leena Miettinen
677fdb78c1 Doc: Fix references to projects-related UI strings
We now have a "Projects mode" and "Projects view",
but "Build & Run" options category.

Change-Id: I5bf1829cb3f9bd47bbbf06c5898e3efd417cb796
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-04-22 07:28:53 +00:00
Leena Miettinen
d973823dbb Doc: Describe selecting the help viewer backend
You can switch the help viewer backend if you have issues
with the current one.

Change-Id: I0b0697980259a4d14b6e694faff0afed14040556
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-04-14 13:54:23 +00:00
Eike Ziller
708f84cce8 Doc: Fix style for menu hierarchies
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-03 06:10:16 +00:00
Leena Miettinen
7be9d0f567 Sessions: Fix UI text according to the guidelines
https://doc.qt.io/qtcreator-extending/qtcreator-ui-text.html

Task-number: QTCREATORBUG-23683
Change-Id: Ie74ee222f5ff7393b65c6f1128cf2e64bb0007ae
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-03-16 11:54:24 +00:00
Leena Miettinen
83a60f10ce Doc: Update info about managing workspaces
Change-Id: I1cd79ac60641d99b86b246cb540cb6a9e70d1f30
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-03-13 09:37:58 +00:00
Leena Miettinen
eea835eab0 Doc: Add a section about finding and filtering output
The standard "find in file" functionality is now used, so
link to it. For filtering, describe the options.

Change-Id: I379d23fbc35ebfbbfef1d6fa3007af5b9d7f23b4
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-03-05 09:14:34 +00:00