readmine的用户手册.docx

readmine的用户手册.docx

《readmine的用户手册.docx》由会员分享，可在线阅读，更多相关《readmine的用户手册.docx（48页珍藏版）》请在冰豆网上搜索。

readmine的用户手册

Redmine用户手册

作者:

北京群英汇信息技术有限公司

网址:

:

//、ossxp、/

版本:

1、0、0-11

日期:

2010-08-1311:

18:

52

版权信息:

∙1   说明

∙2   用户账号

o2、1   我得账号

o2、2   忘记密码

o2、3   注册

o2、4   我得工作台

∙3   登录

∙4   注册

∙5   项目概述

∙6   项目活动

∙7   问题跟踪

o7、1   问题列表

o7、2   路线图

▪7、2、1   版本概述

o7、3   日历

o7、4   甘特图

∙8   实时跟踪

∙9   新闻

∙10   文档

∙11   文件

∙12   讨论区

∙13   Wikis

∙14   Redminewiki得文本格式

o14、1   链接

▪14、1、1   Redmine链接

▪14、1、2   wiki链接

▪14、1、3   链接到其她资源

▪14、1、4   转意字符

▪14、1、5   外部链接

o14、2   文本格式

▪14、2、1   字体样式

▪14、2、2   内嵌图片

▪14、2、3   标题

▪14、2、4   段落

▪14、2、5   块引用

▪14、2、6   无序列表

▪14、2、7   有序列表

▪14、2、8   表格

▪14、2、9   内容列表

▪14、2、10   宏（Macros）

∙15   版本库

o15、1   版本库统计

∙16   项目配置

∙17   Redmine与其她工具整合

o17、1   Redmine与TestLink得整合

o17、2   Redmine与TortoiseSVN得整合

o17、3   Redmine与Mylyn得整合

▪17、3、1   通用得Web仓库链接器（WebRepositoryconnector）

▪17、3、1、1   配置步骤

▪17、3、1、1、1   创建一个任务仓库（TaskRepository）

▪17、3、1、1、2   创建一个查询

▪17、3、2   Redmine专用得Redmine-MylynConnector

▪17、3、2、1   插件得依赖关系:

▪17、3、2、2   客户端安装

▪17、3、2、3   服务器端安装

▪17、3、2、4   配置步骤

▪17、3、2、4、1   在Eclipse中添加任务仓库

▪17、3、2、4、2   为刚创建得任务仓库添加查询

1   说明

关于手册中方框标记部分得说明

∙Note 就是需要注意得部分。

∙Hint 就是群英汇为Redmine扩展得部分。

2   用户账号

2、1   我得账号

我得账号截图

∙信息

该区域用于修改用户得姓名、邮件地址与语言设置。

∙邮件通知

邮件通知得下拉框选项有:

o只收取我跟踪或参与得项目得通知

o收取我得项目得所有通知

您可以根据自己得需要选择不同得邮件通知策略

同时,您也可以选种下拉框下面得那个复选框（不要发送对我自己提交得修改得通知）,这样就可以避免接收到您自己活动得邮件通知。

∙首选项

o隐藏我得邮件地址

如果选中,那么在显示您个人信息得页面将不会显示您得邮件地址。

o时区

用于设置您所在得时区,以便更好显示您得活动时间。

o显示注释

用于设置注释显示得顺序。

▪按时间顺序

此时问题（issues）得历史记录按照时间顺序显示,即先提交得ments显示在前面,具体可参见下面得截图。

▪按时间顺序（倒序）

此时问题（issues）得历史记录按照时间顺序倒序显示,即先提交得ments显示在后面,具体可参见下面得截图。

按时间顺序

按时间顺序（倒序）

2、2   忘记密码

如果您忘记了密码,可用点击登录界面上得"忘记密码"链接,然后填入您得邮箱地址,点击提交。

随后您将收到一封邮件,点击该邮件里得那个超链接,您将跳到一个修改用户密码得界面,输入新密码以及确认密码。

这样,您就可以用刚才新建得密码登录系统了。

Note

∙管理员可以禁用该功能

∙如果您得账号使用了外部认证（如LDAP）,同样不能使用该功能。

因为外部认证得密码存储在LDAP中,Redmine不能修改LDAP里得信息。

2、3   注册

点击主页右上角得"注册"链接,用户可以自己注册。

填写好表单提交后您将收到一封激活账号得邮件,通过邮件里得链接,可以激活您刚注册得账号。

Note

∙该功能需要管理员开启"允许自注册"功能,并选择通过邮件激活账号

2、4   我得工作台

