Преглед на файлове

Merge pull request #4323 from NathanLovato/move-editor-manual

Move and edit editor manual
Nathan Lovato преди 4 години
родител
ревизия
041e326d69

+ 0 - 10
getting_started/editor/index.rst

@@ -1,10 +0,0 @@
-Editor manual
-=============
-
-.. toctree::
-   :maxdepth: 1
-   :name: toc-learn-editor
-
-   command_line_tutorial
-   external_editor
-   default_key_mapping

+ 1 - 1
index.rst

@@ -67,7 +67,6 @@ The main documentation for the site is organized into the following sections:
 
    getting_started/introduction/index
    getting_started/step_by_step/index
-   getting_started/editor/index
    getting_started/workflow/index
 
 
@@ -81,6 +80,7 @@ The main documentation for the site is organized into the following sections:
    tutorials/3d/index
    tutorials/audio/index
    tutorials/physics/index
+   tutorials/editor/index
    tutorials/math/index
    tutorials/animation/index
    tutorials/inputs/index

+ 0 - 0
getting_started/editor/command_line_tutorial.rst → tutorials/editor/command_line_tutorial.rst


+ 0 - 0
getting_started/editor/default_key_mapping.rst → tutorials/editor/default_key_mapping.rst


+ 21 - 6
getting_started/editor/external_editor.rst → tutorials/editor/external_editor.rst

@@ -3,17 +3,20 @@
 Using an external text editor
 ==============================
 
+This page explains how to code using an external text editor.
+
 .. warning::
 
-    `External editors are currently incompatible with Godot's "Sync Script Changes" feature. <https://github.com/godotengine/godot/issues/10946>`__
+    `External editors are currently incompatible with Godot's "Sync Script
+    Changes" feature. <https://github.com/godotengine/godot/issues/10946>`__
 
-Godot can be used with an external text editor, such as Sublime Text or Visual Studio Code.
-To enable an external text editor, browse to the relevant editor settings via:
-``Editor -> Editor Settings -> Text Editor -> External``
+Godot can be used with an external text editor, such as Sublime Text or Visual
+Studio Code. Browse to the relevant editor settings: ``Editor -> Editor Settings
+-> Text Editor -> External``
 
 .. image:: img/editor_settings.png
 
-There are two fields: the executable path and command line flags. The flags
+There are two fields: the executable path and command-line flags. The flags
 allow you to integrate the editor with Godot, passing it the file path to open
 and other relevant arguments. Godot will replace the following placeholders in
 the flags string:
@@ -45,5 +48,17 @@ Some example Exec Flags for various editors include:
 +---------------------+-----------------------------------------------------+
 | Vim (gVim)          | ``"+call cursor({line}, {col})" {file}``            |
 +---------------------+-----------------------------------------------------+
+| Emacs               | ``emacs +{line}:{col} {file}``                      |
++---------------------+-----------------------------------------------------+
+
+.. note:: For Visual Studio Code, you will have to point to the ``code.cmd``
+          file. For Emacs, you can call ``emacsclient`` instead of ``emacs`` if
+          you use the server mode.
+
+Official editor plugins
+-----------------------
+
+We have official plugins for the following code editors:
 
-.. note:: For Visual Studio Code you will have to point to the ``code.cmd`` file.
+- `Visual Studio Code <https://github.com/godotengine/godot-vscode-plugin>`_
+- `Emacs <https://github.com/godotengine/emacs-gdscript-mode>`_

+ 0 - 0
getting_started/editor/img/editor_settings.png → tutorials/editor/img/editor_settings.png


+ 15 - 0
tutorials/editor/index.rst

@@ -0,0 +1,15 @@
+Editor manual
+=============
+
+In this section, we cover the Godot editor in general, from its interface to
+using it with the command line. We cover some specific editors' interface in
+other sections where appropriate. For example, the :ref:`animation editor
+<doc_introduction_animation>`.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-editor
+
+   command_line_tutorial
+   external_editor
+   default_key_mapping