Added page on setting up external editors (and added notes on paths being absolute)

This commit is contained in:
Geoffrey
2018-02-27 10:28:42 +01:00
parent 530fb1cbb2
commit 62458d67e5
3 changed files with 38 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
.. _doc_external_editor
Using an external text editor
==============================
While godot has an inbuilt text editor, some developers have a tendency to
want to use a text editor they are familiar with. Godot provides this
option via the options under
``Editor -> Editor Settings -> Text Editor -> External``
.. image:: img/editor_settings.png
There are two fields: the executable path and command line flags. The flags
allow you to better integrate the editor with godot. Godot will replace the
following inside the flags parameter:
+---------------------+-----------------------------------------------------+
| Field in Exec Flags | Is replaced with |
+=====================+=====================================================+
| {project} | The absolute path to the project directory |
+---------------------+-----------------------------------------------------+
| {file} | The absolute path to the file |
+---------------------+-----------------------------------------------------+
| {col} | The column number of the error |
+---------------------+-----------------------------------------------------+
| {line} | The line number of the error |
+---------------------+-----------------------------------------------------+
Some example Exec Flags for various editors include:
+---------------------+-----------------------------------------------------+
| Editor | Exec Flags |
+=====================+=====================================================+
| geany/kate | {file} --line {line} --column {col} |
+---------------------+-----------------------------------------------------+
| atom/sublime text | {file}:{line} |
+---------------------+-----------------------------------------------------+

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

View File

@@ -8,3 +8,4 @@ Scripting
gdscript/index
visual_script/index
c_sharp/index
external_editor