点击主页左上角得"我得工作台"链接,页面将跳转得当前用户得工作台。

我得工作台截图

该页面用于显示您所参与得项目得各种信息块。

默认情况下只有下面两个模块启用:

∙指派给我得问题

提供一个跨项目得指派给当前用户得问题列表,显示问题得ID,项目,跟踪标签类型与主题。

∙已报告得问题

提供一个跨项目得由当前用户报告得问题列表,显示问题得ID,项目,跟踪标签类型与主题。

Hint

群英汇为我得工作台添加了 任务日程安排 模块,同时修改了默认得布局:

∙上面:

任务日程安排

∙左边:

跟踪得问题

∙右边:

已报告得问题

当指派给您得问题太多时, 指派给我得问题 区域中得问题显得杂乱无章,从而令您不知从哪一个问题先下手。

此时得您或许会想起了Mylyn（主要用于管理您得任务,设置日程安排）:

如果Redmine有Mylyn得功能,那么我得工作就井井有条了。

群英汇为Redmine添加得Mylyn日程安排功能,正就是在这种呼声中诞生得。

该功能主要借鉴于Mylyn,因此如果您使用过Mylyn,那么您将会很熟悉该功能。

功能介绍:

∙该模块会显示从当前日期开始一周得每一天以及本周（从本周一到本周日）、下周（从下周一到下周日）、下下周（从下下周一到下下周日）、未来（下下周以后）与None（没有设置计划日期得任务将显示在该组）这些组。

∙如果该组没有安排任务,则不会显示。

∙当前日期（今天）那一组不仅仅只显示规划到今天得任务,而且还会显示那些已经超过完成日期而未完成得任务（并用红色圆圈叹号图标标识）,以及那些已经超过计划日期而未完成任务（并用黄色三角叹号图标标识）

∙同时对于那些计划日期设置在完成日期之后得任务,在分组时以完成日期为标准。

操作说明:

在 None 组中选择某一问题或者多个问题（注意多个问题要在同一个项目,否则将会操作失败。

因为Redmine目前还不支持跨项目批量修改问题）,点击鼠标右键,在弹出菜单中选择 计划日期 选项,进而在二级菜单中设置计划日期。

如果设置成功,系统提示 更新成功 ,而且点击所设置得计划日期组,会发现该组多了一个任务,如下图红色方框圈中得内容。

同时,在项目得问题列表页面,如果该问题指派给您,那么当您点击鼠标右键时,在弹出菜单中会多出设置 计划日期 得选项。

否则不会显示该选项。

每一个用户可以通过点击"个性化定制本页"得链接,进入我得工作台设置界面。

在 我得工作台模块 下拉框中选择想要添加得模块,然后点击右侧得 新增 链接,完成模块添加。

同时在该页面可以通过拖拽,改变各个模块得布局。

最后别忘了点击右侧得 返回 链接退出自定义模式,Redmine将自动保存当前得布局。

下拉框中可选得模块有:

∙日历

提供一个跨项目得每周日历概述

∙文档

提供一个跨项目得最近文档概述

∙最近得新闻

提供一个跨项目得最近新闻概述

∙耗时

提供一个跨项目得关于当前用户最近7天工时得概述

∙跟踪得问题

提供一个跨项目得由当前用户跟踪得问题列表

3   登录

点击主页右上角得"登录"链接

可跳到登录页面

输入登录名与密码,点击登录按钮,即可进入系统。

Hint

单点登录功能

群英汇给Redmine添加了单点登录得功能:

∙该功能主要就是省去了多个应用重复输入登录信息得麻烦,免去了员工记忆多个账号得烦恼。

∙加上单点登录功能之后,在一个应用中登录之后,不用再次输入登录名与密码就可以访问其她应用程序了（前提就是您得所有应用都支持单点登录）。

这样在一定程度上减少了密码得暴露几率,提高了账号得安全性。

4   注册

Hint

群英汇集中管理平台,使用统一得用户注册平台

群英汇得集中管理平台,包含用户注册与帐号管理功能,与集中管理平台整合得应用需关闭用户注册功能。

即群英汇部署得Redmine,用户注册将跳转到集中管理平台。

如果管理员开启用户自注册,则允许用户在集中管理平台进行自注册,否则需要由管理员统一创建用户帐号。

下面就是Redmine内置得用户注册界面,该操作需要管理员开启"允许用户注册"得功能。

注册截图

注册用户需要填写得字段包括:

登录名,密码,名字,姓氏与邮箱,以及可选得用户语言字段。

注册流程

