diff --git a/doc/qtcreator/src/editors/creator-code-completion.qdoc b/doc/qtcreator/src/editors/creator-code-completion.qdoc index 7383ceb804a..0ed4de52825 100644 --- a/doc/qtcreator/src/editors/creator-code-completion.qdoc +++ b/doc/qtcreator/src/editors/creator-code-completion.qdoc @@ -10,6 +10,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-code \title Complete code @@ -129,12 +130,13 @@ /*! \page creator-preferences-text-editor-completion.html \if defined(qtdesignstudio) - \previouspage creator-completing-code.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif \ingroup creator-reference-preferences-text-editor + \ingroup studio-preferences-code \title Completion @@ -192,12 +194,13 @@ /*! \page creator-preferences-text-editor-shippets.html \if defined(qtdesignstudio) - \previouspage creator-completing-code.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif \ingroup creator-reference-preferences-text-editor + \ingroup studio-preferences-code \title Snippets @@ -330,12 +333,13 @@ /*! \page creator-how-to-add-code-snippets.html \if defined(qtdesignstudio) - \previouspage creator-completing-code.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-configure-editors + \ingroup studio-how-to-code \title Add code snippets to the auto-complete menu diff --git a/doc/qtcreator/src/editors/creator-code-indentation.qdoc b/doc/qtcreator/src/editors/creator-code-indentation.qdoc index d849e67660b..f088e833879 100644 --- a/doc/qtcreator/src/editors/creator-code-indentation.qdoc +++ b/doc/qtcreator/src/editors/creator-code-indentation.qdoc @@ -10,6 +10,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-code \title Indent text or code diff --git a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc index 5a94f1c08d3..3bf65036a25 100644 --- a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc +++ b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc @@ -4,12 +4,13 @@ /*! \page creator-how-to-rename-symbols.html \if defined(qtdesignstudio) - \previouspage studio-finding.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-search + \ingroup studio-how-to-refactor-code \title Rename symbols diff --git a/doc/qtcreator/src/editors/creator-code-syntax.qdoc b/doc/qtcreator/src/editors/creator-code-syntax.qdoc index 9365a7aea32..aa5e01f125e 100644 --- a/doc/qtcreator/src/editors/creator-code-syntax.qdoc +++ b/doc/qtcreator/src/editors/creator-code-syntax.qdoc @@ -10,6 +10,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-code \title Check code syntax @@ -103,6 +104,7 @@ \endif \ingroup creator-reference-editors + \ingroup studio-how-to-code \title JavaScript and QML Checks @@ -787,6 +789,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-code \title Automatically format QML/JS files diff --git a/doc/qtcreator/src/editors/creator-coding.qdoc b/doc/qtcreator/src/editors/creator-coding.qdoc deleted file mode 100644 index ffb3e8453fb..00000000000 --- a/doc/qtcreator/src/editors/creator-coding.qdoc +++ /dev/null @@ -1,47 +0,0 @@ -// Copyright (C) 2023 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -// ********************************************************************** -// NOTE: the sections are not ordered by their logical order to avoid -// reshuffling the file each time the index order changes (i.e., often). -// Run the fixnavi.pl script to adjust the links to the index order. -// ********************************************************************** - -/*! - \page creator-coding.html - \if defined(qtdesignstudio) - \previouspage studio-designer-developer-workflow.html - \else - \previouspage creator-usability.html - \endif - \nextpage creator-editor-functions.html - - \title Coding - - \if defined(qtcreator) - \image front-coding.png - \endif - - \list - - \if defined(qtdesignstudio) - \li \l{Finding} - - Use the incremental and advanced search to search in currently - open projects or files on the file system or use the locator to - browse through projects, files, classes, functions, documentation - and file systems. - \endif - - \li \l{Configuring the Editor} - - You can change the fonts, colors, highlighting, and indentation. - \if defined(qtcreator) - If you are used to the Vim editor, you can even run the main - editor in a manner similar to it in the \uicontrol{FakeVim} mode. - \endif - - \endlist - - \sa {Apply quick fixes} -*/ diff --git a/doc/qtcreator/src/editors/creator-editors-options-text.qdoc b/doc/qtcreator/src/editors/creator-editors-options-text.qdoc index 33c2d02160f..ce84c44cfcf 100644 --- a/doc/qtcreator/src/editors/creator-editors-options-text.qdoc +++ b/doc/qtcreator/src/editors/creator-editors-options-text.qdoc @@ -10,13 +10,13 @@ /*! \page creator-preferences-text-editor-font-colors.html \if defined(qtdesignstudio) - \previouspage creator-editor-options.html - \nextpage studio-debugging.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif \ingroup creator-reference-preferences-text-editor + \ingroup studio-preferences-code \title Font & Colors @@ -50,13 +50,13 @@ /*! \page creator-how-to-change-editor-colors.html \if defined(qtdesignstudio) - \previouspage creator-editor-options.html - \nextpage studio-debugging.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-configure-editors + \ingroup studio-how-to-code \title Change editor colors diff --git a/doc/qtcreator/src/editors/creator-editors-options.qdoc b/doc/qtcreator/src/editors/creator-editors-options.qdoc deleted file mode 100644 index 31987c8a073..00000000000 --- a/doc/qtcreator/src/editors/creator-editors-options.qdoc +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright (C) 2023 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -// ********************************************************************** -// NOTE: the sections are not ordered by their logical order to avoid -// reshuffling the file each time the index order changes (i.e., often). -// Run the fixnavi.pl script to adjust the links to the index order. -// ********************************************************************** - -/*! - \page creator-editor-options.html - \if defined(qtdesignstudio) - \previouspage creator-editor-quick-fixes.html - \else - \previouspage creator-beautifier.html - \endif - \nextpage creator-preferences-text-editor-font-colors.html - - \title Configuring the Editor - - You can configure the text editor to suit your specific needs by selecting - \preferences > \uicontrol{Text Editor}. - - \image qtcreator-font-colors.png "Text Editor preferences" - - The settings you specify apply globally to all projects. - - You can also specify indentation settings separately for C++ and QML files - either globally or for the open project. For more information, see - \l{Indent text or code}. - - You can perform the following configuration actions: - - \list - \li Set the \l{Font & Colors}{font preferences and - apply color schemes} for syntax highlighting in - \uicontrol {Font & Colors}. - \li Specify \l{Download highlight definitions} - {definition files for syntax highlighting} for other types of files - than C++ or QML in \uicontrol {Generic Highlighter}. - - \li Set \l{Indent text or code}{tabs, indentation, the handling of - whitespace, and mouse operations} in \uicontrol Behavior. - - \li Set various display properties, such as \l{Highlight code blocks} - {highlighting} or folding code blocks and text wrapping in - \uicontrol Display. - - \li Add, modify, and remove \l{Snippets}{code snippets} in - \uicontrol Snippets. - - \li Configure \l{Completion}{code completion} in \uicontrol Completion. - - \endlist - - \if defined(qtcreator) - \sa {Specify editor settings}, {Edit like in Vim}, {Completion}, {Snippets} - \endif - -*/ diff --git a/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc b/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc index 9924b003284..dce4173b98e 100644 --- a/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc +++ b/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc @@ -4,13 +4,13 @@ /*! \page creator-preferences-text-editor-behavior.html \if defined(qtdesignstudio) - \previouspage creator-indenting-code.html - \nextpage creator-preferences-qtquick-code-style.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif \ingroup creator-reference-preferences-text-editor + \ingroup studio-preferences-code \title Behavior diff --git a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc index a2db91d7610..964b8134807 100644 --- a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc +++ b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc @@ -4,14 +4,13 @@ /*! \page creator-editor-quick-fixes.html \if defined(qtdesignstudio) - \previouspage creator-jump-to-the-code.html - \nextpage creator-reference-qml-quick-fixes.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-edit - \ingroup studio-code-view + \ingroup studio-how-to-refactor-code \title Apply quick fixes @@ -101,14 +100,13 @@ /*! \page creator-reference-qml-quick-fixes.html \if defined(qtdesignstudio) - \previouspage creator-editor-quick-fixes.html - \nextpage creator-editor-options.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif - \ingroup creator-reference - \ingroup studio-code-view + \ingroup creator-reference-editors + \ingroup studio-how-to-refactor-code \title QML Quick Fixes diff --git a/doc/qtcreator/src/editors/creator-search.qdoc b/doc/qtcreator/src/editors/creator-search.qdoc index c3bd9e1fa22..03c9641fc25 100644 --- a/doc/qtcreator/src/editors/creator-search.qdoc +++ b/doc/qtcreator/src/editors/creator-search.qdoc @@ -4,13 +4,13 @@ /*! \page creator-editor-finding.html \if defined(qtdesignstudio) - \previouspage studio-finding.html - \nextpage creator-how-to-advanced-search.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-search + \ingroup studio-how-to-search \title Search in current file @@ -130,13 +130,13 @@ /*! \page creator-how-to-advanced-search.html \if defined(qtdesignstudio) - \previouspage creator-editor-finding.html - \nextpage creator-how-to-rename-symbols.html + \previouspage qtquick-text-editor.html \else \previouspage creator-how-tos.html \endif \ingroup creator-how-to-search + \ingroup studio-how-to-search \title Search in projects or file systems @@ -216,9 +216,7 @@ \if defined(qtcreator) \sa {Search}{How To: Search}, {Find symbols}, {Turn on Silver Searcher} - \else - \sa {Search in current file} \endif - \sa {Search Results View} + \sa {Search in current file}, {Search Results View} */ diff --git a/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc b/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc index 44c3364c8fd..792a7306878 100644 --- a/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc +++ b/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc @@ -10,6 +10,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-highlight-code \title Download highlight definitions @@ -77,6 +78,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-highlight-code \title Highlight code blocks diff --git a/doc/qtcreator/src/overview/creator-only/mobile-app-design.qdoc b/doc/qtcreator/src/overview/creator-only/mobile-app-design.qdoc index 8dd97e3c8cd..1697c2d51c5 100644 --- a/doc/qtcreator/src/overview/creator-only/mobile-app-design.qdoc +++ b/doc/qtcreator/src/overview/creator-only/mobile-app-design.qdoc @@ -9,7 +9,7 @@ /*! \page creator-usability.html - \nextpage creator-coding.html + \previouspage creator-reference.html \ingroup creator-reference diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 815ec1eb458..52b28cf7e2b 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -25,10 +25,6 @@ \endlist \li \l{Tutorials} \generatelist creator-tutorials - \li \l{Coding} - \list - \li \l{Configuring the Editor} - \endlist \li \l{Running on Devices} \list \li \l{Validating with Target Hardware} diff --git a/doc/qtcreator/src/qtquick/creator-preferences-qtquick-code-style.qdoc b/doc/qtcreator/src/qtquick/creator-preferences-qtquick-code-style.qdoc index d4022d11bc7..5717033ece6 100644 --- a/doc/qtcreator/src/qtquick/creator-preferences-qtquick-code-style.qdoc +++ b/doc/qtcreator/src/qtquick/creator-preferences-qtquick-code-style.qdoc @@ -4,13 +4,13 @@ /*! \page creator-preferences-qtquick-code-style.html \if defined(qtdesignstudio) - \previouspage creator-preferences-text-editor-behavior.html - \nextpage qt-quick-toolbars.html + \previouspage qtquick-text-editor.html \else \previouspage creator-reference.html \endif \ingroup creator-reference-preferences + \ingroup studio-preferences-code \title Qt Quick Code Style diff --git a/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc b/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc index d11ec268b3f..78641697655 100644 --- a/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc @@ -16,6 +16,7 @@ \endif \ingroup creator-how-to-edit + \ingroup studio-how-to-code \title Edit properties of QML types diff --git a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc index 74ffff54688..0a6531fe12c 100644 --- a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc +++ b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc @@ -4,7 +4,7 @@ /*! \page studio-designer-developer-workflow.html \previouspage studio-implementing-applications.html - \nextpage creator-coding.html + \nextpage studio-debugging.html \title Designer-Developer Workflow diff --git a/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc b/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc index d7178236e3a..8eaedf0a7e2 100644 --- a/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc +++ b/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc @@ -2,9 +2,8 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \previouspage creator-how-to-rename-symbols.html \page creator-jump-to-the-code.html - \nextpage creator-editor-quick-fixes.html + \previouspage qtquick-text-editor.html \title Jump to the Code diff --git a/doc/qtdesignstudio/src/overviews/studio-finding.qdoc b/doc/qtdesignstudio/src/overviews/studio-finding.qdoc deleted file mode 100644 index 231efcef3eb..00000000000 --- a/doc/qtdesignstudio/src/overviews/studio-finding.qdoc +++ /dev/null @@ -1,37 +0,0 @@ -// Copyright (C) 2024 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -/*! - \page studio-finding.html - \previouspage qt-quick-toolbars.html - \nextpage creator-editor-finding.html - - \title Finding - - \list - - \li \l{Search in current file} - - The incremental search highlights the matching strings in the - editor while you type. - - \li \l{Search in projects or file systems} - - With advanced search, you can search in currently open projects or - files on the file system. - - \li \l{Rename symbols} - - Search for QML types and rename them in all files in a project. - - \li \l{Jump to the Code} - - Jump to the code for a specific component directly from - the \uicontrol {2D} view or \uicontrol {Navigator} view. - You can also jump to the code of a particular - \uicontrol {State} or \uicontrol {Connection} from their - corresponding views. - - \endlist - -*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc index 85823a8dfa0..9d1fa446aec 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \previouspage creator-editor-options.html + \previouspage studio-designer-developer-workflow.html \page studio-debugging.html \nextpage creator-debugging-qml.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc index 8c88d525426..1f0aa086290 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc @@ -29,14 +29,12 @@ while developers work on the .qml and C++ source files in Qt Creator to create an application that you can build and run on target hardware. - \li \l{Coding} + \li \l{Code}{Coding} - You can use the code editor in the \uicontrol {Code} view or - in the \uicontrol Edit mode to modify QML code. The code editor - understands the QML language as code, not just as plain text. This - enables it to provide you with useful features, such as semantic - highlighting, checking code syntax, code completion, and refactoring - actions. + Modify QML code in the \uicontrol {Code} view. The code editor + understands the QML language as code, not just as plain text, so it + can offer useful features, such as semantic highlighting, checking + code syntax, code completion, and refactoring actions. \li \l{Debugging and Profiling} \QDS comes with a JavaScript debugger. In the \uicontrol Debug mode, diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 9bd546703b1..42e9428f10c 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -28,6 +28,10 @@ \li \l{Timeline} \li \l{Curves} \li \l{Code} + \generatelist studio-how-to-code + \generatelist studio-how-to-refactor-code + \generatelist studio-how-to-search + \generatelist studio-preferences-code \li \l{Projects} \li \l{File System} \li \l{Open Documents} @@ -197,33 +201,6 @@ \li \l{Implementing Applications} \list \li \l{Designer-Developer Workflow} - \li \l{Coding}{Cross-Platform Development} - \list - \li Writing Code - \list - \li \l{Semantic Highlighting} - \li \l{Check code syntax} - \li \l{JavaScript and QML Checks} - \li \l{Qt Quick Code Style} - \li \l{Automatically format QML/JS files} - \li \l{Complete code} - \li \l{Indent text or code} - \li \l{Behavior} - \endlist - \li \l{Finding} - \list - \li \l{Search in current file} - \li \l{Search in projects or file systems} - \li \l{Rename symbols} - \li \l{Jump to the Code} - \endlist - \li \l{Apply quick fixes} - \li \l{QML quick fixes} - \li \l{Configuring the Editor} - \list - \li \l{Font & Colors} - \endlist - \endlist \li \l{Debugging and Profiling} \list \li \l{Debugging Qt Quick Projects} diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index 600bc9427a2..b3d23a873fc 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -66,7 +66,7 @@ \li \b {\l{Implementing Applications}} \list \li \l{Designer-Developer Workflow} - \li \l{Coding}{Cross-Platform Development} + \li \l{Code}{Coding} \li \l{Debugging and Profiling} \endlist \li \b {\l{Advanced Designer Topics}} diff --git a/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc index dfa1e03ccf2..f202df3c372 100644 --- a/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc @@ -8,10 +8,10 @@ \title Code - In the \uicontrol {Code} view, you can view and modify the code in a - \l{UI Files}{UI file} (.ui.qml) or component file (.qml) that is generated - when you create components in the \l {2D} or \l {3D} view and specify - their properties in \l Properties. + To view and modify the code in a \l{UI Files}{UI file} (.ui.qml) or + component file (.qml), go to \uicontrol View and select \uicontrol Views > + \uicontrol Code. \QDS generates the code when you create components in the + \l {2D} or \l {3D} view and specify their properties in \l Properties. \image qtquick-text-editor.png "The Code view" @@ -19,22 +19,13 @@ \section1 Editing Code - The code editor offers semantic highlighting, syntax checking, + The \uicontrol Code view offers semantic highlighting, syntax checking, code completion, code indentation, context sensitive help, and in-line error indicators while you are typing. For more information, see: - \list - \li \l{Semantic Highlighting} - \li \l{Check code syntax} - \li \l{JavaScript and QML Checks} - \li \l{Qt Quick Code Style} - \li \l{Automatically format QML/JS files} - \li \l{Complete code} - \li \l{Indent text or code} - \li \l{Edit properties of QML types} - \endlist + \generatelist studio-how-to-code \section1 Semantic Highlighting @@ -45,6 +36,10 @@ To select the color scheme for semantic highlighting, go to \preferences > \uicontrol {Text Editor} > \uicontrol {Font & Colors}. + For more information, see: + + \generatelist studio-how-to-highlight-code + \section1 Refactoring Code Code refactoring is the process of improving and simplifying code without @@ -52,8 +47,15 @@ and rename symbols and apply quick fixes in the \uicontrol Code view to refactor code. + For more information, see: + + \generatelist studio-how-to-refactor-code + \section1 Searching in Code + The incremental search highlights the matching strings in the + \uicontrol Code view while you type. + To open the search dialog in the \uicontrol {Code} view: \list @@ -62,6 +64,25 @@ \li Select \key Ctrl + \key {F} (or \key Cmd + \key F on \macos). \endlist - \sa {Finding}, {Apply quick fixes}, {Download highlight definitions}, - {Highlight code blocks}, {QML Quick Fixes} + With advanced search, you can search in currently open projects or + files on the file system. + + For more information, see: + + \generatelist studio-how-to-search + + \section1 Setting Code view Preferences + + To set preference for the \uicontrol Code view, go to \preferences > + \uicontrol {Text Editor}. + + \image qtcreator-font-colors.png {Text Editor preferences} + + The settings you specify apply globally to all projects. + + For more information, see: + + \generatelist studio-preferences-code + + \sa {Jump to the Code} */