A (very) quick introduction to Latex-Suite 票友山翻译

Latex-Suite 快速入门

Srinath Avadhanula

<>

翻译:票友山 sunxun


摘要

Latex-Suite 是用于帮助编辑,查看和编译LaTeX 文档的一整套有用的脚本。Latex-Suite 的全部特性在用户手册中有完备的描述。这份入门向导从另一方面入手,通过30-45 分钟来展示了Latex-Suite 一些常用的功能。


目录

1 使用本入门
2 插入模版
3 插入宏包
4 插入新环境
5 一些快捷键
6 Latex-Suite 中的折叠
7 插入参考
8 编译文档
8.1 LaTeX 源程序调试
9 查看 DVI 文件
9.1 执行正向查找
9.2 执行反向查找
10 结语

1 使用本入门

本入门假定你的计算机中已经安装了Vim 6.1 或者更高版本。要查看版本,请打开Vim 并且输入

:ver

在输出文本的第一行,你会看到版本号。要获取最新的Vim ,请访问:http://vim.sf.net

假如你的Vim 6.1+ 已经可以正常运行,请参看此说明(请点这里)来安装Latex-Suite 。需要注意,你必须确定你Vim 中关于'grepprg' 的设置正常工作。

好的,现在你已经做完了所有查看此入门的准备工作。因为这份入门旨在向新手友好地介绍Latex-Suite ,它需要一些图形方面的功能。因此,至少在这份入门中,您需要打开Vim 的图形界面版(在MS Windows 中,这是默认的)。在同一个GVim 会话的分割窗口或者不同会话中打开这个帮助文件,并跟随这份友好的介绍进行学习。

2 插入模版

启动GVim 并且开始编辑一个新的文件。

:e newfile.tex

如果安装时正确的,你将会看到GVim 工具栏显示一些新的菜单。依次点击Tex-Suite > Templates。 你将看到一些列出的可选模版,如果选择article 模版,你将看到在Vim 的编辑窗口中出现如下的一些内容(在敲击一下回车后会迅速显示出来)。

 1 %        File: sample.tex
 2 %     Created: Sun Jun 22 04:00 PM 2003 P
 3 % Last Change: Sun Jun 22 04:00 PM 2003 P
 4 %
 5 \documentclass[a4paper]{article}
 6 \begin{document}
 7
 8 \end{document}
 9
10 ~
11 ~
12 ~
13 ~
-- INSERT --       7,1           All

翻译者注:中文Vim 环境中,相关信息是用中文显示的,如创建时间。

光标将在第7 行的左边(正好在\begin{document} 这一行后面)从这里你可以马上直接开始编辑。 在Latex-Suite 不断地尝试减少移动是一个反复出现的主题。

3 插入宏包

假定我们要写一份数学论文,并且我们想使用广受欢迎的amsmath 宏包,我们将使用一些LaTeX 为包含LaTeX 宏包提供选项而专门设置的基本功能。在\begin{document} 这一行之前的部分在LaTeX 中被叫做导言区。在导言区中的空白行中输入一个单词amsmath ,并在普通模式下点击<F5> ,这一行将会变成

\usepackage[]{amsmath}<++>

光标默认停留在[]之间。这个时候,你无需为这一行最后的<++> 担心。假定我们想要为amsmath 提供sumlimits 选项,你可以手动输入这个选项,也可以从菜单中宏包选项中选取,这些宏包选项是当你用<F5> 插入宏包的时候自动创建的。保持光标停留在[] 之间,依次点击TeX-Suite >Packages > amsmath Options ,选择sumlimits 选项,包含该宏包的这一行将会变成:

\usepackage[sumlimits,]{amsmath}<++>

依旧保持光标在] 之前,在插入模式中点<Ctrl+j> ,你将会看到光标跳到了包含该宏包的这一行的最后,并且<++> 也将消失。刚刚发生了什么?这是你第一次关于占位符 的使用的体验。要了解更多请点击这里查看。简而言之,就是当你在插入模式中点击<Ctrl+j> 的时候,光标会跳到文本中下一处<++>

4 插入新环境

现在,我们来在LaTeX 中输入一个简单的公式。回到文档正文部分(在\begin{document}\end{document} 被叫做正文部分)。在此处的空行中输入一些简单的句子,并输入单词eqnarray ,回到正常模式,并点击<F5>(请记住:<F5>很有用),这一行会变成:

\begin{eqnarray}
    \label{}<++>
\end{eqnarray}<++>

并且光标默认停留在{} 之间,输入一个新标签,这里我们选取eqn:euler,输入完成之后,点击<Ctrl+j>,光标会跳到大括号之外,这是你又一次使用占位符。

5 一些快捷键

现在,我们来输入注明的欧拉公式。我们的目标是输入:

e^{j\pi} + 1 &=& 0