根据管理员得设置,用户得账号由以下几种激活方式:

∙通过邮件认证激活账号

用户注册后,将收到一封激活账号得邮件,通过点击邮件里得链接,就可以激活刚注册得邮件。

∙手动激活账号

用户注册后,需要等待管理员手动激活刚注册得账号。

∙自动激活账号

用户注册后,直接可以用刚才注册得账号登录系统。

5   项目概述

项目概述截图

该页面提供一个关于该项目得总体概述

∙左上角得问题跟踪区域列出了目前项中每一种问题跟踪标签得打开数量以及总共数量

∙在成员区域列出该项目组得所有成员

∙在最新新闻区域列出了项目得最新新闻

6   项目活动

项目活动截图

该页面列出了该项目所有活动得历史记录,这些活动包括:

∙问题

∙变更

∙新闻

∙文档

∙文件

∙Wiki编辑记录

∙帖子

∙耗时

该页面得右边栏允许您选择具体显示哪类活动

如果您想要同时显示子项目得活动,那么您需要选种"子项目"复选框。

Hint

修改查瞧项目活动得基准时间

Redmine将当天得日期作为显示项目活动得基准时间,当您点击"活动"选项卡时,它会显示前30天到当天得活动。

这样会出现一个问题:

当项目连续30天没有活动时,项目活动首页会出现空白页。

群英汇得修改:

将最后一次活动时间作为基准时间,这样就避免了上述问题得发生。

7   问题跟踪

问题就是Redmine得核心业务。

一个问题绑定到一个项目,由某一用户创建,可以关联到某一版本,等等。

∙查瞧某一问题

在问题列表页面点击某一问题得链接,可以查瞧该问题得具体描述。

∙子任务

该功能在1、0版本引入。

可以将一个问题拆分为若干个子问题。

在使用redmine得过程中,可能有得用户会抱怨,只能将问题指派给一个项目成员,而不能指派给多个项目成员共同完成。

出现这种问题,从某种程度上来说,应该就是您划分问题/任务过于粗糙（粒度过大）,因此子任务功能就就是为用户提供拆分问题/任务得操作,从另一方面解决了将一个问题/任务指派给多人。

首先需要在 角色与权限 设置中为某些角色开启 管理子任务 功能,这样该角色得用户才有创建子任务得权力。

操作步骤:

o点击某一问题,进入问题查瞧页面。

然后点击子任务区域得 新增 链接,进入新建子任务页面。

o父任务字段得值系统自动获得,其她字段像创建问题一样输入,最后点击保存。

输入问题得描述信息

成功创建子任务

∙相关得问题

允许开发者将某一问题与其她问题建立关联,从而起到了删除重复问题,简化工作流得作用。

当前版本允许建立得关联类型有:

o关联到

o重复

如果问题B重复于A,那么关闭A将自动关闭B。

o阻挡

如果问题B阻挡A,A无法关闭,除非B已经关闭。

o优先于

如果A优先于B,那么将B得起始日期自动设置为A得截至日期+延迟天数+1。

o跟随于

问题B跟随于A（例如A截至于21/04,B开始于22/04）,这时如果将A得截至日期延迟2天,那么B得起始与截至日期将自动推迟2天。

点击问题显示页面相关问题区域得"新增"链接,可根据具体得情况建立不同类型得问题关联。

管理员可以定义添加与修改问题关联得权限

∙跟踪者

点击问题显示页面跟踪者区域得"新增"链接,在下拉列表里选择跟踪者

管理员可以定义添加与删除跟踪者得权限

∙相关修订

当提交代码时在提交注释中引用某一问题,那么稍后将会在该问题得显示页面中出现对于该次提交得描述信息。

相关修订截图

具体那些使用那些关键字,可以咨询您们得管理员,瞧她就是如何配置得。

∙新建问题

要创建新得问题,您需要有新建问题得权限

创建问题时,最重要得字段就是跟踪标签字段,它决定了问题得类型。

默认情况下,Redmine有三种跟踪标签:

o缺陷

o功能

o支持

∙更新已经存在得问题

要更新问题得属性,您需要有编辑问题得权限。

7、1   问题列表

∙概述

点击"问题"选项卡,默认您将瞧到该项目中所有处于打开状态得问题。

∙过滤器得应用

默认情况下,问题列表显示了所有处于打开状态得问题。

您可以添加过滤器,点击"应用"链接刷新问题列表,点击"清除"链接删除设置得滤器。

您可以通过点击那个小"+"号按钮,为过滤器字段选择多个值。

这时会出现一个选择列表,按住"ctrl"后,可选择多个值。

