此插件通过使用LaTeX排版系统，为Redmine维基页面提供PDF导出和生成功能。但它不仅仅是一个简单的PDF导出器，因为它使用了LaTeX文本和图形布局引擎...

简要介绍...¶

下载当前版本（v0.0.3）： redmine_doc_pu_v003.zip

下载此文档作为PDF（由DocPu生成）： doc_pu_sample.pdf

屏幕截图

开始PDF页面¶

许可证¶

所有文档均根据WTFPL许可证条款发布。

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2004 Sam Hocevar <[email protected]>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO. 

DocPu，文档发布插件¶

此插件通过使用LaTeX排版系统，为Redmine维基页面提供PDF导出和生成功能。但它不仅仅是一个简单的PDF导出器，因为它使用了LaTeX文本和图形布局引擎，从而产生非常漂亮的页面布局。

功能：¶

• 将多个维基页面合并为单个PDF文档
• 自动生成封面页和目录
• 自动从所有粗体或斜体词生成索引
• 维基页面引用转换为PDF链接
• 支持Redmine代码块代码高亮显示
• 可以绘制实线表格边框
• 为每个维基页面添加章节
• 移除Redmine宏，例如{{toc}}
• 将维基脚注转换为LaTeX脚注
• 使用浮动或固定图像
• ...

DocPu使用并扩展了RedCloth4 LaTeX导出模块，它是Textile标记语言的转换器。

安装¶

由于DocPu使用LaTeX和RedCloth4，您必须首先安装它们。

安装RedCloth4¶

目前Redmine使用RedCloth3，因此您还需要安装RedCloth4。
最简单的解决方案是输入gem install RedCloth，但这仅适用于您已设置编译器的情况，因为部分代码是用C编写的。
对于Windows用户，可以从仓库中下载预编译的gem包。首先下载它，然后通过例如gem install RedCloth-4.2.2-x86-mswin32-60.gem进行安装

安装LaTeX¶

在Windows机器上，您可以下载并安装MikTeX LaTeX发行版。对于所有其他平台，请参阅http://www.latex-project.org/ftp.html。

DocPu需要以下LaTeX包，请确保您已安装它们

• listings
• ulem
• graphicx
• float
• multirow
• makeidx
• hyperref

测试LaTeX¶

在使用 DocPu 之前测试 LaTeX 安装是个好主意。创建一个空文件夹，并将插件模板目录（redmine_doc_pu/templates）中的 article_en_tcfi.tex 文件复制到其中。现在创建一个名为 document.tex 的空文件，然后可以使用 pdflatex article_en_tcfi.tex（或 path_to_latex/pdflatex）编译文档。文件应该能够成功编译，并显示消息。

Output written on article_en_tcfi.pdf (1 page, 28874 bytes).

安装 DocPu 插件¶

要安装 DocPu，只需下载并将其内容解压到 Redmine 插件目录中。现在从 Redmine 目录运行 rake db:migrate_plugins 并重新启动服务器。更详细的安装指南可以在这里找到。

配置 DocPu 插件¶

转到 Redmine 管理，选择 插件。您应该看到已安装的 DocPu 插件。现在选择 配置 并填写正确的 LaTeX 和 makeindex 二进制路径。

在这个例子中，LaTeX 和 makindex 二进制路径设置在 PATH 环境变量中。您也可以指定完整路径，例如在 Windows 上为 C:\Program Files\MiKTeX 2.7\miktex\bin\pdflatex.exe。

现在是时候设置 Redmine 中 DocPu 插件的 角色和权限。因此，转到管理并选择 角色和权限。您将看到一个名为 文档发布 的新类别，在该类别中，有 3 个不同的安全设置

• 查看文档：显示分配给项目的所有文档，如果禁用，则项目菜单 发布 不会显示。
• 构建文档：构建文档，允许执行 LaTeX 二进制文件的权限。
• 编辑文档：编辑文档，这也包括创建、编辑和删除文档。

最后一步是在项目设置中启用 文档发布 模块。

DocPu 语法¶

DocPu 主要使用 Redmine/Textile 语法，并有一些小的扩展。

字体样式和列举¶

您可以使用 Redmine wiki 支持的所有字体样式，例如 粗体、斜体、下划线 或 删除线 文本。也支持像 链接 这样的链接。

• 一个列举
• 另一个列举
  • 一个子列举
  • 另一个子列举

所有列举都受支持。

1. 列举 1
2. 列举 2
3. 列举 3

• 描述：一个简单的描述文本。
• 更多描述：另一个更长的描述文本。另一个更长的描述文本。另一个更长的描述文本。另一个更长的描述文本。另一个更长的描述文本。

图像¶

图像位置可以是固定的或浮动的。固定图像出现在它们定义的文本位置。浮动图像将由 LaTeX 根据页面布局指南进行调整。还支持使用替代文本字段进行图像标题。

• 固定图像： !image.jpg!
• 浮动图像： !>image.jpg!
• 带标题的固定图像： !image.jpg(标题文本在这里)!

您也可以通过写入 {{!image.jpg!}} 创建图像的引用，参见图 {{!poo_sample_fix.jpg!}}。

表格¶

DocPu 支持带有表格跨度和标题的 Redmine/Textile 表格语法。

|_.UserID|_.Name|_.Group|
|\3=.IT|
|\2=.IT|Test|
|1|Artur Pirozhkov|/2.Users|
|2|Vasya Rogov|
|3|John Smith|Admin|

示例:¶

此表格是从上面的代码生成的。

UserID	Name	Group
IT
IT		Test
1	Artur Pirozhkov	Users
2	Vasya Rogov
3	John Smith	Admin

代码高亮¶

代码高亮也支持使用LaTeX listings包。所有CodeRay语言都受支持。

<pre><code class="ruby">
</code>

示例：¶

此列表是从上面的代码生成的。

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end

维基页面引用和脚注¶

DocPu¹的另一个功能是生成维基页面引用。只需写下[[WikiPage]]或[[WikiPage|我的页面名称]]即可添加维基页面引用。
例如，请参阅DocPuSample部分或我的页面名称。

¹这是一个脚注。