我们并不是盲目的直接输入,而是使用一些快捷键来减少工作量,首先输入e^ 。现在,输入另外一个^ ,你将会看到e^^ 立即变化为e^{}<++> ,且光标停留在{}之中。 ( ^^ 变化为^{}<++>。)继续输入字母系列 j`p ,它会立即变成j\pi。(`p变为 \pi。) 现在你已经输入了所有我们想在{}之间输入的东西,点击<Ctrl+j>,你将跳到大括号之外。要继续输入剩下的公式,你可以使用== 快捷键来输入&=& 。Latex-Suite 提供了大量像这样的可以使输入变得便利有趣的快捷键, 当然,首先你要熟悉它们。这里我们提供一个列表。要熟悉它们肯定是要花一些时间的,不过它们中的大部分还是很直观的,比如 `/代表 \frac{}{}`8 代表\infty

要更好的理解下一部分的内容,再学一个 \label会很有帮助。让我们利用<F5> 键来输入另外一个等式。这一次,我们要完成一些简单的事情,如下:

\begin{eqnarray}
  \label{eqn:simple}
  1 + 1 = 2
\end{eqnarray}

6 Latex-Suite 中的折叠

很好,现在我们输入了足够的东西,眼下,你文件中的内容很可能是像下面这样:

 1 %        File: sample.tex
 2 %     Created: Sun Jun 22 04:00 PM 2003 P
 3 % Last Change: Mon Dec 15 07:00 PM 2003
 4 %
 5 \documentclass[a4paper]{article}
 6
 7 \usepackage[sumlimits,]{amsmath}
 8
 9 \begin{document}
10 \begin{eqnarray}
11 	\label{eqn:euler}
12 	e^{j\pi} + 1 &=& 0
13 \end{eqnarray}
14 This is the famous euler equation. I
15 will type another equation, just as
16 true:
17 \begin{eqnarray}
18 	\label{eqn:simple}
19 	1 + 1 &=& 2
20 \end{eqnarray}
21 This is my contribution to mathematics.
22 \end{document}

在普通模式,点击 \rf。这整篇文章将会折叠起来,然后文件看起来会像下面的样子:

 1 %        File: sample.tex
 2 %     Created: Sun Jun 22 04:00 PM 2003 P
 3 % Last Change: Mon Dec 15 07:00 PM 2003
 4 %
 5 +--  4 lines: Preamble:   \documentclass[a4paper]{article} -----
 9 \begin{document}
10 +--  4 lines: eqnarray (eqn:euler) \label{eqn:euler} -----------
14 This is the famous euler equation. I
15 will type another equation, just as
16 true:
10 +--  4 lines: eqnarray (eqn:simple) \label{eqn:simple} ---------
21 This is my contribution to mathematics.
22 \end{document}

翻译者注:\rf 使用的时候是长按 \ ,然后依次点击rf

Latex-Suite 一般是将 Latex 的代码块变成一个折叠区域。在普通模式下面,你可以利用命令
za 来打开或者关闭折叠。

7 插入参考

插入参考公式,图像,目录等是LaTeX 编辑中很重要的部分。这是通过\ref\cite 命令来完成的。Latex-Suite 提供了一个简单的方法来完成这一任务,在文档正文任意部分,输入下面句子

This is a reference to (\ref{}) 。

将光标点到 {} 之间并在插入模式中点击 <F9> 。你的 vim 会话会产生两个新的窗口,如下:

 9 \begin{document}
10 +--  4 lines: eqnarray (eqn:euler) :  \label{eqn:euler}-----
14 This is the famous euler equation. I
15 will type another equation, just as
16 true:
17 +--  4 lines: eqnarray (eqn:simple) :  \label{eqn:simple}----
21 This is my contribution to mathematics.
22 This is a reference to (\ref{}<++>)<++>
23 \end{document}
~
~
~
test.tex [+]                                22,29          Bot
test.tex|11| \label{eqn:euler}
test.tex|18| \label{eqn:simple}
~
~
~
[Error List]                                 1,1            All
 7 \usepackage[sumlimits,]{amsmath}
 8
 9 \begin{document}
10 \begin{eqnarray}
11     \label{eqn:euler}
12     e^{j\pi} + 1 &=& 0
13 \end{eqnarray}
14 This is the famous euler equation. I
15 will type another equation, just as
16 true:
test.tex [Preview][+]                    11,2-5         46%

光标将会移动到中间的窗口,在这个窗口中,将会显示当前目录中发现的所有 .tex 中全部的\label

你可以上下滚动的中间的窗口直到你选定你想要插入的参考。注意当你在中部窗口滚动的时候,底部的“预览”窗口会自动显示你当前选择的位置。这可以帮助你更加方便地确定参考,因为很多时候,\labels 并没有完备的描述,或者说描述可能太多。要插入参考,你只需将光标定位到中部窗口中的相关行,并且点击<enter>
你所编辑的那一行将会变成:

This is a reference to (\ref{eqn:euler})

而底部窗口也会自动关闭。

<F9> 键对于用\cite 命令插入目录或者用\inputgraphics 命令通过简单搜索关键词来插入文件名同样有效。点击此处可以获得更详细的信息。

8 编译文档

现在,我们已经创建了一份很小的latex 文档。下一步我们要做的就是利用latex通过这个文件编译产生一个 .dvi 文件。经由latex-suite 来进行编译是很简单的意见时请。回到普通模式,按 \ll

