[LaTeX] rewrite syntaxes #370

randy3k · 2016-05-09T17:40:26Z

close #340

The follow up PR for #340, things to be done

syntax_test files
~~~handle accents~~~ (It seems it is not necessary)
math scope naming (no objection?)
itemize/enumerate etc scope naming (no objection?)
remove incompatible regex patterns
fix R/Rd (R Documentation) and Haskell/Literate Haskell
cite commands
POSIX regex
minted package

There are many changes, I just list the important breaking changes

math mode: string.other.math.tex -> meta.environment.math
itemize/enumerate/description/list scopes are now
- meta.environment.list.itemize.latex
- meta.environment.list.enumerate.latex
- meta.environment.list.description.latex
- meta.environment.list.list.latex
Added symbol lists for labels and sections
The syntaxes for Beamer and Memoir were removed (I think no one is actually using these syntax files).
External packages' support can be added to the packages pattern of LaTeX syntax.

@csch0 @msiniscalchi @ig0774 Do you have any comments? This PR will certainly break your packages. We might have to discuss the naming convention of the scopes.

wbond · 2016-05-10T01:04:44Z

I added a list item to remove incompatible regex patterns

wbond · 2016-05-10T16:00:56Z

This will also affect the R/Rd (R Documentation).sublime-syntax and Haskell/Literate Haskell.sublime-syntax files.

randy3k · 2016-05-10T17:16:30Z

Will fix them too.

r-stein · 2016-05-10T20:11:13Z

Just a few points:

It would be nice to add \ensuremath to the math commands
I think it would be useful to add a meta scope for environments in which the tex commands are treated verbatim, e.g. lstlisting or verbatim. A usecase would be to define keybindings like:

  {
    "keys": ["\""], "command": "insert_snippet", "args": {"contents": "``$0''"},  "context": [
      { "key": "selector", "operator": "equal", "operand": "text.tex.latex - (meta.environment.verbatim.latex, meta.environment.math.latex)" }
    ]
  }

are you planing to support more packages (e.g. minted, comment,...) and additional listing languages?

randy3k · 2016-05-10T20:35:12Z

\ensuremath sounds like a good idea.
verbatim now receives the scope meta.function.verbatim.latex, but to be consistent, I guess it should be renamed as meta.environment.verbatim.latex.
the plan is to add packages which are commonly used. And adding such packages should help in highlighting or defining keybinds.

ig0774 · 2016-05-10T21:33:54Z

One regression I've noticed is that this syntax doesn't properly handle commands in optional arguments where there is a specific rule for the main command. For example, in a command like:

\makebox[\linewidth]{...}

\linewidth isn't properly recognised as a command.

randy3k · 2016-05-11T04:57:25Z

The issue related optional arguments is new to this syntax as the original syntax doesn't detect optional arguments at all (at least for \makebox). I have an idea on how to fix it, but it will take some time since I want to do it more generally.

r-stein · 2016-05-11T12:10:31Z

General ST question: is it possible (in the colorscheme or elsewhere) to present a scope in super- or subscript position? It would be nice to show something like $x^2$ as $x^²$ .

FichteFoll · 2016-05-11T13:15:52Z

No.
Only regular, bold and italics are supported. Textmate also supports underline, but Sublime Text does not render this.

I also wouldn't be too pleased by this tbh.

r-stein · 2016-05-11T13:48:03Z

Okay thanks. I personally think this and named foldings like \alpha to α and \label{...} to [l] increases the readability of tex files.

randy3k · 2016-05-11T14:02:44Z

@r-stein I would let other packages to handle it. Some users may not like this idea.

r-stein · 2016-05-11T14:24:52Z

@randy3k As far ich know this is not possible in ST, it was just a general comment :)

wbond · 2016-07-15T20:21:14Z

@Eyenseo Yes, syntaxes are global to Sublime Text, and are not per-project.

randy3k · 2016-07-15T21:50:57Z

LaTeX/LaTeX.sublime-syntax

@@ -552,7 +552,7 @@ contexts:
        4: variable.parameter.function.latex
        5: punctuation.definition.group.brace.end.latex
      push:
-        - meta_scope: meta.environment.math.block.be.latex
+        - meta_content_scope: meta.environment.math.block.be.latex


For consistency, shall this also be applied to \[\] and  and $$ and $ pairs?
Though, it may break BracketHighlighter or make BracketHighlighter hard to highlight brackets.

