Commit Graph

274 Commits

Author SHA1 Message Date
Leena Miettinen
bd38c30759 Doc: Reorganize info on kits
Divide current topics into how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I0e64b2bbe9d4f6d403815dffe937a567eb9d4844
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:32 +00:00
Leena Miettinen
0ae0b84936 Doc: Edit "Specifying Code Style" and "Indenting Text or Code"
Turn these topics into several how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I8d6a7af2db7eff2c852c2cc491878ce29272b59b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:19 +00:00
Tim Jenssen
1a3a8ecc96 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Id242ab4ca485527defdcc1555d204e12e50ddb7a
2023-09-14 17:37:24 +02:00
Mats Honkamaa
781e9dd5e3 Doc: Unify product naming
Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses
as well.

Task-number: QTBUG-116573
Change-Id: I90247956300607b852a17df96aa667bf55805e36
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:22:28 +00:00
Mats Honkamaa
902a1206dd Doc: Add note about Qt Quick Studio Modules
Task-number: QDS-9586
Change-Id: I0550a3ebcfc7bab6c00bc8ada3497c4d6f880030
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-09-11 11:45:37 +00:00
Leena Miettinen
39dfc12a9e Doc: Divide "Creating Files" into How-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ib5e31777ef1649f86525b41bcfbcac52b9dd231e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-08-30 11:26:15 +00:00
Leena Miettinen
4c4719f4d0 Doc: Turn Qt for Python wizard docs into tutorials
Remove the Python instructions from Creating Projects and
turn them into Qt Quick and Qt Widgets tutorials.

Turn the Developing Qt for Python Applications topic into
a How-to.

Change-Id: Ia3b547fbefd5f8e6b67d673b9724cd6e3f0b4424
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-08-28 09:55:01 +00:00
Leena Miettinen
a0f0f9c69b Doc: Update tutorials
- Use \ingroup creator-tutorials to group tutorials
- Use \annotatedlist to automatically generate tables that list tutorials
- Add \brief commands to add descriptions to the tables
- Remove some leftover descriptions from the Qt Quick Application
  wizard template docs
- Fix references to UI text
- Write "you" instead of "we"
- Use curly braces to define alt text for images
- Some language fixes

Task-number: QTCREATORBUG-28996
Change-Id: I4b611319b6867cae11d613e0a4d075923cdb037e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-07-05 13:48:04 +00:00
Leena Miettinen
12bcdee809 Doc: Fix instructions for previewing QML files
Change-Id: Ifbc0df8d64ab84adc05d427c0c925221533ea973
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-06-26 06:46:09 +00:00
Eike Ziller
7724f8653f Merge remote-tracking branch 'origin/10.0'
Change-Id: I7a3925ad8e4f97461b64a70217102ed900430253
2023-05-05 10:39:47 +02:00
Leena Miettinen
885bf15a79 Doc: Describe the "Qt Quick Application (compat)" wizard template
Fix descriptions of the "Qt Quick Application" wizard template.

Change-Id: I15390252b29f5437d488bb8692787993855d1545
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-02 09:33:21 +00:00
Leena Miettinen
e7b5e64a70 Doc: Remove detailed info about wizard templates
Improve descriptions of some wizard templates.

Task-number: QTCREATORBUG-28996
Change-Id: Ib53fa38918120af60a03f3850fed7db1e6f0c391
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-26 12:18:57 +00:00
Leena Miettinen
e16ddefbdd Doc: Fix link to a removed section
... called Adding Qt Quick Timeline Module to Qt Installations

Change-Id: Ia074ad82ea544bc65286b8f0a8d54997521aabe6
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-03-09 09:37:29 +00:00
Fabian Kosmale
b80546c1d9 Docs: Adjust to QtQuick application wizard changes
The filename starts now with an upper-case M.
Amends fa2ea6fd97

Change-Id: Ia5055b0be1edc77aa5cab84329424241c4334a27
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-03-03 12:51:29 +00:00
Leena Miettinen
90a8496cdc Doc: Update docs about creating Qt Quick Application projects
You now have the option to create projects that you can open in QDS.

Task-number: QTCREATORBUG-28721
Change-Id: Ia8f36fd65f2356b9987b027d7b37ac6848ff7e03
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-03-02 13:10:54 +00:00
Leena Miettinen
a8e424f75e Doc: Select the tool to automatically format QML files
For example, qmlformat.

