diff --git a/doc/qtcreator/images/qtcreator-preferences-texteditor-macros.webp b/doc/qtcreator/images/qtcreator-preferences-texteditor-macros.webp new file mode 100644 index 00000000000..f8c7347f45d Binary files /dev/null and b/doc/qtcreator/images/qtcreator-preferences-texteditor-macros.webp differ diff --git a/doc/qtcreator/src/editors/creator-editors-options.qdoc b/doc/qtcreator/src/editors/creator-editors-options.qdoc index 152b89e6b15..fa1ee7df04c 100644 --- a/doc/qtcreator/src/editors/creator-editors-options.qdoc +++ b/doc/qtcreator/src/editors/creator-editors-options.qdoc @@ -49,11 +49,6 @@ \li Add, modify, and remove \l{Snippets}{code snippets} in \uicontrol Snippets. - \if defined(qtcreator) - \li View and remove \l{Using Text Editing Macros}{text editing macros} - in \uicontrol Macros. - \endif - \li Configure \l{Completion}{code completion} in \uicontrol Completion. \endlist diff --git a/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc b/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc index b9eb672eb01..c0ca9294607 100644 --- a/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc +++ b/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc @@ -65,12 +65,6 @@ colleagues to review a change that you plan to submit to a version control system. - \li \l{Using Text Editing Macros} - - When you have a file open in the code editor, you can record a - keyboard sequence as a macro. You can then play the macro to - repeat the sequence. You can save the latest macro and assign a - keyboard shortcut for running it or run it from the locator. \endif \endlist diff --git a/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc b/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc index fd4b4a8b709..796931f3289 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc @@ -1,35 +1,61 @@ -// 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 /*! \previouspage creator-editor-codepasting.html \page creator-macros.html - \nextpage creator-diff-editor.html + \previouspage creator-how-tos.html - \title Using Text Editing Macros + \ingroup creator-how-to-edit - To record a text editing macro, select \uicontrol Tools > - \uicontrol {Text Editing Macros} > \uicontrol {Record Macro} - or press \key {Alt+[}. To stop recording, select \uicontrol Tools > - \uicontrol {Text Editing Macros} > \uicontrol {Stop Recording Macro} or - press \key {Alt+]}. + \title Record text editing macros + + When you have a file open in the code editor, you can record a + keyboard sequence as a macro. You can then play the macro to + repeat the sequence. You can save the latest macro and assign a + keyboard shortcut for running it or run it from the locator. + + \section1 Record macros + + To record a text editing macro: + + \list 1 + \li Go to \uicontrol Tools > \uicontrol {Text Editing Macros} > + \uicontrol {Record Macro} or press \key {Alt+[}. + \li Press keyboard keys. + \li To stop recording, go to \uicontrol Tools > + \uicontrol {Text Editing Macros} > \uicontrol {Stop Recording Macro} + or press \key {Alt+]}. + \endlist \note The macro recorder does not support code completion. - To play the last macro, select \uicontrol Tools > - \uicontrol {Text Editing Macros} > \uicontrol {Play Last Macro} or - press \key {Alt+R}. + \section1 Play macros - To save the last macro, select \uicontrol Tools > + To play the last macro: + + \list + \li Go to \uicontrol Tools > \uicontrol {Text Editing Macros} > + \uicontrol {Play Last Macro}. + \li Press \key {Alt+R}. + \li Enter \c rm in the locator. + \endlist + + \section1 Save macros + + To save the last macro, go to \uicontrol Tools > \uicontrol {Text Editing Macros} > \uicontrol {Save Last Macro}. - To assign a keyboard shortcut to a text editing macro, select - \preferences > \uicontrol Environment > - \uicontrol Keyboard. For more information, see \l{Assign keyboard shortcuts}. - - You can also use the \c rm locator filter to run a macro. For more - information, see \l{Navigate with locator}. - - To view and remove saved macros, select \preferences > + To view and remove saved macros, go to \preferences > \uicontrol {Text Editor} > \uicontrol Macros. + + \image qtcreator-preferences-texteditor-macros.webp {Macros tab in Text Editor Preferences} + + \section1 Assign keyboard shortcuts to macros + + To assign a keyboard shortcut to a text editing macro, go to + \preferences > \uicontrol Environment > \uicontrol Keyboard. + + \sa {Assign keyboard shortcuts}, {Edit Code}{How To: Edit Code}, + {Navigate with locator} */ diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 5f254d59923..6e45a628343 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -33,7 +33,6 @@ \li \l{Checking Code Syntax} \li \l{Using Qt Quick Toolbars} \li \l{Pasting and Fetching Code Snippets} - \li \l{Using Text Editing Macros} \endlist \li \l{Configuring the Editor} \li \l{Using GitHub Copilot}