Redmine用户手册.docx

Redmine用户手册.docx

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

Redmine用户手册

Redmine用户手册

目录

∙1   说明

∙2   用户账号

∙3   登录

∙4   注册

∙5   项目概述

∙6   项目活动

∙7   问题跟踪

∙7.1   问题列表

∙7.2   路线图

∙7.2.1   版本概述

∙7.3   日历

∙7.4   甘特图

∙8   实时跟踪

∙9   新闻

∙10   文档

∙11   文件

∙12   讨论区

∙13   Wikis

∙14   Redminewiki的文本格式

∙14.1   链接

∙14.1.1   Redmine链接

∙14.1.2   wiki链接

∙14.1.3   链接到其他资源

∙14.1.4   转意字符

∙14.1.5   外部链接

∙14.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   版本库

∙15.1   版本库统计

∙16   项目配置

1   说明

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

∙Note 是需要注意的部分。

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

2   用户账号

此界面可以修改用户的姓名、邮件地址、语言、以及时区和接收邮件的设置。

∙邮件通知

邮件通知的下拉框选项有：

∙只收取我跟踪或参与的项目的通知

∙收取我的项目的所有通知

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

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

∙我的工作台

我的工作台截图

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

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

∙指派给我的问题

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

∙已报告的问题

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

每一个用户可以通过点击"个性化定制本页"的链接个性化我的工作台。

然后用户可以选择哪些可用的模块被显示:

∙日历

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

∙文档

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

∙最近的新闻

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

∙耗时

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

∙跟踪的问题

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

∙忘记密码

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

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

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

Note

∙管理员可以禁用该功能

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

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

∙注册

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

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

Note

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

3   登录

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

可跳到登录页面

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

..hint:

:

 单点登录功能

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

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

∙加上单点登录功能之后,在一个应用中登录之后,不用再次输入登录名和密码就可以访问其他应用程序了（前提是你的所有应用都支持单点登录）,这样在一定程度上减少了密码的暴露几率,提高了账号的安全性。

4   注册

该操作需要管理员开启"允许用户注册"的功能

注册截图

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

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

注册流程

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

∙通过邮件认证激活账号

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

∙手动激活账号

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

∙自动激活账号

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

5   项目概述

项目概述截图

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

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

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

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

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页面）

∙相关的问题列表

∙时间跟踪区域

∙预期时间

∙耗时

∙分组显示区域

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

∙类别

∙跟踪标签

∙优先级

∙作者

∙指派给

7.3   日历

∙概述

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

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

在这里你可以看到一个任务状态的起止日期。

∙过滤器

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

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

7.4   甘特图

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

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

甘特图截图

8   实时跟踪

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

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

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

∙给问题登记工时

通过点击问题浏览页面上"登