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>
- Add missing sourcedir (../api) to get landing page and other
documentation generated.
- Remove invalid sourcedirs (Find and Locator plugin directories
no longer exist).
Change-Id: I125e86702eaded08de342e103970281984f449d4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
A default indent of 1 was defined for code snippets. It was overridden
by the template, and most likely left there as an oversight. Now, with
QDoc and the templates from Qt 5.6 it does have an effect, and makes
the style look worse and copy-pasting code more cumbersome.
Change-Id: I37a0facd4c03566eaf295a2cc391fa328f50c14d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
A commercial Qt Quick Designer plugin for
adding ISO 7000 icons to applications from
an icon library.
Change-Id: I96d740d63bc77da9817ce2d5ccdb1625dbc5caa6
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
"Debugging and Analyzing" is now "Testing", because
autotests are also described in this section.
Change-Id: Ied1de78d630e4e7faa39d343475b5e493b5e89c7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
It has been deprecated and was only used as an example.
Change-Id: I4e483e2f86b32476e4b88c9c3eecb7eeffa42e72
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
Update text to match the template and UI.
Use the \example command instead of \page to have qdoc
generate HTML files from the example files. This requires
also adding the .pro file.
Add an SVG image to the sources and link to it from the
text.
Change-Id: Ib90798386ee082c9ea2a405b33a4f2a5996a9d2a
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
Based on the Qt Quick Controls UI Forms example.
Change-Id: Iec42b7559161f980e4f482c63bfc40a22f5e77f8
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
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>
- Add a copyright notice (required for projects external
to Qt in the new template)
- Add an .html file with sidebar content
Change-Id: I2c9d965698aa2d2ed01426510b16916ed4fef8cf
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
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>
-can be used for referencing Qt Creator's pages from other
QDoc projects.
Change-Id: Ifdb82a8995976580876523f5bd6efb688bdfb9b1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
the global qdoc configs may live in the source dir, but the indexes are
always in the build dir.
this will obviously only work for a non-prefix (developer) build of qt,
as a non-installed prefix build is not usable from the outside.
Task-number: QTCREATORBUG-11919
Change-Id: I268af2f075a098ac5fe788a2f85c754dc6e4e8b0
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
