Redmine-用户手册

Redmine用户手册作者:Silence网址:版本:1β日期:2011-06-0314:04:46版权信息:目录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讨论区13Wikis14Redminewiki的文本格式o14.1链接14.1.1Redmine链接14.1.2wiki链接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项目配置17Redmine与其他工具整合o17.1Redmine与TestLink的整合o17.2Redmine与TortoiseSVN的整合o17.3Redmine与Mylyn的整合17.3.1通用的Web仓库链接器(WebRepositoryconnector)17.3.1.1配置步骤17.3.1.1.1创建一个任务仓库(TaskRepository)17.3.1.1.2创建一个查询17.3.2Redmine专用的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)的历史记录按照时间顺序显示，即先提交的comments显示在前面，具体可参见下面的截图。按时间顺序（倒序）此时问题(issues)的历史记录按照时间顺序倒序显示，即先提交的comments显示在后面，具体可参见下面的截图。按时间顺序按时间顺序（倒序）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后,可选择多个值。自定义查询当刷新页面后,刚设置的过滤器就会消失,你可以通过点击保存链接保存你设置的过滤器,从而建立自定义查询。在新建自定义查询的界面输入自定义查询的名称,以及过滤器和其他属性的设置。点击保存之后,新建的自定义查询将会出现在问题列表界面的右边栏中。快捷菜单在问题列表的某一个问题上,点击鼠标右键,将弹出一个快捷菜单,用于便捷编辑问题。快捷菜单包含的选项有: