Metadata Files
Metadata are parameters that can be assigned to certain text sections using scope selectors.
These paremeters can be used for many purposes; for example:
- specifying the current comment markers, even within embedded source code, so that you can toggle comments in any syntax,
- defining rules for auto-indentation,
- marking symbols that Sublime Text will allow you to browse to quickly.
Furthermore, snippets can access metadata
declared in the shellVariables
setting,
which allows you to create a snippet
that has different contents
depending on where it's used.
# File Format
Metadata files have the .tmPreferences
extension
and use the Property List format.
The file name is ignored by Sublime Text.
Metadata files are inherited from TextMate.
# Example
Here's an example of a metadata file:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>name</key>
<string>JavaScript Metadata</string>
<key>scope</key>
<string>source.js</string>
<key>settings</key>
<dict>
<key>decreaseIndentPattern</key>
<string>^(.*\*/)?\s*\}.*$</string>
<key>increaseIndentPattern</key>
<string>^.*\{[^}"']*$</string>
<key>bracketIndentNextLinePattern</key>
<string>(?x)
^ \s* \b(if|while|else)\b [^;]* $
| ^ \s* \b(for)\b .* $
</string>
</dict>
<dict>
<key>shellVariables</key>
<array>
<dict>
<key>name</key>
<string>TM_COMMENT_START</string>
<key>value</key>
<string>// </string>
</dict>
<dict>
<key>name</key>
<string>TM_COMMENT_START_2</string>
<key>value</key>
<string>/*</string>
</dict>
<dict>
<key>name</key>
<string>TM_COMMENT_END_2</string>
<key>value</key>
<string>*/</string>
</dict>
</array>
</dict>
<key>uuid</key>
<string>BC062860-3346-4D3B-8421-C5543F83D11F</string>
</dict>
</plist>
The example file combines several types of metadata.
# Structure of a Metadata File
All metadata files share the same topmost structure, which is inherited from the Property List format.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
</dict>
</plist>
Sublime Text uses the following topmost keys in metadata files; all others are ignored by default.
name
Optional. Name of the metadata. Ignored by Sublime Text.
<key>name</key> <string>Shell Variables</string>
scope
Required. Scope selector to determine in which context the metadata should be available.
<key>scope</key> <string>source.python</string>
settings
Required. Container for settings.
<key>settings</key> <dict> ... </dict>
uuid
Optional. A unique identifier for the file. Ignored by Sublime Text.
<key>uuid</key> <string>BC062860-3346-4D3B-8421-C5543F83D11F</string>
# Subelements of settings
The settings
element can contain
subelements for different purposes,
which will be grouped in the following sections.
Some subelements have certain functionality associated with them by default, while others can only be accessed via the API.
# Indentation Options
Indentation options control aspects of the auto-indentation mechanism.
increaseIndentPattern
Regex. If it matches on the current line, the next line will be indented one level further.
<key>increaseIndentPattern</key> <string>insert regex here</string>
decreaseIndentPattern
Regex. If it matches on the current line, the next line will be unindented one level.
<key>decreaseIndentPattern</key> <string>insert regex here</string>
bracketIndentNextLinePattern
Regex. If it matches on the current line, only the next line will be indented one level further.
<key>bracketIndentNextLinePattern</key> <string>insert regex here</string>
disableIndentNextLinePattern
Regex. If it matches on the current line, the next line will not be indented further.
<key>disableIndentNextLinePattern</key> <string>insert regex here</string>
unIndentedLinePattern
Regex. The auto-indenter will ignore lines matching this regex when computing the next line's indentation level.
<key>unIndentedLinePattern</key> <string>insert regex here</string>
# Completions Options
Completion options control aspects of the completions mechanism.
cancelCompletion
Regex. If it matches on the current line, supresses the autocomplete popup.
<key>cancelCompletion</key> <string>insert regex here</string>
# Symbol Definitions
Documentation for symbol definitions was moved to a separate page: Symbol Definition settings.
# Shell Variables
Shell variables are used for different purposes and can be accessed from snippets.
Note that shell variables are defined
as dictionaries in an array,
and thus have a different format
from settings
subelements.
shellVariables
Container for "shell variables".
<key>shellVariables</key> <array> ... </array>
# shellVariables
Subelements
Subelements of shellVariables
are
dictionaries with name
and value
keys.
<dict>
<key>name</key>
<string>BOOK_OPENING</string>
<key>value</key>
<string>Once upon a time...</string>
</dict>
See Also
- Comments
- Shell variables defining comment markers.
# Related API Functions
To extract metadata information from plugin code,
you can use the view.meta_info(key, point)
API call.