Task-number: QTCREATORBUG-28721
Change-Id: I509cba3fd842f94e7656a3356cc1de81e41fd8e2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-02-23 10:00:38 +00:00
Leena Miettinen
0328c14167 Doc: Describe color tooltips for QML code in code editor
Task-number: QTCREATORBUG-28721
Change-Id: Ifdd82a9e72bc19f484f6b3737f1a562a95e9a7c3
Reviewed-by: André Hartmann <aha_1980@gmx.de>
2023-02-22 09:22:51 +00:00
Leena Miettinen
447f8b80c3 Doc: Remove double words and fix a typo
For example, "and and", "the the", "or or"...

Change-Id: Ie5795efb857e674c5a584e97a60bcb9b2ba869d2
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-07 07:23:13 +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
Pranta Dastider
51fe3ca59e QmlDesigner: Update component integration instructions for CMake
Starting with QDS 3.9 the cmake projects can download and
add the Qt Quick Studio Components to the application project.
This patch updates that notion into the document.

Fixes: QDS-8603
Change-Id: I7555b04eca72fc09bc9c73b0954f58aec2f3ddd5
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-12-15 15:48:15 +00:00
Tim Jenssen
02c65495d1 Merge remote-tracking branch 'origin/9.0' into qds/dev
Change-Id: I5e66666644fd16de60a0158e5e884706622ae3ba
2022-11-24 19:01:47 +01:00
Pranta Dastider
ab7b805296 QmlDesigner: Update Qt Installation instruction
This update the Qt installation instructions with a bit
more example. Also removes the outdated part with qmake.

Fixes: QDS-8189
Change-Id: I9cfaeaff30585dc6ef65bb1ddedb48c1e5d13805
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-11-21 10:30:33 +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
Eike Ziller
b402f35481 Merge remote-tracking branch 'origin/8.0' into 9.0
Conflicts:
	doc/qtcreator/src/qtquick/qt-design-viewer.qdoc
	src/plugins/qmldesigner/components/assetslibrary/assetslibrarywidget.cpp
	src/plugins/qmldesigner/components/edit3d/edit3dwidget.cpp
	src/plugins/qmldesigner/components/materialbrowser/materialbrowserview.cpp
	src/plugins/qmldesigner/components/navigator/choosefrompropertylistdialog.cpp
	src/plugins/qmldesigner/components/navigator/navigatortreemodel.cpp
	src/plugins/qmldesigner/designercore/model/abstractview.cpp
	src/plugins/qmldesigner/designercore/model/import.cpp
	src/plugins/qmldesigner/designercore/model/model_p.h
	src/plugins/qmldesigner/designercore/model/texttomodelmerger.cpp
	src/plugins/qmlprojectmanager/qmlproject.cpp

Change-Id: I4236bf0da9306abf201f4679259e72dd7c1eddbe
2022-11-01 15:38:49 +01:00
Leena Miettinen
596529651b Doc: Fix link to Qt 6 based Qt Design Viewer
Change-Id: I68a10b4508feb6760f28ef63d29fa54bc1ae37f3
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2022-10-27 13:06:17 +00:00
Mats Honkamaa
552831ead4 Doc: Update documentation on how to share apps online
Provide basic information and instructions about sharing applications online

Task-number: QDS-7155
Change-Id: I69632f370a452c1b9cc03ebac260f0382a89449b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-10-25 11:23:20 +00:00
Leena Miettinen
59b92b6417 Doc: Create separate topics for Qt Design Viewer in QC and QDS manuals
The process in the two apps now differs too much for single-sourcing
the docs to be helpful.

Change-Id: I3aa60c9f2219d19843f5a4c635fc49c83548f13f
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2022-10-21 13:24:00 +00:00
Eike Ziller
a2f21d40f5 Merge remote-tracking branch 'origin/8.0'
Conflicts:
	src/plugins/debugger/debuggerdialogs.cpp
	src/plugins/qmldesigner/components/materialeditor/materialeditorview.cpp
	src/plugins/texteditor/fontsettingspage.cpp

Change-Id: I5a6accd2065e0d8320045b57ade7b54a9a09aae0
2022-08-31 11:03:13 +02:00
Mats Honkamaa
422a20864e Doc: Update view names in documentation
Changing the following view names:
Form Editor -> 2D
3D Editor -> 3D
Connection View -> Connections
Curve Editor -> Curves
Transition Editor - Transitions

Task-number: QDS-7316
Change-Id: Id9b719b368cf5f7156319a597e94f0a3eb7c89ab
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-08-30 09:02:08 +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
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
1b4c3552c6 Doc: Fix UI text in docs to "Pin Qt Quick Toolbar"
Add screenshot of the tab and point to it from where the tab is
described.

