Commit Graph

44 Commits

Author SHA1 Message Date
Leena Miettinen
bcd3491fd9 Doc: Update front page and getting started page
Apply new design and images from the UX team.

Task-number: QTCREATORBUG-30248
Change-Id: I202288f0dccedc65e47cd8bdfa49915d47cd79cd
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-04 10:48:11 +00:00
Leena Miettinen
b4d345db2a Doc: Restructure "Building Applications for the Web"
Remove the requirements and link to Qt for WebAssembly docs.

Task-number: QTCREATORBUG-29361
Change-Id: I73b708953834fa0b239805c0ea10232c3fa440f5
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-05-29 09:54:31 +00:00
Leena Miettinen
5b94de6308 Doc: Turn QML preview topics in to how-to topics in Qt Creator docs
- Move qt-quick-live-preview.qdoc to QDS sources
- Copy qt-quick-live-preview-desktop.qdoc to QDS sources as
  how-to\qtdesignstudio-live-preview-desktop.qdoc and remove
  Qt Creator-specific information from it
- Remove the "Running on Devices" and "Using SCXML State Machines"
  topics, which are not used any more
- Edit for style

Task-number: QTCREATORBUG-29361
Change-Id: I1646505aff8659605b09735da515e5d21070d39e
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
2024-05-03 12:31:41 +00:00
Leena Miettinen
b27be7e2bf Doc: Move deployment info to Reference
Task-number: QTCREATORBUG-29361
Change-Id: Ibabac3192c3f2c1aa7ae5594ed6f5f3a915d774c
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Reviewed-by: Jarno Lämsä <jarno.lamsa@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
2024-04-19 08:28:09 +00:00
Leena Miettinen
e43c8c178d Doc: Split up "Using Squish" into how-to and reference topics
- Move general information to "Developing with Qt Creator"

Task-number: QTCREATORBUG-29361
Change-Id: Ia630346c6fc4e158215e1af77f4579f2a513a937
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-04-10 06:36:31 +00:00
Leena Miettinen
e31942fb23 Doc: Organize the front page into four columns
Lots of the information from the first column will still
move into the How To and Reference sections in future releases.

- Remove obsolete sub-TOC topics.
- Rename the "Overview" as "Developing with Qt Creator" and place it
  first in the TOC.

Task-number: QTCREATORBUG-29361
Change-Id: I8af0460b2391f3152606e5326bb7e8f630f64531
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-22 12:54:45 +00:00
Leena Miettinen
9e1c513167 Doc: Add direct links to reference topics to the front page
Add links to "Version Control Systems" and "Views"

Change-Id: I7a3865bde35912307be3b86fd19c2387cb755cba
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-21 12:21:14 +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
f6c3318e94 Doc: Turn "Running on Multiple Platforms" into how-to topics
And hide it from the top level TOC in the manual.
Link to "How To: Build with CMake" from CMake topics.

Task-number: QTCREATORBUG-29361
Change-Id: If0522cdd9636ac075e8bdeafa0fc7248199aaf2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-14 08:56:36 +00: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
Leena Miettinen
add834577b Doc: Update info about autotests
- Split the topic up into how-to and reference topics
- Add and remove descriptions of preferences
- Move general information to the overview
- Describe qdt locator filter

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: Idb29eebaeb2f77326ebbb5e6b5654c135473f329
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-03-04 09:38:35 +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
Leena Miettinen
76539a659e Doc: Update the IDE Overview
Use sections instead of a table and move or copy text from
other topics. This is to create a place for information that
becomes homeless when I remove other topics.

Task-number: QTCREATORBUG-29361
Change-Id: Ib3fcc2c345080e05f9f7ad4ed78e049c899e0855
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-19 15:28:14 +00:00
Leena Miettinen
c28a388b1f Doc: Turn "Running on Multiple Platforms" into how-to topics
- Update screenshots of kit selector and Devices preferences,
  which now show the device status
- Turn running on QML and Linux into their own topics
- Remove conditions because the projects folder is excluded from
  QDS Manual

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: I869f6b577016c6712c6b37170dbee2249ded1f8e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-02-19 12:33:24 +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
Leena Miettinen
321b245477 Doc: Describe Help > About Qt Creator > Copy and Close
Move the instructions for contacting Qt from the front page to
a how-to topic.

Task-number: QTCREATORBUG-30209
Change-Id: I4f4083927ad54bdca555e1825f817f494e30e860
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: hjk <hjk@qt.io>
2024-02-14 08:35:28 +00:00
Leena Miettinen
62c0e5024e Doc: Split "Modeling" into several topics
Task-number: QTCREATORBUG-29361
Change-Id: Iaffaf6d148d05738d92d9ccd8fe634c4b2be063d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-19 12:50:41 +00:00
Leena Miettinen
158058ca3b Doc: Reorganize the "Designing UIs" section
- Create how-to and reference topics.
- Move the short descriptions of topics to "IDE Overview".

Task-number: QTCREATORBUG-29361
Change-Id: I11a334de6151350ce993e4135828a3eecaabf308
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-05 13:35:43 +00:00
Leena Miettinen
7fd20e98d7 Doc: Edit info about state chart editor
- Convert paragraphs and lists into tables with icons to allow
  users to browse easier
- Move the info about using the wizard into a how-to topic
- Add subtitles
- Move the topic to Reference

