diff options
author | Tim Jenssen <tim.jenssen@qt.io> | 2024-04-23 14:36:48 +0200 |
---|---|---|
committer | Tim Jenssen <tim.jenssen@qt.io> | 2024-04-23 16:05:55 +0200 |
commit | ef0ee52bf92739bc5b32d70c01ff1eadd752d813 (patch) | |
tree | 0f3b2f546af088b86f21452622d77be43386cd5f /doc/qtcreator | |
parent | d9c8590c5fd10b1feceb389c142ec244909739a2 (diff) | |
parent | 7dfa7469207f899e347dc6f2bf0c3011140a9b23 (diff) |
Merge remote-tracking branch 'origin/qds/dev'
Conflicts:
doc/qtcreator/src/overview/creator-only/creator-keyboard-shortcuts.qdoc
doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
doc/qtcreator/src/qtquick/qtquick-profiler.qdoc
src/plugins/qmlprojectmanager/qmlprojectmanager.qbs
src/plugins/remotelinux/linuxdevicetester.cpp
Change-Id: I3683c1799df05209d05413383456b285a2daf96e
Diffstat (limited to 'doc/qtcreator')
9 files changed, 81 insertions, 39 deletions
diff --git a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc index 30aa5c1358..e7141a99f2 100644 --- a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc +++ b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc @@ -33,7 +33,7 @@ \if defined(qtdesignstudio) \note In this tutorial, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. \endif diff --git a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc index 7ed5365595..77f54e858f 100644 --- a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc +++ b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc @@ -35,7 +35,7 @@ \if defined(qtdesignstudio) \note In this section, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. \endif \section1 Setting Up QML Debugging diff --git a/doc/qtcreator/src/external-resources/external-resources-qds.qdoc b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc index d5b7fcf1bd..2a340b9ea9 100644 --- a/doc/qtcreator/src/external-resources/external-resources-qds.qdoc +++ b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc @@ -69,3 +69,39 @@ \externalpage https://www.qt.io/download \title Try Qt */ +/*! + \externalpage https://doc.qt.io/qt-5/custom-material-reference.html + \title Qt Quick 3D Custom Material Reference +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-arealight.html + \title AreaLight +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-shaderinfo.html + \title ShaderInfo +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-bufferblit.html + \title BufferBlit +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-cullmode.html + \title CullMode +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-depthinput.html + \title DepthInput +*/ +/*! + \externalpage https://doc.qt.io/qt-5/qml-qtquick3d-renderstate.html + \title RenderState +*/ +/*! + \externalpage https://doc.qt.io/qt/i18n-source-translation.html#mark-strings-for-translation + \title Mark Strings for Translation +*/ +/*! + \externalpage https://doc.qt.io/qt/linguist-id-based-i18n.html + \title Text ID based translations +*/ diff --git a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc index b0508fe8cb..bd0985e312 100644 --- a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc @@ -27,7 +27,7 @@ \if defined(qtdesignstudio) \note In this section, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see - \l{Customizing the Menu}. + \l{Customizing the Menu Bar}. \endif diff --git a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc index ba666b35cc..a8ce9dbb5a 100644 --- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2023 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -15,7 +15,11 @@ \title File System + \if defined(qtdesignstudio) + \brief View all the files in the current directory. + \else \brief Shows all the files in the current directory. + \endif \if defined(qtcreator) \note Usually, \l{Navigate with locator}{searching with the locator} @@ -25,7 +29,7 @@ \image qtcreator-filesystem-view.webp {File System view in the sidebar} \else - \image qtcreator-filesystem-view-design.webp {File System view} + \image filesystem-view-design.webp {File System view} \endif To go to the root directory of the file system, select \uicontrol Computer @@ -52,6 +56,7 @@ The view displays the path to the active file as bread crumbs. You can move to any directory along the path by clicking it. + \if defined(qtcreator) \section1 File System Context Menu Use the context menu functions to: @@ -64,34 +69,24 @@ that has the file. To specify the terminal to use on Linux and \macos, select \preferences > \uicontrol Environment > \uicontrol System. - \if defined(qtcreator) To use an \l{Terminal} {internal terminal}, select \preferences > \uicontrol Terminal > \uicontrol {Use internal terminal}. - \endif \li Search in the selected directory. \li View file properties, such as name, path, MIME type, default editor, line endings, indentation, owner, size, last read and modified dates, and permissions. - \li Create new files. For more information, see - \if defined(qtdesignstudio) - \l{Adding Files to Projects}. - \else - \l{Create files}. - \endif + \li Create new files. For more information, see {Create files}. \li Rename existing files. To move the file to another directory, enter the relative or absolute path to its new location in addition to the new filename. \li Remove existing files. \li Create new folders. - \if defined(qtcreator) \li Compare the selected file with the currently open file in the diff editor. For more information, see \l{Compare files}. - \endif \li Display the contents of a particular directory in the view. \li Collapse all open folders. \endlist - \if defined(qtcreator) \section1 File System View Toolbar The toolbar in the \uicontrol {File System} view has additional diff --git a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc index 87760c448c..67c0134c78 100644 --- a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2023 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -16,13 +16,26 @@ \title Open Documents + \if defined(qtdesignstudio) + \brief View currently open files. + \else \brief Shows currently open files. + \endif + \if defined(qtdesignstudio) + \image open-documents-view.webp {Open Documents view} + \else \image qtcreator-open-documents-view.png {Open Documents view} + \endif You can use the context menu to apply some of the functions also available - in the \uicontrol File menu and in the \l {File System Context Menu} - {File System} view to the file that you select in the view. + in the \uicontrol File menu and in the + \if defined(qtcreator) + \l {File System Context Menu}{File System} + \else + \uicontrol {File System} + \endif + view to the file that you select in the view. In addition, you can: diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index b6b74f0993..d28e6f9ef0 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2023 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -15,7 +15,11 @@ \title Projects + \if defined(qtdesignstudio) + \brief View a list of the files contained within the open project. + \else \brief Shows a list of projects in a project tree. + \endif \if defined(qtcreator) The project tree has a list of all projects open in the current @@ -29,7 +33,7 @@ is the fastest way to find a particular project, file, class, or function, or almost anything else in your project. \else - \image qtcreator-projects-view-design.png {Projects view} + \image projects-view-design.webp {Projects view} \endif You can use the project tree in the following ways: @@ -43,14 +47,19 @@ Use the \l{Switch between modes} {mode selector} to open the current file in another editor. \endif - \li To bring up a \l{Projects View Context Menu}{context menu} + \li To open a + \if defined(qtcreator) + \l{Projects View Context Menu}{context menu} + \else + context menu + \endif that has the actions most commonly needed, right-click an item in the project tree. For example, through the menu of the project root directory you can, among other actions, run and close the project. \li To see the absolute path of a file, move the mouse pointer over the file name. - \li To move files from one project to another, drag-and-drop them + \li To move files from one project to another, drag them in the project tree. \QC makes the necessary changes to project configuration files. \endlist @@ -58,6 +67,7 @@ \note If you cannot see a file in the \l Projects view, switch to the \uicontrol {File System} view, which shows all the files in the file system. + \if defined(qtcreator) \section1 Projects View Context Menu The \uicontrol Projects view has context menus for managing projects, @@ -65,22 +75,15 @@ projects and subprojects: \list - \if defined(qtcreator) \li Set a project as the active project. - \endif \li Execute \uicontrol Build menu commands. \li Create new files. For more information, see - \if defined(qtdesignstudio) - \l{Adding Files to Projects}. - \else \l{Create files}. - \endif \li Rename existing files. If you change the base name of a file, \QC displays a list of other files with the same base name and offers to rename them as well. If you rename a UI file (.ui), \QC also changes corresponding include statements accordingly. \li Remove existing files. - \if defined(qtcreator) \li Remove existing directories from \l{Import an existing project} {generic projects}. \li Add existing files and directories. @@ -88,16 +91,13 @@ \l{Add libraries to qmake projects}. \li Add and remove subprojects. \li Find unused functions. - \endif \li Search in the selected directory. \li Open a terminal window in the project directory. To specify the terminal to use on Linux and \macos, select \preferences > \uicontrol Environment > \uicontrol System. - \if defined(qtcreator) To use an \l{Terminal}{internal terminal}, select \preferences > \uicontrol Terminal > \uicontrol {Use internal terminal}. - \endif \li Open a terminal window in the project directory that you configured for building or running the project. \li Expand or collapse the tree view to show or hide all files and @@ -114,7 +114,6 @@ the \l {File System} view. To view a project in it, select \uicontrol {Show in File System View}. - \if defined(qtcreator) \section1 Projects View Toolbar The toolbar in the \uicontrol Projects view has additional options. diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 9041e6432f..9794667f5b 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -95,7 +95,7 @@ \endif \if defined(qtdesignstudio) - \section1 Customizing the Menu + \section1 Customizing the Menu Bar By default, top-level menu items \uicontrol Build, \uicontrol Debug, and \uicontrol Analyze are not visible. These menu items have options for @@ -113,6 +113,9 @@ You need to restart \QDS to apply changes made to these settings. + \note To show or hide the \uicontrol {Menu Bar}, select \uicontrol View > + \uicontrol {Show Menu Bar}, or use \key {Ctrl+Alt+M}. + \section1 Customizing the UI The following topics describe how to customize the UI: diff --git a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc index ea23e53443..e853a86812 100644 --- a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc +++ b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc @@ -30,10 +30,6 @@ You can use the \l{http://code.google.com/p/gerrit/}{Gerrit} code review tool for projects that use Git. - \if defined(qtdesignstudio) - \include creator-vcs-options.qdocinc vcs options - \endif - \if defined(qtcreator) \section1 Using Git for Windows |