Commit Graph

597 Commits

Author SHA1 Message Date
Leena Miettinen
9884620724 Doc: Remove "Coding", "Finding", and "Configuring the Editor"
- In the QDS Manual, edit the "Code" view docs
- In the QDS Manual, add topics related to coding to the "Code"
  view docs by using \ingroup and \generatelist commands

Task-number: QTCREATORBUG-29361
Change-Id: I0966986a3b01b3551e8b68265e22fe86d1d5933d
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-19 12:37:53 +00:00
Leena Miettinen
05b640abc0 Doc: Turn "Checking Code Syntax" into how-to and reference topics
Task-number: QTCREATORBUG-29361
Change-Id: I96c4384dbde04189be3c80c3b21ee09ca33fb90c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 12:37:45 +00:00
Leena Miettinen
44fe5a9c5c Doc: Auto-generate navigation links based on "All Topics"
This does not change what you see as values of \previouspage
and \nextpage in the source files. However, when you build the
docs, QDoc replaces those values with links to the next and
previous page from the list in qtdesignstudio-toc.qdoc because
that page contains "\title All Topics".

So, with this change, you need to keep the list in "All Topics"
up to date.

Change-Id: I0996e383cbd60b7f4297524e4141a2d7af6fae13
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-18 15:04:55 +00:00
Leena Miettinen
4fa5422026 Doc: List Tutorials as a separate category on the front page
Add the following topics to the creator-tutorials group:

- Building and Running an Example
- Debugging a C++ Example Application

Task-number: QTCREATORBUG-29361
Change-Id: Ib6de92e99caf552ee8337b49af48bd04d6760474
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:17:06 +00:00
Leena Miettinen
9fa1dbcd3c Doc: Turn "Semantic Highlighting" into how-to topics
And move the general information to the Overview (or the Code
view docs in the QDS Manual).

Task-number: QTCREATORBUG-29361
Change-Id: Ib1d13f3d81d707691c84aa4241ed28662e2bc8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:37 +00:00
Leena Miettinen
ebb3ad8d47 Doc: Turn "Using Qt Quick Toolbars" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I5ed2aa9322f2d83dc8c58a6254a7cde5186252be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:09 +00:00
Tim Jenssen
6ea8c6290c Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: I3adcadf18eb19344461c5a6a0b6d3aec9045430c
2024-03-13 18:25:08 +01:00
Leena Miettinen
1cf925bc17 Doc: Describe the application manager plugin
Task-number: QTCREATORBUG-30209
Change-Id: Icd40d6da99e7fa53f667745a4de32b03b1157c99
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
2024-03-12 15:43:42 +00:00
Teea Poldsam
7def8caf65 Doc: Update Installation
Rewrote almost the whole page, renamed the topic, and updated the image.

Fixes: QDS-12025
Change-Id: Id8b4dcdb8513e726db933158833ba032ca9b8125
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-12 13:47:21 +00:00
Leena Miettinen
8c0bb53c76 Doc: Turn "Comparing Files" into a how-to topic
Hide it from the QDS Manual.

Task-number: QTCREATORBUG-29361
Change-Id: I7c44aaed42e374b8e07d093279c8078ada18c250
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-12 12:20:25 +00:00
Tim Jenssen
e7e9a58e46 Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: I8cd3cdf5854299d3017d6c6bfa656fc483a0e20b
2024-03-11 17:18:48 +00:00
Pranta Dastider
e1c9720c09 QmlDesigner: Create a document to list Qt runtime versions
Qt Design Studio uses a specific Qt Runtime version to
run the projects. This document lists the Qt runtime
versions used for different Qt Design Studio releases.

Fixes: QDS-12052
Change-Id: Ia9411393db4d800945c85ac67e4a9872a611308c
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2024-03-07 14:35:42 +00:00
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
Teea Poldsam
cbd91b0167 Doc: Update Log In UI - Timeline
Edited the tutorial and added some images.

Fixes: QDS-11191
Change-Id: Icfc9bda96472a7d5bd82822ff5dac66c6a5c5849
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2024-03-05 11:16:02 +00:00
Teea Poldsam
968b88edf9 Doc: Update Log In UI - States
Edited the tutorial and added some images.

Fixes: QDS-11190
Change-Id: Idb25b9bbe2274185ff279528fa6815a0a74abb94
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2024-03-05 08:34:24 +00:00
Pranta Dastider
555772130c QmlDesigner: Update instructions in the QML Modules with Plugins doc
This patch updates instructions in the QML Modules
with Plugins document. It also includes a new image
to give a visual idea about the instruction.

Fixes: QDS-12065
Change-Id: I35f0c7f96196c772cbcdd728817ea409318ff952
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2024-03-04 10:06:54 +00:00
Leena Miettinen
642c4beac1 Doc: Split up Refactoring into how-to topics
- Move info about viewing search results to the Search Results View
  reference topic
- Remove the Refactoring top-level topic (the general info is now in
  the Overview topic)

