sublime-undocs icon indicating copy to clipboard operation
sublime-undocs copied to clipboard

Documentation of Syntax Naming Conventions

Open leoheck opened this issue 11 years ago • 4 comments

Hi, its possible to update the documentation with the _Naming Conventions_ for syntax files? You can search the some information here (I believe that is the same for sublime): http://manual.macromates.com/en/language_grammars

leoheck avatar Oct 29 '14 17:10 leoheck

Check the Textmate online manual for guidance on scope names.

This section is actually in the documentation and has initially led me to browse the docs in order to find scope names for my first syntax, but I agree that this is definitely not enough. We might as well mirror the TM docs and add a few other conventions like the punctuation thing.

I think we should add a separate doc about scopes and scope selectors for this purpose that we can also link from syntax definitions and color schemes.

FichteFoll avatar Oct 29 '14 17:10 FichteFoll

A separate doc should be fine. Thanks.

leoheck avatar Oct 29 '14 17:10 leoheck

As far as #69 this seems to be covered in more detail at http://sublimetext.info/docs/en/extensibility/syntaxdefs.html#scopes-and-scope-selectors - the equivalent page here might be http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/reference/syntaxdefs.html but it is more limited.

jcrben avatar Apr 11 '15 06:04 jcrben

ed6fba5288bdd7e9f28b9f3a74e8f32acb8e5de8 adds a reference to the official docs in our color scheme docs.

I will take a look at our syntax docs at another time.

FichteFoll avatar Oct 23 '16 20:10 FichteFoll