文字格式设置¶
- 目录
- 文字格式设置
链接¶
Redmine 链接¶
在任何可以使用文字格式设置的地方,Redmine 都允许在资源(问题、变更集、Wiki 页面...)间建立超链接。
- 链接到一个问题: #1 (显示 #1,如果该问题已结束,则使用删除线来显示链接)
- 链接到一个问题的笔记: #124-6,或 #124#note-6
- 链接到一个变更集: r758 (显示 r758)
- 链接到一个使用非数字哈希的变更集: commit:c6f4d0fd (显示 c6f4d0fd).
Wiki 链接
- [[指南]] 显示一个名为 '指南' 的页面链接: 指南
- [[指南|用户手册]] 使用不同的文字来显示相同页面的链接: 用户手册
- [[指南#用户指南|用户指南]] 使用不同的文字来显示相同页面中某个标题的链接: 用户指南
您也可以链接到其他项目的 Wiki 页面(使用项目的代码):
- [[sandbox:某些页面]] 显示 Sanbox 项目 Wiki 页面一个名为 '某些页面' 的链接
- [[sandbox:]] 显示 Sandbox 项目 Wiki 首页的链接
当页面不存在时,Wiki 链接会以红色方式显示,例如: 不存在页面.
链接到其他资源:
- 文件:
- document#17 (链接到编号为 17 的文件)
- document:Greetings (链接到标题为 "Greetings" 的文件)
- document:"Some document" (文件标题包含空格字符时,可以使用双引号来表示)
- sandbox:document:"Some document" (链接到 "sandbox" 项目中,标题为 "Some document" 的文件)
- 版本:
- version#3 (链接到编号为 3 的版本)
- version:1.0.0 (链接到名称为 "1.0.0" 的版本)
- version:"1.0 beta 2" (版本名称包含空格字符时,可以使用双引号来表示)
- sandbox:version:1.0.0 (链接到 "sandbox" 项目中,名称为 "1.0.0" 的版本)
- 附加文件:
- attachment:file.zip (链接到当前对象中,名称为 file.zip 的附加文件)
- attachment:"some file.zip" (文件名称包含空格字符时,可以使用双引号来表示)
- 目前,仅提供参考到当前对象中的附加文件 (如果您正位于一个问题中,仅可参考位于此问题中的附加文件)
- 变更集:
- r758 (链接到一个变更集)
- commit:c6f4d0fd (链接到一个使用非数字哈希的变更集)
- svn1|r758 (链接到指定存储机制中的变更集,用于使用多个存储机制的项目)
- commit:hg|c6f4d0fd (链接到指定存储机制中,使用非数字哈希的变更集)
- sandbox:r758 (链接到其他项目的变更集)
- sandbox:commit:c6f4d0fd (链接到其他项目中,使用非数字哈希的变更集)
- 存储机制中的文件:
- source:some/file (链接到项目存储机制中,位于 /some/file 的文件)
- source:some/file@52 (链接到此文件的 52 版次)
- source:some/file#L120 (链接到此文件的第 120 行)
- source:some/file@52#L120 (链接到此文件的 52 版次中的第 120 行)
- source:"some file@52#L120" (当 URL 包含空格字符时,可以使用双引号来表示)
(链接到指定存储机制中的此文件,用于项目使用多个存储机制时的情况) - source:repo_identifier|some/file (链接到其他存储机制中的文件,用于使用多个存储机制的项目)
- source:"repo_identifier|some file" (链接到其他存储机制中的文件,有空白字元的文件名)
- export:some/file (强制下载此文件)
- 论坛:
- 论坛#2(链接至编号为2的论坛)
- 论坛:Discussion(链接至名为 "Discussion" 的论坛)
- 论坛:"Help and more"(当论坛名称包含空格字符时,可以使用双引号来标记)
- 论坛信息:
- message#1218(链接至编号为1218的消息)
- 新闻项目:
- news#1(链接至编号为1的新闻项目)
- news:Greetings(链接至名为 "Greetings" 的新闻项目)
- news:"eCookbook first release !"(当新闻项目名称包含空格字符时,可以使用双引号来标记)
- 项目:
- project#3(链接至编号为3的项目)
- project:someproject(链接至名为 "someproject" 的项目)
- project:"Multiple words project"(当项目名称包含空格字符时,可以使用双引号来标记)
溢出字符:
- 您可以在文字前面加上感叹号 (!) 来避免该文字被解析成 Remine 链接
外部链接¶
HTTP 链接与电子邮件地址会自动转换为可点击的链接:
- https://redmine.ruby-lang.org.cn -- 外部链接到 redmine 网站: https://redmine.ruby-lang.org.cn
- [email protected] -- 链接到电子邮件地址: [email protected]
HTTP 链接也可以使用不同的文字来显示:
- "Redmine web site":https://redmine.ruby-lang.org.cn -- 使用不同文字的外部链接(标准的 textile 语法): Redmine web site
- !https://redmine.ruby-lang.org.cn/attachments/7069/Redmine_logo.png(Redmine web site)!:https://redmine.ruby-lang.org.cn -- 显示一个带有标题并链接至 URL 的外部图像:
电子邮件地址¶
电子邮件地址被自动转换为可点击的链接:
- "Email someone":mailto:[email protected] -- 以不同文字显示的电子邮件链接: Email someone
更复杂的电子邮件指令可以加入到电子邮件链接。可以定义一个默认的主题,默认的正文和 CC 信息。请注意,在这些字段中的任何空格字符需要替换为 %20。
- "Email webmaster and admin":mailto:[email protected][email protected] -- 发送电子邮件给 webmaster,CC 给 admin: Email webmaster and admin
- "Email someone for help":mailto:[email protected]?subject=Website%20Help -- 带有主题 "Website Help" 的电子邮件链接: Email someone for help
- "Email someone for help":mailto:[email protected]?subject=Website%20Help&body=My%20problem%20is%20 -- 带有主题 "Website Help" 和默认正文的电子邮件链接: Email someone for help
文字格式设置¶
对于标题、粗体、表格、列表等项目, Redmine 支持使用 Textile 语法 http://redcloth.org/hobix.com/textile/ 关于使用这些格式化功能的说明信息。下面包含了一些使用示例,但格式化引擎的处理能力远多于这些简单的示例。
首字母缩写字¶
JPL(Jean-Philippe Lang)
显示:
JPL
字体样式¶
* *bold*
* _italic_
* *_bold italic_*
* +underline+
* -strike-through-
* Plain ^superscript^
* Plain ~subscript~
* @inline monospace@
* normal *bold* _italic_ normal;E=mc ^2^
* normal<notextile></notextile>*bold*<notextile></notextile>_italic_<notextile></notextile>normal;E=mc<notextile></notextile>^2^
* Escaping: <notextile>*bold* _italic_ @inlinemono@</notextile> Alternative using HTML-codes: *bold* _italic_ @inlinemono@
* <pre>*some lines* some "link":https://redmine.ruby-lang.org.cn</pre>
* <pre><notextile></notextile>*some lines* some "link":https://redmine.ruby-lang.org.cn</pre>
显示:
- 粗体
- 斜体
- 粗体斜体
- 下划线
删除线- 普通 上标
- 普通 下标
内联等宽字体
- 正常 粗体 斜体 正常;E=mc 2
- 正常粗体斜体正常;E=mc2
- 转义: *粗体* _斜体_ @inlinemono@ 使用 HTML 代码的替代方法: *粗体* _斜体_ @inlinemono@
*some lines* some "link":https://redmine.ruby-lang.org.cn
some lines some link
颜色¶
* %{color:red}red% %{color:green}green% %{color:yellow}yellow% %{color:#82B6E1}blue'ish%
* %{color:red}red%<notextile></notextile>%{color:green}green%<notextile></notextile>%{color:yellow}yellow%<notextile></notextile>%{color:#82B6E1}blue'ish%
* %{background:lightgreen}Lightgreen Background% %{background:yellow}Yellow Background%
* %{background:lightgreen}Lightgreen Background%<notextile></notextile>%{background:yellow}Yellow Background%
显示:
- 红色 绿色 黄色 蓝色
- 红色绿色黄色蓝色
- 浅绿色背景 黄色背景
- 浅绿色背景黄色背景
内联图像¶
- !image_url! 显示位于 image_url 的图像(textile 语法)
- !>image_url! 右浮动图像
- !image_url(Image title)! 显示具有 alt/title 属性的图像
- !image_url!:URL 显示位于 image_url 的图像,并加入 URL 链接
如果您有图像文件附加到您的 wiki 页面,可以使用它的文件名来内联显示: !attached_image.png!
您也可以应用 CSS 样式到图像,与应用到 SPAN 相同。代码 !{width: 100%}attached_image.png! 将图像的大小调整为父元素的宽度。
标题¶
h1. Heading
h2. Subheading
h3. Subheading
Redmine 为每种标题指定一个 HTML 锚点 (anchor),因此您可以使用 "#Heading"、"#Subheading" 等方式链接到这些标题。
段落¶
p. left aligned
p(. left ident 1em
p((. left ident 2em
as well as for following lines
p>. right aligned
p)))>. right ident 3em
p=. This is centered paragraph.
水平线¶
----
显示:
预定格式¶
若要转义 wiki 语法
<pre> *您的文字將不會變成粗體字* </pre>
显示:
*您的文字將不會變成粗體字*
引用文字¶
使用 bq. 开始一个引文段落:
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
显示:
Rails 是一个遵循模型-视图-控制器模式的数据库支持型网络应用程序的全栈框架。
要上线,您只需要添加数据库和网络服务器。
您也可以在每一行的开头使用 >,然后堆叠它们进行嵌套引用:
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. >> To go live, all you need to add is a database and a web server. > Great!
显示:
Rails 是一个遵循模型-视图-控制器模式的数据库支持型网络应用程序的全栈框架。
要上线,您只需要添加数据库和网络服务器。Great!
项目列表¶
* Item 1 * Item 2 ** Item 21 ** Item 22 * Item 3
显示:
- 项目 1
- 项目 2
- 项目 21
- 项目 22
- 项目 3
编号列表¶
# Item 1 # Item 2 # Item 3 ## Item 3.1 ## Item 3.2
显示:
- 项目 1
- 项目 2
- 项目 3
- 项目 3.1
- 项目 3.2
表格¶
|_.UserID |_.Name |_.Group |_. attribute list | |Starting with | a | simple |row | |\3=.IT |<. align left | |1 |Artur Pirozhkov |/2.Users |>. align right | |2 |Vasya Rogov |=. center | |3 |John Smith |Admin (root) |^. valign top | |4 |- |Nobody (anonymous) |~. valign bottom |
显示(所有多个空白字符将被替换为一个空白):
UserID | 姓名 | 组 | 属性列表 |
---|---|---|---|
从 | a | 简单 | 行 |
IT | 左对齐 | ||
1 | Artur Pirozhkov | 用户 | 右对齐 |
2 | Vasya Rogov | 居中 | |
3 | John Smith | 管理员 (root) |
垂直居顶 |
4 | - | Nobody (匿名) |
垂直居底 |
如果您要在您的表格中(例如,wiki 链接)包含管道字符(|),您必须防止 textile 解释它们:
输入 | 输出 |
---|---|
<notextile>|</notextile> | | |
目录¶
{{toc}} => 靠左對齊目錄
{{>toc}} => 靠右對齊目錄
请记住,toc 标记的上一行和下一行必须是空白行,而且它的前后不能有其他文字。
示例:
h1. headLineOne
h2. something
{{toc}}
h2. something more
宏¶
Redmine 包含一个宏系统,允许您添加自定义函数,以在格式化文本中插入动态内容。您可以学习编写您自己的宏,在 RedmineMacros 。Redmine 已包含几个内置宏:
hello_world
Sample macro.
macro_list
Displays a list of all available macros, including description if available.
child_pages
Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples: {{child_pages}} -- can be used from a wiki page only {{child_pages(depth=2)}} -- display 2 levels nesting only {{child_pages(Foo)}} -- lists all children of page Foo {{child_pages(Foo, parent=1)}} -- same as above with a link to page Foo
include
Includes a wiki page. Examples: {{include(Foo)}} {{include(projectname:Foo)}} -- to include a page of a specific project wiki
collapse
Inserts of collapsed block of text. Examples: {{collapse This is a block of text that is collapsed by default. It can be expanded by clicking a link. }} {{collapse(View details...) With custom link text. }}
thumbnail
Displays a clickable thumbnail of an attached image. Default size is 200 pixels. Examples: {{thumbnail(image.png)}} {{thumbnail(image.png, size=300, title=Thumbnail)}} -- with custom title and size
issue
Displays an issue link including additional information. Examples: {{issue(123)}} -- Issue #123: Enhance macro capabilities {{issue(123, project=true)}} -- Andromeda - Issue #123: Enhance macro capabilities {{issue(123, tracker=false)}} -- #123: Enhance macro capabilities {{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123
sample_macro
Sample macro
代码高亮显示¶
代码高亮显示依赖于 CodeRay Ruby 所编写的。它目前支持 C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML 和 YAML 代码。
您可以在您的 wiki 页面中使用以下语法高亮显示代码:
<pre><code class="ruby">
Place your code here.
</code></pre>
示例:
# The Greeter class
class Greeter
def initialize(name)
@name = name.capitalize
end
def salute
puts "Hello #{@name}!"
end
end
Textile 格式化¶
Redmine 支持 textile 格式化。详细信息请参阅 Textile 语法
额外支持的 textiles:- %{background:lightgreen}绿色背景% 显示 绿色背景
由 chigeon null 更新 约9年前 · 2次修订