Commit Graph

3372 Commits

Author SHA1 Message Date
Leena Miettinen
19970878b8 Doc: Update info about Clang diagnostics
Task-number: QTCREATORBUG-25195
Change-Id: Idb8dee94fae29cb0f347decf50e686a3485d9139
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-01-07 14:16:56 +00:00
Leena Miettinen
dd75e97cb8 Doc: Add docs for Studio Logic Helper types
Task-number: QDS-3248
Change-Id: I348d82be4a9a5574046cd590b07e711eb862d2ec
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-01-06 14:02:55 +00:00
Eike Ziller
739eeec19d Explicitly state that only 64 bit Windows is supported
by our binary packages. Building on 32bit is still possible.

Fixes: QTCREATORBUG-25182
Change-Id: Ic88579bcd9bf3b6aef449e6ac3bcaa6430cd68f2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-01-04 10:14:03 +00:00
Leena Miettinen
428ac96dd1 Doc: Describe using Qt Bridge for Figma
Task-number: QDS-2525
Change-Id: I5c574c291bfb526452a2429a91920a875e1573a5
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-11 16:26:06 +00:00
Venugopal Shivashankar
1f41c53f0f Doc: Update the MCU options dialog screenshot
In addition, document the new option that
enables automatic kit creation for all the
available targets.

Change-Id: Ic9168f032472bdd98b9b026934476e606a9ab94e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-11 13:19:18 +00:00
Leena Miettinen
b09cc04c87 Doc: Replace external links to Qt docs with internal ones
Where possible, link to sections about QML types within the manual.

Task-number: QDS-2744
Change-Id: If12e8ce0261258c0c7e4b293e2cd45ad959c7882
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-11 12:54:55 +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
Leena Miettinen
5179dd2400 Doc: Add "Technical Support" topic to QDS Manual
It opens from Help > Technical Support.
Make the content more useful to QDS users and hide
the developer information from QDS Manual.

Fixes: QDS-3307
Change-Id: I01eec99b85ecd6d2f2d2c970370e560d6719ee75
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-11 07:50:38 +00:00
Leena Miettinen
ed56036ada Doc: Update supported Linux version
Task-number: QTCREATORBUG-24529
Change-Id: I5db8866e2b682c4d4b8cb15c046753c047848135
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-10 13:30:05 +00:00
Kai Koehne
33487984b9 Doc: Use version independent Qt link
or use direct links where possible.

Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-10 10:48:25 +00:00
Leena Miettinen
4e806fc194 Doc: Add location of anchor buttons to tutorial
Fixes: QDS-3308
Change-Id: Ib177cfee01689ff51e6a4c56dce52857ac1f0705
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-10 07:36:31 +00:00
Leena Miettinen
a45689f85c Doc: Update instructions for using the \youtube macro
We needed a workaround to make this work in Qt Creator
and Qt Design Studio help mode.

Change-Id: I9b66fe91a5faa07366375a886a9f99352629945d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-09 14:19:23 +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
e6b742a7e1 Doc: Describe the Group Component
Fixes: QDS-3080
Change-Id: Iea4bae5c8d2cbf3097fc99bfbb87132b460ab404
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-08 14:54:37 +00:00
Leena Miettinen
698733afbf Doc: Fix some language issues in the Studio component docs
Task-number: QDS-2744
Change-Id: I472bb1d030c8119357b17b58b645fc0364f3cc5a
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-08 08:16:46 +00:00
Leena Miettinen
10132574a7 Doc: Describe all View menu commands
- Add Curve Editor and Transition Editor to list of Design mode views
- Describe Toggle States menu item

Task-number: QDS-2744
Change-Id: Ib83d7f4d6ccdb8af0ee66af8d5a4f5be40394591
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-08 08:16:30 +00:00
Leena Miettinen
ca263cd44a Doc: Add links to videos
Task-number: QDS-2744
Change-Id: I1ffa0cd1cd4999c372c68ec180bcf89f31db7293
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-07 15:49:04 +00:00
Kai Koehne
eb711d7bd6 Fix qtquickcontrols2.conf in QtDS examples for Qt 6
Since the default style got renamed to 'Basic',
Style=Default will cause a runtime error with Qt 6.0.0

Avoid this by not setting an explicit style.