Task-number: QTCREATORBUG-29361
Change-Id: I4072e628368905ed1d5006ececae1b9eaa02fa10
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-04 07:37:47 +00:00
Teea Poldsam
9f024eb5cd Doc: Fix broken links to keyboard shortcuts
Fixed the broken links to keyboard shortcuts.

Fixes: QDS-12122
Change-Id: I461bbe2aa8f30e8f7fea202b15d7e66cfa23083f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-01 12:52:10 +00:00
Tim Jenssen
56c4ba1db4 Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: I1d328f67a1c538e36a54f9660d5fb2840a6753df
2024-02-29 19:40:30 +01:00
Teea Poldsam
3d77fb4c56 Doc: Update Log In UI - Positioning
Edited the tutorial and added some images.

Fixes: QDS-11189
Change-Id: I787afd3ee96c65f817ed844e23ba3c5786344524
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2024-02-28 14:20:59 +00:00
Mats Honkamaa
471479c21d Doc: Fix error in Figma Bridge docs
Task-number: QDS-12015
Change-Id: Iff96fc54ad953edf0dc247cb55df74d0b10306a1
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2024-02-28 09:43:29 +00:00
Pranta Dastider
18c2a8e02c QmlDesigner: Create the documentation for Qt UI Viewer
This patch creates the documentation for the
Android app Qt UI Viewer.

Fixes: QDS-11807
Change-Id: Ieabc7f986fa6470bf3c674062e10d3b3e4c10d42
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2024-02-27 10:08:36 +00:00
Teea Poldsam
d576441d97 Doc: Update Log In UI - Components
Edited the tutorial and added or updated images.

Fixes: QDS-11188
Change-Id: I9db7bacd28b9899fcfbf51e2d3447c060c578013
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-02-26 13:15:07 +00:00
Mats Honkamaa
417fbc7861 Doc: Add info about JSON backend function
Task-number: QDS-10961
Change-Id: I470fe9e1cda514e9b343d56f3e3bf34b95e3269e
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-02-26 08:23:04 +00:00
Teea Poldsam
5e4f5d9a21 Doc: Update Setting up a 3D Scene tutorial
Fixes: QDS-11910
Change-Id: I2ebc117a6caa98aba9846c8cad9b18c835fc10b2
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-02-22 10:35:00 +00:00
Tim Jenssen
0416941fd1 CMake: introduce option BUILD_DESIGNSTUDIO
This change needs an update of the super repository

If you want to buid QtDesignStudio documentation no branding path
is necessary anymore:

cmake -DCMAKE_GENERATOR:STRING=Ninja -DWITH_DOCS=ON -DCMAKE_PREFIX_PATH:PATH=C:\Qt_online\6.5.3\msvc2019_64 -DBUILD_DESIGNSTUDIO=ON C:/dev/tqtc-qtc-super/qtcreator
cmake --build . --target html_docs

Task-number: QDS-9827
Task-number: QTCREATORBUG-24222
Change-Id: Ic779b6ab57c71c7f6fa53467bf1ba3ee17cab0ea
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2024-02-20 20:19:40 +00:00
Leena Miettinen
75fa962eb4 Doc: Update info about QML live preview
Task-number: QTCREATORBUG-30209
Change-Id: I0c4717a192e7fd94924fa573994bc27d7687d1d3
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-02-15 13:58:49 +00:00
Leena Miettinen
9d3b154ca8 Doc: Describe new search options
- Restructure the "Finding and Replacing" topic.

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: I107f366d99877a80a0ed8973c9156e46ee0ab312
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-15 13:49:17 +00:00
Tim Jenssen
adcac7cb6b Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: I242c01e82fc1b0db1f5e88c35d526f91dd022337
2024-02-13 14:33:35 +01:00
Teea Poldsam
ba536a5e9a Doc: Fix a broken link
Fixes: QDS-11930
Change-Id: Ide113597e9a1f3b1958946431db4fceaad41b069
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-02-13 07:35:56 +00:00
Teea Poldsam
dccd828f1f Doc: Update keyboard shortcuts
Created separate page for QDS. Reviewed and updated shortcut list.

Fixes: QDS-9499
Change-Id: I27d7dac386570c81958b8af5da2987143162aab4
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-02-12 10:46:27 +00:00
Johanna Vanhatapio
c6705be88b Doc: Describe the Effect Composer
Fixes: QDS-10528
Change-Id: I46d7ab1977acb7f0af5c0aa790de7fbf2624a449
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-02-08 14:38:11 +00:00
Teea Poldsam
9201491292 Doc: Update the image for 3D models
Updated the image for 3D models and added "sphere" in description
text.

Task-number: QDS-11888
Change-Id: Iab917dea2baff548140751a095325494791a8bdf
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-02-05 11:54:01 +00:00
Tim Jenssen
a3a69d83f3 Merge remote-tracking branch 'origin/qds/dev' into 13.0
Change-Id: I09a0e8514c8ad7badaa7af6d101c71d5c96b5465
2024-01-31 20:25:34 +01:00
Pranta Dastider
2b59676b49 QmlDesigner: Update images in the 3D Textures document
This patch updates the old images in the 3D Textures
document screenshot. Some descriptions were updated
to keep it relevent with the new changes.