I would not apply this to those pairs, because it would break bracket highlighter and I don't see disadvantages for it.
Since it should have the same or a special highlighting and it has only 1-2 chars and is therefore to short to use hotkeys inside. However I agree, that it might look less consistent.
Nonetheless I think this is the best solution to do it like this.

FichteFoll · 2016-07-16T00:20:19Z

I've been using this syntax for a while now and reported everything I noticed so far. This is obviously a great improvement over the current LaTeX syntax but people will need to adapt to changes since things are highlighted differently now (e.g. entity.name.label for \label definitions) but more consistent. When JavaScript was changed they had to as well and that affected a lot more people.

The only remaining thing is inline Python highlighting which is seemingly broken "just for me". Since I did work on the syntax that relates to the resulting highlighting, I should be able to know why it behaves that way, but I don't just from thinking about it and I lack the time to actually investigate into it. I have a couple more changes planned for the Python syntax and will take a look at this again once I find time for that.

So far, this is getting a big 👍 from me. If users spot errors once they start using the changes in their setup, we can always fix those later.

ig0774 · 2016-07-16T14:22:38Z

I agree this is a major improvement over the previous syntax.

One small regression I've noticed is that commands in optional brackets after \cite commands don't get highlighted properly. (The same thing happens with \ref, but I don't think any of the major variants of \ref allow optional arguments anyways).

Not really a big a deal though.

randy3k · 2016-07-17T02:34:13Z

@ig0774 fixed.

r-stein · 2016-07-17T09:18:27Z

It might be worth to discuss to omit the scope punctuation.definition.backslash.latex for each \ in the commands (\command), because ST seems to change the soft wrap behavior.
See also https://forum.sublimetext.com/t/word-wrapping-in-latex-files-st-st2/1403 and SublimeText/LaTeXTools#643

randy3k · 2016-07-17T13:21:52Z

Firstly, just want to clarify, it does not seem that I have the splitting issue.

Secondly, I would rather keep the scope for potential different highlight via color scheme. Some users may be interested in highlighting backslashes with a different color.

ig0774 · 2016-07-17T13:34:18Z

It still occurs for me with the latest version of the syntax:

Frankly, however, I'm indifferent to what is done. For me, syntax highlighting still makes it clear its a command when the wrapping occurs, and I can see some small benefit to being able to highlight backslashes.

randy3k · 2016-07-17T16:02:54Z

I see, I could reproduce it now. My suggestion is to not do soft wrap, do hard wrap instead. Hard wrap also improves the results in reverse synctex search from the pdf.

r-stein · 2016-07-20T17:44:40Z

Small remark: math is currently not highlighted inside \newcommand:

randy3k · 2016-07-20T18:00:23Z

@r-stein it is intended. The content inside the bracket can create all sort of issues.

Consider

\newcommand{\foo}{\begin{equation}}
\newcommand{\bla}{\[}

If we start to match the content, it will be difficult to close the scope, so only commands and constants are highlighted inside the bracket. This is actually the whole reason I started this re-write.

r-stein · 2016-07-20T18:06:55Z

Ah okay I agree.

wbond · 2016-07-22T11:43:50Z

Thank you for all of your work on this @randy3k.

And thank you to everyone who has been reviewing it and giving feedback.

musm · 2016-07-28T04:42:46Z

I tried testing this out. I placed the LaTeX directory obtained from github to %appdata%/Sublime Text 3/Packages

Firing a tex document gives:

Fixes sublimehq#608 The issue was partly fixed by PR sublimehq#370. This commit adds support for highlighting XML/HTML inside \begin{minted}{...} ... \end{minted}.

Fixes #608 The issue was partly fixed by PR #370. This commit adds support for highlighting XML/HTML inside \begin{minted}{...} ... \end{minted}.

Fixes sublimehq#608 The issue was partly fixed by PR sublimehq#370. This commit adds support for highlighting XML/HTML inside \begin{minted}{...} ... \end{minted}.

randy3k force-pushed the latex branch 11 times, most recently from 632c39b to e753c50 Compare May 9, 2016 20:46

randy3k force-pushed the latex branch 2 times, most recently from 8ea5672 to cac8db8 Compare May 10, 2016 16:28

randy3k force-pushed the latex branch 2 times, most recently from 8eddab1 to 4a0c364 Compare May 10, 2016 18:02

randy3k force-pushed the latex branch 3 times, most recently from 0ef2120 to 0b3d250 Compare May 11, 2016 05:20

randy3k reviewed Jul 15, 2016
View reviewed changes

[LaTeX] Adapt syntax text to recent changes

b85b54f

r-stein mentioned this pull request Jul 16, 2016

Support for new LaTeX Syntax LaTeXing/LaTeXing#224

Open

[LaTeX] match cite/ref optional arguments

23f17cb

randy3k force-pushed the latex branch from 53f3ad8 to 23f17cb Compare July 17, 2016 02:35

r-stein mentioned this pull request Jul 18, 2016

Improvement for new LaTeX Syntax jonschlinkert/sublime-monokai-extended#72

Merged

randy3k force-pushed the latex branch from 3cdcfb2 to 23f17cb Compare July 19, 2016 01:18

randy3k mentioned this pull request Jul 19, 2016

constant.language not scoped as function parameter randy3k/R-Box#84

Closed

wbond merged commit 2b4f7e7 into sublimehq:master Jul 22, 2016

wbond mentioned this pull request Jul 22, 2016

[LaTeX] Add match for \path command to make it behave like \url and \href #543

Merged

randy3k mentioned this pull request Sep 3, 2016

[LaTeX] Quotation mark followed by closing angle bracket causes highlighting bug #608

Closed

randy3k deleted the latex branch September 11, 2016 05:56

randy3k mentioned this pull request Sep 27, 2016

[LaTeX] Math environments not highlighted in newcommand scopes #636

Closed

deathaxe mentioned this pull request Aug 24, 2019

[LaTeX] Add html/xml support to embedded code blocks #2067

Merged

wbond pushed a commit that referenced this pull request Oct 18, 2019

[LaTeX] Add html/xml support to embedded code blocks (#2067)

062cc0e

Fixes #608 The issue was partly fixed by PR #370. This commit adds support for highlighting XML/HTML inside \begin{minted}{...} ... \end{minted}.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[LaTeX] rewrite syntaxes #370

[LaTeX] rewrite syntaxes #370

randy3k commented May 9, 2016 •

edited

Loading

wbond commented May 10, 2016

wbond commented May 10, 2016

randy3k commented May 10, 2016

r-stein commented May 10, 2016

randy3k commented May 10, 2016

ig0774 commented May 10, 2016

randy3k commented May 11, 2016

r-stein commented May 11, 2016

FichteFoll commented May 11, 2016 •

edited

Loading

r-stein commented May 11, 2016

randy3k commented May 11, 2016 •

edited

Loading

r-stein commented May 11, 2016

wbond commented Jul 15, 2016

randy3k Jul 15, 2016

r-stein Jul 15, 2016

FichteFoll commented Jul 16, 2016 •

edited

Loading

ig0774 commented Jul 16, 2016

randy3k commented Jul 17, 2016

r-stein commented Jul 17, 2016

randy3k commented Jul 17, 2016

ig0774 commented Jul 17, 2016

randy3k commented Jul 17, 2016

r-stein commented Jul 20, 2016

randy3k commented Jul 20, 2016 •

edited

Loading

r-stein commented Jul 20, 2016

wbond commented Jul 22, 2016

musm commented Jul 28, 2016

[LaTeX] rewrite syntaxes #370

[LaTeX] rewrite syntaxes #370

Conversation

randy3k commented May 9, 2016 • edited Loading

wbond commented May 10, 2016

wbond commented May 10, 2016

randy3k commented May 10, 2016

r-stein commented May 10, 2016

randy3k commented May 10, 2016

ig0774 commented May 10, 2016

randy3k commented May 11, 2016

r-stein commented May 11, 2016

FichteFoll commented May 11, 2016 • edited Loading

r-stein commented May 11, 2016

randy3k commented May 11, 2016 • edited Loading

r-stein commented May 11, 2016

wbond commented Jul 15, 2016

randy3k Jul 15, 2016

Choose a reason for hiding this comment

r-stein Jul 15, 2016

Choose a reason for hiding this comment

FichteFoll commented Jul 16, 2016 • edited Loading

ig0774 commented Jul 16, 2016

randy3k commented Jul 17, 2016

r-stein commented Jul 17, 2016

randy3k commented Jul 17, 2016

ig0774 commented Jul 17, 2016

randy3k commented Jul 17, 2016

r-stein commented Jul 20, 2016

randy3k commented Jul 20, 2016 • edited Loading

r-stein commented Jul 20, 2016

wbond commented Jul 22, 2016

musm commented Jul 28, 2016

randy3k commented May 9, 2016 •

edited

Loading

FichteFoll commented May 11, 2016 •

edited

Loading

randy3k commented May 11, 2016 •

edited

Loading

FichteFoll commented Jul 16, 2016 •

edited

Loading

randy3k commented Jul 20, 2016 •

edited

Loading