Task-number: QTCREATORBUG-24905
Change-Id: I0f35e1dfb38536412da064d9f8ba88264485ef52
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-07 14:57:05 +00:00
Leena Miettinen
e9f7340816 Doc: Add missing docs for 2D effects
Moved the section to its own topic, because it was getting very
long. Also described the properties of each effect.

Fixes: QDS-3229
Change-Id: Ie93f4ca956bdca4afbd31e7606a47c4e1d1e5bb4
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-07 13:06:40 +00:00
Leena Miettinen
f9b255b679 Doc: Hide QDS specific info from Qt Creator Manual
Group type and Event List are only available for QDS.

Change-Id: I244a774de07260b4cdad8769aba7cd4761029c05
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-07 10:29:38 +00:00
hjk
7e8c212c1a Coding style: Remove outdated recommendation of foreach()
Change-Id: I01eadfdbefededf3b71df492a0e29abdd3a3a93f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-07 08:31:33 +00:00
Leena Miettinen
8d44cd1d5a Doc: Update info about platform support for QDS
Fixes: QDS-3245
Change-Id: Ifa434db2769331698956d7a2f0d037f0b0c0e137
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-12-03 17:07:27 +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
0c29e50353 Doc: Describe building docs with CMake and using the online style
You can now use CMake to build docs.

You also have an option to use the online style, which
enables you to check how the docs will look after release.

Change-Id: I63f573a58a2daf3aa05a2f0dd57f33f859e25bc2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-03 11:53:24 +00:00
Leena Miettinen
bfba7a1e07 Doc: Fix commas
Change-Id: I55f18d0cabc35c345bc382118d4fc59cf69813bc
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
2020-12-03 07:58:10 +00:00
Leena Miettinen
b9886a4b04 Doc: Fix the \youtube macro for use with liteHTML help backend
Create a common directory for extra image files, and move the video
thumbnails there. This folder structure is required to work around
the fact that relative image paths passed to qhp.<project>.extraFiles
are not resolved correctly when loading the generated help project.

Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-01 10:40:02 +00:00
Leena Miettinen
21f16c8d3d Doc: Add text properties
Fixes: QDS-2849
Change-Id: Id1fc33208bb5bfea10947b2c699ce2c9fb14250f
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 16:09:28 +00:00
Leena Miettinen
8cbbdacf3e Doc: Update info about custom components
- Describe "Edit Master Component" button in custom component
  properties.
- Organize the different ways of creating custom components under
  one heading.

Fixes: QDS-3164
Change-Id: I4b7c1f42e32c6d615ad5b2d9da26f15e69b2cb69
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 16:09:13 +00:00
Johanna Vanhatapio
6250b13eb3 Doc: Add a link to Getting Started Video 2
Change-Id: I912ac899e658945f4ede5eb0ad5da70fa3df622d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-30 14:48:50 +00:00
Leena Miettinen
bd17dd445b Doc: Add instructions for using the \youtube macro
The macro shows a thumbnail with a play button to start the
video.

Change-Id: If4dcddfbdbc40e795f4306e83ede43187dd2439c
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 10:12:00 +00:00
Leena Miettinen
b92a445a64 Doc: Describe "Create sub directory for each metadata" check box
In Asset Import dialog.

Task-number: QDS-2744
Change-Id: I4c675f7406735ab808008e92cadac0770bb4f342
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-27 13:55:08 +00:00
Leena Miettinen
8c2e1eef86 Doc: Describe valid property names
The error message, "Error rewiting document" is unfortunately
not helpful.

Change-Id: Ie9973865929e5a7048411cc400d5c45fc60bc3a3
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-27 13:54:48 +00:00
Leena Miettinen
e1a8923699 Doc: Replace most occurrences of "artwork" with "design"
...or remove the term. Qt Bridge can be use to export complete
UI designs, instead of just artwork, and we want to stress that.

Task-number: QDS-2744
Change-Id: I843b09d822c77ca4a59b993a9b3e392b747c15f6
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Antti Aaltonen
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-27 13:54:38 +00:00
Leena Miettinen
7f28237915 Doc: Add support for the \youtube macro
Show links to Youtube videos using thumbnails with a play button.

