嵌入式插件¶

描述¶

此插件允许您将HTML文件（例如，文档、测试报告...）嵌入到您的项目中。

它内置了以下文件的模板以方便显示：Doxygen和Javadoc文档以及Rcov覆盖率报告。除非它们包含HTML框架，否则可以显示任何其他HTML文件。

它添加了一个新的权限“查看嵌入式文档”和一个新的模块“嵌入式”，可以在项目级别启用/禁用。

要求¶

此插件需要Redmine r1659或更高版本，并运行Rails 2.1。由于插件API的一些更改，它不会与0.7.x版本一起工作。

安装¶

您可以通过在redmine目录中运行以下命令来安装插件

ruby script/plugin install http://redmine.rubyforge.org/svn/plugins/embedded

然后重新启动Redmine。

配置¶

1. 前往 管理 -> 插件 -> 嵌入式 -> 配置 以配置插件

• HTML目录：输入每个项目中可以找到HTML文件的根目录。您可以在路径中使用此标签：{PROJECT} 来表示项目标识符。应用程序需要对此路径有读取访问权限。
  例如，如果您有一个类似下面的目录结构，其中foo和bar是2个项目，则此设置应设置为/var/{PROJECT}/doxygen

-var
 |-bar
 | |-doxygen
 |  |-doc.html
 |  |-index.html
 |   
 |-foo
   |-doxygen
     |-doc.html
     |-index.html
     |-subdirectory
       |-index.html
       |-misc.html

• 索引文件：默认显示的文件名列表，用空格分隔。

• 有效扩展名：可以显示的文件扩展名列表，用空格分隔。将拒绝访问具有不同扩展名的文件。

• 默认模板：显示文件时将使用的默认模板（样式表和javascript）。
  如果您有多种类型的文档（例如，Doxygen和Rdoc文件），可以使用文件路径来检测要使用的模板。例如，位于包含doxygen（如上面的示例）的路径中的文件将自动使用Doxygen模板显示。

• 编码：如果文件不是UTF-8编码，请输入文件的编码。文件将被重新编码为UTF-8以在Redmine中正确显示。

• 选项卡标题：用于添加到项目菜单的导航选项卡中的文本。
  如果此字段留空，则不会添加导航选项卡。这样，您可以从维基链接到页面。

2. 前往 管理 -> 角色和权限 以将新权限分配给您的角色。

3. 在项目设置中启用模块。

注释¶

• 如果您启用了导航标签页，请确保您输入的索引文件之一（例如 index.html）存在于项目的根目录中，否则点击此标签页将导致404错误。

• 访问嵌入式页面的URL模式为：/embedded/:project/:path，其中:project是项目标识符，:path是相对于插件设置中输入的HTML目录的嵌入式文件的路径。
  以下示例基于上述目录结构和将HTML目录设置为/var/{PROJECT}/doxygen。

URL:
/embedded/foo                           => displays /var/foo/doxygen/index.html
/embedded/foo/index.html                => same as above
/embedded/foo/subdirectory              => displays /var/foo/doxygen/subdirectory/index.html
/embedded/foo/subdirectory/misc.html    => displays /var/foo/doxygen/subdirectory/misc.html

• 您可以通过向插件的/assets/stylesheets目录添加样式表来定义新的模板。需要重新启动应用程序。