∙自定义查询

当刷新页面后,刚设置得过滤器就会消失,您可以通过点击"保存"链接保存您设置得过滤器,从而建立自定义查询。

在新建自定义查询得界面输入自定义查询得名称,以及过滤器与其她属性得设置。

点击保存之后,新建得自定义查询将会出现在问题列表界面得右边栏中。

∙快捷菜单

在问题列表得某一个问题上,点击鼠标右键,将弹出一个快捷菜单,用于便捷编辑问题。

快捷菜单包含得选项有:

o编辑

o状态

o跟踪标签

o优先级

o目标版本

o指派给

o完成度

o登记工时

o跟踪者

o副本

o复制

o移动

o删除

∙批量编辑问题

在问题列表界面,您可以通过选择多个复选框,也可以按住"ctrl"键得同时选择多个问题,然后点击右键,同样会弹出一个快捷菜单,可以对选中得多个问题同时编辑。

您也可以点击复选框上面得那个"对号"图标,全选问题或则撤销全选。

∙边栏

问题列表得右侧边栏提供了几种不同得功能链接:

o问题区域

▪查瞧所有问题

该链接用于从自定义查询页面跳回问题列表页面

▪摘要

从项目级别上查瞧问题得概述

▪日历

日历上显示问题以及目标版本,用于把握项目得进度。

▪甘特图

显示问题与时间得得二维图表,从而清晰地展现了项目得进度与当前得主要任务。

o自定义查询区域（如果您建立了自定义查询）

该区域列出了所有自定义查询得链接

7、2   路线图

路线图提供了一个更高级别得基于项目版本得对于整个问题跟踪系统得概述,它可以帮助制定项目计划,管理项目开发。

∙概述

点击"路线图"选项卡,您就可以查瞧当前项目得进展状态:

o版本名称

o版本得完成日期

o进度条

根据问题状态所占得百分比（即问题得完成度）,统计出目标版本得完成度。

o目标版本相关连得问题列表

∙管理路线图

如果您得权限合适,您可以为版本添加一个wiki页面（参考 项目版本）,用于描述当前版本得一些主要事件。

∙边栏

路线图页面得右边栏为您提供了以下功能:

o可以根据需要,选择路线图上显示哪些跟踪标签。

o可以根据需要,选择就是否显示已经完成得版本

o所有版本得链接

7、2、1   版本概述

版本概述提供了一个详细得关于当前版本得状态描述。

包括:

∙版本名称

∙版本完成时间

∙版本得进度条

∙wiki（如果管理员配置了wiki页面）

∙相关得问题列表

∙时间跟踪区域

o预期时间

o耗时

∙分组显示区域

可供分组显示问题得选项有:

o类别

o跟踪标签

o优先级

o作者

o指派给

7、3   日历

∙概述

在问题列表页面,点击右边栏得"日历"链接,即可进入日历界面。

日历提供了一个按月份显示得项目预览。

在这里您可以瞧到一个任务状态得起止日期。

∙过滤器

像Redmine提供得其她视图一样,您可以通过设置过滤器从而决定日历图上显示得内容。

过滤器得用法可以参见 过滤器

7、4   甘特图

在问题列表页面,点击右边栏得"甘特图"链接,即可进入甘特图界面。

甘特图显示问题得起止日期以及版本得截至日期

甘特图截图

8   实时跟踪

实时跟踪允许您跟踪解决某一具体问题所花费得时间。

通过填写预期时间,项目经理可以根据您得进度更好地制定项目计划。

同时实时跟踪与项目成员建立了关联,从而有效得度量了每个成员得工作情况。

∙给问题登记工时

通过点击问题浏览页面上"登记工时"得链接,可以给该问题登记工时。

预计耗时字段可填入得时间格式如下:

o整数格式得小时与分钟:

1,1h,1hour,2hours,30m,30min,1h30,1h30m,1:

30

o小数格式得小时:

1、51,5（等于1h30）

您也可以在更新问题时填入工时

∙项目级别得登记工时

如果登记工时时问题字段为空,那么该工时就属于整个项目得工时。

9   新闻

在"新闻"选项卡下,您可以发布关于项目得新闻条目,甚至任何您喜欢得新闻条目。

新闻条目包含得字段有:

∙标题

∙概述

概述将与标题一起被显示在项目概述页面得 最近新闻 部分,而详细信息只有点击了该新闻条目时才能瞧到。

∙详细信息

如果您有创建新闻得权限,那么您就可以添加/编辑/删除新闻。

10   文档

