Skip to content

Commit

Permalink
Merge pull request #214 from guillermooo/add-generated-global-settings
Browse files Browse the repository at this point in the history
add generated settings docs
  • Loading branch information
guillermooo committed Jun 30, 2016
2 parents 60ef2d4 + 6660961 commit ae5f084
Show file tree
Hide file tree
Showing 12 changed files with 1,785 additions and 215 deletions.
24 changes: 12 additions & 12 deletions source/_includes/build_system_summary_table.g.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
.. This file was generated. Don't edit it.

+---------------+--------------------------------------+
| **Format** | JSON (with comments) |
+---------------+--------------------------------------+
| **Extension** | :file:`.sublime-build` |
+---------------+--------------------------------------+
| **Name** | Any |
+---------------+--------------------------------------+
| **Location** | Any under :file:`Packages` |
+---------------+--------------------------------------+
| **Content** | Predefined items and, optionally, |
| | arbitrary user-defined items |
+---------------+--------------------------------------+
+---------------+------------------------------------------------+
| **Format** | JSON (with comments) |
+---------------+------------------------------------------------+
| **Extension** | :file:`.sublime-build` |
+---------------+------------------------------------------------+
| **Name** | Any |
+---------------+------------------------------------------------+
| **Location** | Any under :file:`Packages` |
+---------------+------------------------------------------------+
| **Content** | Predefined items and, optionally, arbitrary |
| | user-defined items |
+---------------+------------------------------------------------+
26 changes: 13 additions & 13 deletions source/_includes/command_line.g.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,24 @@ For details, see below the next summary.

``--project <project>``
Load the given project.

The **project** argument
designates the :file:`.sublime-project` or :file:`.sublime-workspace` file
to be loaded.

``--command <command>``
Execute the given command.

The **command** argument
designates the command to be run.

If Sublime Text isn't running already,
only ``ApplicationCommand``\s will work
when invoked from the command line.
If Sublime Text is already running,
``WindowCommand``\s will work as well
when invoked from the command line.

You can also pass arguments
to the command. The arguments must
be separated from the command name by a space
Expand All @@ -61,39 +61,39 @@ For details, see below the next summary.
For example, this syntax may work
in bash as well as PowerShell:
``subl --command 'echo {\"foo\": 100 }'``.

``--new-window (-n)``
Open a new window.

This option should be used
when an instance of Sublime Text
is already running.

``--add (-a)``
Add folders to the current window.

Add folders to the current window
instead of opening a new window.

``--wait (-w)``
Wait for the files to be closed before returning.

This is useful, for example,
to use Sublime Text as an editor
with version control systems like git.
Implied if reading from standard input.

``--background (-b)``
Don't activate the application.

``--stay (-s)``
Keep the application activated after closing the file.

Only works in combination with ``--wait``.

``--help (-h)``
Display help.

``--version (-v)``
Show version information.

27 changes: 13 additions & 14 deletions source/_includes/menus_summary_table.g.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
.. This file was generated. Don't edit it.

+---------------+--------------------------------------+
| **Format** | JSON (with comments) |
+---------------+--------------------------------------+
| **Extension** | :file:`.sublime-menu` |
+---------------+--------------------------------------+
| **Name** | One out of the list of available |
| | menus. See :ref:`menu-types` for the |
| | complete name list and what menu |
| | they represent. |
+---------------+--------------------------------------+
| **Location** | Any under :file:`Packages` |
+---------------+--------------------------------------+
| **Content** | A list of :ref:`menu-item-objects` |
+---------------+--------------------------------------+
+---------------+------------------------------------------------+
| **Format** | JSON (with comments) |
+---------------+------------------------------------------------+
| **Extension** | :file:`.sublime-menu` |
+---------------+------------------------------------------------+
| **Name** | One out of the list of available menus. See |
| | :ref:`menu-types` for the complete name list |
| | and what menu they represent. |
+---------------+------------------------------------------------+
| **Location** | Any under :file:`Packages` |
+---------------+------------------------------------------------+
| **Content** | A list of :ref:`menu-item-objects` |
+---------------+------------------------------------------------+
76 changes: 76 additions & 0 deletions source/_includes/settings_automatic.g.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
.. This file was generated. Don't edit it.

``auto_match_enabled``

+-------------+----------+
| **Type** | bool |
+-------------+----------+
| **Default** | ``true`` |
+-------------+----------+

Toggles automatic pairing of quotes, brackets, etc.


``save_on_focus_lost``

+-------------+-----------+
| **Type** | bool |
+-------------+-----------+
| **Default** | ``false`` |
+-------------+-----------+

If ``true``,
saves files automatically
when switching to a different file or application.


``find_selected_text``

+--------------------+-----------+
| **Type** | bool |
+--------------------+-----------+
| **Default (All)** | ``true`` |
+--------------------+-----------+
| **Default (OS X)** | ``false`` |
+--------------------+-----------+

If ``true``,
the selected text will be copied
into the find panel
when the panel is opened.


``word_separators``

+-------------+-------------------------------------------+
| **Type** | str |
+-------------+-------------------------------------------+
| **Default** | ``"./\\()\"'-:,.;<>~!@#$%^&*|+=[]{}`~?"`` |
+-------------+-------------------------------------------+

Characters considered to divide words
for actions like advancing the cursor, etc.
Not used for every context
where a notion of a word separator is useful
(for example, word wrapping).
In some contexts,
the text might be tokenized
based on other criteria
(for example, the syntax definition rules).


``ensure_newline_at_eof_on_save``

+-------------+-----------+
| **Type** | bool |
+-------------+-----------+
| **Default** | ``false`` |
+-------------+-----------+

If ``true``,
adds a new line
at the end of the active file
before saving
if no new line is present.


58 changes: 58 additions & 0 deletions source/_includes/settings_build.g.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.. This file was generated. Don't edit it.

``result_file_regex``

+-------------+----------+
| **Type** | str |
+-------------+----------+
| **Default** | ``null`` |
+-------------+----------+

Regular expression
used to extract file names
from build system output
printed to a view or output panel.
Follows the rules for :ref:`error capturing
in build systems <build-capture-error-output>`.


``result_line_regex``

+-------------+----------+
| **Type** | str |
+-------------+----------+
| **Default** | ``null`` |
+-------------+----------+

Regular expression
used to extract line information
from build system output
printed to a view or output panel.
Follows the rules for :ref:`error capturing
in build systems <build-capture-error-output>`.


``result_base_dir``

+-------------+----------+
| **Type** | str |
+-------------+----------+
| **Default** | ``null`` |
+-------------+----------+

Folder to start looking
for offending files
based on information extracted with ``result_file_regex`` and ``result_line_regex``.


``build_env``

+-------------+--------------------+
| **Type** | bool | {str : str} |
+-------------+--------------------+
| **Default** | ``false`` |
+-------------+--------------------+

List of paths to add to build systems by default.


0 comments on commit ae5f084

Please sign in to comment.