代码之家 › 专栏 › 技术社区 › paxdiablo

如何在用户手册中使用Tex[关闭]

tex documentation visual-studio-2008

2

paxdiablo · 技术社区 · 14 年前

我们正在为发布产品做最后的准备,我们必须修改用户指南。

我们目前所掌握的是一些MS Word和一些OpenOffice.org文档的合并。虽然这已经足够了,但是我们将在发布之后大量地重新进行,以准备接下来的发布。

我们对这些解决方案都不太满意或因为它们都有自己的局限性。管理层已经指派我们识别标记语言的使用,其中一部分是研究Tex。

基本上,我们需要纯文本文档(因为我们可以编写shell脚本来更改它们,这比vba或OpenOffice宏容易得多),它将被转换为pdf。我们需要对TOC、索引和术语表的支持,以及能够嵌入图像和具有全局样式、易于更改的功能。

例如,假设我们有一个命令列表:

+----------------------------+
| cmd1 <param1> <parameter2> |
+----------------------------+
    This command blah blah ...

    Param1     : hsdfhdfjhs
    Parameter2 : fsfsfsfsd

    Full description ...

最上面的部分是一个漂亮的背景填充框。

我们可能有100个不同的格式的页面,我们希望能够改变所有的格式,只需在文件前面的某个地方做一个简单的改变。理想情况下,我们希望能够用 {command-header} 或 {command-params} 并自动应用一组样式。

问题2:如何进行目录、词汇表和索引条目?

问题3:我们能否以某种方式将此PDF的构建集成到Visual Studio 2008的构建过程中?

问题4:从tex源文件生成pdf有多简单(我们如何做)?

2 回复 | 直到 14 年前

1

2

Michael Madsen 14 年前

1)严格来说,除了(la)tex发行版之外,您不需要任何软件,但是一个专门的tex编辑器可能会有所帮助,特别是如果您不太习惯使用它的话。在这种情况下,你可能还会发现 the LaTeX Wikibook 乐于助人。

我建议你用乳胶代替普通的Tex,因为这样做没有什么意义。为了更好的分配,我个人使用跨平台 TeX Live 有一个完整的安装,但是还有其他的,比如 MiKTeX ,它将根据需要下载包。

2)您希望这样做的方法是定义一个或多个命令,这些命令将实际文本作为一组参数,并知道如何将它们转换为所需的布局。如果您想更改这些命令的格式,那么只需更改命令定义。

作为命令的一部分,您可以让它执行其他操作:每个命令的头可能只是 \section 或 \subsection 应用某种样式的标题。索引项使用 \index 命令,这样你也可以在里面工作。

对于术语表,我认为您需要将该部分与其他部分分开维护,但也可能在其中工作——如果有一个包也可以这样做,我不会感到惊讶。

3)是的,这不应该是一个问题-只需在项目设置中将其设置为后期生成事件。

4)相当简单。执行这组命令应该可以做任何事情(假定file.tex是“main”tex文件):

pdflatex file
bibtex file
makeindex file
pdflatex file
pdflatex file

如果你没有书目,那就把bibtex一行删掉。您需要运行pdflatex几次,以获得正确的引用。

默认情况下,生成会在出现错误时停止,以便您确定接下来应该发生什么。您可以使用 -interaction pdflatex参数-请参见 pdflatex -help 对于可能的选项。

2

1

High Performance Mark 14 年前

A1——你最好从安装乳胶(包括Tex)开始,而不仅仅是简单的ol'Tex。在微软的Windows系统上,我已经愉快地使用了Miktex好几年了,还有其他的安装可用。

A2——一旦建立了文档,就非常容易。宏中包含目录 \tableofcontents ,索引和词汇表需要您标记条目,然后它们的生成就几乎一样简单。

A4——非常简单,Miktex的安装包括一个程序(可能称为pdflatex),用于发送PDF而不是标准的DVI。

希望能让你开始。从头到头 CTAN 为了满足你所有的(la)tex需求,谷歌搜索 对乳胶的不那么简短的介绍。