嵌入式外掛¶

描述¶

此插件允許您將 HTML 檔案（例如文件、測試報告...）嵌入您的專案中。

它具有內建範本，可以良好地顯示以下檔案：Doxygen 和 Javadoc 文件以及 Rcov 覆蓋率報告。除非包含 HTML 框架，否則也可以顯示任何其他 HTML 檔案。

它新增了一個新的權限「檢視嵌入式文件」和一個新的模組「嵌入式」，可以在專案級別啟用/停用。

需求¶

此插件需要執行 Rails 2.1 的 Redmine r1659 或更高版本。由於插件 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 中正確顯示。

• **標籤標題**：用於新增到專案選單的導航標籤的文字。
  如果此欄位留空，則不會新增導航標籤。這樣，您可以從您的 Wiki 連結到這些頁面。

2. 前往「管理 -> 角色和權限」將新權限授予您的角色。

3. 在專案設定中啟用模組。

註釋¶

• 如果您啟用了導航標籤，請確保您輸入的其中一個索引文件（例如 index.html）存在於您專案的根目錄中，否則點擊此標籤將會導致 404 錯誤。

• 用於訪問嵌入頁面的網址格式為：/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 目錄來定義新的模板。需要重新啟動應用程序。