我们正在准备发布产品,我们必须修改用户指南。
我们现有的是一些MS Word和一些OpenOffice.org文档的合并。虽然这已足够,但我们将在发布后大规模重新执行此操作以准备下一个版本。
我们对这些解决方案(Word 或 OpenOffice)都不满意,因为它们都有自己的局限性。管理层已经责成我们确定使用标记语言,其中一部分正在研究TeX。
基本上,我们需要纯文本文档(因为我们可以编写shell脚本来比VBA或OpenOffice宏更容易地更改它们),这些文档将变成PDF。我们需要对TOC,索引和术语表的支持,以及能够嵌入图像和具有全局风格,易于更改。
例如,假设我们有一个命令列表:
+----------------------------+
| cmd1 <param1> <parameter2> |
+----------------------------+
This command blah blah ...
Param1 : hsdfhdfjhs
Parameter2 : fsfsfsfsd
Full description ...
,顶部是一个很好的背景填充框。
我们可能有100个不同页面的格式,我们希望能够通过简单的更改文件前面的某个地方来更改所有页面的格式。理想情况下,我们希望能够使用{command-header}
或{command-params}
标记某些文字,并自动应用一组样式。
问题1:为使这项任务尽可能简单,我们需要安装什么软件?显然TeX本身,但我们是否也应该使用别的东西?
问题2:您如何进行TOC,词汇表和索引条目?
问题3:我们能否以某种方式将此PDF的构建集成到Visual Studio 2008构建过程中?
问题4:从TeX源文件生成PDF有多容易(我们该怎么做)?
答案 0 :(得分:2)
1)严格来说,您不需要除(La)TeX发行版之外的任何软件,但专用的TeX编辑器可能会有所帮助,特别是如果您不习惯使用它。在这种情况下,您可能还会发现the LaTeX Wikibook有帮助。
我建议你使用LaTeX而不是普通的TeX,因为没有这样做是没有意义的。为了获得良好的分发,我个人使用跨平台TeX Live进行完整安装,但还有其他内容,如MiKTeX,它们将根据您的需要下载软件包。
2)你想要这样做的方法是定义一个或多个命令,它们将实际文本作为一堆参数,并知道如何将它们转换为所需的布局。如果要更改这些格式,则只需更改命令定义。
作为命令的一部分,您可以执行此操作:每个命令的标头可能只是\section
或\subsection
标头,您可以应用某些样式。索引条目使用\index
命令,因此您也可以使用它。
对于词汇表,我认为你需要将其与其他部分分开维护,但也可以将其作为一部分 - 如果有一个包也不会让我感到懊恼。
3)是的,这应该不是问题 - 只需在项目设置中将其作为构建后事件。
4)很简单。执行这组命令应该做所有事情(假设file.tex是“主”TeX文件):
pdflatex file
bibtex file
makeindex file
pdflatex file
pdflatex file
如果您没有参考书目,请忽略bibtex系列。您需要运行pdflatex几次才能获得正确的引用。
默认情况下,如果出现错误,构建会停止,以便您确定接下来会发生什么。您可以使用pdflatex使用-interaction
参数来更改此行为 - 有关可能的选项,请参阅pdflatex -help
。
答案 1 :(得分:1)
A1 - 你可能最好从安装LaTeX(包括TeX)开始,而不仅仅是简单的'TeX。在MS Windows上,我已经愉快地使用了MikTeX多年,其他安装也可用。
A2 - 一旦您设置了文档,就会非常轻松。宏\tableofcontents
中包含一个目录,索引和词汇表需要您标记条目,然后它们的生成几乎一样简单。
A4 - 非常简单,MikTeX安装包括一个程序(可能称为pdflatex)来发射PDF而不是标准的DVI。
希望能让你开始。转到CTAN以满足您的所有(La)TeX需求,谷歌浏览 LaTeX简介。