项目

常规

个人资料

操作
历史记录

指南 » 用户指南 »

Markdown格式化

以下为Markdown格式化。关于Textile格式化，请参阅Textile格式化。
目前默认不允许使用HTML标签。有关详细信息，请参阅#15520和#20497。关于当前Markdown格式化的其他限制，请参阅#16373和#21443。

链接

Redmine链接

Redmine允许在文本格式化使用的任何位置之间创建资源（维基页面、问题、文档等）的链接。

维基链接

  • [[指南]]显示指向“指南”页面的链接： 指南
  • [[指南#进一步阅读]]将您带到“进一步阅读”锚点。标题会自动分配锚点，以便您可以引用它们： 指南
  • [[指南|用户手册]]显示指向同一页面的链接，但文本不同： 用户手册
  • [[指南#用户指南|用户指南]]显示指向同一页面上不同文本的标题的链接： 用户指南

您还可以链接到另一个项目的维基页面（使用项目标识符）

  • [[sandbox:一些页面]]显示指向Sandbox维基中名为“一些页面”的页面的链接
  • [[sandbox:]]显示指向Sandbox维基主页面的链接

如果页面尚不存在，维基链接将显示为红色，例如：不存在页面。

指向其他资源的链接

  • 问题
    • 编号#124（问题链接：显示#124，如果问题已关闭，则链接将被划掉）
    • #124-6，或 #124#note-6（问题备注链接：显示#124-6，或#124#note-6）
  • 文档
    • 文档#17（链接到ID为17的文档）
    • 文档:Greetings（链接到标题为“Greetings”的文档）
    • 文档:"Some document"（当文档标题包含空格时，可以使用双引号）
    • 沙盒:文档:"Some document"（链接到项目标识符“沙盒”中标题为“Some document”的文档）
  • 版本
    • 版本#3（链接到ID为3的版本）
    • 版本:1.0.0（链接到名为“1.0.0”的版本）
    • 版本:"1.0 beta 2"（当版本名称包含空格时，可以使用双引号）
    • 沙盒:版本:1.0.0（链接到项目标识符“沙盒”中的版本“1.0.0”）
  • 附件
    • 附件:file.zip（链接到当前对象的附件file.zip）
    • 附件:"file name.zip"（当文件名包含非单词字符时，可以使用双引号）
    • 目前，只能引用当前对象的附件（如果您在问题中，则只能引用此问题的附件）
  • 更改集
    • r758（链接到更改集，显示r758）
    • commit:c6f4d0fd（链接到具有非数字散列的更改集）
    • svn1|r758（链接到具有多个仓库的项目中的特定仓库的更改集）
    • commit:hg|c6f4d0fd（链接到具有非数字散列的特定仓库的更改集）
    • 沙盒:r758（链接到另一个项目的更改集）
    • 沙盒:commit:c6f4d0fd（链接到具有非数字散列的另一个项目标识符的更改集）
  • 仓库文件
    • source:some/file（链接到项目仓库中位于/some/file的文件）
    • source:"some file"（链接到路径中包含非单词字符的文件）
    • source:some/file@52（链接到文件的修订版本52）
    • source:some/file@master（链接到分支master中的文件）
    • source:some/file#L120（链接到文件的第120行）
    • source:some/file@52#L120（链接到文件的修订版本52的第120行）
    • source:repo_identifier|some/file（链接到具有多个仓库的项目中的特定仓库的文件）
    • 沙盒:source:some/file（链接到项目标识符“沙盒”中的文件）
    • 沙盒:source:repo_identifier|some/file（链接到项目标识符“沙盒”中路径中包含非单词字符的特定仓库的文件）
    • export:some/file（强制下载文件）
  • 论坛
    • 论坛#2（链接到ID为2的论坛）
    • 论坛:Discussion（链接到名为“Discussion”的论坛）
    • 论坛:"Help and more"（当论坛名称包含空格时，可以使用双引号）
  • 论坛消息
    • 消息#1218（链接到ID为1218的消息）
  • 新闻条目
    • 新闻#1（链接到ID为1的新闻条目）
    • 新闻:Greetings（链接到名为“Greetings”的新闻条目）
    • 新闻："eCookbook 首次发布！" （当新闻条目名称包含空格时，可以使用双引号）
  • 项目
    • 项目#3 （链接到 ID 为 3 的项目）
    • 项目:someproject （链接到名为 "someproject" 的项目）
    • 项目："多词项目" （当项目名称包含空格时，可以使用双引号）
  • 用户
    • 托马斯·莱卡维耶 （链接到 ID 为 2 的用户）
    • 用户:jsmith （链接到登录名为 "jsmith" 的用户）
    • @jsmith （链接到登录名为 "jsmith" 的用户）

转义

  • 您可以通过在前面加上感叹号来防止 Redmine 链接被解析：！

外部链接

URLs（http、https、ftp 和 ftps）将自动转换为可点击的链接

URLs还可以使用与链接本身不同的文本

  • [Redmine 网站](https://redmine.ruby-lang.org.cn) -- 使用不同文本的外部链接： Redmine 网站
  • [![Redmine 网站](https://redmine.ruby-lang.org.cn/attachments/7069/Redmine_logo.png)](https://redmine.ruby-lang.org.cn) -- 链接到 URL 的带标题的外部图像

Redmine web site

电子邮件地址

电子邮件地址将自动转换为可点击的链接

可以在电子邮件链接中添加更复杂的电子邮件指令。可以定义默认主题、默认正文和 CC 信息。请注意，这些字段中的任何空格都需要替换为代码 %20。

文本格式

对于标题、粗体、表格、列表等，Redmine 支持以下 Markdown 语法。请参阅 http://daringfireball.net/projects/markdown/syntax、http://agea.github.io/tutorial.md/、http://stackoverflow.com/editing-help 了解有关使用这些功能的详细信息。以下是一些示例，但该引擎可以做到更多。有关转换，请参阅 Pandoc。使用的格式化程序是 Redcarpet formatter。

缩写

Markdown 不支持

字体样式

* **bold** __bold__
* *italic* _italic_
* ***bold italic*** ___bold italic___
* <ins>underline</ins>
* <del>strike through</del>
* Plain <sup>superscript</sup>
* Plain <sub>subscript</sub>
* `inline monospace`
* normal **bold** _italic_ normal;E=mc<sup>2</sup>
* normal<strong>bold</strong><em>italic</em>normal;E=mc<sup>2</sup>
* Escaping: \*\*bold\*\* \_italic\_ \`inlinemono\`
* <pre>**some lines**      some [link](https://redmine.ruby-lang.org.cn)</pre>
* <pre>\*\*some lines\*\*      some \[link](http\://www\.redmine\.org)</pre>

显示

  • 粗体 粗体
  • 斜体 斜体
  • 粗体斜体 粗体斜体
  • 下划线
  • 删除线
  • 普通 上标
  • 普通 下标
  • 内联等宽
  • 正常 粗体 斜体 正常;E=mc2
  • 正常粗体斜体正常;E=mc2
  • 转义：**粗体** _斜体_ `内联等宽`
  • some lines      some link
  • **some lines**      some [link](https://redmine.ruby-lang.org.cn)

注意：需要允许使用 HTML 标签（<strong>、<em>、<ins>、<del>、<sup>、<sub>）。有关详细信息，请参阅 #15520-16 和 #15520-17。
更明确地说，您需要修补 redmine，如 这篇帖子 中所述。

颜色

* <span style="color:red">red</span> <span style="color:green">green</span> <span style="color:yellow">yellow</span> <span style="color:#82B6E1">blue'ish</span>
* <span style="color:red">red</span><span style="color:green">green</span><span style="color:yellow">yellow</span><span style="color:#82B6E1">blue'ish</span>
* <span style="background-color:lightgreen">Lightgreen Background</span> <span style="background-color:yellow">Yellow Background</span>
* <span style="background-color:lightgreen">Lightgreen Background</span><span style="background-color:yellow">Yellow Background</span>

显示

  • 红色 绿色 黄色 类似蓝色
  • 红色绿色黄色类似蓝色
  • 浅绿色背景 黄色背景
  • 浅绿色背景黄色背景

注意： 需要允许使用HTML标签（<span>）。请参阅#15520-16和#15520-17以获取详细信息。
更明确地说，您需要修补 redmine，如 这篇帖子 中所述。

内联图片

  • ![](image_url) 在textile语法中显示位于image_url处的图片
  • ![替代文本](image_url "可选标题") 显示带有alt/title属性的图片
  • [![](image_url)](URL) 显示位于image_url处的图片，并添加链接URL

如果您将图片附加到Wiki页面，可以使用其文件名内联显示：![](attached_image.png)。

截至本文撰写时，Markdown没有指定图像尺寸的语法；如果这对您很重要，您可以使用常规HTML <img>标签。

  • <img style="float:right" src="URL"/>
  • <img style="width:100%" src="attached_image.png"/>

注意： 需要允许使用HTML标签（<img>）。请参阅#15520-16和#15520-17以获取详细信息。
更明确地说，您需要修补 redmine，如 这篇帖子 中所述。

标题

# Heading

## Subheading

### Subheading

or

Heading
=======

Subheading
----------

Redmine将为每个标题分配一个锚点，因此您可以使用"#Heading"、"#Subheading"等链接到它们。

段落

Markdown不支持段落的对齐。如果需要，请使用 <div> 标签。

left aligned
<div style="padding-left:1em;">
left ident 1em
</div>

<div style="padding-left:2em;">
left ident 2em
as well as for following lines
</div>

<div style="text-align:right;">
right aligned
</div>

<div style="padding-right:3em;text-align:right;">
right ident 3em
</div>

<div style="text-align:center;">
This is centered paragraph.
</div>

显示；

左对齐

左缩进 1em

左缩进 2em
以及后续行

右对齐

右缩进 3em

这是一个居中段落。

注意： 需要允许使用HTML标签（<div>）。请参阅#15520-16和#15520-17以获取详细信息。
更明确地说，您需要修补 redmine，如 这篇帖子 中所述。

水平线

----

显示

预格式化文本

 <pre>**Your text won't become bold**</pre>

显示

**Your text won't become bold**

引用

您可以在每行的开头使用 > 并堆叠它们以进行嵌套引用

>> 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是一个根据MVC模式（模型-视图-控制器）开发数据库支持的Web应用程序的全栈框架。
要上线，您只需要添加一个数据库和一个Web服务器。

太好了！

无序列表

无序列表使用星号（*）、加号（+）和连字符（-）作为列表标记

* Item 1
* Item 2
  * Item 21 (two spaces indentation)
  * Item 22
* Item 3

显示

  • 项目 1
  • 项目 2
    • 项目 21
    • 项目 22
  • 项目 3

有序列表

有序列表使用数字后跟句点。

1. Item 1
3. Item 2
2. Item 3
  1. Item 3.1 (two spaces)
  1. Item 3.2

显示

  1. 项目 1
  2. 项目 2
  3. 项目 3
    1. 项目 3.1
    2. 项目 3.2

请注意，您实际使用的标记列表的数字对输出没有影响。

任务列表

您可以使用common_mark格式添加任务列表项

 * [ ] Task title

或者通过点击工具栏中的"任务列表"图标。

目前，要检查项目，您需要使用编辑功能，我们将在不久的将来尝试通过点击复选框来实现这一点。

表格

|UserID (align right)|Name (align left)|Group (align center)|
|-------------------:|:----------------|:------------------:|
|2                   |John Smith       |                    |
|3                   |Dave Lopper      |A Team              |
|4                   |Robert Hill      |B Team              |

显示（所有多个空格都替换为1个空格）

UserID（右对齐） 名称（左对齐） 组（居中对齐）
2 John Smith
3 Dave Lopper A Team
4 Robert Hill B Team

目录

{{toc}} => left aligned toc
{{>toc}} => right aligned toc

请注意，toc标签需要在其上方和下方留一个空行，并且其前后不应有其他文本。

示例

h1. headLineOne

h2. something

{{toc}}

h2. something more

脚注

脚注非常类似于引用样式的链接：它由文本旁边的标记组成，例如

This is a sentence.[^1]
以及在其文档中任何位置单独一行的脚注定义，例如
[^1]: This is a footnote.

宏

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

代码高亮

默认代码高亮依赖于Rouge，这是一个纯Ruby编写的语法高亮库。它支持许多常用语言，如c、cpp (c++)、csharp (c#, cs)、css、diff (补丁，udiff)、go (golang)、groovy、html、java、javascript (js)、kotlin、objective_c (objc)、perl (pl)、php、python (py)、r、ruby (rb)、sass、scala、shell (bash, zsh, ksh, sh)、sql、swift、xml和yaml (yml)语言，其中括号中的名称是别名。有关支持语言的完整列表，请参阅RedmineCodeHighlightingLanguages。

您可以使用以下语法在Wiki页面上突出显示代码

``` ruby
Place your code here.
```

示例

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end

翻译

请注意，以下翻译可能不是最新的。如有需要，请参考原始英文文档。

由C S更新 10个月前 · 32次修订