├── The testfile for vscode.pdf ├── LaTeX testfile for vscode ├── Figures │ └── Ali.jpg ├── books.bib └── The testfile for vscode.tex ├── External ├── Linux-settings.json ├── Windows-vscode-settings.json └── macOS-vscode-settings.json ├── Linux └── vscode-settings.json ├── README.md ├── Windows └── vscode-settings.json └── MacOS └── vscode-settings.json /The testfile for vscode.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Hydraallen/Latex-vscode/HEAD/The testfile for vscode.pdf -------------------------------------------------------------------------------- /LaTeX testfile for vscode/Figures/Ali.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Hydraallen/Latex-vscode/HEAD/LaTeX testfile for vscode/Figures/Ali.jpg -------------------------------------------------------------------------------- /LaTeX testfile for vscode/books.bib: -------------------------------------------------------------------------------- 1 | @article{1, 2 | title={Embedding the Internet: Wireless integrated network sensors}, 3 | author={Pottie, G. J. and Kaiser, W. J.}, 4 | journal={Communications of the Acm}, 5 | volume={43}, 6 | year={2000}, 7 | } -------------------------------------------------------------------------------- /LaTeX testfile for vscode/The testfile for vscode.tex: -------------------------------------------------------------------------------- 1 | %使用XeLaTex编译或BibTex编译！ 2 | \documentclass[fontset=windows]{article} 3 | \usepackage[margin=1in]{geometry}%设置边距，符合Word设定 4 | \usepackage{ctex} 5 | \usepackage{setspace} 6 | \usepackage{lipsum} 7 | \usepackage{graphicx}%插入图片 8 | \graphicspath{{Figures/}}%文章所用图片在当前目录下的 Figures目录 9 | 10 | \usepackage{hyperref} % 对目录生成链接，注：该宏包可能与其他宏包冲突，故放在所有引用的宏包之后 11 | \hypersetup{colorlinks = true, % 将链接文字带颜色 12 | bookmarksopen = true, % 展开书签 13 | bookmarksnumbered = true, % 书签带章节编号 14 | pdftitle = This is a testfile for vscode, % 标题 15 | pdfauthor =Ali-loner} % 作者 16 | \bibliographystyle{plain}% 参考文献引用格式 17 | \newcommand{\upcite}[1]{\textsuperscript{\cite{#1}}} 18 | 19 | \renewcommand{\contentsname}{\centerline{Contents}} %经过设置word格式后，将目录标题居中 20 | 21 | 22 | \title{\heiti\zihao{2} This is a testfile for vscode} 23 | \author{\songti Ali-loner} 24 | \date{2023.03.05} 25 | 26 | 27 | \begin{document} 28 | \maketitle 29 | \thispagestyle{empty} 30 | 31 | \begin{abstract} 32 | \lipsum[2] 33 | \end{abstract} 34 | 35 | \tableofcontents 36 | 37 | \section{This is a section} 38 | Hello world! Hello Ali! As shown in figure \ref{1} 39 | \begin{figure}[htbp] 40 | \centering 41 | \includegraphics[scale=0.2]{Ali.jpg} 42 | \caption{this is Ali} 43 | \label{1} 44 | \end{figure} 45 | 46 | 这句话是测试能否进行引用及支持中文\upcite{1}。 47 | \bibliography{books} 48 | \end{document} -------------------------------------------------------------------------------- /External/Linux-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "workbench.colorTheme": "One Dark Pro", 3 | //------------------------------LaTeX 配置---------------------------------- 4 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 5 | "latex-workshop.latex.autoBuild.run": "onSave", 6 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 7 | "latex-workshop.showContextMenu": true, //false 8 | //从使用的包中自动补全命令和环境 9 | "latex-workshop.intellisense.package.enabled": true, 10 | //编译出错时设置是否弹出气泡设置 11 | "latex-workshop.message.error.show": false, 12 | "latex-workshop.message.warning.show": false, 13 | // 编译工具和命令 14 | "latex-workshop.latex.tools": [ 15 | { 16 | "name": "xelatex", 17 | "command": "/usr/bin/xelatex", //通过终端获取完整路径 18 | "args": [ 19 | "-synctex=1", 20 | "-interaction=nonstopmode", 21 | "-file-line-error", 22 | "%DOCFILE%" 23 | ] 24 | }, 25 | { 26 | "name": "pdflatex", 27 | "command": "/usr/bin/pdflatex", 28 | "args": [ 29 | "-synctex=1", 30 | "-interaction=nonstopmode", 31 | "-file-line-error", 32 | "%DOCFILE%" 33 | ] 34 | }, 35 | { 36 | "name": "latexmk", 37 | "command": "/usr/bin/latexmk", 38 | "args": [ 39 | "-synctex=1", 40 | "-interaction=nonstopmode", 41 | "-file-line-error", 42 | "-pdf", 43 | "-outdir=%OUTDIR%", 44 | "%DOCFILE%" 45 | ] 46 | }, 47 | { 48 | "name": "bibtex", 49 | "command": "/usr/bin/bibtex", 50 | "args": [ 51 | "%DOCFILE%" 52 | ] 53 | } 54 | ], 55 | // 用于配置编译链 56 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 57 | "latex-workshop.latex.recipes": [ 58 | { 59 | "name": "PDFLaTeX", 60 | "tools": [ 61 | "pdflatex" 62 | ] 63 | }, 64 | { 65 | "name": "XeLaTeX", 66 | "tools": [ 67 | "xelatex" 68 | ] 69 | }, 70 | { 71 | "name": "BibTeX", 72 | "tools": [ 73 | "bibtex" 74 | ] 75 | }, 76 | { 77 | "name": "LaTeXmk", 78 | "tools": [ 79 | "latexmk" 80 | ] 81 | }, 82 | { 83 | "name": "xelatex -> bibtex -> xelatex*2", 84 | "tools": [ 85 | "xelatex", 86 | "bibtex", 87 | "xelatex", 88 | "xelatex" 89 | ] 90 | }, 91 | { 92 | "name": "pdflatex -> bibtex -> pdflatex*2", 93 | "tools": [ 94 | "pdflatex", 95 | "bibtex", 96 | "pdflatex", 97 | "pdflatex" 98 | ] 99 | } 100 | ], 101 | //文件清理。此属性必须是字符串数组 102 | "latex-workshop.latex.clean.fileTypes": [ 103 | "*.aux", 104 | "*.bbl", 105 | "*.blg", 106 | "*.idx", 107 | "*.ind", 108 | "*.lof", 109 | "*.lot", 110 | "*.out", 111 | "*.toc", 112 | "*.acn", 113 | "*.acr", 114 | "*.alg", 115 | "*.glg", 116 | "*.glo", 117 | "*.gls", 118 | "*.ist", 119 | "*.fls", 120 | "*.log", 121 | "*.fdb_latexmk" 122 | ], 123 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 124 | "latex-workshop.latex.autoClean.run": "onFailed", 125 | // 使用上次的recipe编译组合 126 | "latex-workshop.latex.recipe.default": "lastUsed", 127 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 128 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 129 | //Windows使用 SumatraPDF 预览编译好的PDF文件 130 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 131 | "latex-workshop.view.pdf.viewer": "external", 132 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 133 | "latex-workshop.view.pdf.ref.viewer": "auto", 134 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 135 | //"latex-workshop.view.pdf.external.viewer.command": "/Applications/PDF Expert.app", // 注意修改路径 136 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 137 | "latex-workshop.view.pdf.external.viewer.args": [ 138 | "%PDF%" 139 | ], 140 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 141 | //"latex-workshop.view.pdf.external.synctex.command": "/Applications/PDF Expert.app", // 注意修改路径 142 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 143 | } -------------------------------------------------------------------------------- /Linux/vscode-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | //------------------------------LaTeX 配置---------------------------------- 3 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 4 | "latex-workshop.latex.autoBuild.run": "onSave", 5 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 6 | "latex-workshop.showContextMenu": true, //false 7 | //从使用的包中自动补全命令和环境 8 | "latex-workshop.intellisense.package.enabled": true, 9 | //编译出错时设置是否弹出气泡设置 10 | "latex-workshop.message.error.show": false, 11 | "latex-workshop.message.warning.show": false, 12 | // 编译工具和命令 13 | "latex-workshop.latex.tools": [ 14 | { 15 | "name": "xelatex", 16 | "command": "/usr/bin/xelatex", //通过终端获取完整路径 17 | "args": [ 18 | "-synctex=1", 19 | "-interaction=nonstopmode", 20 | "-file-line-error", 21 | "%DOCFILE%" 22 | ] 23 | }, 24 | { 25 | "name": "pdflatex", 26 | "command": "/usr/bin/pdflatex", 27 | "args": [ 28 | "-synctex=1", 29 | "-interaction=nonstopmode", 30 | "-file-line-error", 31 | "%DOCFILE%" 32 | ] 33 | }, 34 | { 35 | "name": "latexmk", 36 | "command": "/usr/bin/latexmk", 37 | "args": [ 38 | "-synctex=1", 39 | "-interaction=nonstopmode", 40 | "-file-line-error", 41 | "-pdf", 42 | "-outdir=%OUTDIR%", 43 | "%DOCFILE%" 44 | ] 45 | }, 46 | { 47 | "name": "bibtex", 48 | "command": "/usr/bin/bibtex", 49 | "args": [ 50 | "%DOCFILE%" 51 | ] 52 | } 53 | ], 54 | // 用于配置编译链 55 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 56 | "latex-workshop.latex.recipes": [ 57 | { 58 | "name": "PDFLaTeX", 59 | "tools": [ 60 | "pdflatex" 61 | ] 62 | }, 63 | { 64 | "name": "PDFLaTeX*2", 65 | "tools": [ 66 | "pdflatex", 67 | "pdflatex" 68 | ] 69 | }, 70 | { 71 | "name": "XeLaTeX", 72 | "tools": [ 73 | "xelatex" 74 | ] 75 | }, 76 | { 77 | "name": "BibTeX", 78 | "tools": [ 79 | "bibtex" 80 | ] 81 | }, 82 | { 83 | "name": "LaTeXmk", 84 | "tools": [ 85 | "latexmk" 86 | ] 87 | }, 88 | { 89 | "name": "xelatex -> bibtex -> xelatex*2", 90 | "tools": [ 91 | "xelatex", 92 | "bibtex", 93 | "xelatex", 94 | "xelatex" 95 | ] 96 | }, 97 | { 98 | "name": "pdflatex -> bibtex -> pdflatex*2", 99 | "tools": [ 100 | "pdflatex", 101 | "bibtex", 102 | "pdflatex", 103 | "pdflatex" 104 | ] 105 | } 106 | ], 107 | //文件清理。此属性必须是字符串数组 108 | "latex-workshop.latex.clean.fileTypes": [ 109 | "*.aux", 110 | "*.bbl", 111 | "*.blg", 112 | "*.idx", 113 | "*.ind", 114 | "*.lof", 115 | "*.lot", 116 | "*.out", 117 | "*.toc", 118 | "*.acn", 119 | "*.acr", 120 | "*.alg", 121 | "*.glg", 122 | "*.glo", 123 | "*.gls", 124 | "*.ist", 125 | "*.fls", 126 | "*.log", 127 | "*.fdb_latexmk" 128 | ], 129 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 130 | "latex-workshop.latex.autoClean.run": "onFailed", 131 | // 使用上次的recipe编译组合 132 | "latex-workshop.latex.recipe.default": "lastUsed", 133 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 134 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 135 | //Windows使用 SumatraPDF 预览编译好的PDF文件 136 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 137 | "latex-workshop.view.pdf.viewer": "external", 138 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 139 | "latex-workshop.view.pdf.ref.viewer": "auto", 140 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 141 | //"latex-workshop.view.pdf.external.viewer.command": "/Applications/PDF Expert.app", // 注意修改路径 142 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 143 | "latex-workshop.view.pdf.external.viewer.args": [ 144 | "%PDF%" 145 | ], 146 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 147 | //"latex-workshop.view.pdf.external.synctex.command": "/Applications/PDF Expert.app", // 注意修改路径 148 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 149 | } 150 | -------------------------------------------------------------------------------- /External/Windows-vscode-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.autoSave": "afterDelay", 3 | //------------------------------LaTeX 配置---------------------------------- 4 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 5 | "latex-workshop.latex.autoBuild.run": "onSave", 6 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 7 | "latex-workshop.showContextMenu": true, //false 8 | //从使用的包中自动补全命令和环境 9 | "latex-workshop.intellisense.package.enabled": true, 10 | //编译出错时设置是否弹出气泡设置 11 | "latex-workshop.message.error.show": false, 12 | "latex-workshop.message.warning.show": false, 13 | // 编译工具和命令 14 | "latex-workshop.latex.tools": [ 15 | { 16 | "name": "xelatex", 17 | "command": "xelatex", 18 | "args": [ 19 | "-synctex=1", 20 | "-interaction=nonstopmode", 21 | "-file-line-error", 22 | "%DOCFILE%" 23 | ] 24 | }, 25 | { 26 | "name": "pdflatex", 27 | "command": "pdflatex", 28 | "args": [ 29 | "-synctex=1", 30 | "-interaction=nonstopmode", 31 | "-file-line-error", 32 | "%DOCFILE%" 33 | ] 34 | }, 35 | { 36 | "name": "latexmk", 37 | "command": "latexmk", 38 | "args": [ 39 | "-synctex=1", 40 | "-interaction=nonstopmode", 41 | "-file-line-error", 42 | "-pdf", 43 | "-outdir=%OUTDIR%", 44 | "%DOCFILE%" 45 | ] 46 | }, 47 | { 48 | "name": "bibtex", 49 | "command": "bibtex", 50 | "args": [ 51 | "%DOCFILE%" 52 | ] 53 | } 54 | ], 55 | // 用于配置编译链 56 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 57 | "latex-workshop.latex.recipes": [ 58 | { 59 | "name": "XeLaTeX", 60 | "tools": [ 61 | "xelatex" 62 | ] 63 | }, 64 | { 65 | "name": "PDFLaTeX", 66 | "tools": [ 67 | "pdflatex" 68 | ] 69 | }, 70 | { 71 | "name": "BibTeX", 72 | "tools": [ 73 | "bibtex" 74 | ] 75 | }, 76 | { 77 | "name": "LaTeXmk", 78 | "tools": [ 79 | "latexmk" 80 | ] 81 | }, 82 | { 83 | "name": "xelatex -> bibtex -> xelatex*2", 84 | "tools": [ 85 | "xelatex", 86 | "bibtex", 87 | "xelatex", 88 | "xelatex" 89 | ] 90 | }, 91 | { 92 | "name": "pdflatex -> bibtex -> pdflatex*2", 93 | "tools": [ 94 | "pdflatex", 95 | "bibtex", 96 | "pdflatex", 97 | "pdflatex" 98 | ] 99 | } 100 | ], 101 | //文件清理。此属性必须是字符串数组 102 | "latex-workshop.latex.clean.fileTypes": [ 103 | "*.aux", 104 | "*.bbl", 105 | "*.blg", 106 | "*.idx", 107 | "*.ind", 108 | "*.lof", 109 | "*.lot", 110 | "*.out", 111 | "*.toc", 112 | "*.acn", 113 | "*.acr", 114 | "*.alg", 115 | "*.glg", 116 | "*.glo", 117 | "*.gls", 118 | "*.ist", 119 | "*.fls", 120 | "*.log", 121 | "*.fdb_latexmk" 122 | ], 123 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 124 | "latex-workshop.latex.autoClean.run": "onFailed", 125 | // 使用上次的recipe编译组合 126 | "latex-workshop.latex.recipe.default": "lastUsed", 127 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 128 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 129 | //Windows使用 SumatraPDF 预览编译好的PDF文件 130 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 131 | "latex-workshop.view.pdf.viewer": "external", 132 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 133 | "latex-workshop.view.pdf.ref.viewer": "auto", 134 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 135 | "latex-workshop.view.pdf.external.viewer.command": "D:/AppInstall/SumatraPDF/SumatraPDF.exe", // 注意修改路径 136 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 137 | "latex-workshop.view.pdf.external.viewer.args": [ 138 | "%PDF%" 139 | ], 140 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 141 | "latex-workshop.view.pdf.external.synctex.command": "D:/AppInstall/SumatraPDF/SumatraPDF.exe", // 注意修改路径 142 | // latex-workshop.view.pdf.external.synctex的参数。当同步到外部查看器时。%LINE%是行号，%PDF%是生成PDF文件的绝对路径的占位符，%TEX%是触发syncTeX的扩展名为.tex的LaTeX文件路径。 143 | "latex-workshop.view.pdf.external.synctex.args": [ 144 | "-forward-search", 145 | "%TEX%", 146 | "%LINE%", 147 | "-reuse-instance", 148 | "-inverse-search", 149 | "\"D:/AppInstall/VScode/Microsoft VS Code/Code.exe\" \"D:/AppInstall/VScode/Microsoft VS Code/resources/app/out/cli.js\" -r -g \"%f:%l\"", // 注意修改路径 150 | "%PDF%" 151 | ], 152 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 153 | } -------------------------------------------------------------------------------- /External/macOS-vscode-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.autoSave": "afterDelay", 3 | //------------------------------LaTeX 配置---------------------------------- 4 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 5 | "latex-workshop.latex.autoBuild.run": "onSave", 6 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 7 | "latex-workshop.showContextMenu": true,//false 8 | //从使用的包中自动补全命令和环境 9 | "latex-workshop.intellisense.package.enabled": true, 10 | //编译出错时设置是否弹出气泡设置 11 | "latex-workshop.message.error.show": false, 12 | "latex-workshop.message.warning.show": false, 13 | // 编译工具和命令 14 | "latex-workshop.latex.tools": [ 15 | { 16 | "name": "xelatex", 17 | "command": "/Library/TeX/texbin/xelatex",//通过终端获取完整路径 18 | "args": [ 19 | "-synctex=1", 20 | "-interaction=nonstopmode", 21 | "-file-line-error", 22 | "%DOCFILE%" 23 | ] 24 | }, 25 | { 26 | "name": "pdflatex", 27 | "command": "/Library/TeX/texbin/pdflatex", 28 | "args": [ 29 | "-synctex=1", 30 | "-interaction=nonstopmode", 31 | "-file-line-error", 32 | "%DOCFILE%" 33 | ] 34 | }, 35 | { 36 | "name": "latexmk", 37 | "command": "/Library/TeX/texbin/latexmk", 38 | "args": [ 39 | "-synctex=1", 40 | "-interaction=nonstopmode", 41 | "-file-line-error", 42 | "-pdf", 43 | "-outdir=%OUTDIR%", 44 | "%DOCFILE%" 45 | ] 46 | }, 47 | { 48 | "name": "bibtex", 49 | "command": "/Library/TeX/texbin/bibtex", 50 | "args": [ 51 | "%DOCFILE%" 52 | ] 53 | } 54 | ], 55 | // 用于配置编译链 56 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 57 | "latex-workshop.latex.recipes": [ 58 | { 59 | "name": "PDFLaTeX", 60 | "tools": [ 61 | "pdflatex" 62 | ] 63 | }, 64 | { 65 | "name": "XeLaTeX", 66 | "tools": [ 67 | "xelatex" 68 | ] 69 | }, 70 | { 71 | "name": "BibTeX", 72 | "tools": [ 73 | "bibtex" 74 | ] 75 | }, 76 | { 77 | "name": "LaTeXmk", 78 | "tools": [ 79 | "latexmk" 80 | ] 81 | }, 82 | { 83 | "name": "xelatex -> bibtex -> xelatex*2", 84 | "tools": [ 85 | "xelatex", 86 | "bibtex", 87 | "xelatex", 88 | "xelatex" 89 | ] 90 | }, 91 | { 92 | "name": "pdflatex -> bibtex -> pdflatex*2", 93 | "tools": [ 94 | "pdflatex", 95 | "bibtex", 96 | "pdflatex", 97 | "pdflatex" 98 | ] 99 | } 100 | ], 101 | //文件清理。此属性必须是字符串数组 102 | "latex-workshop.latex.clean.fileTypes": [ 103 | "*.aux", 104 | "*.bbl", 105 | "*.blg", 106 | "*.idx", 107 | "*.ind", 108 | "*.lof", 109 | "*.lot", 110 | "*.out", 111 | "*.toc", 112 | "*.acn", 113 | "*.acr", 114 | "*.alg", 115 | "*.glg", 116 | "*.glo", 117 | "*.gls", 118 | "*.ist", 119 | "*.fls", 120 | "*.log", 121 | "*.fdb_latexmk" 122 | ], 123 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 124 | "latex-workshop.latex.autoClean.run": "onFailed", 125 | // 使用上次的recipe编译组合 126 | "latex-workshop.latex.recipe.default": "lastUsed", 127 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 128 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 129 | //Windows使用 SumatraPDF 预览编译好的PDF文件 130 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 131 | "latex-workshop.view.pdf.viewer": "external", 132 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 133 | "latex-workshop.view.pdf.ref.viewer": "auto", 134 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 135 | "latex-workshop.view.pdf.external.viewer.command": "/Applications/PDF Expert.app", // 注意修改路径 136 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 137 | "latex-workshop.view.pdf.external.viewer.args": [ 138 | "%PDF%" 139 | ], 140 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 141 | "latex-workshop.view.pdf.external.synctex.command": "/Applications/PDF Expert.app", // 注意修改路径 142 | // latex-workshop.view.pdf.external.synctex的参数。当同步到外部查看器时。%LINE%是行号，%PDF%是生成PDF文件的绝对路径的占位符，%TEX%是触发syncTeX的扩展名为.tex的LaTeX文件路径。 143 | "latex-workshop.view.pdf.external.synctex.args": [ 144 | "-forward-search", 145 | "%TEX%", 146 | "%LINE%", 147 | "-reuse-instance", 148 | "-inverse-search", 149 | "\"F:/Microsoft VS Code/Code.exe\" \"F:/Microsoft VS Code/resources/app/out/cli.js\" -r -g \"%f:%l\"", // 注意修改路径 150 | "%PDF%" 151 | ], 152 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 153 | 154 | } 155 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Latex-vscode 2 | This is a repository for latex settings in vscode 3 | 4 | # Repository 5 | 6 | Github: https://github.com/Hydraallen/Latex-vscode 7 | 8 | # Downloads 9 | + vscode: https://code.visualstudio.com/ 10 | + Texlive: (choose one) 11 | + https://tug.org/texlive/acquire-iso.html 12 | + https://mirrors.cloud.tencent.com/CTAN/systems/texlive/Images/ 13 | + https://mirrors.tuna.tsinghua.edu.cn/CTAN/systems/mac/mactex/ 14 | + SumatraPDF: https://www.sumatrapdfreader.org/free-pdf-reader 15 | 16 | 17 | 18 | # Installation 19 | 20 | ## Windows 21 | 22 | Video for Reference->https://www.bilibili.com/video/BV1wP411f7gG/ 23 | 24 | 1. Install Texlive （about 4G） 25 | 26 | Download -> https://mirrors.tuna.tsinghua.edu.cn/CTAN/systems/texlive/Images/texlive.iso 27 | 28 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_01-10-17.png) 29 | 30 | Run as asministrator 31 | 32 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_01-33-41.png) 33 | 34 | Wait for finish 35 | 36 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_01-38-01.png) 37 | 38 | Test installation 39 | 40 | Open cmd or Powershell and type in `tex -v`, if shows information like picture below then it means texlive has been installed. 41 | 42 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG359.png) 43 | 44 | 2. Install VScode and Latex Workshop 45 | 46 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/latex-windows-%E5%AE%8C%E6%95%B4%E6%97%A0%E5%AD%97%E5%B9%95-0002.png) 47 | 48 | edit `settings.json` (You may refer to `vscode-settings.json` in repository`Latex-vscode/Windows` and refer to the video) 49 | 50 | 3. Install SumatraPDF (optional) 51 | 52 | ## macOS 53 | 54 | （It applies to both Intel and Apple Silicon） 55 | 56 | Video for Reference->https://www.bilibili.com/video/BV1DM4y1z71m 57 | 58 | 1. Install MacTex 59 | 60 | First check your system version 61 | 62 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG1497.png) 63 | 64 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-05-22_21-32-19.png) 65 | 66 | ### option 1 67 | 68 | Download MacTex on http://tug.org/mactex/ 69 | 70 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-24-39.png) 71 | 72 | 73 | 74 | Choose one according to your system. 75 | 76 | Remember to check `md5` for `MacTex.pkg` 77 | 78 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-35-50.png) 79 | 80 | Install `MacTex.pkg` 81 | 82 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-29-53.png) 83 | 84 | 85 | 86 | ### option 2 87 | 88 | Install with [`homebrew`](https://brew.sh/). If you fail to connect to the official website, you may try [mirror](https://mirrors.tuna.tsinghua.edu.cn/help/homebrew/). 89 | 90 | ``` 91 | brew install mactex --cask 92 | ``` 93 | 94 | 95 | 96 | Test `MacTex.pkg` 97 | 98 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-38-58.png) 99 | 100 | 2. Install VScode and Latex Workshop 101 | 102 | https://code.visualstudio.com/ 103 | 104 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-44-40.png) 105 | 106 | 3. edit `setting.json` in VScode 107 | 108 | *You may refer to `Latex-vscode/Linux/vscode-setting.json`in the repository* 109 | 110 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-47-34.png) 111 | 112 | Remember to change the route of Xelatex, PDFLatex, etc. 113 | 114 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-48-40.png) 115 | 116 | 4. testfile 117 | 118 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-50-14.png) 119 | 120 | 121 | 122 | ## Linux 123 | 124 | ### Arch/Manjaro 125 | 126 | article for reference -> https://www.bilibili.com/read/cv22494481 127 | 128 | 1. Install VScode and install `Latex Workshop` in VScode 129 | 130 | ``` 131 | yay -S visual-studio-code-bin 132 | ``` 133 | 134 | 135 | 136 | 2. Install TexLive 137 | 138 | ``` 139 | yay -S texlive-full 140 | ``` 141 | 142 | 143 | 144 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG379.jpeg) 145 | 146 | use `tex -v` to test 147 | 148 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG376.png) 149 | 150 | 3. edit `setting.json` in VScode 151 | 152 | *You may refer to `Latex-vscode/Linux/vscode-setting.json`in the repository* 153 | 154 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG375.png) 155 | 156 | Remember to change the route of Xelatex, PDFLatex, etc. 157 | 158 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/Snipaste_2023-03-18_23-18-55.png) 159 | 160 | 4. testfile 161 | 162 | ![](https://raw.githubusercontent.com/Hydraallen/images/master/img/WechatIMG378.png) 163 | 164 | 165 | 166 | ### **debina/ubuntu** 167 | 168 | Run `sudo apt-get install texlive-full` 169 | 170 | # Reference 171 | 172 | https://zhuanlan.zhihu.com/p/166523064 173 | 174 | https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#placeholders 175 | 176 | https://mp.weixin.qq.com/s/GxYrbhxiv7bIG5Ulr2XetQ 177 | 178 | ## Star History 179 | 180 | [![Star History Chart](https://api.star-history.com/svg?repos=Hydraallen/Latex-vscode&type=Date)](https://star-history.com/#Hydraallen/Latex-vscode&Date) 181 | -------------------------------------------------------------------------------- /Windows/vscode-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | 3 | //------------------------------LaTeX 配置---------------------------------- 4 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 5 | "latex-workshop.latex.autoBuild.run": "onSave", 6 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 7 | "latex-workshop.showContextMenu": true, //false 8 | //从使用的包中自动补全命令和环境 9 | "latex-workshop.intellisense.package.enabled": true, 10 | //编译出错时设置是否弹出气泡设置 11 | "latex-workshop.message.error.show": false, 12 | "latex-workshop.message.warning.show": false, 13 | // 编译工具和命令 14 | "latex-workshop.latex.tools": [ 15 | { 16 | "name": "xelatex", 17 | "command": "xelatex", 18 | "args": [ 19 | "-synctex=1", 20 | "-interaction=nonstopmode", 21 | "-file-line-error", 22 | "%DOCFILE%" 23 | ] 24 | }, 25 | { 26 | "name": "pdflatex", 27 | "command": "pdflatex", 28 | "args": [ 29 | "-synctex=1", 30 | "-interaction=nonstopmode", 31 | "-file-line-error", 32 | "%DOCFILE%" 33 | ] 34 | }, 35 | { 36 | "name": "latexmk", 37 | "command": "latexmk", 38 | "args": [ 39 | "-synctex=1", 40 | "-interaction=nonstopmode", 41 | "-file-line-error", 42 | "-pdf", 43 | "-outdir=%OUTDIR%", 44 | "%DOCFILE%" 45 | ] 46 | }, 47 | { 48 | "name": "bibtex", 49 | "command": "bibtex", 50 | "args": [ 51 | "%DOCFILE%" 52 | ] 53 | } 54 | ], 55 | // 用于配置编译链 56 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 57 | "latex-workshop.latex.recipes": [ 58 | { 59 | "name": "XeLaTeX", 60 | "tools": [ 61 | "xelatex" 62 | ] 63 | }, 64 | { 65 | "name": "PDFLaTeX", 66 | "tools": [ 67 | "pdflatex" 68 | ] 69 | }, 70 | { 71 | "name": "PDFLaTeX*2", 72 | "tools": [ 73 | "pdflatex", 74 | "pdflatex" 75 | ] 76 | }, 77 | { 78 | "name": "BibTeX", 79 | "tools": [ 80 | "bibtex" 81 | ] 82 | }, 83 | { 84 | "name": "LaTeXmk", 85 | "tools": [ 86 | "latexmk" 87 | ] 88 | }, 89 | { 90 | "name": "xelatex -> bibtex -> xelatex*2", 91 | "tools": [ 92 | "xelatex", 93 | "bibtex", 94 | "xelatex", 95 | "xelatex" 96 | ] 97 | }, 98 | { 99 | "name": "pdflatex -> bibtex -> pdflatex*2", 100 | "tools": [ 101 | "pdflatex", 102 | "bibtex", 103 | "pdflatex", 104 | "pdflatex" 105 | ] 106 | } 107 | ], 108 | //文件清理。此属性必须是字符串数组 109 | "latex-workshop.latex.clean.fileTypes": [ 110 | "*.aux", 111 | "*.bbl", 112 | "*.blg", 113 | "*.idx", 114 | "*.ind", 115 | "*.lof", 116 | "*.lot", 117 | "*.out", 118 | "*.toc", 119 | "*.acn", 120 | "*.acr", 121 | "*.alg", 122 | "*.glg", 123 | "*.glo", 124 | "*.gls", 125 | "*.ist", 126 | "*.fls", 127 | "*.log", 128 | "*.fdb_latexmk" 129 | ], 130 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 131 | "latex-workshop.latex.autoClean.run": "onFailed", 132 | // 使用上次的recipe编译组合 133 | "latex-workshop.latex.recipe.default": "lastUsed", 134 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 135 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 136 | //Windows使用 SumatraPDF 预览编译好的PDF文件 137 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 138 | "latex-workshop.view.pdf.viewer": "external", 139 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 140 | "latex-workshop.view.pdf.ref.viewer": "auto", 141 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 142 | "latex-workshop.view.pdf.external.viewer.command": "D:/AppInstall/SumatraPDF/SumatraPDF.exe", // 注意修改路径 143 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 144 | "latex-workshop.view.pdf.external.viewer.args": [ 145 | "%PDF%" 146 | ], 147 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 148 | "latex-workshop.view.pdf.external.synctex.command": "D:/AppInstall/SumatraPDF/SumatraPDF.exe", // 注意修改路径 149 | // latex-workshop.view.pdf.external.synctex的参数。当同步到外部查看器时。%LINE%是行号，%PDF%是生成PDF文件的绝对路径的占位符，%TEX%是触发syncTeX的扩展名为.tex的LaTeX文件路径。 150 | "latex-workshop.view.pdf.external.synctex.args": [ 151 | "-forward-search", 152 | "%TEX%", 153 | "%LINE%", 154 | "-reuse-instance", 155 | "-inverse-search", 156 | "\"D:/AppInstall/VScode/Microsoft VS Code/Code.exe\" \"D:/AppInstall/VScode/Microsoft VS Code/resources/app/out/cli.js\" -r -g \"%f:%l\"", // 注意修改路径 157 | "%PDF%" 158 | ], 159 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 160 | } 161 | -------------------------------------------------------------------------------- /MacOS/vscode-settings.json: -------------------------------------------------------------------------------- 1 | { 2 | //------------------------------LaTeX 配置---------------------------------- 3 | // 设置是否自动编译："onSave"当代码被保存时自动编译文件；"never"从不自动编译，即需编写者手动编译文档;"onFileChange"在检测任何依赖项中的文件更改(甚至被其他应用程序修改)时构建项目，即当检测到代码被更改时就自动编译tex文件 4 | "latex-workshop.latex.autoBuild.run": "onSave", 5 | //右键菜单,设置是否将编译文档的选项出现在鼠标右键的菜单 6 | "latex-workshop.showContextMenu": true,//false 7 | //从使用的包中自动补全命令和环境 8 | "latex-workshop.intellisense.package.enabled": true, 9 | //编译出错时设置是否弹出气泡设置 10 | "latex-workshop.message.error.show": false, 11 | "latex-workshop.message.warning.show": false, 12 | // 编译工具和命令 13 | "latex-workshop.latex.tools": [ 14 | { 15 | "name": "xelatex", 16 | "command": "/Library/TeX/texbin/xelatex",//通过终端获取完整路径 17 | "args": [ 18 | "-synctex=1", 19 | "-interaction=nonstopmode", 20 | "-file-line-error", 21 | "%DOCFILE%" 22 | ] 23 | }, 24 | { 25 | "name": "pdflatex", 26 | "command": "/Library/TeX/texbin/pdflatex", 27 | "args": [ 28 | "-synctex=1", 29 | "-interaction=nonstopmode", 30 | "-file-line-error", 31 | "%DOCFILE%" 32 | ] 33 | }, 34 | { 35 | "name": "latexmk", 36 | "command": "/Library/TeX/texbin/latexmk", 37 | "args": [ 38 | "-synctex=1", 39 | "-interaction=nonstopmode", 40 | "-file-line-error", 41 | "-pdf", 42 | "-outdir=%OUTDIR%", 43 | "%DOCFILE%" 44 | ] 45 | }, 46 | { 47 | "name": "bibtex", 48 | "command": "/Library/TeX/texbin/bibtex", 49 | "args": [ 50 | "%DOCFILE%" 51 | ] 52 | } 53 | ], 54 | // 用于配置编译链 55 | //其中name是标签，也就是出现在工具栏中的链名称；tool是name标签所对应的编译顺序 56 | "latex-workshop.latex.recipes": [ 57 | { 58 | "name": "PDFLaTeX", 59 | "tools": [ 60 | "pdflatex" 61 | ] 62 | }, 63 | { 64 | "name": "PDFLaTeX*2", 65 | "tools": [ 66 | "pdflatex", 67 | "pdflatex" 68 | ] 69 | }, 70 | { 71 | "name": "XeLaTeX", 72 | "tools": [ 73 | "xelatex" 74 | ] 75 | }, 76 | { 77 | "name": "BibTeX", 78 | "tools": [ 79 | "bibtex" 80 | ] 81 | }, 82 | { 83 | "name": "LaTeXmk", 84 | "tools": [ 85 | "latexmk" 86 | ] 87 | }, 88 | { 89 | "name": "xelatex -> bibtex -> xelatex*2", 90 | "tools": [ 91 | "xelatex", 92 | "bibtex", 93 | "xelatex", 94 | "xelatex" 95 | ] 96 | }, 97 | { 98 | "name": "pdflatex -> bibtex -> pdflatex*2", 99 | "tools": [ 100 | "pdflatex", 101 | "bibtex", 102 | "pdflatex", 103 | "pdflatex" 104 | ] 105 | } 106 | ], 107 | //文件清理。此属性必须是字符串数组 108 | "latex-workshop.latex.clean.fileTypes": [ 109 | "*.aux", 110 | "*.bbl", 111 | "*.blg", 112 | "*.idx", 113 | "*.ind", 114 | "*.lof", 115 | "*.lot", 116 | "*.out", 117 | "*.toc", 118 | "*.acn", 119 | "*.acr", 120 | "*.alg", 121 | "*.glg", 122 | "*.glo", 123 | "*.gls", 124 | "*.ist", 125 | "*.fls", 126 | "*.log", 127 | "*.fdb_latexmk" 128 | ], 129 | //设置为onFaild 在构建失败后清除辅助文件："onFailed"当编译失败时，清除辅助文件；"onBuilt"无论是否编译成功，都选择清除辅助文件；"never"无论何时，都不清除辅助文件 130 | "latex-workshop.latex.autoClean.run": "onFailed", 131 | // 使用上次的recipe编译组合 132 | "latex-workshop.latex.recipe.default": "lastUsed", 133 | // 用于反向同步的内部查看器的键绑定。ctrl/cmd +点击(默认)或双击 134 | "latex-workshop.view.pdf.internal.synctex.keybinding": "double-click", 135 | //Windows使用 SumatraPDF 预览编译好的PDF文件 136 | // 设置VScode内部查看生成的pdf文件："external"使用外部pdf查看器查看;"tab"使用vscode内置pdf查看器;"browser"使用电脑默认浏览器进行pdf查看 137 | "latex-workshop.view.pdf.viewer": "external", 138 | // PDF查看器用于在\ref上的[View on PDF]链接："auto"由编辑器根据情况自动设置;“tabOrBrowser”使用vscode内置pdf查看器或使用电脑默认浏览器进行pdf查看；“external”使用外部pdf查看器查看 139 | "latex-workshop.view.pdf.ref.viewer": "auto", 140 | // 使用外部查看器时要执行的命令。此功能不受官方支持。 141 | "latex-workshop.view.pdf.external.viewer.command": "/Applications/PDF Expert.app", // 注意修改路径 142 | // 使用外部查看器时，latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 143 | "latex-workshop.view.pdf.external.viewer.args": [ 144 | "%PDF%" 145 | ], 146 | // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 147 | "latex-workshop.view.pdf.external.synctex.command": "/Applications/PDF Expert.app", // 注意修改路径 148 | // latex-workshop.view.pdf.external.synctex的参数。当同步到外部查看器时。%LINE%是行号，%PDF%是生成PDF文件的绝对路径的占位符，%TEX%是触发syncTeX的扩展名为.tex的LaTeX文件路径。 149 | "latex-workshop.view.pdf.external.synctex.args": [ 150 | "-forward-search", 151 | "%TEX%", 152 | "%LINE%", 153 | "-reuse-instance", 154 | "-inverse-search", 155 | "\"F:/Microsoft VS Code/Code.exe\" \"F:/Microsoft VS Code/resources/app/out/cli.js\" -r -g \"%f:%l\"", // 注意修改路径 156 | "%PDF%" 157 | ], 158 | "latex-workshop.intellisense.biblatexJSON.replace": {}, 159 | } 160 | --------------------------------------------------------------------------------