visual-studio-2008 - 如何将 TeX 用于用户手册

Question

关闭。这个问题需要更多focused .它目前不接受答案。












想改善这个问题吗？更新问题，使其仅关注一个问题 editing this post .

3年前关闭。




Improve this question




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

当前我们拥有的是一些 MS Word 和一些 OpenOffice.org 文档的合并。虽然这已经足够了，但我们将在发布后大量重新做，为下一个版本做好准备。

我们对这两种解决方案(Word 或 OpenOffice)都不太满意，因为它们都有自己的局限性。管理层要求我们确定标记语言的使用，其中一部分正在研究 TeX。

基本上，我们想要将转换为 PDF 的纯文本文档(因为我们可以编写 shell 脚本来更改它们，比 VBA 或 OpenOffice 宏更容易)。我们需要对目录、索引和词汇表的支持，以及能够嵌入图像和具有全局样式，易于更改。

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

+----------------------------+
| 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 有多容易(以及我们如何做到)？

Answer 1

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 几次才能获得正确的引用。

默认情况下，构建会在出现错误时停止，让您确定接下来会发生什么。您可以使用 -interaction 更改此行为。 pdflatex 参数 - 见 pdflatex -help对于可能的选项。