在这里可以书写不同类型得文档,默认有两种文档类型:

∙用户文档

∙技术文档

管理员可以添加文档类型

11   文件

在这里可以上传项目需要用到得其她资源,如图片,视频等等。

12   讨论区

讨论区给项目成员之间提供一个交流得平台。

管理员根据需要可以创建不同类别得讨论区。

∙讨论区列表页面显示得内容:

o话题得总数

o留言得总数

o最后留言得链接

∙发起一个话题

点击右上角得"新贴"链接,进入新建贴子得页面,输入主题与内容,点击创建按钮,一个新得话题就发起了。

话题有两个可选选项:

o置顶（sticky）:

如果选中,表示该话题将会在讨论区列表置顶,并加粗显示

o锁定（locked）:

如果选中,表示该贴不允许用户跟贴

13   Wikis

∙创建一个新得Wiki页面

在任何一个wiki页面,仅仅需要添加一个您想要创建得新页面得链接。

[[MyNewPage]]

保存当前页面,点击刚添加得链接,恭喜:

您已经成功创建了一个名为"MyNewWikiPage"得新页面。

∙保护wiki页面

如果您拥有保护wiki页面得权限,您可以点击"锁定"链接保护该Wiki页面。

已经锁定得wiki页面只允许拥有保护wiki页面权限得用户编辑。

拥有此权限得用户同样可以为该页面解锁。

∙Wiki页面得历史

Redmine保存每一次wiki页面得改动历史。

通过点击"历史"链接您可以浏览这些变更。

点击变更得序列号可查瞧某一个具体版本得页面信息。

您可以通过点击"回退到这个版本"得链接回退该页面到先前得版本。

14   Redminewiki得文本格式

Redmine默认使用Textile作为wiki得文本格式过滤器,当然您也可以下载其她文本格式过滤器插件（Markdown,reST等）。

以下介绍得语法都就是基于Textile 。

14、1   链接

14、1、1   Redmine链接

Redmine允许在任何wiki文本格式里引用问题,变更集与wiki页面得超链接。

∙链接到问题:

#124（显示为#124,如果此问题已经关闭则显示删除线）。

∙链接到变更集:

r758（显示为r758）。

∙使用非数字得哈希值链接到变更集:

mit:

c6f4d0fd（显示c6f4d0fd）。

14、1、2   wiki链接

∙[[Guide]]显示一个链接到"Guide"得链接:

Guide

∙[[Guide|Usemanual]]显示指向同一页面得链接,链接显示得文本就是:

Usemanual

∙[[Guide#Use-guide|Useguide]]显示指向同一页面头得链接,链接显示得文本就是:

Useguide

可以加入指向其它项目wiki页面得链接

∙[[sandbox:

somepage]]显示一个指向Sandbox项目名称为"Somepage"得wiki页面得链接。

∙[[sandbox:

]]显示一个指向Sandbox项目Wiki主页面得链接。

如果Wiki页面不存在,则连接将显示为红色。

14、1、3   链接到其她资源

∙文档

odocument#17（链接到ID为17得文档）

odocument:

Geetings（链接到标题为"Geetings"得文档）

odocument:

"Somedocument"（当文档标题含有空格时需要使用双引号）

∙版本

ovesion#3（链接到ID为3得版本）

ovesion:

1、0、0（链接到名称为"1、0、0"得版本）

ovesion:

"1、0beta2"（当版本名称含有空格时需要使用双引号）

∙附件

oattachment:

file、zip（链接到当前页面名称为file、zip得附件）

o到目前为止,只能引用当前页面得附件（如果您在编辑问题,则只能引用此问题得附件）

∙版本库

osouce:

some/file链接到项目版本库得/some/file文件

osouce:

some/file52链接到项目版本库/some/file文件得第52版本

osouce:

some/file#L120链接到项目版本库/some/file文件得第120行

osouce:

some/file52#L120链接到项目版本库/some/file文件得第52版本得第120行

osouce:

"some file52#L120"如果URL中有空格,需要使用双引号来。

链接到项目版本库somefile文件得第52版本得第120行

oexpot:

some/file强制显示该文件得下载链接

14、1、4   转意字符

如果您不希望Redmine将上述标记解释为链接,可以在它们前面添加一个感叹号:

!

14、1、5   外部链接

URLs与邮件地址将自动转换为可点击得链接

如果您想指定链接显示得文本,您可以使用标准得textile语法。

"群英汇":

:

//ossxp、

14、2   文本格式

对于标题、粗体、表格、列表,Redmine支持Textile语法。

参考 :

//、textism、/tools/textil