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>
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>
- 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>
- 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>
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>
- 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>
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>
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>
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>
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>
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>
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>
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>
..from the Qt Design Studio Manual doc configuration file.
Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
For some unknown reason qdoc does not add the include paths for
Qt modules, so we need to do that manually.
Also, if we do that, we need to pass it the default include paths, so
standard C++ headers are found.
Qt includes and standard headers are found now, but
Framework style includes on macOS still fail ("QtCore/QString"), which are
used in Qt headers as well. Looks like the framework path that is passed
with -F to qdoc is not passed on correctly.
Task-number: QTCREATORBUG-22451
Change-Id: I04b2c75ecdeb1f0e70ba9adfea039f0ff16ec96b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.
doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio
Edit the config files accordingly.
Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Qt Quick Timeline module is delivered with Qt 5.14 and later.
Change-Id: I5666fa0fd190607a1bb6224dcff5ac7f39db61f7
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
For running Qt Quick UI projects (.qmlproject) in web
browsers.
Change-Id: Ied9b971755ccef9f94e9e0ffb578d3ecbd0ef6c0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
The documentation was moved from the Qt Design Studio repository
and edited to make it applicable to Qt Creator, too.
Change-Id: I3072fc712b5ee002cd6e7486927de31f9117d7bc
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
- Qt Quick Controls 1 has been removed and most link targets have
been changed
- Leave some link targets where links would break
- Leave strings that still have the "2" in Qt Creator
- Remove the obsolete dependency (QDoc complained about it)
Change-Id: I05148df3b07b4499f802557252c028b11ca29213
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
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>
Currently, only Android and embedded Linux devices are supported
by Qt Design Studio.
Change-Id: I10005f6a9cfeb93c99447796c1c9e6d47ab578de
Reviewed-by: Vikas Pachdha <vikas.pachdha@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Do not rename documentation qhp file. The documentation qmake files
currently depend on the files having the same base name as the qdocconf file.
Also do not change the documentation namespace. There are places where
these are mentioned in translated strings.
Fixup of 54208113ee
Change-Id: Iace171535ea5be6e22fec9760a5d96722b052341
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
Some regularly used context-menu items can now be selected
on the toolbar. Some of the icons are constructed at runtime,
so images are needed for them. Some are in a new location that
has to be added to the configuration file.
Change-Id: Ibfc38ec21ed5526702abf89e64899efa5b978700
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Since we cannot directly use qt_docs.prf since it contains
various Qt specific details, adapt it for use in Qt Creator.
This can then be used e.g. by plugins that are not part of the
Qt Creator repository.
Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
This fixes the problem that the whole TOC is not visible in the
Qt Creator Help mode Contents view (because it was generated based on
the \table entries, not the \list entries).
Task-number: QTCREATORBUG-10585
Change-Id: I86607e10db7172b2a7492e4ce1660c39390ef9ed
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Add a link to the Layout QML type and fix the name of the import
to stop an autolink from being generated to the wrong target.
Change-Id: Id2ca5e418ea6d254813a20f00b6623ff21dda09a
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
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>
Add the Qt SCXML index file to be able to link to the module
docs.
Change-Id: Ibd28071cdc3c98c07fb91c73732d809ffed5333b
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
They are needed in the timeline view.
The change in qtcreator-project.qdocconf makes sure
that qdoc still finds the referenced icons.
Change-Id: I812fba8e57d06d93efc00c295467c83c08cd1784
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
This removes the need to take screenshots of icons.
- Add icon source directories for the .qdocconf file
- Remove screenshots of icons from doc\images (except completion
icons)
- Copy images that do not have unique names from src or libs
to \docs\images
- Create images that use overlays and update them in docs\images
- Fix paths and filenames in \inlineimage commands
- Fix text where one screenshot was replaced by two icons
Change-Id: Ib98206890bd15a843566de8d709e45487c70dfbd
Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