Change-Id: I131f24b1fb723c817c2387429bbf52997003f105
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 13:51:31 +00:00
Johanna Vanhatapio
3680d6aa5c Doc: Update Editing 3D Assets in Design Mode
Fixes: QDS-3105
Change-Id: I7ddbe2330c30c2bd8c5630bb499c64b7366e406a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-26 07:51:30 +00:00
Leena Miettinen
3d6ef913b7 Doc: Update info about 2D effects
The effects can now be dragged to components in Navigator.
Add icons to the table to follow the new style of listing
components.

Fixes: QDS-3153
Change-Id: I2c603acb165f809143b04adb93f65a2655344fab
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-26 07:11:05 +00:00
Leena Miettinen
80777e7579 Doc: Document context menu commands for components
- Add a table that lists commands available for components
  in Navigator and Form Editor
- Include the table in Navigator and Form Editor topics
  using an include file
- Add documentation for new commands (and those that were
  not documented for some reason)

Task-number: QDS-2744
Change-Id: I6d2d886aaeb9d7f5e21ca5e8007e3b036c61f1d0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-25 09:07:15 +00:00
Leena Miettinen
6fa57b79c1 Doc: Describe using NOT check box in Binding Editor
To use the NOT operator.

Move the summary of logical operators into an include file
and include it in both the States and Binding Editor docs.

Fixes: QDS-3163
Change-Id: I8547c3dee50db35cf7d3037df84de7fe2d24ac3c
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-25 07:43:34 +00:00
Leena Miettinen
c01711435f Doc: Show "Using QML Modules with Plugins" in QDS Manual
This topic is also interesting to QDS users, who want to use
C++ plugins to simulate data in their applications.

Show and hide parts of the topic depending on whether the
QC Manual or QDS Manual is built.

Fixes: QDS-3126
Change-Id: Iba55de73cda265f3261bf6f790103251a6ef01db
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-25 07:43:16 +00:00
Leena Miettinen
038cac9fe6 Doc: Describe adding Studio Components and Effects to Qt installations
The Qt Quick Designer Components module is currently only delivered
with Qt Design Studio. To build projects that use the QML types in
the module, the developer must build the module and install it into
their Qt.

Fixes: QDS-3147
Change-Id: I649576be7f07e19ac2fc3fa9ace6fcb65882ea84
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-24 16:39:39 +00:00
Leena Miettinen
5d602466a5 Doc: Update info about Form Editor
Describe move, resize, and rotate cursors.
Add and update screenshots.

Change-Id: Id309b7ccc2221192813814d917e018f78971d60b
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-24 08:01:18 +00:00
Leena Miettinen
c9b53add47 Doc: Describe new and changed Navigator functions
- Locking
- Reversing
- Arranging

Fixes: QDS-3082
Change-Id: If1a246661219d8d55b66efa4cf16f5cad0c086af
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-24 08:01:02 +00:00
Leena Miettinen
50456e8a92 Doc: Add hardware and software recommendations for QDS
Fixes: QDS-3032
Change-Id: Ia11963a006141d2f53a8154faf7db6edccc5ea4a
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-20 17:36:40 +00:00
Leena Miettinen
2241e45891 Doc: Update some icons and move them to icons folder
Change-Id: I06867460704b6ff085cd2f06042c0dce81d26377
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-20 14:46:51 +00:00
Leena Miettinen
95685898a5 Doc: Edit info about MCU support and add screenshot
The QML Types tab displays only the supported types, so
that will tell users which types are supported.

Change-Id: I49dd1f7d81401a84b8780fdc61f49870c58c3935
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-20 07:58:44 +00:00
Leena Miettinen
552a86f6b3 Doc: Link to Qbs licenses and attributions
Fixes: QTCREATORBUG-24622
Change-Id: Ieeb35e94f1409a849383bc88739047b3b30bbe26
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-11-20 07:57:21 +00:00
Leena Miettinen
bb9ca6227c Doc: Describe rotating items in Form Editor
Fixes: QDS-3067
Change-Id: Id97876edaccac0d567694a9fcf350701d9df926b
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-19 17:35:49 +00:00
Johanna Vanhatapio
253a758d89 Doc: Update Applying 3D Effects
Task-number: QDS-3087
Change-Id: I2e2f4e70f98fbb54b32d22ce64307f48a1c79832
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-11-19 16:34:09 +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
Leena Miettinen
095970a57b Doc: Describe MCU support for types and properties
Fixes: QDS-3072
Change-Id: I3050b706b597d6f9171932c0ab5884b7d8ee094c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-19 10:39:40 +00:00