feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Edit info about configuring external tools

Browse Source 
The menu items in Tools > External are meant as examples.
To use the system editor, it is better to use Open With >
System Editor.

Change-Id: Ib746846e6bfff29f4884a9d4ab6363d9831dfb04
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2024-10-10 15:24:54 +02:00
parent 85862d3ca6
commit afac0965c2
1 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/qtcreator/src/howto/creator-external-tools.qdoc
View File

@@ -20,9 +20,10 @@
\title Use external tools \title Use external tools
You can use external tools directly from \QC. You can change the default You can add menu items for using external tools directly from \QC to
configurations of the QML preview tools and the default text editor for \uicontrol Tools > \uicontrol External. As examples, the menu shows
your system or configure new tools. items for opening the currently active file for editing in a text editor
or running the currently active QML file.
To run the tools, select \uicontrol Tools > \uicontrol External, or use the To run the tools, select \uicontrol Tools > \uicontrol External, or use the
\c x filter in the locator. \c x filter in the locator.
@@ -41,6 +42,7 @@
particular context. particular context.
\endif \endif
To configure external tools: To configure external tools:
\list 1 \list 1
@@ -197,12 +199,27 @@
\title Use external text editors \title Use external text editors
You can open files for editing in the default text editor for your system: To open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and \macos.
To open the file you are currently viewing in an external editor, select \list 1
\uicontrol Tools > \uicontrol External > \uicontrol Text > \li Right-click the filename in one of the following views to open a context
\uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on menu:
your system. \list
\li \l {Edit mode}
\li \l {File System}
\li \l {Open Documents}
\li \l {Projects}
\endlist
\li Select \uicontrol {Open With} > \uicontrol {System Editor}.
\endlist
\section1 Add editors to Tools menu
You can add menu items for opening the file you are currently viewing in
an external editor to \uicontrol Tools > \uicontrol External >
\uicontrol Text. The current example commands are
\uicontrol {Edit with Notepad} on Windows and \uicontrol {Edit with vi} on
Linux and \macos.
\QC looks for the editor path in the PATH environment variable \QC looks for the editor path in the PATH environment variable
of your operating system. of your operating system.