Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Development scripts
We describe the purpose of the scripts found in directory `dev/`.
## ctanpkglist.py
It fetches the latest list of packages and classes along with their descriptions from CTAN at https://ctan.org/pkg and save the result as a json file. For every package
### Classes
The list of classes is computed from the local LaTeX installation by looking for `.cls` files in `ls-R`. The description associated to each class is retrieved from CTAN.
### Packages
Getting a proper list of packages is tricky as the package names (as listed by CTAN) do not always match the base names of the `.sty` files to be loaded by `\usepackage`. This is handled in the following way
- We use the local `ls-R` file to
- List all the `.sty` files provided by the local LaTeX installation.
- For every directory in `texmf`, list the `.sty` files it contains. The last component of a directory name inside `texmf` is typically the package name as defined by CTAN, hence the name to pass to `\usepackage` is the base name of one of the `.sty` files inside it.
- For every package `pkg` listed by CTAN
- If `pkg.sty` exists on the local installation, store `pkg` for package intellisense.
- If not, search if a directory `pkg/` exists and look up a file whose lowercase name matches `pkg`. If it is found, then save it for package intellisense.
As some packages cannot be properly detected using the above mechanism, we maintain a list of extra packages to be added to the list in [extra-packagenames.json](extra-packagenames.json). These packages are automatically added at the end of the [`ctanpkglist.py`](dev/ctanpkglist.py) script.
## unimathsymbols.py
It parses uni-math symbols from http://milde.users.sourceforge.net/LUCR/Math/data/unimathsymbols.txt and save the result as a json file. The result is used to generate command intellisense.
## pkgcommand.py
This script generates intellisense data from [https://github.com/LaTeXing/LaTeX-cwl/](https://github.com/LaTeXing/LaTeX-cwl/). For every package or class, two files are generated:
- a `_cmd.json` file containing the data for the commands defined in the `.cwl` file. Entry example
```json
"acro{}{}": {
"command": "acro{acronym}{full name}",
"package": "acronym",
"snippet": "acro{${1:acronym}}{${2:full name}}"
}
```
- a `_env.json` file containing the data for the environments defined in the `.cwl` file.
```json
"aligned": {
"name": "aligned",
"detail": "aligned",
"snippet": "",
"package": "amsmath"
}
```
If the environment takes extra arguments, they are listed in the `snippet` field
```json
"aligned []": {
"name": "aligned",
"detail": "aligned[alignment]",
"snippet": "[${1:alignment}]",
"package": "amsmath"
}
"alignat* []{}": {
"name": "alignat*",
"detail": "alignat*[alignment]{n}",
"snippet": "[${2:alignment}]{${1:n}}",
"package": "amsmath"
}
```
Completion files for classes are all prefixed by `class-`.
## func3.py
This script generates intellisense data for LaTeX stored in [`../data/expl3_cmd.json`](../data/expl3_cmd.json).