Commit Graph

35 Commits

Author SHA1 Message Date
Pranta Dastider
0a54933c8d QmlDesigner: Create a document for the Design Effect Demo Example
This patch creates a document for the Design Effect Demo Example
in Qt Design Studio. It updates a macro, include images and creates text to
support the usage of this demo.

Fixes: QDS-13034
Change-Id: Ifc3634d388d8e27c64ecd2b244669d60757ad33c
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-08-05 09:55:52 +00:00
Tim Jenssen
4515fba526 Merge remote-tracking branch 'origin/qds/dev'
Conflicts: src/plugins/qmldesigner/CMakeLists.txt

Change-Id: I250c8e5284ddb0f335c440999b8920762419c89b
2024-05-28 19:06:18 +02:00
Eike Ziller
8b5f5744dc Rename Qt Designer -> Qt Widgets Designer
Fixes: QTCREATORBUG-30756
Change-Id: Icb4a2513e230b71b5bb5033ead6a09ad3a8963ab
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-05-23 11:37:08 +00:00
Pranta Dastider
5f23a07ba7 QmlDesigner: Update Qt Academy course links in documents
This patch adds some of the Qt Academy course links in
the relevant documents.

Fixes: QDS-12747
Change-Id: I8309681869922be3277e775c312ffa1210d64a29
Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
2024-05-23 08:46:38 +00:00
Eike Ziller
90b3068ecf Merge remote-tracking branch 'origin/13.0'
Conflicts:
	doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc

Change-Id: If93df2592a66679eeff9c8a337372e3aad65f1f1
2024-05-21 09:40:46 +02:00
Tim Jenssen
cbd36f93fa Merge remote-tracking branch 'origin/13.0' into qds/dev
Change-Id: Ief07ead0b4cf513c70bd74d4f5e28e4642edc78e
2024-05-17 17:57:18 +00:00
Leena Miettinen
c7803fe6ae Doc: Mention QML Language Server in "Adding Language Servers"
- Add a link to "Turn on QML Language Server".
- Add the \QMLLS macro and use it everywhere.