Change-Id: I0ff67733de7b15b9c7aa9ccae4589142f76236fb
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 07:42:27 +00:00
Leena Miettinen
de4c8cb174 Doc: Describe Squish Coco plugin
Fixes: QTCREATORBUG-27693
Change-Id: Ia4fadaeca08fc0f63d761394f1b8750a3ae6c010
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-07-05 06:11: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
Eike Ziller
6a296ab68a Merge remote-tracking branch 'origin/7.0'
Conflicts:
	src/plugins/qmlprojectmanager/qmlprojectplugin.cpp

Change-Id: I14030f58303839e706af892dd12a67566e3bed68
2022-05-18 13:35:47 +02:00
Leena Miettinen
6537f1cadc Doc: Remove obsolete instructions for registering QML types
QML types are now registered automatically in most cases.

Task-number: QTCREATORBUG-26617
Change-Id: I4f1e2a731893081cbb0c399e7742b3656f201a1d
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-05-17 07:14:06 +00:00
Eike Ziller
3b2134711b Merge remote-tracking branch 'origin/7.0'
Conflicts:
	src/plugins/webassembly/webassemblyrunconfiguration.cpp
	src/tools/processlauncher/launchersockethandler.cpp

Change-Id: Iab052af98013aa59282c16f22ae6e9ecb32f50c4
2022-04-20 16:12:41 +02:00
Leena Miettinen
63aaa65439 Doc: Fix links to Boot2Qt topics
And update information about Boot2Qt requirements.

Fixes: QTCREATORBUG-27251
Change-Id: Ifda686fafcd6b258a2c4dd8102260e05b637335d
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-04-13 13:49:42 +00:00
Mats Honkamaa
653c9b4a6f Doc: Add Android live preview docs
Copyedit and add the documentation from https://intranet.qt.io/display/QTRD/Preview+Android+application
to the public doc repo.

Task-number: QDS-5729
Change-Id: I8324226f108549b069976b7447ae5712735c1434
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-04-08 07:06:51 +00:00
Eike Ziller
6a1e3f5e6e Merge remote-tracking branch 'origin/7.0'
Change-Id: I95dba3037fe5630cafc3c1e45c579ff18730262c
2022-04-04 11:50:16 +02:00
Thomas Hartmann
b43da9c42d QmlDesigner: Explain how to build qtquickdesigner-components with CMake
For qmake you have to use the qmake or 5.15 branch.
Using links to code.qt.io instead of codereview.

Change-Id: I8915529968623f8c239f1abc1165f3e7f95a4866
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-04-01 08:35:36 +00:00
Artem Sokolovskii
09264b6da3 Wizard: Fix misspelling
Change-Id: Iabf0655fd9d8690e7d18d0cc2366bcbf43835916
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-03-23 11:41:32 +00:00
Leena Miettinen
a61c39eb26 Doc: Update screenshots of New Project and New Wizard dialogs
Rename some screenshots and use them in several places.

Fixes: QTCREATORBUG-27139
Change-Id: I3986a3060710270b4d4400228d4917e83e3183da
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-03 14:11:06 +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
a6c44fdb1c Doc: Remove remaining referrences to Library view
The view was divided into Assets and Components views.

Task-number: QDS-6216
Change-Id: I5a73f60e511bb2936a009bbe6f61004f9d85d348
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2022-02-28 14:26:45 +00:00
Leena Miettinen
6e366c0823 Doc: Replace "New File or Project" with "New Project" or "New File"
We missed the .qdocinc files.
Update the screenshot.

Task-number: QTCREATORBUG-26610
Change-Id: Ic5a86c94e995a209c2139976ed645b7f71556b37
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-23 11:56:50 +00:00
Leena Miettinen
d487110351 QML/JS: Fix terminology in messages
- Replace Qt Quick Designer with Qt Design Studio
- Replace "Qt Quick UI form" with "UI file (.ui.qml)"

Also fix the docs:

- Add missing messages
- Hide QDS  messages from Qt Creator Manual
- Make punctuation consistent
- Add some links to more information

Task-number: QDS-2670
Task-number: QTCREATORBUG-27055
Change-Id: Id90f1ad82e7297f91225bc8d650a9578ba071330
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-02-18 07:33:35 +00:00
Antti Määttä
3905239cea Add Quick 3D events to profiler documentation
Task-number: QTBUG-100643
Change-Id: I8e3096892742b647d3aadabfc61e0eab966f11ea
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
2022-02-15 12:47:08 +00:00
Eike Ziller
65e8c864af Merge remote-tracking branch 'origin/6.0'
Change-Id: I405e3f95b0cdcd7b2686f31baae16c03c787f007
2022-01-06 11:55:39 +01:00