Set settings local to a single buffer. A more granular approach to settings
than the per file type .sublime-settings
files.
Inspired in Vim's modelines feature.
Getting Started
Download and install SublimeModelines
_.
See the installation instructions
_ for .sublime-package
\ s.
.. _installation instructions: http://sublimetext.info/docs/en/extensibility/packages.html#installation-of-packages .. _SublimeModelines: https://bitbucket.org/guillermooo/sublimemodelines/downloads/SublimeModelines.sublime-package
Side Effects
Buffers will be scanned .on_load()
for modelines and settings will be set
accordingly. Settings will apply only to the buffer declaring them.
.. Note: Application- and Window-level options declared in modelines are .. obviously global.
Usage
Modelines must be declared at the top or the bottom of source code files with one of the following syntaxes::
# sublime: option_name value
# sublime: option_name value; another_option value; third_option value
Note: #
is the default comment character. Use the corresponding
single-line comment character for your language. When there isn't a concept of
comment, the default comment character must be used.
SublimeModelines finds the appropriate single-line comment character by inspecting
the shellVariables
preference, which must be defined in a .tmPreferences
file. To see an example of how this is done, open Packages/Python/Miscellaneous.tmPreferences
.
Many packages giving support for programming languages already include this, but
you might need to create a .tmPreferences
file for the language you're working
with if you want SublimeModelines to be available.
Caveats
If the option's value contains a semicolon (;
), make sure it isn't followed
by a blank space. Otherwise it will be interpreted as a multioption separator.
Non-Standard Options
For some common cases, no directly settable option exists (for example, a setting to specify a syntax). For such cases, Sublime Modelines provides non-standard accessors as a stop-gap solution.
x_syntax Packages/Foo/Foo.tmLanguage
Sets the syntax to the specified .tmLanguage file.