Thu, 14 May 2020 17:45:50 -0500
More compact example colour definition
0 | 1 | # latex-syntax |
2 | ||
4 | 3 | This package provides rich LaTeX _syntax highlighting_ for VSCode. It provides |
4 | _only_ syntax highlighting: no annoying snippets etc. that only serve to mess | |
5 | up your work. It is recommended to be combined with [texlab][]. The latter | |
7 | 6 | provides language intelligence/auto-completion and a build system interface. |
4 | 7 | The present package complements texlab with richer syntax highlighting. The |
8 | grammar is derived from LaTeX-Workshop, but has improvements including | |
0 | 9 | |
5
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
10 | a) Highlighting for the `todonotes` package: `\todo` as well as custom-defined |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
11 | `\XYtodo` for author initials `X` and `Y`. |
0 | 12 | |
9 | 13 | b) Footnote highlighting (`\footnote`, `\footnotemark`, and `\footnotetext`). |
0 | 14 | |
15 | c) Highlighting of `comment` environments as comment blocks. | |
16 | ||
5
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
17 | The highlighting of todo-notes and footnotes has to be specifically configured: |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
18 | see below. |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
19 | |
0 | 20 | ### Regarding `todonotes` and `footnote` support |
21 | ||
11
3633d38b64bd
Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents:
9
diff
changeset
|
22 | Unfortunately, VSCode does not appear to let extensions contribute token colours |
3633d38b64bd
Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents:
9
diff
changeset
|
23 | for syntax highlighting. Therefore, to enable syntax highlighting for `\todo` and |
3633d38b64bd
Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents:
9
diff
changeset
|
24 | `\footnote`, add the following (with possibly customised colours) to your user |
3633d38b64bd
Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents:
9
diff
changeset
|
25 | `settings.json` (Cmd+Shift+P, “Open Settings (JSON)”): |
0 | 26 | |
27 | ```json | |
1 | 28 | "editor.tokenColorCustomizations": { |
29 | "textMateRules": [ | |
30 | { | |
20
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
31 | "scope": [ |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
32 | "entity.name.todo.latex", |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
33 | "support.function.todo.latex", |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
34 | "entity.name.footnote.latex", |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
35 | "support.function.footnote.latex" |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
36 | ], |
1 | 37 | "settings": { |
38 | "foreground": "#d17000", | |
20
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
39 | "fontStyle": "italic" |
1 | 40 | } |
41 | } | |
20
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
42 | ] |
2f22cc1afaad
More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents:
15
diff
changeset
|
43 | } |
0 | 44 | ``` |
45 | ||
5
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
46 | Initial-prefixed `\XYtodo` custom todonotes commands are also supported. |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
47 | For example, `\lstodo{a latex-syntax todo}` will be highlighted if you do |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
48 | the above colour customisations and in your LaTeX source define |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
49 | ```tex |
7 | 50 | \newcommand{\lstodo}[2][]{\todo[color=DarkRed!40,#1]{#2}} |
5
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
51 | ``` |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
52 | (The colour setting here only affects LaTeX output, not VSCode.) |
993903fd4434
Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents:
4
diff
changeset
|
53 | |
0 | 54 | [texlab]: https://marketplace.visualstudio.com/items?itemName=efoerster.texlab |