Commit Graph

37 Commits

Author SHA1 Message Date
Leena Miettinen
becb0af00a Doc: Add more topics to \ingroup creator-how-to-manage-kits
- Add links to the kit management topics from other topics
- Always use \l{Kits} to link to Preferences > Kits
  This has lived a little, as I've changed the category names

Change-Id: Ibcb137824a23bfe7e320a215eb461f689c43db77
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-06-17 14:33:45 +00: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
Leena Miettinen
24797179a7 Doc: Remove "Managing Projects"
This topic is not used anymore.

Task-number: QTCREATORBUG-29361
Change-Id: Ia4d54a77fb3aac2e98fc00d697b045aee798b1ae
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-02-02 08:19:29 +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
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
022847c852 Doc: Make the instructions for enabling plugins more consistent
- Add the following for documented plugins that are
  disabled by default: \note Enable the <name> plugin to use it
- Add \sa {Enable and disable plugins} for the above plugins and
  describe there how to find the About Plugins dialog on macOS
- For the one occurrence in the QDS Manual, add instructions for
  finding the About Plugins dialog on macOS ("Enable and disable plugins"
  is not included in the QDS Manual
- Mostly remove other kinds of references to enabling plugins

Task-number: QTCREATORBUG-29734
Change-Id: I7b12bd651c1c99e0c6b3ca6f94d3831ebe038438
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-27 06:59:11 +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
Leena Miettinen
66fabd0c0d Doc: Turn some "Advanced Use" topics into how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ie675e4d72ad524e0a7a4ba4adca8a477ff579d55
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-13 06:56:40 +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
6ed6946d2a Doc: Add links to YouTube videos
Task-number: QTCREATORBUG-28996
Change-Id: Ib829b67f2d91f06e0d567d5c19cad0d37bceb916
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-06-28 06:58:54 +00:00
Eike Ziller
cf90e478e6 Doc: Fix documentation about (widget) Designer plugins
- fix the plugin location for the three platforms
- Qt and Qt Creator use RPATH on macOS since a longer while, which
  removes the need to fix library references with
  otool+install_name_tool
- clarify the paragraph on compatibility

Change-Id: Id7e011e061cff578398a83e9f54aec0a25ebdc4c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-14 06:25:08 +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
de6ed91c9c Doc: Fix link to Qt UI Tools Text Finder example
The word "Example" was removed from the doc title.

Change-Id: I67250c2f09a9c21e93a2d48e6391ac175780336c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-04 09:11:01 +00:00
Leena Miettinen
c6a98002fd Doc: Remove info about manually adding files to CMakeLists.txt
It is now done automatically.

Task-number: QTCREATORBUG-28996
Change-Id: I25844b087575eba11cdce1c8a2f5040c92dae80e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-04-21 05:47:35 +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
Leena Miettinen
be1aa6abed Doc: Fix typos
Change-Id: I22b610a6dcab73867f915f877d7b7b844da5dc22
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-11-16 10:39:24 +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
Leena Miettinen
b1af1502a0 Doc: Describe following symbol under cursor for QRC files
Task-number: QTCREATORBUG-27876
Change-Id: If4fa6235fe450617753e5f4a753ca491a92a0613
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-10-07 13:13:28 +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
4ff4d2b6e9 Doc: Fix case in folder name in \quotefromfile command
When building docs on Linux, the folder and file were not
found.

Task-number: QTCREATORBUG-27560
Change-Id: I767703c66edf73221037bd17692d3f469319522d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-14 12:33:35 +00:00
Leena Miettinen
894a62325a Doc: Update info on Qt Designer preferences
Device profiles can be used from Tools > Form Editor >
Preview In.

Task-number: QTCREATORBUG-27560
Change-Id: Ic3fb26f1df7589b4ad8c09eaccb7da5da86f0d00
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2022-07-12 11:26:53 +00:00
Leena Miettinen
8d1fd930b1 Doc: Convert Qt Widgets tutorial to use CMake as build system
- Describe adding resource file to CMakeLists.txt
- Update screenshots

Fixes: QTCREATORBUG-26686
Change-Id: I2b06a9753ee73b736982923e3b2a5bb6b4dd8861
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-07-07 14:13:53 +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
d422b408e0 Merge remote-tracking branch 'origin/6.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri

Change-Id: I32991a77e52831dd2e24cf4a51ec252998c2d743
2021-12-09 12:04:32 +01:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Eike Ziller
d097314873 Split "New File or Project" into "File" and "Project" parts
This was non-standard to begin with, and splitting it makes it
possible to have different designs for New Project and New File dialogs
that are more tailored for the different needs (as is done in
Design Studio)

Change-Id: Ie6246e3c3f3527702c4562ec6f8fcbf5fae6c6ad
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2021-12-02 11:02:35 +00:00
Leena Miettinen
f48c7f4df6 Doc: Update Qt Widget based application tutorial
- Describe new wizard dialogs
- Update screenshots

Task-number: QTCREATORBUG-26278
Change-Id: I66407a2f799e05aa1d01e9c9d1ddd509ab07cadb
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
2021-11-02 11:54:50 +00:00
Leena Miettinen
73fa76f776 Doc: Remove info about Qt Quick Designer plugin from Qt Creator Manual
Fixes: QTCREATORBUG-26321
Change-Id: I8738cbdc56d6469a4d133b17741871787e0cba9f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-10-18 07:21:39 +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
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
Vikas Pachdha
f6e013c80e Doc: Add asset export documentation
Task-number: QDS-2729
Change-Id: I0af45f22a49cf0a8a74bc6bd9a0b0c3fd4091e1f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-09-04 08:42:32 +00:00
Leena Miettinen
2c36c737b7 Doc: Use \MinGW to prevent broken automatically generated links
Change-Id: Ib576e3be1035448905cc8c5bf23960450cf10057
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-09-02 06:18:29 +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
Leena Miettinen
fc879d196f Doc: Update widget-based app tutorial
Task-number: QTCREATORBUG-23364
Change-Id: Iedc02d8e774093d176e6ccd881f096d9b3163a60
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-04-14 10:54:55 +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
4cd4316a16 Doc: Replace "pane" with "view"
...for anything listed in Window > Views, except "Output Pane".

Task-number: QTCREATORBUG-23582
Change-Id: I1a46de22657dd5779d693a5078b5aca8b1b57a37
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 08:10:19 +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