Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of Syntax Naming Conventions #101

Open
leoheck opened this issue Oct 29, 2014 · 4 comments
Open

Documentation of Syntax Naming Conventions #101

leoheck opened this issue Oct 29, 2014 · 4 comments

Comments

@leoheck
Copy link

leoheck commented Oct 29, 2014

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

@FichteFoll
Copy link
Collaborator

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.

@leoheck
Copy link
Author

leoheck commented Oct 29, 2014

A separate doc should be fine. Thanks.

@jcrben
Copy link
Contributor

jcrben commented Apr 11, 2015

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.

@FichteFoll
Copy link
Collaborator

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants