From e6eed39985f31b89f6f038d23972079a91c8e595 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 11 Mar 2024 17:07:20 +0100 Subject: [PATCH] Doc: Turn "Using Text Editing Macros" into a how-to topic Task-number: QTCREATORBUG-29361 Change-Id: I0d62d48036e08528c025eac8653e58ff0039e5a2 Reviewed-by: Eike Ziller --- ...creator-preferences-texteditor-macros.webp | Bin 0 -> 5428 bytes .../src/editors/creator-editors-options.qdoc | 5 -- .../editors/creator-editors-writing-code.qdoc | 6 -- .../creator-text-editing-macros.qdoc | 66 ++++++++++++------ doc/qtcreator/src/qtcreator-toc.qdoc | 1 - 5 files changed, 46 insertions(+), 32 deletions(-) create mode 100644 doc/qtcreator/images/qtcreator-preferences-texteditor-macros.webp 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 0000000000000000000000000000000000000000..f8c7347f45db0cfa38b69a4eb08fa8be293255b3 GIT binary patch literal 5428 zcmWIYbaT@YWnc(*bqWXzu<(%=Wnj=}b#iC8`ry|8`-M`T?^6#g9be`x7G9i_NA*rR6~3OvKZq+ zf;>%>wmu0;RGE8W&iHE;UCSzap z^N{-ErpmRKuWifCl(ju?^dj%^)WS}Iq;UQBFZ-ie{@HJS>F{q&@{9etH?|#JGVNJV zocf`{cg1|138#BMTyK1)x&5%a_CK-ylaD1fZ4tL?+TQ8kvHnq@P4}EF`;@*vRM+|` zwf*$%4}Vv@waDiuWRRD*1=`!$rO%<^QTFVpjsx1aTIqw|x(_lMnB(sDc7Y3XO}#_5ZV?mTLVF8!srI(g@Jbo-v#aQO13=*rWZelK$NxN%}5R|~su^zU0N zJM=Pm>QAt%y^GLNY6>dMirK;byf?m z^Lf^Nt6DmJqy6&he462x@;fJ#Y!CVJyjJN6Yw$%+&ysId)ys>8CKO3mX)xJ~7K*!U zjLyjqyj>Bata*AX=N@LM8D~^4s-_!WIPjUbSf-hgx1;I#g_d_qKD~M&t;3$f+R}N* zFL$xN)Yg=lp(?9Oyf!p`)LA3ybt917bZzdFW06xgFtF`!^9_||JiRI46UKH{^u8Fg)(G?AHFs9%kA8o z)^mT0?!9QVmrb|p-=6)f-+ZEt_U+L9tg>Y5N$s-=1x)WA>e-(<`^{|6aW0d%NyWu~ z4IGsVvKN|7Oqb5yw(`BSPAAi?zZWj5?2`GWtQO>YTlqmJuX&Nob)(SWTJI)}HwT`b z+S-{tdyA39KA&>)^&w45Sr>SPF|3&%->k~=ZmZf}t%HvOzbAEWVqI1;(^?>CTETTQ zZ_6u@TX`MDuPlCL)$99q&rxmhGO0Yys>j+Zmv%jn%3tDbZk1g$iNkZswNEN@_QtJH zZfx8=SG`d;b;0+{Jh`K6Ul^qHJFk=nY|@x};I+mqjvup*P1Jn<%<_5?tMj_mcePf> z#h%%Cwnt`zX!@1|KPH*Hxzcv3DtIBw)gwh`Hif#$?XEm3rBkZDl{fCAm(Y$9?~g5h zQ6_wAR1?L!AFqFxRMu_1YQ^OM?+eidf951VVD;N0qT;`I+gGDc&tq2bFWW0v?`rHviNRvvA;5D6%>@Qf3ERO zLETozbDrOgcgI>U#>8b^eIxzk&(<5ll}Wo46m`EEd`tgpbtzLf&S1Ip=V05otinvA zwf7%9)v(&W;k)Kt2mS>Y)hBi{l!PB>o5nq5VfxYXwM9ZPJ?STkS?5NF)dtPh_`E>) zwqDR&#ia|4-bU;Zy5juxgTh8$`{1Y74MG-W{g|B)e?mLXkxBQ%!}p~IhxEk0hWp-6 zIFc4Qll_&+l}SzIo7eQQ)|b8g81y1_>He~>>^GK7-gIz>p+D0kjg31sJI~q1srH@7 zdy;lE@Pa@?u5YK_g8U0__b^6(e0SUY=~mx+wzcyV&okWP4c|KJm*ab_^fgZdY%iWP zidzxYrMhApdvN$6>BcYD47amoZ(sGUkV{MZwAWE>kA_2^x(sd~pDQiFD*jHuvHt7a zu&oupz|l23l;N1a;M>Kjiw`AF>uS#3Sp53Eq4%EGqQ#uG%R9fy=6IybH13`teLe7k zM6E;lypmJzw)z^1Pd-%9_-d&>=YmW4$J6hYh3zt25?N@c z|L$=624TyU@9(j3N%d8pia(Gj8T9Vp;YWu*IR3D?!(Ok?$K>_$+4CcR+O>X2X+P6c ze{#R`!Y2j2bv40tj&~lV+*S^=)BfIg_~a$8x*UbT|38(dl>|?c(d@ibc>SZL{Vd^$ zFZ)a$POxFUZeuz#b(YPm?&ohc=bJxm_*x?<>~C8eS-a@QTU$F_kA{w)dGUH)Kc}qx zeC7a?-iZgAyfb|F&E9DL+IwbGki)?my({9A9S-_kyDTJG5G$s?-RWMMv0kUo+a+)9_5ms=McQ(7EVj*8a$Uf;M~y0}bxa6k0UR{QgSUzt6u%e^BM$ zSC+^2>3@fR0=t!!*SE)aGP-vsefYC@PxQJLt;OEuJ6}we+tJx~>6b+v)0U$j>=XVP zwY_qLtRm#@R14{3>Ik-%VmWFZfZ_Qg&63-rd#;{yE3k1HxyPZh5L_Qqkvd zjxW@0`nyL3_U5~~Iv<EGoQl+5SRoc_-Hk^jO|FD}K-2;Q-JwNK_b#;GdF7p_b( zIeE$Ox>Of?iqzp((}L_WwG;b%xrHtnUe}6j5kA)|7IaSDB4gKCt_X8aJQ2YI6Ti-KfvFrlK!}XI9i&?Kd+v2>6xDYIp5rX7ACRyIS70 zs(Dt%y+o}Y(^-FZO!*W)YpdalNn7>Sdi}k4Vg0V`gSSdvuE@_mcJlA1%8&I)%fF}@ zTd3^U$lma1@#UtL3#9>5HwEb1u#|`Y&v>~0>UEbYW{_z!;`XqM7W1?Itgubh`~JY* zKh357Ub1eB+WVG$7A=XhqV zI;8Vzjc``!9YOc*rYW7JJX<_MXSnJfu3DCK#V2w>amp$tx087b?m5`9{^pffAQ&py za^j=nPmN>#v+^E2s(7}3ZtX;2_2r+NRIGl_x%^l>ySZsk#wzcZKBv6b8XRTg7?>z8A*Dv|LqHU?6J|ORBp@UlL1-HnGIhZQbONbcEmeG zeAm(y4F7qgLh<)qMvVur68C@E&AeZqP2D(Wqn38 zl_mXeoH96)_4nO|Q!9(|&CG32FEu;eCL9^yoF>TkLZ0VlX;Ro0bBFyKSD$$m73%z9 z|I<|kSJ=N?kh@`McR;!B!0W~nPfMx}&RHS6Md;7=Sm(p9;CsPLpI~h@H%+yySxPg8GF0Yu9;N zW@wns@Zd;%9j)>_XmuEq{J*1n;=}8A=-piqwu|A|iPrLY9(m%3{4QS(=|K)G*5M3Mt=w+L1qJ z!{oQy7Ozg=TYOF~?5YI6giSsB{N~Pp)RLF$HZ&x&HA&vT5PHn?*pHWybvN$UzIc=N z&|>c0-z}?GE4*{4YGAYSsx4RFvuXeAyPqF=R-F5HuUYS>#3p8w3%*|F_8NA552ya! z`)3}1WyQJB*h&8--dI?j@-xcccj0CJ;TLV;@ABd-iyVI3l6Q~WcK=r8!!1v;>wk8q zKNbx9bM(-?@8#>XzkT1d`?lq2{`cbccjU7T%D2b=|CVaC`>WvgC6(vy-TwFOw8(l% zjqPs!`$~VG)&G}Y|M8+FqmlCc5AnVBD=yZb{kxD?Cf#>N&ExZ5+_GXA4zo^`E;J}8 zG*9?m7B%yf{=DAlF=Br|zS;WeW~|}1^q>`g9?dMC8UJU0{qd#Ib00PA<=xgDb*iUk z^LO26>t63Vux!T@v+4h{-#v{fJgFykIfhlibW!c5oi-mn7i(RVsr1~KvGS<+^UfCi ze{a5u&s%9bZ|DBnzw00Tw)Iz8$G*>K!z1I}@0r$5>W+qpY3DVTfhbFB?;gD*PSNo~Bi;C1~5 z`%TYo$Q;sT-M57?lQr#FKGU)#yJLCJ^c=6>V4ugnk0(_xc+%hFFh@?*b|oT+Mpu8~FCd{pt_LDsM~gm#cgFq08j3_QBnn_O4Az0$PPfO7?t?TxBiLg9{% zbJqX-%kJtIDB#I;WkKLJckgXC?p`=`X40jm-JvYv%-q{2Eiy^YTwD3$(5tPzj@xdV z$5$JkseF8W_Ra@A(s7=fS1dLATTxY>!@T;|NV-0npT=G@*sV!B_i1m~Jv-FLs^?aYUw zcbAvnXFV>r)#R|5cLLka^|?OlQ9?iRtd{+U3eI*;p8*fP{J@C)`X||7J^0wUD z@Ah$B@3VN!#dNH^s7QEKEB~9bC+7HC_cZ*QGOd2n1O3F4`((Q)UWf6OrQSAsN3m! z>rL^UUJtq5dw*uuAKN|U^vNk4lJ5Ez26eJcsi#be@09k2*gXz^)8|#T=*y=|*Th!} zaC**4GpalK?u6T_dDALqb4ca{eH49>yTr%%ZqNGp>-qn7`ThuEW*7Cbshr)BGB4@! zbk?*!U55vU=B3V?`7QlqQ?Ag%^{Vv@dmkM5QOXfkz2EfL-)upduk-IWKhmj*o-t{S zRR7jBnkS>KaK7qx@t7&n`uEzFNv&S<`pwVF|75**ko{8jF28@RQJ3be%a5D9D6;>G zr}u|5R;z;jy}znQ+XsH0e5jO>M?562#m#PW`pd?4`!{lSzk)aAeVTFa;r?Q;J?SAY zzo}M#o|>fMz*1Y?yW{=l0ImLe#j3x$ui04rc%vSBeS6)a`&MPM&gM;I`uQQSX~DE_ zb(iLP+^qg%ywtFA8Q@(noy`xUKIQ3o~7#2@+%w_ zrU#z1_-{M7H6S7(-q$R$IEU}yG!IAFNeWIvrVKkOCvDp4+I8Rh+$q(q=RzNJ8m~~; zcjxoRwD3Ry&qH1l{8P5i`h8B5(_rsn)*N<)r_tMlZsr8NJG4{yj)UTbl1t(n+B*1m z)q?`~vbCpPx2Kt9C3g(>Kc}R!*>6qCriwk-#u<@2)xdbI)vbdJmvat@Ib}3L%bF)& zEm$iqiM+F3&N4r+_4~D&#^raiA8a=8R-D&wUNW6oOxR^Z^yC#wS#Ikbl%8fEnWJWy zu#t0H)b2Cye=2v(O{g!3D-pAjbZwlP&^ar|EiU5|Lu;V?=9afDpDt<%pZxqWZCmp4 xWpaNW9EtuGanOHbUH_DgP5;^dL>zqY@^>L;;QxNHtTPWX7A`V2GMgaE007buqm%#u literal 0 HcmV?d00001 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}