Fixes: QDS-11564
Change-Id: Ia1acb9199d76e202373a45e801d290d7b1ae8505
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-31 12:43:14 +00:00
Samuel Mira
2a430a5fa4 Update supported feature list for MCU in QDS 4.4 docs
. Noted that StateGroup is disabled now
. Removed the part about the need to configure QUL to use ts files

Task-number: QDS-10577
Change-Id: Iedf21549ef9e32e84629eb43f4e15d43bac67dd6
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-31 08:53:19 +00:00
Pranta Dastider
be41546c5b QmlDesigner: Update image in the Design Views and Concepts and Terms documents
This patch updates the old image to include lock the views features
in the document screenshot.

Fixes: QDS-11560
Change-Id: I886c2cdd385117791ac7f45f7477a7bf5458ac66
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-24 13:10:05 +00:00
Pranta Dastider
5711ac4df0 QmlDesigner: Update image in the 2D view document
This patch updates the old image to include new topbar
in the document screenshot.

Fixes: QDS-11567
Change-Id: I07573874a1bfa428e377c394ade0cf556ce6b056
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-24 13:07:09 +00:00
Pranta Dastider
e63b88c7dd QmlDesigner: Update image in the Live Preview documents
This patch updates the old image to include lock the views features
in the document screenshot. Also it updates the text description to match
the change.

Fixes: QDS-11565
Change-Id: I262be3392552920607725becda6e21d3e571c122
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-24 09:19:48 +00:00
Tim Jenssen
399f7a1968 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: I5d593fc74785958886453dc0b452c25356a8c65f
2024-01-18 11:15:29 +00:00
Pranta Dastider
0500a9e547 QmlDesigner: Update image in the Materials document
This patch updates the old image to include new top bar
in the document screenshot. Also it updates the old material
editor image to include more context to it.

Fixes: QDS-11563
Change-Id: I3e9c064702b50ce0a22628f1a12c28c2dbb1d0eb
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2024-01-17 11:30:13 +00:00
Vikas Pachdha
8d5b3b4ad6 Docs: Update figma qt bridge plugin docs
Update screenshots
Remove stale docs
Document start screen and page organization

Task-number: QDS-11614
Change-Id: I16160ffae415a258e1250d6529f976e9dbe0e376
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2024-01-15 15:13:46 +00:00
Vikas Pachdha
65b0d04558 Docs: Document page organization for Sketch
Task-number: QDS-11614
Change-Id: I22e5e7668ae1617f459dce1549847ab163265b61
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-15 15:13:38 +00:00
Pranta Dastider
1e56f5d919 QmlDesigner: Update image in the Effect Maker document
This patch updates the old image to include the new topbar
in the Qt Quick Effect Maker document.

Fixes: QDS-11568
Change-Id: I90086b8fdb0f86947efcce40d2ef2171fa9b1c63
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-12 12:01:43 +00:00
Pranta Dastider
fdcb29c711 QmlDesigner: Update image in the Managing Workspaces document
This patch updates the old image to include lock the views features
in the document screenshot. Also it updates the text description to match
the change.

Fixes: QDS-11562
Change-Id: I0e573be2f0e879bf4fb62a6f5120cd0b0aafa1d0
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-11 15:16:42 +00:00
Pranta Dastider
f631c25d8b QmlDesigner: Update image in the Previewing Android Applications document
This patch updates the old image to include lock the views features
in the document screenshot. The image was updated from Png to Webp.

Fixes: QDS-11566
Change-Id: I28fc637a3fe78a8e82b6fb3474b1edb49a31c1ee
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-11 15:16:06 +00:00
Leena Miettinen
c01129828f Doc: Split up "Refactoring" and "Applying Refactoring Actions"
Replace "refactoring actions" with "quick fixes", as they are
called that in the UI.

Task-number: QTCREATORBUG-29361
Change-Id: I6952bb1b222c340a6bccb175733c611907885a47
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-01-09 12:54:34 +00:00
Leena Miettinen
32e6f73119 Doc: Split "Completing Code" into several topics
Task-number: QTCREATORBUG-29361
Change-Id: Icbface3923c3d56ed54d53dc1e614f02269c30b2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-09 11:48:09 +00:00
Leena Miettinen
77ad9a60da Doc: Split "Specifying Text Editor Settings"
- Move info into "Font & Colors" and "Behavior" reference topics
- Turn the step list into the "Change editor colors" how-to topic
- Fix the "Font & Colors" tab name in several places

Task-number: QTCREATORBUG-29361
Change-Id: I1495295764fdcaed346891e93880a78ab7ce655d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-09 08:37:16 +00:00
Tim Jenssen
435761fd0a Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Ieb14c6311dbfe828a94981854b9ec8c18182b6cd
2024-01-05 14:18:18 +00:00