Textile格式化¶
以下是Textile格式化。有关Markdown格式化的信息,请参阅RedmineTextFormattingMarkdown。
有关当前Textile支持的限制,请参阅#6269,#10078(定义列表)。
链接¶
Redmine链接¶
Redmine允许在文本格式化中使用的地方进行资源(维基页面、问题、文档等)之间的超链接。
维基链接
- [[Guide]] 显示名为“指南”的页面链接: 指南
- [[Guide#further-reading]] 带您前往“further-reading”锚点。标题会自动分配锚点,以便您引用: 指南
- [[Guide|用户手册]] 显示指向同一页面的链接,但文本不同: 用户手册
- [[Guide#User-guide|用户指南]] 显示指向同一页面上的不同文本的标题链接: 用户指南
您还可以链接到其他项目的维基页面的页面(使用项目标识符)
- [[sandbox:some page]] 显示指向Sandbox维基名为“Some page”的页面链接
- [[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)
- 提交:c6f4d0fd(链接到具有非数字散列的更改集)
- svn1|r758(链接到特定存储库的更改集,对于具有多个存储库的项目)
- 提交:hg|c6f4d0fd(链接到具有特定存储库的非数字散列的更改集)
- 沙箱:r758(链接到另一个项目的更改集)
- 沙箱:提交:c6f4d0fd(链接到另一个项目标识符的更改集)
- 存储库文件
- 源:some/file(链接到项目存储库中位于/some/file的文件)
- 源:"some file"(链接到路径中包含非单词字符的文件)
- 源:some/file@52(链接到文件的修订版本52)
- 源:some/file@master(链接到分支master中的文件)
- 源:some/file#L120(链接到文件的第120行)
- 源:some/file@52#L120(链接到文件的修订版本52的第120行)
- 源:repo_identifier|some/file(链接到具有多个存储库的项目中的特定存储库的文件)
- 沙箱:源:some/file(链接到项目标识符“沙箱”中的文件)
- 沙箱:源:repo_identifier|some/file(链接到项目标识符“沙箱”中路径中包含非单词字符的特定存储库的文件)
- 导出:some/file(强制下载文件)
- 论坛
- 论坛#2(链接到ID为2的论坛)
- 论坛:Discussion(链接到名为“Discussion”的论坛)
- 论坛:"Help and more"(当论坛名称包含空格时可以使用双引号)
- 论坛消息
- 消息#1218(链接到ID为1218的消息)
- 新闻条目
- 新闻#1(链接到ID为1的新闻条目)
- 新闻:Greetings(链接到名为“Greetings”的新闻条目)
- 新闻:"eCookbook first release !"(当新闻条目名称包含空格时可以使用双引号)
- 项目
- 项目#3(链接到ID为3的项目)
- 项目:someproject(链接到名为“someproject”的项目)
- 项目:"Multiple words project"(当项目名称包含空格时可以使用双引号)
- 用户
- Thomas Lecavelier(链接到ID为2的用户)
- 用户:jsmith (链接到用户“jsmith”)
- @jsmith (链接到用户“jsmith”)
转义
- 您可以在链接前加上感叹号来防止Redmine链接被解析:!
外部链接¶
URL(http、https、ftp和ftps)会自动转换为可点击链接- https://redmine.ruby-lang.org.cn -- 到redmine网站的链接: https://redmine.ruby-lang.org.cn
- "Redmine网站":https://redmine.ruby-lang.org.cn -- 使用不同文本的外部链接: Redmine网站
- !https://redmine.ruby-lang.org.cn/attachments/7069/Redmine_logo.png(Redmine网站)!:https://redmine.ruby-lang.org.cn -- 有标题的图片链接到URL
- "\\server\share$":file://///server/share%24 -- 显示UNC路径的文件URI: \\server\share$
对于空格、$、á、é、í、ó、ú等特殊字符,您应该使用URL编码。
电子邮件地址¶
电子邮件地址会自动转换为可点击链接
- [email protected] -- 链接到电子邮件地址: [email protected]
- "Email someone":mailto:[email protected] -- 使用不同文本的电子邮件链接: Email someone
- "Email webmaster and admin":mailto:[email protected][email protected] -- 给webmaster发送邮件,抄送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"并具有默认正文的电子邮件链接: My problem is
文本格式¶
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(图片标题)! 显示具有alt/title属性的图片
- !image_url!:URL 显示位于 image_url 的图像,并添加链接 URL
如果你的维基页面上有图像,可以使用其文件名在行内显示: !attached_image.png!
你也可以像对 SPAN 进行样式设置一样对图像进行样式设置。代码 !{width: 100%}attached_image.png! 将使图像调整到父级的宽度。
标题¶
h1. Heading
h2. Subheading
h3. Subheading
Redmine 为这些标题中的每一个都分配了一个锚点,因此你可以使用 "#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.
显示;
左对齐
左缩进 1em
左缩进 2em
以及对于后续行
右对齐
右缩进 3em
这是居中的段落。
水平线¶
----
显示
预格式化文本¶
<pre>*Your text won't become bold*</pre>
显示
*Your text won't become bold*
引用区块¶
在段落开始时使用 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 是一个遵循 Model-View-Control 模式的全栈框架,用于开发数据库支持的 Web 应用程序。
要上线,你只需要添加数据库和 Web 服务器。
你还可以在每个行的开头使用 > 并堆叠它们以进行嵌套引用
>> 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 是一个遵循 Model-View-Control 模式的全栈框架,用于开发数据库支持的 Web 应用程序。
要上线,你只需要添加数据库和 Web 服务器。太棒了!
无序列表¶
* 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 |
显示(所有多个空格都被替换为 1 个空格)
UserID | Name | Group | 属性列表 |
---|---|---|---|
从 | a | 一个简单的 | 行 |
IT | 左对齐 | ||
1 | Artur Pirozhkov | 用户 | 右对齐 |
2 | Vasya Rogov | 居中 | |
3 | John Smith | 管理员 (root) |
valign top |
4 | - | Nobody (匿名) |
valign bottom |
如果你想在表格中包含管道字符(例如用于 Wiki 链接),需要防止 textile 解释它们
输入 | 输出 |
---|---|
<notextile>|</notextile> | | |
如果你要指定表格的宽度,需要在表格定义之前加上 table{width:100%}.
table{width:100%}. | This table will use all horizontal space |
这样表格就会扩展到整个页面的宽度...
这个表格将使用 所有水平空间 |
...与标准宽度相比
这个表格将使用 仅所需空间 |
目录¶
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
请注意,toc-tag 需要在其上方和下方保留空行,并且在其前后没有其他文本。
示例
h1. headLineOne
h2. something
{{toc}}
h2. something more
脚注¶
标记
This is a first word[1] with a footnote. This is a second word[2] with a footnote.
注意:标记直接附加到单词上(之间没有空格、点或其他任何内容)。
定义
fn1. Footnote for the first word fn2. Footnote for the second word
注意:每个定义都在文档中的单独一行上。定义之间有空行。
显示
这是一个带有脚注的第一个单词1。
这是一个带有脚注的第二个单词2。
1 第一个单词的脚注
2 第二个单词的脚注
宏¶
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
代码高亮¶
默认代码高亮依赖于纯Ruby编写的语法高亮库Rouge。它支持许多常用语言,如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。
您可以使用以下语法在您的维基页面上高亮代码
<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
使用CSS样式化文本¶
Textile可以使用CSS样式化文本。例如:
Three primary colors of light are %{color: #f00}red%, %{color: #0f0}green% and %{color: #00f}blue%. p{border: solid 1px #000; padding: 0.5em;}. The quick brown fox jumps over the lazy dog. table{width: 100%}. |={width: 30%; background-color: #aaf;}. column 1 |={width: 70%}. column 2 |
显示
光的三原色是红色、绿色和蓝色。
一只敏捷的棕色狐狸跳过了一只懒惰的狗。
列1 | 列2 |
允许的CSS属性¶
Redmine允许以下属性。出于安全原因,不允许其他属性(参见r2192)。
- background
- background-*
- border
- border-*
- color
- float
- font
- font-*
- height
- margin
- margin-*
- max-height
- max-width
- min-height
- min-width
- padding
- padding-*
- text
- text-*
- width
翻译¶
请注意,以下翻译可能不是最新的。如有需要,请参阅原始英文文档。
由Andrea Ludin更新于超过2年前 · 14次修订