Task-number: QTCREATORBUG-29361
Fixes: QTCREATORBUG-29766
Change-Id: Id9c1aabd8f3a7bfb0659898dd329cedbcbb5f697
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-29 15:23:51 +00:00
Leena Miettinen
eb9c2da726 Doc: Turn Managing Sessions into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: If15556fdcb5d365b65f1f56a77ab9c21739d0854
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-13 09:05:07 +00:00
Leena Miettinen
aa9206ca81 Doc: Describe CMake profiling
Task-number: QTCREATORBUG-29392
Change-Id: I661d6d39148a53daf328b4895d8cd7cabf163d7a
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-02 10:00:19 +00:00
Leena Miettinen
372d19f9f4 Doc: Describe CMake changes
- Divide the "Setting Up CMake" into several how-to topics.
- Rename it as "CMake" and link to all the new topics.
- Update related topics accordingly.

Task-number: QTCREATORBUG-29361
Task-number: QTCREATORBUG-29392
Change-Id: Ib8f4a1951b5ffd7eaa25a4e5cf40e7bb252f9cf4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-01 13:26:19 +00:00
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
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Leena Miettinen
2d9aa27b61 Doc: Chop up the "Using Version Control Systems" topic
Turn the topic into Reference and How-to topics.

Task-number: QTCREATORBUG-29361
Change-Id: I2fd4050f712b61b3e4140a5bf93e968c02b36d36
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2023-09-13 06:57:07 +00:00
Leena Miettinen
097cb17af4 Doc: Replace "Getting Help" with "How To"
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 06:56:53 +00:00
Leena Miettinen
50b14b5046 Doc: Replace "Advanced Use" with "Reference"
Will move some topics to how-to topics in a follow-up change.

Task-number: QTCREATORBUG-29361
Change-Id: I7a7475844faafa9dfae9f2f4e3f6940959022c54
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-04 07:14:31 +00:00
Leena Miettinen
31386c3fa0 Doc: Add a Reference topic
For listing reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I1d0463c4bfcd826464535a377da533509d838435
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-11 07:58:51 +00:00
Leena Miettinen
0d75ba0293 Doc: Reorganize "User Interface" topic and move info to How-tos
Moved How-to topics into separate topics (HTML files) and
linked to them from UI Interface in QDS Manual and from How-to
in Qt Creator Manual.

Task-number: QTCREATORBUG-28996
Change-Id: I2b6defa936954c6a41085d0276f29942462ec12f
Signed-off-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-30 09:31:50 +00:00
Leena Miettinen
2d91be25f2 Doc: Try to make All Topics more visible
And provide some tips for searching.

Task-number: QTCREATORBUG-28996
Change-Id: I35d611326555ccc568c98c49e092380d206fce6b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-26 12:21:38 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00
Leena Miettinen
49378ced3c Doc: Describe Squish plugin
Fixes: QTCREATORBUG-27890
Change-Id: Icc203a96f08c785f016130480c45c988d26ac371
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-10-06 07:07:56 +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
b7bae45d12 Doc: Rename "Using Other Build Systems" to "Build Systems"
...now that qmake is not the default anymore, but you can choose
the build system when creating projects.

Change-Id: I52098059e1d32ba2c43c48af7df9dd4c2daff09e
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2021-11-11 08:09:51 +00:00
Leena Miettinen
bddcf63da9 Doc: Document Help > Contact command and dialog
- Move All Topics to the top of the page
- Create a list of ways to contact the team

Task-number: QTCREATORBUG-25642
Change-Id: Ie18cd3ba397f8cf1b3101692713f411d03b25098
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-06-29 12:53:40 +00:00
Leena Miettinen
e539ac263a Doc: Fix QDoc errors introduced by restructuring the manuals
- Remove an obsolete file
- Fix link targets
- Fix navigation link targets
- Fix conditional text

Change-Id: I2421be9867c350ec04b7a09489b0655de9bafa53
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-06-28 11:51:25 +00:00
Leena Miettinen
a3fbc85ced Doc: Create a Prototyping chapter
Restructure existing information and fix navigation links.

Fixes: QDS-4470
Change-Id: I4a1118a4620527b461b99bf05b8b06d947018c80
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-06-24 07:54:20 +00:00
Johanna Vanhatapio
77b91fd4a9 Doc: Describe Best Practices in QDS
Project files for the example scene will be added as a separate task.

Task-number: QDS-1243
Change-Id: I0bc9bd861d2b6a3c58372cedb2395deb3c78f590
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-10-29 15:32:40 +00:00
Leena Miettinen
daea5358c8 Doc: Link to the new platform topics from the front page
Change-Id: I3d7bb548a9edb3eca6f6a4bf8c7e9e1bd77f4f7e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-08-21 14:15:22 +00:00
Leena Miettinen
197ccb9bda Doc: Resize front page images to remove scrollbar
Change-Id: I8555bd5f7952530a02d57be436fc27c8a04de0be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-05-26 14:06:52 +00:00
Leena Miettinen
c370d345f1 Doc: Remove obsolete \contentspage command
This prints a QDoc warning when building with QDoc 5.15.

Change-Id: Id6f4646738f3e09956a243dc0da639f5567470f3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-11 08:43:31 +00:00
Eike Ziller
708f84cce8 Doc: Fix style for menu hierarchies
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-03 06:10:16 +00:00
Leena Miettinen
a8c9d394fd Doc: Replace "Qt Bug Tracker" with "Qt Project Bug Tracker"
Add links where they were missing.

Change-Id: I218c1160226ec5223e6bd055d73e82092f254792
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-28 09:30:42 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
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>
2020-01-27 09:05:07 +00:00