[gnome-builder] doc: add howto on changing indentation



commit 43c7e2b35ec788e0980d7488031246d6647b7f47
Author: Christian Hergert <chergert redhat com>
Date:   Mon Jun 12 14:23:27 2017 -0700

    doc: add howto on changing indentation

 doc/howto/indentation.rst |   35 +++++++++++++++++++++++++++++++++++
 doc/howto/index.rst       |   16 ++++++++++++++++
 doc/index.rst             |    1 +
 3 files changed, 52 insertions(+), 0 deletions(-)
---
diff --git a/doc/howto/indentation.rst b/doc/howto/indentation.rst
new file mode 100644
index 0000000..d70fcaa
--- /dev/null
+++ b/doc/howto/indentation.rst
@@ -0,0 +1,35 @@
+####################
+Changing Indentation
+####################
+
+To change the indentation rules you have two options.
+Either globally for your system, or for just the current project.
+
+Project-Wide
+------------
+
+If you would like to change settings for just your project, use a ``.editorconfig`` file.
+You can add a ``.editorconfig`` file to the root of your project in the editorconfig_ format.
+
+It looks something like:
+
+.. code-block:: ini
+
+   root = true
+
+   [*]
+   charset = utf-8
+   end_of_line = lf
+
+Globally
+--------
+
+If you would like to change the indentation rules for your user, and thereby all projects which do not 
contain an ``.editorconfig`` file, use the application preferences.
+You can access the preferences through the perspective selector or using the ``Command+,`` keyboard shortcut.
+
+First select “Programming Languages” from the sidebar on the left.
+Then select the programming language from the list of options.
+On the right you will now see a list of preferences that may be tweaked for that language.
+Change the indentation level to your desired preference.
+
+.. _editorconfig: http://editorconfig.org/
diff --git a/doc/howto/index.rst b/doc/howto/index.rst
new file mode 100644
index 0000000..9f128bf
--- /dev/null
+++ b/doc/howto/index.rst
@@ -0,0 +1,16 @@
+#############
+How-To Guides
+#############
+
+These quick and to the point “How To” articles are meant to help you answer common questions.
+If you have an addition to the list, please let us know!
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 4
+   :titlesonly:
+
+   indentation
+
diff --git a/doc/index.rst b/doc/index.rst
index 73dc730..9331ba8 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -20,6 +20,7 @@ Contents
    exploring
    projects/index
    plugins/index
+   howto/index
    api/index
    contributing/index
    credits


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]