annotate README.md @ 3:99e8f2f1a24b

add README
author matac42 <matac@cr.ie.u-ryukyu.ac.jp>
date Wed, 15 Nov 2023 10:06:46 +0900
parents
children 18eff4ddae61
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 ## How to build tex
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 1. Create an environment in which `ptex2pdf` and `pbibtex` can run.
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
4 2. Add the following to the VSCode configuration JSON.
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
5
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
6 ```
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
8 "[tex]": {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 "editor.suggest.snippetsPreventQuickSuggestions": false,
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
10 "editor.tabSize": 2
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 "[latex]": {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
13 "editor.suggest.snippetsPreventQuickSuggestions": false,
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 "editor.tabSize": 2,
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
15 "editor.formatOnSave": false
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
16 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
17 "[bibtex]": {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 "editor.tabSize": 2
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
19 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
20 "latex-workshop.intellisense.package.enabled": true,
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
21 "latex-workshop.latex.autoBuild.cleanAndRetry.enabled": true,
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
22 "latex-workshop.latex.clean.fileTypes": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
23 "*.aux",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
24 "*.bbl",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
25 "*.blg",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
26 "*.idx",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 "*.ind",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
28 "*.lof",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 "*.lot",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
30 "*.out",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
31 "*.toc",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
32 "*.acn",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
33 "*.acr",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
34 "*.alg",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
35 "*.glg",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
36 "*.glo",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
37 "*.gls",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
38 "*.ist",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
39 "*.fls",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
40 "*.log",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
41 "*.fdb_latexmk",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
42 "*.snm",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
43 "*.nav",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
44 "*.dvi",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
45 "*.synctex.gz"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
46 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
47 "latex-workshop.latex.outDir": ".",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
48 "latex-workshop.latex.tools": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
49 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
50 "command": "ptex2pdf",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 "args": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
52 "-l",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
53 "-ot",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
54 "-kanji=utf8 -synctex=1",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
55 "%DOC%"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
56 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
57 "name": "Step 1: ptex2pdf"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
58 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
59 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
60 "command": "pbibtex",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
61 "args": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
62 "%DOCFILE%",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
63 "-kanji=utf8"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
64 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
65 "name": "Step 2: pbibtex"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
66 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
67 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
68 "command": "ptex2pdf",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
69 "args": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
70 "-l",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
71 "-ot",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
72 "-kanji=utf8 -synctex=1",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
73 "%DOC%"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
74 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
75 "name": "Step 3: ptex2pdf"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
76 },
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
77 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
78 "command": "ptex2pdf",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
79 "args": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
80 "-l",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
81 "-ot",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
82 "-kanji=utf8 -synctex=1",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
83 "%DOC%"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
84 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
85 "name": "Step 4: ptex2pdf"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
86 }
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
87 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
88 "latex-workshop.latex.recipes": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
89 {
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
90 "name": "toolchain",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
91 "tools": [
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
92 "Step 1: ptex2pdf",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
93 "Step 2: pbibtex",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
94 "Step 3: ptex2pdf",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
95 "Step 4: ptex2pdf"
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
96 ]
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
97 }
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
98 ],
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
99 "latex-workshop.view.pdf.viewer": "tab",
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
100 }
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
101 ```
99e8f2f1a24b add README
matac42 <matac@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
102