<no title>

Syntax Definitions 语法定义 ==================

警告

This topic is a draft and may contain wrong information.

警告：: 这部分内容仍处于草稿阶段，并可能包含错误信息。

Compatibility with Textmate 与Textmate的兼容性 ***********************

Sublime Text syntax definitions are generally compatible with Textmate language files. Sublime Text的语法定义内容基本上与Textmate的语法定义文件是相互兼容的。

File Format 文件格式 *******

Syntax definitions are files in the Plist format with the tmLanguage extension. In this reference files, however, JSON is used instead and converted into Plist. 语法定义文件是以 tmLanguage 作为扩展名的Plist（属性列表）文件。然而，在本文档中，我们将使用 JSON文件来进行讲解，然后再将JSON文件转换为Plist文件。

{ "name": "Sublime Snippet (Raw)",
  "scopeName": "source.ssraw",
  "fileTypes": ["ssraw"],
  "patterns": [
      { "match": "\\$(\\d+)",
        "name": "keyword.ssraw",
        "captures": {
            "1": { "name": "constant.numeric.ssraw" }
         },
        "comment": "Tab stops like $1, $2..."
      },
      { "match": "\\$([A-Za-z][A-Za-z0-9_]+)",
        "name": "keyword.ssraw",
        "captures": {
            "1": { "name": "constant.numeric.ssraw" }
         },
        "comment": "Variables like $PARAM1, $TM_SELECTION..."
      },
      { "name": "variable.complex.ssraw",
        "begin": "(\\$)(\\{)([0-9]+):",
        "beginCaptures": {
            "1": { "name": "keyword.control.ssraw" },
            "3": { "name": "constant.numeric.ssraw" }
         },
         "patterns": [
            { "include": "$self" },
            { "name": "string.ssraw",
              "match": "."
            }
         ],
         "end": "\\}"
      },
      { "name": "constant.character.escape.ssraw",
        "match": "\\\\(\\$|\\>|\\<)"
      },
      { "name": "invalid.ssraw",
        "match": "(\\$|\\>|\\<)"
      }
  ],
  "uuid": "ca03e751-04ef-4330-9a6b-9b99aae1c418"
}

name: Descriptive name for the syntax definition. Shows up in the syntax definition dropdown menu located in the bottom right of Sublime Text interface. It’s usually the name of the programming language or equivalent. 所定义语法的描述性名称。这个名称显示在Sublime Text界面右下角的下拉菜单中。通常情况下， name 表示的是编程语言或其他标记语言的名称。
scopeName: Name of the top-level scope for this syntax definition. Either source.<lang> or text.<lang>. Use source for programming languages and text for everything else. 语法定义文件起效的顶级坐拥域名称。这个名称一般是 source.<语言名称> 或者 text.<语言名称> 。如果是在定义编程语言的语法，那么就使用 source 这个名称，否则使用 text 作为名称。
fileTypes: And array of file type extensions for which this syntax should be automatically activated. Include the extensions without the leading dot. 记录适用于这个语法文件的文件扩展名的数组。数组中的每项是去掉”.”的文件扩展名称。
uuid: Unique indentifier for this syntax definition. Currently ignored. 这个语法定义的唯一标示符。目前被忽略。
foldingStartMarker: Currently ignored. Used for code folding. 目前被忽略，用于标示折叠内容的开始。
foldingStopMarker: Currently ignored. Used for code folding. 目前被忽略，用于标示折叠内容的结束。
patterns: Array of patterns to match against the buffer’s text. 记录与缓冲区中的文字进行匹配的模式的数组。
repository: Array of patterns abstracted out from the patterns element. Useful to keep the syntax definition tidy as well as for specialized uses like recursive patterns. Optional. 从模式元素中抽象出来的数组。定义这个数组一方面有助于保持语法定义文件整洁，另一方面也能为像递归模式这样的功能服务。这个内容是可选的。

The Patterns Array 模式数组 **************

Elements contained in the patterns array. 在 patterns 数组中包含的元素。

match

Contains the following elements: 包含下列原素：

`match`	Pattern to search for.
`match`	用于搜索的模式。
`name`	Scope name to be assigned to matches of `match`.
`name`	设置被 `match` 匹配到的内容所具有的作用域。
`comment`	Optional. For information only.
`comment`	可选。只是为了提供信息。
`captures`	Optional. Refinement of `match`. See below.
`captures`	可选。是对 `match` 的精炼。见下文解释

