Skip to content

Commit

Permalink
单独添加编辑器章
Browse files Browse the repository at this point in the history
  • Loading branch information
OsbertWang committed Oct 28, 2019
1 parent 3492479 commit c50ebfd
Show file tree
Hide file tree
Showing 7 changed files with 371 additions and 324 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# 一份简短的安装 LaTeX 的介绍

本文将介绍 Windows 10、Ubuntu 和 macOS 系统中安装 TeX Live、升级宏包、编译简易文档、配置编辑器的相关操作,并多以介绍命令行操作为主。建议用户阅读 [LaTeX2e 安装 & 新手指点 FAQ](http://www.latexstudio.net/archives/11469.html)[lshort-zh-ch](http://mirrors.ctan.org/info/lshort/chinese/lshort-zh-cn.pdf) 以更全面地了解基础内容。本文还补充了一些使用 [Overleaf](www.overleaf.com) 的相关内容。本文所涉及到的代码还请用户多多动手,不要简单地复制粘贴。
本文将介绍 Windows 10、Ubuntu 和 macOS 系统中安装 TeX Live (macOS 中介绍 MacTeX)、升级宏包、编译简易文档的相关操作,并多以介绍命令行操作为主;
还将简要介绍几款常见编辑器的使用方法。
建议用户阅读 [LaTeX2e 安装 & 新手指点 FAQ](http://www.latexstudio.net/archives/11469.html)[lshort-zh-ch](http://mirrors.ctan.org/info/lshort/chinese/lshort-zh-cn.pdf) 以更全面地了解基础内容。
本文还补充了一些使用 [Overleaf](www.overleaf.com) 的相关内容。本文所涉及到的代码还请用户多多动手,不要简单地复制粘贴。

若需要本项目编译完成的 PDF 文件,可至 [Releases](https://github.com/OsbertWang/install-latex/releases/latest) 处下载。
338 changes: 338 additions & 0 deletions chapter/editor.tex

Large diffs are not rendered by default.

26 changes: 0 additions & 26 deletions chapter/macos.tex
Original file line number Diff line number Diff line change
Expand Up @@ -90,29 +90,3 @@ \section{编译文件}
可以打开 \texttt{main.pdf} 查看内容.

编译命令可添加参数, 这里不再赘述.

\section{使用编辑器}

\subsection{\TeX Shop}

Mac\TeX{} 自带 \TeX Shop 编辑器 (注意不要与其他自带的程序混淆), 通常在安装完毕后便可立即使用.
通过编辑器打开 \texttt{main.tex},
将排版程序 (工具栏上面左数第二个下拉菜单) 由默认的 \menu{LaTeX} 切换到 \menu{pdflatexmk},
再点击旁边的排版 \menu{排版} (\menu{Typeset}), 待编译完成后会弹出 PDF 预览界面.

编译中文文档, 通常需要将排版程序切换到 \menu{XeLaTeX}.
注意可能需要多次编译以生成正确的交叉引用等内容.

\subsection{\TeX studio}

如果希望使用 \TeX studio, 也可以通过 Homebrew 安装:
\begin{lstlisting}[language=bash]
brew cask install texstudio
\end{lstlisting}
注意因为网络问题可能会下载失败. 这时可能需要从其他途径获得安装包并手工安装, 此处不再赘述.

\subsubsection{无法显示文字}

\TeX studio 在 macOS 下有可能无法显示文字,
这是其他系统下目前没有发现的问题.
具体解决方法见\href{https://zhuanlan.zhihu.com/p/80728204}{李阿玲在知乎的文章}.
54 changes: 0 additions & 54 deletions chapter/ubuntu.tex
Original file line number Diff line number Diff line change
Expand Up @@ -225,57 +225,3 @@ \subsection{无法使用 \texttt{xelatex} 命令}
sudo apt-get install libfontconfig1
\end{lstlisting}
进行安装.

\section{使用编辑器}

简化起见, 这里只介绍如何使用 \TeX studio.

根据官网推荐, 我们安装源内的 \TeX studio.
由于网络问题, 直接安装速度比较慢, 因此我们首先更换 Ubuntu 18.04 的源至清华大学.
\textsf{Terminal} 中执行
\begin{lstlisting}[language = bash]
sudo cp /etc/apt/sources.list /etc/apt/sources.list.bak
\end{lstlisting}
备份 \texttt{sources.list} 文件.
接下来执行
\begin{lstlisting}[language = bash]
sudo gedit /etc/apt/sources.list
\end{lstlisting}
将文件替换为以下内容\footnote{本段文字可至 \href{https://mirrors.tuna.tsinghua.edu.cn/help/ubuntu/}{清华大学镜像网站} 获取}
\begin{lstlisting}
# 默认注释了源码镜像以提高 apt update 速度, 如有需要可自行取消注释
deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic main restricted universe multiverse
# deb-src https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic main restricted universe multiverse
deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-updates main restricted universe multiverse
# deb-src https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-updates main restricted universe multiverse
deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-backports main restricted universe multiverse
# deb-src https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-backports main restricted universe multiverse
deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-security main restricted universe multiverse
# deb-src https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-security main restricted universe multiverse

# 预发布软件源, 不建议启用
# deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-proposed main restricted universe multiverse
# deb-src https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ bionic-proposed main restricted universe multiverse
\end{lstlisting}
然后执行
\begin{lstlisting}[language = bash]
sudo apt-get update && sudo apt-get upgrade
\end{lstlisting}
至此换源完毕.

\textsf{Terminal} 中执行
\begin{lstlisting}[language = bash]
sudo apt install texstudio
\end{lstlisting}
即可安装 \TeX studio.
注意安装过程中会产生一些依赖, 它们包括了源内的 \TeX{} live 包, 如 \texttt{tex-common}, \texttt{texlive-base}, \texttt{texlive-binaries}, \texttt{texlive-latex-base} 和 \texttt{texlive-latex-recommended}.
用户需要卸载它们.

用户可以在 \textsf{Terminal} 中执行
\begin{lstlisting}[language = bash]
texstudio main.tex
\end{lstlisting}
使用 \TeX studio 编辑文档.
也可直接双击 \texttt{main.tex} 文件.

注意, 在双击打开时, 用户需要在 \menu{Options > Configure TeXstudio} 中 点击 \menu{Show Advanced Options}, 接下来在 \menu{Build > Build Options > Commands (\${}PATH)} 中添加 \texttt{/usr/local/texlive/2019/bin/x86\_64-linux}.
197 changes: 0 additions & 197 deletions chapter/windows.tex
Original file line number Diff line number Diff line change
Expand Up @@ -349,200 +349,3 @@ \section{编译文档}
pdflatex -synctex=1 -interaction=nonstopmode main
\end{lstlisting}
来编译文档 \texttt{main.tex}, 并在有需要时完成其他步骤\footnote{如使用 \texttt{bibtex} 或 \texttt{biblatex} 处理参考文献时需要多次编译, 详情见相关文档}.

\section{使用编辑器}
在实际操作中, 用户会发觉使用记事本编写 \texttt{tex} 文件十分不便, 因此很多用户都将其他编辑器作为自己的首选. 表~\ref{tab:editor} 是 \href{https://ddswhu.me/}{ddswhu} 在 \LaTeX{} 小圈子内部对 \LaTeX{} 编辑器所进行的用户体验调查的结果, 比较主观, 仅供参考.

\begin{table}[htbp]
\centering
\caption{\LaTeX{} 编辑器对比}
\begin{tabular}{cccccc}
\toprule
& WinEdt & \TeX{}studio & \TeX{}works & Sublime Text & VS Code \\
\midrule
主流系统 & Win & 全平台 & Linux/Win & 全平台 & 全平台 \\
软件类型 & 商业软件 & 开源软件 & 开源软件 & 商业软件 & 商业软件 \\
软件价格 & 219 元 & 0 & 0 & 80 刀 & 0 \\
代码高亮 & \stars{2.7} & \stars{3.2} & \stars{1.5} & \stars{4.3} & \stars{4.5} \\
颜色主题 & \stars{2.3} & \stars{2.2} & \stars{1.0} & \stars{4.0} & \stars{4.0} \\
自动补全 & \stars{2.7} & \stars{3.4} & \stars{2.0} & \stars{3.5} & \stars{4.0} \\
代码片段 & \stars{2.7} & \stars{2.4} & \stars{0.5} & \stars{3.8} & \stars{4.0} \\
辅助输入 & \stars{4.0} & \stars{3.4} & \stars{0.5} & \stars{2.3} & \stars{3.3} \\
开发完成 & \stars{4.0} & \stars{3.8} & \stars{4.5} & \stars{3.5} & \stars{4.0} \\
推荐指数 & \stars{2.7} & \stars{4.0} & \stars{1.5} & \stars{3.0} & \stars{4.3} \\
\bottomrule
\end{tabular}%
\label{tab:editor}%
\end{table}%

本文向大家介绍随 \TeX{} Live 一同发行的轻量级编辑器 \TeX works 和功能更加丰富的 \href{https://github.com/texstudio-org/texstudio/releases}{\TeX studio}.
其他编辑器, 因本人并不常用, 无法一一介绍, 还请自己在网上寻求更多帮助.

\subsection{\TeX works}
\TeX works 是一款轻量级的 \LaTeX 编辑器, 个人认为非常适合入门级用户使用\footnote{很多用户在编写 \texttt{tex} 文件时喜欢借助其他工具, 这不是个好习惯, 这里鼓励用户多手动敲代码}.

和大多数国产软件不同, \TeX works 不会自动在桌面生成快捷方式, 新人往往不知道如何打开它.
实际上 \TeX works 在 \TeX{} Live 安装路径的 \texttt{\textbackslash bin\textbackslash win32} 中, 可在 \textsf{cmd} 中执行 \texttt{texworks} 打开, 也可直接在 Windows 搜索栏里搜 \TeX works 打开.

刚开始使用 \TeX works 的用户不必过多配置, 在默认状态下打开软件、编写代码、保存文件后, 用户可使用 \TeX works 的“排版”按钮进行文档编译而不必回到命令行\footnote{实际上编辑器的按钮也是调用命令行来编译文档, \TeX works 默认排版快捷键是 \texttt{ctrl + T}}.
按钮旁边是编译命令菜单, 用户可根据需要自行选择.

下面介绍几个常用的功能.

\subsubsection{显示行号}
打开 \menu{编辑 > 首选项 > 编辑器}, 选择 \menu{行号} 即可.

\subsubsection{自动补全}
自动补全主要是 \keys{tab} 键的功能, 使用前需确定 \menu{首选项 > 编辑器} 中是否勾选了 \menu{启动自动补全}.
有关自动补全的更多内容用户可参考 \href{https://github.com/EthanDeng/\TeX works-autocomplete}{\TeX works 的自动补全功能}.

\subsubsection{使用模板}
\TeX works支持从模板新建文档, 在 \menu{文件} 菜单中可见.

\subsubsection{拼写检查}
默认情况, \TeX works没有搭载拼写检查字典, 需要用户自己配置.
首先, 访问 \href{http://wiki.openoffice.org/wiki/Dictionaries}{openoffice} 下载词典.
接下来将词典安装到 \texttt{<resources>\textbackslash dictionaries} \footnote{\texttt{<resources>} 的具体位置可以在 \menu{帮助 > TeXworks 配置与资源} 中找到}.
安装完成后, 在 \menu{编辑 > 拼写} 中选择即可.

\subsubsection{魔法注释}
魔法注释可以直接规定主文档、文件编码和编译命令等.
例如用户写学位论文时, 往往有一个主文档和若干子文档.
在子文档的开头写上魔法注释
\begin{lstlisting}
% !TeX root = ../mainfile.tex
\end{lstlisting}
即可告诉系统上一级目录中的 \texttt{main.tex} 是主文档\footnote{主文档和子文档的更多内容请参考 \texttt{\textbackslash include} 和 \texttt{\textbackslash input} 的用法}.
\begin{lstlisting}
% !TeX encoding = UTF8
\end{lstlisting}
表示该文档使用 ``UTF-8'' 编码\footnote{目前建议用户多用 ``UTF-8'' 编码, 尤其是中文文档}.
\begin{lstlisting}
% !TeX program = xelatex
\end{lstlisting}
表示该文档使用 \texttt{xelatex} 编译命令进行编译.
\begin{lstlisting}
% !TeX spellcheck = <language_code>
\end{lstlisting}
表示该文档使用 \texttt{<language\_code>} 进行拼写检查, 它的具体名称请用户到 \menu{编辑 > 拼写} 中查看.

\subsubsection{转编码}
实际上转编码是很多编辑器都具备的功能.
\TeX works右下角有三个按钮, 左边按钮控制换行符类型, 中间按钮控制文档编码, 右边按钮控制行跳转.
目前大部分中文用户主要面临的是``UTF-8''``GBK''之间的转换.
如果文档是``GBK''编码, 使用\TeX works打开文件后, 文档会出现乱码.
这时, 点中间按钮, 选择编码类型``GBK'', 再点击按钮, 选择 \menu{使用所选编码重载文档}, 若文档中乱码消失, 则再次点击按钮, 选择``UTF-8'', 最后保存文档, 完成转码工作.

除以上内容外, \TeX works 还支持正则表达式、自定义快捷键等.
这些内容都写在 \TeX works 自带的手册中.
手册不长, 用户可以通读一遍以了解更多内容.

\subsection{\TeX studio}
相较于 \TeX works, \TeX studio 功能更丰富, 用法更多.
在使用 \TeX studio 前, 用户一定要查询 \texttt{system32} 是否在环境变量中.
具体方法在前面已有说明, 此处不再赘述.

\subsubsection{更改默认编译命令}

\menu{Options > configure TeXstudio > build > default compiler} 中选择默认编译命令.

另外如果有用户喜欢用 \texttt{latexmk} 和 \texttt{biblatex}, 可以考虑在 \menu{Options > Configure TeXstudio > build > Build Options} 中取消 \menu{Check and update bibliography before compiling}.

\subsubsection{显示行号}

\menu{Options > configure TeXstudio} 中勾选 \menu{Show Advanced Options},
然后在 \menu{Adv. Editor > show line numbers} 选择.

\subsubsection{调整缩进}

\menu{Options > Configure TeXstudio > Editor > Indentation Mode} 处可以选择是否保持缩进.
如果需要让缩进完全变为空格, 勾选 \menu{Replace Indentation Tab by Spaces}.

\menu{Adv. Editor > Appearance} 中可以更改 \menu{Tab Widths}.

\subsubsection{块选择模式}

同时按 \keys{Ctrl + Alt} 便可通过鼠标左键进行块选择.

\subsubsection{自动补全和未识别代码}
\TeX studio 自动补全功能会先通过用户引用的宏包来判断代码是否需要自动补全,
同时它也可以以此判定用户输入的命令是否正确,
即命令出现红色背景.
\TeX studio 能够识别的命令全部被写入了 \href{https://github.com/texstudio-org/texstudio/tree/master/completion}{cwl 文件} 中.
用户可以根据自己的需要更改 cwl 文件, 然后将其放入 \texttt{<settings directory>\textbackslash completion\textbackslash user} 文件夹\footnote{点击 \menu{Help > Check LaTeX Installation}, 在生成的 \texttt{System Report.txt} 中找到 \texttt{texstudio.ini} 文件, 其所在文件夹即为 \texttt{<settings directory>}}.
自动补全后有可能生成文本框, 使用 \keys{\ctrl + \arrowkey{>}} 可以跳转至下一个文本框;\keys{\ctrl + \arrowkey{<}} 则可以跳转至下一个.

\subsubsection{拼写检查}
\TeX studio 默认使用德语进行拼写检查, 在右下角将 \texttt{de\_DE} 改为 \texttt{en\_US} 即可进行英文拼写检查,

\subsubsection{魔法注释}
除了像 \TeX works 中使用魔法注释外, \TeX studio 还有很多其他的魔法注释, 例如
\begin{lstlisting}
% !TeX TXS-program:compile = txs:///latexmk/{}[-xelatex -synctex=1 -interaction=nonstopmode %.tex]
\end{lstlisting}
表示使用 \texttt{latexmk} 编译命令, \texttt{\{\}} 表示无视编辑器赋予该命令的一切参数, 而 \texttt{[]} 表示添加其中的参数进行编译, 本例中添加 \texttt{-xelatex -synctex=1 -interaction=nonstopmode} 作为参数.

\subsubsection{渲染方式}
\TeX studio 默认渲染方式对中文括号的支持不够好.
\menu{Options > Configure TeXstudio > Adv. Editor > Hacks/Workarounds} 中取消 \menu{Try to automatically choose best display options}, 选择 \menu{Disable cache of character width} 和 \menu{Disable fixed pitch mdoe}.

\subsubsection{转编码}
\TeX studio右下角有一处显示文档编码 (Encoding).
依旧以``UTF-8''``GBK''之间的转换为例.
如果文档是``GBK''编码, 使用\TeX studio打开文件后, 点击 \menu{Encoding} 处, 选择 \menu{More Encodings}.
打开窗口后, 选择``GBK / ...'', 点击 \menu{Reload With}, 若这时文档没有乱码, 再点击 \menu{Encoding > More Encodings}, 选择``UTF-8'', 点击 \menu{Change To}, 保存文件, 完成转码.

\subsubsection{自定义命令并生成按钮}
\TeX studio 允许用户自定义命令, 并将命令做成按钮放置于面板上.
例如, 在 \menu{Options > Configure TeXstudio > Build > User commands} 中, 填写名称 \texttt{User1:Build-xe-view} 和功能 \texttt{latexmk -pdfxe -silent -synctex=1 -interaction=nonstopmode \% | txs:///view-pdf-internal --embedded}, 点击 \menu{OK}.
接下来我们在 \menu{Tools > User} 中即可看到自定义的命令和相应快捷键.
再打开 \menu{Options > Configure TeXstudio > Toolbars}, 在两个下拉菜单中分别选择 \menu{Tools} 和 \menu{All menus}, 在右边找到 \menu{Tools > User > Build-xe-view} 并将其添加至左端, 点击 \menu{OK}.
这时, 在面板中将添加新的按钮.

\subsubsection{生成宏指令}
\TeX studio 允许用户生成宏指令.
\menu{Macros > Edit Macros} 中, 用户可以根据自己的需要, 给出宏指令的名称、快捷键、内容等等.
例如我们将 \texttt{latexmk-pdf} 填写在 \menu{name} 中,
\texttt{\% !TeX TXS-program:compile = txs:///latexmk/\{\}[-pdf -synctex=1 -interaction=nonstopmode -silent \%]} 填写在 \menu{LaTeX Content} 中,
再将 \texttt{Shift+F1} 填写在 \menu{Shortcut}.
设置完毕后, 点击 \menu{OK}.
这时, 我们可以看到 \menu{Macros > latexmk-pdf} 出现.
在文档特定位置点击它或者直接使用 \keys{\shift + F1}, 即可看到魔法注释出现.

\subsubsection{更改颜色方案}
有一些用户喜欢深色的颜色方案.
手动修改颜色不方便的话, 我们可以从网上找到一些现成的颜色方案,
例如 \href{https://tex.stackexchange.com/questions/108315/how-can-i-set-a-dark-theme-in-texstudio}{stackexchange 网站} 和 \href{https://robjhyndman.com/hyndsight/dark-themes-for-writing/}{某些用户的博客}.
更改方案只需要打开 \texttt{ini} 文件,
将这些颜色方案复制到 \texttt{[formats]} 部分.
\menu{Help > Check LaTeX Installation} 中有 \texttt{ini} 文件的具体位置.

\subsubsection{调用外部 PDF 阅读器}
\href{https://www.sumatrapdfreader.org/free-pdf-reader.html}{SumatraPDF} 为例,
用户直接安装或下载便携版均可,
假定它在本地的位置为 \texttt{<SumatraPDFDIR>}.
打开 \menu{Options > Configure TeXstudio} 窗口,
激活 \menu{Show Advanced Options},
之后在 \menu{Build > User commands} 中添加
\begin{lstlisting}
dde:///"<SumatraPDFDIR>\SumatraPDF.exe":SUMATRA/control/[ForwardSearch("?am.pdf","?c:am.tex",@,0,0,1)]
\end{lstlisting}
将其命名为 \texttt{user0:sumatrapdf}.
接下来, 在 \menu{Build > Build \& View} 中将 \texttt{txs:///compile | txs:///view} 改为 \texttt{txs:///compile | txs:///user0}.
最后, 在 \menu{Menus} 中将 \texttt{\&View} 的命令由 \texttt{txs:///view} 改为 \texttt{txs:///user0}.
完成以上设置后,
关闭窗口.
这时, 用户使用快捷键 \keys{F5} 和 \keys{F7} 均可打开 SumatraPDF 并且实现了正向搜索.
如果有人喜欢在编译时添加参数 \texttt{--outdir=temp},
那么可以将 \texttt{user0:sumatrapdf} 改为
\begin{lstlisting}
dde:///"<SumatraPDFDIR>\SumatraPDF.exe":SUMATRA/control/[ForwardSearch("?a)temp\?m.pdf","?c:a)temp\?m.tex",@,0,0,1)]
\end{lstlisting}

用 SumatraPDF 打开编译完的 PDF 文件, 在 \menu{Settings > Options > Set inverse search command line} 中输入
\begin{lstlisting}
"<TeXstudioDIR>\texstudio.exe" "%f" -line %l
\end{lstlisting}
其中, \texttt{<TeXstudioDIR>} 是 \TeX studio 在本地的位置.
至此完成了逆向搜索,
双击 PDF 文件便可回到 \TeX studio 中对应代码的行首.
Loading

0 comments on commit c50ebfd

Please sign in to comment.