Fixes: QTCREATORBUG-30823
Change-Id: I75ff67967ad6bf592dceeae46486713012aafd50
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-05-17 09:07:23 +00:00
Leena Miettinen
5b5c61c519 Doc: Restructure info on developing for Boot2Qt devices
- Split the topic into how-to and reference topics
- Remove redundant information
- Make the instructions consistent with the remote Linux topics
- Include info about SSH connections from the remote Linux topic
- Add the \B2Q macro for "Boot to Qt" and use it where possible
  (some UI text still says "Boot2Qt"

Task-number: TCREATORBUG-29361
Change-Id: I7fe5f957049d84ec7402f4c11a070ac2d44fcb38
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
2024-05-16 07:42:09 +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
Riitta-Leena Miettinen
0fe891678a Doc: Use a link to "Find preferences" as value of \preferences
- Add the instructions for finding the Preferences menu to the
  "Find a particular preference" topic and rename it "Find preferences".
- Remove the "Find menu items on macOS" topic

Change-Id: I627e5c20d2c63efb4490d446608b923ac15a6aac
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-24 09:00:36 +00:00
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00: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
239d8882a9 Doc: Update QQEM parts in doc
Task-number: QDS-9588
Change-Id: I3ae76bf708549e18e8024122d809bd15cb63de05
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-05-11 09:31:18 +00:00
Esa Törmänen
53ce5d6dff Doc: Add Qt Quick Ultralite macro
Task-number: QDS-9613
Change-Id: I8b3dc970d2ca335f9efb320eb22b41891d96f498
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-04-04 08:51:14 +00:00
Esa Törmänen
ae6c686836 Doc: Add Qt for MCUs macro
Added a new Qt for MCUs macro and modified a number of related topics
accordingly.

Task-number: QDS-9609
Change-Id: I6506a9cb6671c29d5b164d53cb01c827639ecb16
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-04-04 06:39:19 +00:00
Pranta Dastider
a34401eae2 QmlDesigner: Create Figma Quick Control Template merge doc
There is a new feature, which lets to have Figma users templates
from Qt Design studio on Figma end. And later getting components
imported from Figma to Qt Design studio to have them accurately
as local components. This document aims to note that process.

Fixes: QDS-8719
Change-Id: I8b375730c32c8a41bbeebcacc616ed2a295bf881
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-02-22 09:51:12 +00:00
Vikas Pachdha
624df6ec44 Doc: Add Qt-Bridge plugin docs for adobe XD
Task-number: QDS-4615
Change-Id: Ie3c7d814fbf59841f112315cf71553076ec7e0d7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-09-29 10:02:06 +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
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
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
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
Leena Miettinen
f51258a17c Doc: Move Qt Bridge product name macros to the common macros file
..from the Qt Design Studio Manual doc configuration file.

Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-14 10:18:31 +00:00
Leena Miettinen
999564d393 Doc: Describe using Qt Design Viewer
For running Qt Quick UI projects (.qmlproject) in web
browsers.

Change-Id: Ied9b971755ccef9f94e9e0ffb578d3ecbd0ef6c0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-10-25 07:56:23 +00:00
Leena Miettinen
fdd8650657 Doc: Describe converting Qt Quick UI Prototypes to Applications
Qt Quick UI Prototype projects (.qmlproject) are used in Qt Design
Studio, but they must be converted to Qt Quick Application projects
for building and running them in Qt Creator.

Add example files and quote code from them.

Task-number: QDS-357
Change-Id: Ib0bf1b342ec54faeca108e5586389730a85b5116
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-01-16 10:59:30 +00:00
Eike Ziller
54208113ee Pass IDE_DISPLAY_NAME et al to qdoc and use it for manual
Change-Id: I5d52c9561d4c49df503c0e99c8765979516e5b5c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-20 10:01:52 +00:00
hjk
1e8ffa20d0 Doc: Introduce a macro \macos to adapt to upcoming renamings
Start with an initial value 'macOS' and use in uncontroversial
places in the docs. Some explicit references to older versions
are untouched in this patch.

Change-Id: Ibea4115c45fc2ff2c9a0518d92797df26fd4138f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-08-03 15:30:06 +00:00
Leena Miettinen
db48c49af9 Doc: add a "commercial" icon to commercial-only topics
For purely commercial apps, this is done by using the
template, but Qt Creator is mostly open source, so an
image is used.

Use a \commercial macro with a tooltip and link to the
image.

Change-Id: I5e3df953821551331afef2ec642b482b52ff909e
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-04-08 10:45:50 +00:00
Ulf Hermann
52ef14190e QmlProfiler: Update documentation
Quite a few things have changed and the documentation should describe
them correctly.

Change-Id: I21a1f81022f21500c069b641744a37eef9eaa6b9
Task-number: QTCREATORBUG-12590
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-07-04 16:14:40 +02:00
Leena Miettinen
0962c0b03f Doc: remove Qt Simulator macro
The Qt Simulator is no longer mentioned in the docs.

Change-Id: I8730e45c75f2e69dadc053ebfa205aa7b6eef5fd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-03-14 16:14:05 +01:00
Leena Miettinen
7b088afbe9 Doc: don't use the term SDK in connection with Qt
Replace with "Qt distributions" or "installers" or rewrite
in some other way.

Remove references to installing Qt 4 SDK, because it is
no longer available for downloading.

Change-Id: I291f82702e21d953f2efbb0e634d6454b4bc17b9
Reviewed-by: hjk <hjk121@nokiamail.com>
2014-03-14 16:12:10 +01:00
Leena Miettinen
419c6de735 Doc: replace deprecated QDoc commands
The \i and \o commands were replaced with \li and
\bold was replaced with \b in QDoc for Qt 5.

The \input command was replaced with \include in the docs.

Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 09:44:18 +01:00
Leena Miettinen
d465f2e363 Doc: use macro for Qt Simulator product name
Change-Id: I68b7d4d2d8a6ef62f3b09aaf114b1cde94cda63b
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-01-19 09:39:41 +01:00
Leena Miettinen
35d81bb367 Doc: add and edit macros to remove emphasis for product names
Change-Id: I077c721c661a2b9fa8dfbd93dd9888a8d700f5c5
Reviewed-on: http://codereview.qt-project.org/5603
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 15:53:45 +02:00
Leena Miettinen
f0828d6114 Doc: change SDK name 2011-03-07 14:24:51 +01:00
David Boddie
a20cd34863 Updated the configuration files to use the updated qdoc.
Updated qdoc to remove hard-coded dependencies on style sheets.
Simplified the offline documentation, introducing an offline.css
file to be used for documentation in Qt Creator.
2011-02-11 08:40:55 +01:00