README.md

Thu, 13 May 2021 09:47:46 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Thu, 13 May 2021 09:47:46 -0500
changeset 27
f34b09beada4
parent 24
7c7d9c0a314d
permissions
-rw-r--r--

Support \missingfigure

0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
1 # latex-syntax
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
2
4
acf39baa1c7d More README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
3 This package provides rich LaTeX _syntax highlighting_ for VSCode. It provides
acf39baa1c7d More README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
4 _only_ syntax highlighting: no annoying snippets etc. that only serve to mess
acf39baa1c7d More README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
5 up your work. It is recommended to be combined with [texlab][]. The latter
7
fedc1fbea767 typofixes
Tuomo Valkonen <tuomov@iki.fi>
parents: 6
diff changeset
6 provides language intelligence/auto-completion and a build system interface.
4
acf39baa1c7d More README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
7 The present package complements texlab with richer syntax highlighting. The
acf39baa1c7d More README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
8 grammar is derived from LaTeX-Workshop, but has improvements including
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
9
27
f34b09beada4 Support \missingfigure
Tuomo Valkonen <tuomov@iki.fi>
parents: 24
diff changeset
10 a) Highlighting for the `todonotes` package: `\todo` and `\missingfigure` as well as custom-defined
5
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
11 `\XYtodo` for author initials `X` and `Y`.
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
12
24
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
13 b) Likewise (custom-defined) `\reply` and `\XYreply` macros are highlighted to
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
14 allow discussion of document review.
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
15
24
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
16 c) Footnote highlighting (`\footnote`, `\footnotemark`, and `\footnotetext`).
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
17
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
18 d) Highlighting of `comment` environments as comment blocks.
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
19
5
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
20 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
21 see below.
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
22
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
23 ### Regarding `todonotes` and `footnote` support
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
24
11
3633d38b64bd Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents: 9
diff changeset
25 Unfortunately, VSCode does not appear to let extensions contribute token colours
24
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
26 for syntax highlighting. Therefore, to enable syntax highlighting for `\todo`, `\reply`, and
11
3633d38b64bd Explain that extensions cannot seem to be able to contribute token colours.
Tuomo Valkonen <tuomov@iki.fi>
parents: 9
diff changeset
27 `\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
28 `settings.json` (Cmd+Shift+P, “Open Settings (JSON)”):
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
29
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
30 ```json
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
31 "editor.tokenColorCustomizations": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
32 "textMateRules": [
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
33 {
20
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
34 "scope": [
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
35 "entity.name.todo.latex",
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
36 "support.function.todo.latex",
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
37 "entity.name.footnote.latex",
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
38 "support.function.footnote.latex"
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
39 ],
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
40 "settings": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
41 "foreground": "#d17000",
20
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
42 "fontStyle": "italic"
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
43 }
24
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
44 },
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
45 {
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
46 "scope": [
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
47 "entity.name.todo.reply.latex",
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
48 "support.function.todo.reply.latex",
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
49 ],
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
50 "settings": {
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
51 "foreground": "#d17000",
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
52 "fontStyle": "italic bold"
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
53 }
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
54 }
20
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
55 ]
2f22cc1afaad More compact example colour definition
Tuomo Valkonen <tuomov@iki.fi>
parents: 15
diff changeset
56 }
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
57 ```
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
58
5
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
59 Initial-prefixed `\XYtodo` custom todonotes commands are also supported.
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
60 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
61 the above colour customisations and in your LaTeX source define
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
62 ```tex
7
fedc1fbea767 typofixes
Tuomo Valkonen <tuomov@iki.fi>
parents: 6
diff changeset
63 \newcommand{\lstodo}[2][]{\todo[color=DarkRed!40,#1]{#2}}
5
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
64 ```
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
65 (The colour setting here only affects LaTeX output, not VSCode.)
993903fd4434 Support initial-prefixed \XYtodo.
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
66
24
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
67 To define `\reply` for discussion inside todonotes, a simple one is
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
68 ```tex
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
69 \newcommand{\reply}[1]{\textbf{#1}}
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
70 ```
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
71
7c7d9c0a314d Support custom-defined `\reply` and `\XYreply` for discussion within todonotes.
Tuomo Valkonen <tuomov@iki.fi>
parents: 20
diff changeset
72
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
73 [texlab]: https://marketplace.visualstudio.com/items?itemName=efoerster.texlab

mercurial