In turn, captures can contain n of the following pairs of elements: captures 内容可以包含多组下面要说明的元素对：

`0..n`	Name of the group referenced.
`0..n`	被索引的组的名字。
`name`	Scope to be assigned to the group.
`name`	组内元素具有的作用域。

Examples: 示例：

// Simple

{ "name": "constant.character.escape.ssraw",
  "match": "\\\\(\\$|\\>|\\<)"
  "comment". "Sequences like \$, \> and \<"
}

// With captures

{ "match": "\\$(\\d+)",
  "name": "keyword.ssraw",
  "captures": {
      "1": { "name": "constant.numeric.ssraw" }
   },
  "comment": "Tab stops like $1, $2..."
}

include

Includes items in the repository, other syntax definitions or the current one. 在仓库中包含其他的语法定义内容或者当前定义的内容。

References:

$self The current syntax definition.

$self 当前的语法定义。

#itemName itemName in the repository.

#itemName 仓库中名为 “itemName” 的内容。

source.js External syntax definitions.

source.js 外部的语法定义。

Examples: 示例：

// Requires presence of DoubleQuotedStrings element in the repository.
{ "include": "#DoubleQuotedStrings" }

// Recursively includes the current syntax definition.
{ "include": "$self" }

// Includes and external syntax definition.
{ "include": "source.js" }

begin..end

Defines a scope potentially spanning multiple lines 定义一个可以跨多行的作用域。

Contains the following elements: 包含下面的一些元素：

begin The start marker pattern.

begin 模式的开始标志。

end The end marker pattern.

end 模式的终止标志。

name Scope name for the whole region.

name 整个区域的作用域名称。

beginCaptures captures for begin. See captures.

beginCaptures 为 begin 准备的 captures。请参考 captures。

endCaptures captures for end. See captures.

endCaptures 为 end 准备的 captures。请参考 captures。

patterns patterns to be matched against the content.

patterns 与正文内容进行配对的 patterns 。

contentName Scope name for the content excluding the markers.

contentName 除掉标志符之后的内容的作用域名称。

Example: 示例：

{ "name": "variable.complex.ssraw",
  "begin": "(\\$)(\\{)([0-9]+):",
  "beginCaptures": {
      "1": { "name": "keyword.control.ssraw" },
      "3": { "name": "constant.numeric.ssraw" }
   },
   "patterns": [
      { "include": "$self" },
      { "name": "string.ssraw",
        "match": "."
      }
   ],
   "end": "\\}"
}

Repository 仓库 ******

Can be referenced from patterns or from itself in an include element. See include for more information. 在 include 元素中，既可以从 patterns 中饮用，也可以从自身引用。请参考 include 章节来了解更多信息。

The repository can contain the following elements: 仓库可以包含下列元素：

Simple elements:

"elementName": {
  "match":  "some regexp",
  "name":   "some.scope.somelang"
}

Complex elements:

"elementName": {
  "patterns": [
    { "match":  "some regexp",
      "name":   "some.scope.somelang"
    },
    { "match":  "other regexp",
      "name":   "some.other.scope.somelang"
    }
  ]
}

Examples: 示例：

"repository": {
  "numericConstant": {
    "patterns": [
      { "match":  "\\d*(?<!\\.)(\\.)\\d+(d)?(mb|kb|gb)?",
        "name":   "constant.numeric.double.powershell",
        "captures": {
          "1": { "name": "support.constant.powershell" },
          "2": { "name": "support.constant.powershell" },
          "3": { "name": "keyword.other.powershell" }
          }
      },
      { "match":  "(?<!\\w)\\d+(d)?(mb|kb|gb)?(?!\\w)",
        "name":   "constant.numeric.powershell",
        "captures": {
          "1": { "name": "support.constant.powershell" },
          "2": { "name": "keyword.other.powershell" }
          }
      }
    ]
  },
  "scriptblock": {
    "begin":  "\\{",
    "end":    "\\}",
    "name":   "meta.scriptblock.powershell",
    "patterns": [
      { "include": "$self" }
    ]
  },
}

Escape Sequences 转义序列 ************

Be sure to escape JSON/XML sequences as needed. 请确保对JSON/XML序列内容进行正确的转义。