Redmine 中文用戶手冊
此文章是 基於Redmine 0.9 版本編寫的
1 說明
關於手冊中方框標記部分的說明
- Note 是需要注意的部分。
- Hint 是羣英匯爲Redmine擴展的部分。
2 用戶賬號
-
我的賬號
此界面可以修改用戶的姓名、郵件地址、語言、以及時區和接收郵件的設置。
-
郵件通知
郵件通知的下拉框選項有:
- 只收取我跟蹤或參與的項目的通知
- 收取我的項目的所有通知
你可以根據自己的需要選擇不同的郵件通知策略
同時,你也可以選種下拉框下面的那個複選框(不要發送對我自己提交的修改的通知),這樣就可以避免接收到你自己活動的郵件通知。
-
我的工作臺
該頁面用於顯示你所參與的項目的各種信息塊。 默認情況下只有下面兩個模塊啓用:
-
指派給我的問題
提供一個跨項目的指派給當前用戶的問題列表,顯示問題的ID,項目,跟蹤標類型籤和主題。
-
已報告的問題
提供一個跨項目的由當前用戶報告的問題列表,顯示問題的ID,項目,跟蹤標籤類型和主題。 每一個用戶可以通過點擊"個性化定製本頁"的鏈接個性化我的工作臺。 然後用戶可以選擇哪些可用的模塊被顯示:
-
日曆
提供一個跨項目的每週日曆概述
-
文檔
提供一個跨項目的最近文檔概述
-
最近的新聞
提供一個跨項目的最近新聞概述
-
耗時
提供一個跨項目的關於當前用戶最近7天工時的概述
-
跟蹤的問題
提供一個跨項目的由當前用戶跟蹤的問題列表
-
-
忘記密碼
如果你忘記了密碼,可用點擊登錄界面上的"忘記密碼"鏈接, 然後填入你的郵箱地址, 點擊提交。 隨後你將收到一封郵件, 點擊該郵件裏的那個超鏈接, 你將跳到一個修改用戶密碼的界面, 輸入新密碼以及確認密碼。 這樣, 你就可以用剛纔新建的密碼登錄系統了。
Note
- 管理員可以禁用該功能
- 如果你的賬號使用了外部認證(如LDAP),同樣不能使用該功能。 因爲外部認證的密碼存儲在LDAP中, Redmine不能修改LDAP裏的信息。
-
註冊
點擊主頁右上角的"註冊"鏈接, 用戶可以自己註冊。 填寫好表單提交後你將收到一封激活賬號的郵件, 通過郵件裏的鏈接, 可以激活你剛註冊的賬號。
Note
- 該功能需要管理員開啓"允許自注冊"功能, 並選擇通過郵件激活賬號
3 登錄
點擊主頁右上角的"登錄"鏈接
可跳到登錄頁面
輸入登錄名和密碼, 點擊登錄按鈕, 即可進入系統。 .. hint:: 單點登錄功能
羣英匯給Redmine添加了單點登錄的功能:
- 該功能主要是省去了多個應用重複輸入登錄信息的麻煩, 免去了員工記憶多個賬號的煩惱。
- 加上單點登錄功能之後, 在一個應用中登錄之後, 不用再次輸入登錄名和密碼就可以訪問其他應用程序了(前提是你的所有應用都支持單點登錄),這樣在一定程度上減少了密碼的暴露機率, 提高了賬號的安全性。
4 註冊
該操作需要管理員開啓"允許用戶註冊"的功能
註冊用戶需要填寫的字段包括: 登錄名, 密碼, 名字, 姓氏和郵箱, 以及可選的用戶語言字段。
註冊流程
根據管理員的設置, 用戶的賬號由以下幾種激活方式:
-
通過郵件認證激活賬號
用戶註冊後, 將收到一封激活賬號的郵件, 通過點擊郵件裏的鏈接, 就可以激活剛註冊的郵件。
-
手動激活賬號
用戶註冊後, 需要等待管理員手動激活剛註冊的賬號。
-
自動激活賬號
用戶註冊後, 直接可以用剛纔註冊的賬號登錄系統。
6 項目活動
該頁面列出了該項目所有活動的歷史記錄, 這些活動包括:
- 問題
- 變更
- 新聞
- 文檔
- 文件
- Wiki編輯記錄
- 帖子
- 耗時
該頁面的右邊欄允許你選擇具體顯示哪類活動
如果你想要同時顯示子項目的活動, 那麼你需要選種"子項目"複選框。 .. hint:: 修改查看項目活動的基準時間
Redmine 將當天的日期作爲顯示項目活動的基準時間, 當你點擊"活動"選項卡時, 它會顯示前30天到當天的活動。
這樣會出現一個問題: 當項目連續30天沒有活動時, 項目活動首頁會出現空白頁。
羣英匯的修改: 將最後一次活動時間作爲基準時間, 這樣就避免了上述問題的發生。
7 問題跟蹤
問題是Redmine的核心業務。 一個問題綁定到一個項目, 由某一用於創建, 可以關聯到某一版本, 等等。
-
查看某一問題
在問題列表頁面點擊某一問題的鏈接, 可以查看該問題的具體描述。
-
相關的問題
允許開發者將某一問題與其他問題建立關聯, 從而起到了刪除重複問題, 簡化工作流的作用。 當前版本允許建立的關聯類型有:
-
關聯到
-
重複
如果問題B重複於A,那麼關閉A將自動關閉B。
-
阻擋
如果問題B阻擋A,A無法關閉,除非B已經關閉。
-
優先於
如果A優先於B,那麼將B的起始日期自動設置爲A的截至日期+延遲天數+1。
-
跟隨於
問題B跟隨於A(例如A截至於21/04,B開始於22/04),這時如果將A的截至日期延遲2天,那麼B的起始和截至日期將自動推遲2天。
點擊問題顯示頁面相關問題區域的"新增"鏈接, 可根據具體的情況建立不同類型的問題關聯。
管理員可以定義添加和修改問題關聯的權限
-
-
跟蹤者
點擊問題顯示頁面跟蹤者區域的"新增"鏈接, 在下拉列表裏選擇跟蹤者
管理員可以定義添加和刪除跟蹤者的權限
-
相關修訂
當提交代碼時在提交註釋中引用某一問題, 那麼稍後將會在該問題的顯示頁面中出現對於該次提交的描述信息。
具體那些使用那些關鍵字, 可以諮詢你們的管理員, 看他是如何配置的。
-
新建問題
要創建新的問題, 你需要有新建問題的權限
創建問題時, 最重要的字段是跟蹤標籤字段, 它決定了問題的類型。
默認情況下, Redmine有三種跟蹤標籤:
- 缺陷
- 功能
- 支持
-
更新已經存在的問題
要更新問題的屬性, 你需要有編輯問題的權限。
7.1 問題列表
-
過濾器的應用
默認情況下, 問題列表顯示了所有處於打開狀態的問題。 你可以添加過濾器, 點擊"應用"鏈接刷新問題列表, 點擊"清除"鏈接刪除設置的濾器。
你可以通過點擊那個小"+"號按鈕, 爲過濾器字段選擇多個值。 這時會出現一個選擇列表, 按住"ctrl"後, 可選擇多個值。
-
自定義查詢
當刷新頁面後, 剛設置的過濾器就會消失, 你可以通過點擊"保存"鏈接保存你設置的過濾器, 從而建立自定義查詢。
在新建自定義查詢的界面輸入自定義查詢的名稱, 以及過濾器和其他屬性的設置。
點擊保存之後, 新建的自定義查詢將會出現在問題列表界面的右邊欄中。
-
快捷菜單
在問題列表的某一個問題上, 點擊鼠標右鍵, 將彈出一個快捷菜單, 用於便捷編輯問題。
快捷菜單包含的選項有:
- 編輯
- 狀態
- 跟蹤標籤
- 優先級
- 目標版本
- 指派給
- 完成度
- 登記工時
- 跟蹤者
- 副本
- 複製
- 移動
- 刪除
-
批量編輯問題
在問題列表界面, 你可以通過選擇多個複選框, 也可以按住"ctrl"鍵的同時選擇多個問題, 然後點擊右鍵, 同樣會彈出一個快捷菜單, 可以對選中的多個問題同時編輯。 你也可以點擊複選框上面的那個"對號"圖標, 全選問題或則撤銷全選。
-
邊欄
問題列表的右側邊欄提供了幾種不同的功能鏈接:
-
問題區域
-
查看所有問題
該鏈接用於從自定義查詢頁面跳回問題列表頁面
-
摘要
從項目級別上查看問題的概述
-
日曆
日曆上顯示問題以及目標版本, 用於把握項目的進度。
-
甘特圖
顯示問題與時間的的二維圖表, 從而清晰地展現了項目的進度與當前的主要任務。
-
-
自定義查詢區域 (如果你建立了自定義查詢)
該區域列出了所有自定義查詢的鏈接
-
7.2 路線圖
路線圖提供了一個更高級別的基於項目版本的對於整個問題跟蹤系統的概述, 它可以幫助制定項目計劃, 管理項目開發。
-
概述
點擊"路線圖"選項卡, 你就可以查看當前項目的進展狀態:
-
版本名稱
-
版本的完成日期
-
進度條
根據問題狀態所佔的百分比(即問題的完成度), 統計出目標版本的完成度。
-
目標版本相關連的問題列表
-
-
管理路線圖
如果你的權限合適, 你可以爲版本添加一個wiki頁面(參考 項目版本), 用於描述當前版本的一些主要事件。
-
邊欄
路線圖頁面的右邊欄爲你提供了以下功能:
- 可以根據需要, 選擇路線圖上顯示哪些跟蹤標籤。
- 可以根據需要, 選擇是否顯示已經完成的版本
- 所有版本的鏈接
7.2.1 版本概述
版本概述提供了一個詳細的關於當前版本的狀態描述。 包括:
-
版本名稱
-
版本完成時間
-
版本的進度條
-
wiki(如果管理員配置了wiki頁面)
-
相關的問題列表
-
時間跟蹤區域
- 預期時間
- 耗時
-
分組顯示區域
可供分組顯示問題的選項有:
- 類別
- 跟蹤標籤
- 優先級
- 作者
- 指派給
8 實時跟蹤
實時跟蹤允許你跟蹤解決某一具體問題所花費的時間。 通過填寫預期時間, 項目經理可以根據你的進度更好地制定項目計劃。 同時實時跟蹤與項目成員建立了關聯, 從而有效的度量了每個成員的工作情況。
9 新聞
在"新聞"選項卡下, 你可以發佈關於項目的新聞條目, 甚至任何你喜歡的新聞條目。
新聞條目包含的字段有:
-
標題
-
概述
概述將和標題一起被顯示在項目概述頁面的 最近新聞 部分, 而詳細信息只有點擊了該新聞條目時才能看到。
-
詳細信息
如果你有創建新聞的權限, 那麼你就可以添加/編輯/刪除新聞。
12 討論區
討論區給項目成員之間提供一個交流的平臺。 管理員根據需要可以創建不同類別的討論區。
-
討論區列表頁面顯示的內容:
- 話題的總數
- 留言的總數
- 最後留言的鏈接
-
發起一個話題
點擊右上角的"新貼"鏈接, 進入新建貼子的頁面, 輸入主題和內容, 點擊創建按鈕, 一個新的話題就發起了。
話題有兩個可選選項:
- 置頂(sticky): 如果選中, 表示該話題將會在討論區列表置頂, 並加粗顯示
- 鎖定(locked): 如果選中, 表示該貼不允許用戶跟貼
13 Wikis
-
創建一個新的Wiki頁面
在任何一個wiki頁面,僅僅需要添加一個你想要創建的新頁面的鏈接。
[[MyNewPage]]
保存當前頁面,點擊剛添加的鏈接,恭喜:你已經成功創建了一個名爲"MyNewWikiPage"的新頁面。
-
保護wiki頁面
如果你擁有保護wiki頁面的權限,你可以點擊"鎖定"鏈接保護該Wiki頁面。
已經鎖定的wiki頁面只允許擁有保護wiki頁面權限的用戶編輯。
擁有此權限的用戶同樣可以爲該頁面解鎖。
-
Wiki頁面的歷史
Redmine保存每一次wiki頁面的改動歷史。 通過點擊"歷史"鏈接你可以瀏覽這些變更。
點擊變更的序列號可查看某一個具體版本的頁面信息。
你可以通過點擊"回退到這個版本"的鏈接回退該頁面到先前的版本。
14 Redmine wiki的文本格式
Redmine默認使用Textile作爲wiki的文本格式過濾器, 當然你也可以下載其他文本格式過濾器插件(Markdown, reST等)。 以下介紹的語法都是基於Textile 。
14.1 鏈接
14.1.1 Redmine鏈接
Redmine允許在任何wiki文本格式裏引用問題,變更集和wiki頁面的超鏈接。
- 鏈接到問題: #124 (顯示爲#124, 如果此問題已經關閉則顯示刪除線)。
- 鏈接到變更集: r758 (顯示爲r758)。
- 使用非數字的哈希值鏈接到變更集: commit:c6f4d0fd(顯示c6f4d0fd)。
14.1.2 wiki鏈接
- [[Guide]] 顯示一個鏈接到"Guide"的鏈接: Guide
- [[Guide|Use manual]] 顯示指向同一頁面的鏈接,鏈接顯示的文本是: Use manual
- [[Guide#Use-guide|Use guide]] 顯示指向同一頁面頭的鏈接,鏈接顯示的文本是: Use guide
可以加入指向其它項目wiki頁面的鏈接
- [[sandbox:some page]] 顯示一個指向Sandbox項目名稱爲"Some page"的wiki頁面的鏈接。
- [[sandbox:]] 顯示一個指向Sandbox項目Wiki主頁面的鏈接。
如果Wiki頁面不存在,則連接將顯示爲紅色。
14.1.3 鏈接到其他資源
- 文檔
- document#17 (鏈接到ID爲17的文檔)
- document:Geetings (鏈接到標題爲"Geetings"的文檔)
- document:"Some document" (當文檔標題含有空格時需要使用雙引號)
- 版本
- vesion#3 (鏈接到ID爲3的版本)
- vesion:1.0.0 (鏈接到名稱爲"1.0.0"的版本)
- vesion:"1.0 beta 2" (當版本名稱含有空格時需要使用雙引號)
- 附件
- attachment:file.zip (鏈接到當前頁面名稱爲 file.zip 的附件)
- 到目前爲止, 只能引用當前頁面的附件(如果您在編輯問題,則只能引用此問題的附件)
- 版本庫
- souce:some/file 鏈接到項目版本庫的 /some/file 文件
- souce:some/file@52 鏈接到項目版本庫 /some/file 文件的第52版本
- souce:some/file#L120 鏈接到項目版本庫 /some/file 文件的第120行
- souce:some/file@52#L120 鏈接到項目版本庫 /some/file 文件的第52版本的第120行
- expot:some/file 強制顯示該文件的下載鏈接
14.1.4 轉意字符
如果您不希望Redmine將上述標記解釋爲鏈接,可以在它們前面添加一個感嘆號:!
14.2 文本格式
對於標題、粗體、表格、列表, Redmine支持Textile語法。參考 http://www.textism.com/tools/textile/ 上對使用這些特徵的詳細信息。
下面列出一些例子:
14.2.1 字體樣式
*bold* 加粗
_italic_ 斜體
*_bold italic_* 加粗並斜體
+underline+ 下劃線
-strike-through- 刪除線
14.2.2 內嵌圖片
- !image_url! 顯示地址爲image_url的圖片(textile語法)
- !>image_url! 圖片右懸浮
- !{width:300px}image_url! 設置圖片的顯示寬度
如果你的wiki頁面有圖片附件,你可以使用文件名:!attached_image.png!顯示它。
14.2.3 標題
- h1. 一級標題
- h2. 二級標題
- h3. 三級標題
14.2.4 段落
- p>. 右對齊
- p=. 居中
14.2.5 塊引用
段落以 bq. 開始
14.2.6 無序列表
* Item 1
* Item 2
** Item 21
** Item 22
* Item 3
14.2.7 有序列表
# Item 1
# Item 2
# Item 3
## Item 3.1
## Item 3.2
14.2.8 表格
|_.UserID|_.Name|_.Group|
|\3=.IT|
|1|張三|/2.Users|
|2|李四|
|3|王五|Admin|
14.2.9 內容列表
{{toc}} => 內容列表左對齊
{{>toc}} => 內容列表右對齊
14.2.10 宏(Macros)
Redmine有以下內置宏:
-
子頁面
顯示子頁面列表。 當沒有參數時,將顯示當前wiki頁面的子頁面。 例如:
{{child_paegs}} 該功能只有在wiki頁面有效
{{child_pages(Foo)}} 列出Foo頁面的子頁面
{{child_paegs(Foo,parent=1)}} 和上面的功能一樣,只不過多了一個鏈到Foo頁面的鏈接 -
hello_world
一個宏示例
-
include
包含一個wiki頁面。例如:
{{include(Foo)}}
或者包含一個指定項目的wiki頁面:
{{include(projectname:Foo)}}
-
macro_list
顯示所有可用宏的列表,以及關於宏的描述。
-
代碼高亮顯示
代碼高亮顯示依賴 CodeRay http://coderay.rubychan.de/ ,它是一個完全用Ruby編寫的快速的語法高亮顯示庫。 目前支持的語言: c,html,javascript,rhtml,ruby,scheme,xml。
你可以用下面的語法高亮顯示ruby代碼:
<pre><code class='ruby'>
加入你的代碼
</code></pre>
Note
此功能僅在Wiki頁面有效
15 版本庫
點擊"版本庫"選項卡, 你可以瀏覽項目的版本庫以及最近的提交。
你可以通過打開目錄前面的"+"按鈕, 展開目錄。
你也可以點擊目錄鏈接進入該目錄。
點擊某一修訂號你可以查看該次提交的詳細信息。
想要瀏覽已知提交號的某一次提交的具體信息, 你可以將該提交號直接輸入右上角的輸入框裏, 按回車鍵即可查看。
15.1 版本庫統計
Redmine生成兩種關於變更和修訂數量的版本庫圖片。 上面的一幅按月份顯示變更和修訂數量; 下面的一幅按提交者顯示變更和修訂數量。
名詞解釋
- 修訂 是版本庫的提交次數, 顯示爲橘紅色。
- 變更 是對版本庫中文件的修改次數, 顯示爲藍色。
16 項目配置
該界面提供項目級別的配置, 可用的配置選項卡如下:
-
信息
在這裏可以設置
-
項目名稱
-
上級項目
指定該項目的父項目
在Redmine 0.9 版本之前, 只允許2級嵌套; 0.9版本之後, 可以無限嵌套。
-
項目描述
-
標識
由於Redmine支持多項目, 而且採用REST架構, 所以需要一個URL的唯一標識符。 這個值在創建項目時填寫, 且一旦創建成功就不能修改。
-
主頁
主頁鏈接會顯示在項目概述頁面中
-
是否公開
如果選中, 該項目將允許所有用戶瀏覽, 包括非項目成員的用戶。
如果不選, 只有項目成員纔有權限訪問。
-
跟蹤標籤
在這裏可以設置開啓哪些跟蹤標籤, 默認可用的有三種: 錯誤, 功能和支持。
管理員可以在管理界面添加跟蹤標籤的類型。
-
-
模塊
在這裏可以設置該項目開啓的功能模塊
-
成員
在這裏可以指定項目的成員, 以及他們的角色。
Redmine 0.9之後可以以組爲操作單元, 給組賦予角色, 添加到項目中。 這樣該組的所有成員都成爲該項目的成員, 且屬於相同的角色, 擁有一樣的權限。
-
版本
項目版本可以對變更進行跟蹤和計劃。 你可以給問題指定目標版本, 然後在路線圖中就能看到與改版本關聯的問題列表。
版本包括的屬性:
-
名稱
-
描述
-
狀態
這個屬性是Redmine-0.9添加的, 這些狀態控制問題如何被指定目標版本。
-
打開
默認值, 沒有限制
-
鎖定
不能再給該版本指定新的問題
-
關閉
不能再給該版本指定新的問題, 而且不能重新打開已經指定目標版本的問題。
-
-
Wiki頁面
可以將該版本的主要事件寫入Wiki裏, 以供瀏覽該版本時顯示 可選屬性 。
-
日期
版本的完成日期 可選屬性
-
共享
這個屬性是Redmine-0.9添加的, 該屬性決定該版本是否能被其他項目共享, 從而使其他項目的問題也可以指定到該版本 可選屬性 。
-
不共享
-
與子項目共享
所有子孫項目
-
與項目繼承層次共享
祖先以及子孫項目
-
與項目樹共享
根項目和所有子孫項目(與上面的等同)
-
與所有項目共享
私有項目與公開項目共享版本後, 私有項目的名稱將能夠別所有用戶看到。
在版本列表頁面點擊"關閉已完成的版本"鏈接, 那些處於完成狀態的版本(到達截至日期並且沒有處於打開狀態的問題)將自動關閉。
-
-
Hint
指定默認目標版本
在這裏可以給項目指定默認目標版本, 這是羣英匯爲Redmine添加的功能。
這樣可以省去在給項目創建問題時指定目標目標版本的繁瑣操作。
羣英匯的擴展靈活地與Redmine指定目標版本結合, 當你新建問題時, 如果感覺該問題不應該指定到默認的目標版本, 你也可以重新選擇其他的版本。
-
問題類別
問題類別功能可以有效組織管理項目的問題。
問題類別的屬性:
-
名字 必填字段
-
指派給
新建屬於該類別的問題將自動指派給該項目成員 可選字段 。
-
-
wiki
每一個項目擁有它自己的wiki。
-
版本庫
每一個項目能跟一個版本庫(SCM)建立關聯。 一旦版本庫配置成功, 你就可以點擊"版本庫"選項卡, 瀏覽版本庫的變更集了。 版本庫的變更集也能在活動頁面瀏覽到。
-
討論區
每一個項目可以有一個或者多個討論區。 討論區的屬性有:
- 名稱
- 描述
-
活動
默認情況下, 活動階段有"開發"和"測試"兩種類型, 管理員可以根據需要創建新的活動階段。
只有選中的活動階段纔會出現在登記工時頁面的下拉框中。