你可以通过你设定的任何mapleader替换 \ 。这回调用latex 编译器。如果顺利的话,不用多久,vim 窗口又会恢复被选定状态。 如果什么都没有发生,你可能需要一些更多的设置,请查阅此处

8.1 LaTeX 源程序调试

要展示调试的例子,让我们来在这份文件中制造一些错误。现在让我们来在文件中插入这个错误:

This is a $\mistake$.
And this is $\another$

现在请再一次点击 \ll 。这一次你会发现当编译过程结束的时候,光标自动落到了$\mistake$上面。并且,两个新窗口将会出现。

中间的窗口的是 错误列表 窗口,这个窗口显示latex 编译器发现的错误。底部的窗口是 Log 预览 窗口,这个窗口会告诉你错误错误在 .log 文件中的相关位置, 这个文件是在编译过程中自动生成的。现在我们跳转到 错误列表窗口,并通过 j,k 键或者方向键滚动它。你会发现,Log 预览窗口也会自动滚动并定位到你现在正在查看的错误。如果你在任一行上点击<enter> ,你会发现光标将会只想错误的地方。Latex-Suite 会用最好的方法尝试找到相应的列数,让你可以尽快开始继续编辑。

对编译已经有了了解,让我们来删除错误行,并重新编译。

Latex-Suite 编译器有能力胜任更多的事情,包括有选择的过滤掉一些你可能想暂时忽略的错误,只是编译文档的一部分,设定编译器输出信息的长度等等。查看此处可以获取更多信息。

9 查看 DVI 文件

现在你已经编译了你的第一个latex 源文件,是时候看看这个文件编译后的效果了。和上面其他东西一样,这个过程还是会很简单,在普通模式下点击\lv 。DVI 阅读器将会启动,并且显示刚刚编译出的dvi 文件,这取决于系统中安装的dvi查看器。

如果什么都没有发生的话,你可能需要一些其他设置,请查看此处

9.1 执行正向查找

如果你使用的是新式的DVI 阅读器,你应该可以进行正向或者反向的查找。不过,你可能需要对标准的Latex-Suite 发行版进行一些设置,才可以实现这一功能。输入如下的命令行:

:let g:Tex_CompileRule_dvi = 'latex -src-specials -interaction=nonstopmode $*'
:TCTarget dvi

现在点击 \ll 重新编译latex文件。这一次,不是点击 \lv 来查看文件,而是在tex 文件内部点击 \ls ,如果DVI 阅读器支持正向查找(大部分DVI 阅读器都可以),DVI 阅读器会自动显示与你编辑的位置相关部分的DVI 文件的内容。

备注

Latex-Suite 没有默认支持该设定是因为在某些系统上,这可能会导致DVI 输出的时候产生一些不可预知的结果。如果你DVI 的输出是令人满意的,你可以在$VIM/ftplugin/tex.vim 文件中插入上面两行命令中的第一行。

$VIM 在windows 下代表 ~/vimfiles 而在*nix 系统中代表 ~/.vim

9.1 执行反向查找

同样,大部分DVI 阅读器也都支持反向查找。借此,你可以在查看DVI 文件某部分的时候调用VIM 反查相关源代码,这个功能在校对大文档的时候尤其有用。

一般,如果阅读器支持的话,在阅读器窗口中双击任意一处,阅读器会尝试打开一个编辑窗口并指向源文件中你双击的部分。在 *nix 平台上,Latex-Suite 会尝试使用VIM 打开tex 源代码,因为阅读器程序已经知道是使用VIM 编辑tex 源代码。因此,你应该会看见VIM 程序打开并显示tex 源文件。然而,如果有错误,或者说使用了其他的程序,你需要告诉阅读器程序使用GVim 作为默认编辑器。在windows 平台,如果你使用的是比较通用的 yap 阅读器(在某些miktex 发行版中是包含了这个程序的),你可以通过点击 View > Options > Inverse Search来设置该功能。在 命令行 窗口写入

"C:\Program Files\vim\vim61\gvim" -c ":RemoteOpen +%l %f"

(请根据你安装GVim 的文件夹来设置这个路径),设置完成后双击查看窗口,你可以看到gvim 启动并且指向tex 源文件中的相关部分。

10 结语

朋友们,以上就是这个入门全部的文字了!现在,你们应该已经知道足够多的latex-suite 基本功能。当然,latex-suite 能胜任事情远远更多,比如多次编译文件来解决变化过的标签,编译依赖关系,处理用户宏包。要获取更多,你需要看一下 Latex-Suite 用户手册

版权说明

无特殊说明均为原创文章,转载请注明。
本文链接地址: http://sunxun.info/2009/06/latex-suite_guide_cn/

分享家:Addthis中国
2009年6月27日 | 归档于 tex
标签: , , ,
本文目前尚无任何评论.

发表评论

XHTML: 您可以使用这些标签: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>
注意: 评论者允许使用'@user空格'的方式将自己的评论通知另外评论者。例如, ABC是本文的评论者之一,则使用'@ABC '(不包括单引号)将会自动将您的评论发送给ABC。请务必注意user必须和评论者名相匹配(大小写一致)。