專案

一般

個人檔案

動作
歷史記錄

指南 » 使用者指南 »

Textile 格式

以下是 Textile 格式。如需 Markdown 格式，請參閱 RedmineTextFormattingMarkdown。
有關目前 Textile 支援的限制，請參閱 #6269，#10078（定義清單）。

連結

Redmine 連結

Redmine 允許在任何使用文字格式的地方建立資源之間的超連結（Wiki 頁面、議題、文件...）。

Wiki 連結

  • [[指南]] 顯示指向名為「指南」頁面的連結：指南
  • [[指南#進一步閱讀]] 會帶您到「進一步閱讀」的錨點。標題會自動分配錨點，以便您可以參考它們：指南
  • [[指南|使用者手冊]] 顯示指向相同頁面的連結，但文字不同：使用者手冊
  • [[指南#使用者指南|使用者指南]] 顯示指向相同頁面上標題的連結，但文字不同：使用者指南

您也可以連結到另一個專案 Wiki 的頁面（使用專案識別碼）

  • [[sandbox:某個頁面]] 顯示指向 Sandbox Wiki 中名為「某個頁面」的連結
  • [[sandbox:]] 顯示指向 Sandbox Wiki 首頁的連結

如果頁面尚不存在，則 Wiki 連結會以紅色顯示，例如：不存在的頁面。

指向其他資源的連結

  • 議題
    • #124（指向議題的連結：顯示 #124，如果議題已關閉，則連結會顯示刪除線）
    • #124-6 或 #124#note-6（連結到一個議題備註：顯示 #124-6 或 #124#note-6）
  • 文件
    • document#17（連結到 ID 為 17 的文件）
    • document:問候語（連結到標題為「問候語」的文件）
    • document:"某個文件"（當文件標題包含空格時，可以使用雙引號）
    • sandbox:document:"某個文件"（連結到專案識別碼「sandbox」中標題為「某個文件」的文件）
  • 版本
    • version#3（連結到 ID 為 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:"檔案名稱.zip"（當檔名包含非單字字元時，可以使用雙引號）
    • 目前只能參考目前物件的附件（如果您正在處理一個議題，則只能參考此議題的附件）
  • 變更集
    • r758（連結到一個變更集，顯示 r758）
    • commit:c6f4d0fd（連結到具有非數字雜湊的變更集）
    • svn1|r758（連結到特定存放庫的變更集，適用於具有多個存放庫的專案）
    • commit:hg|c6f4d0fd（連結到特定存放庫中具有非數字雜湊的變更集）
    • sandbox:r758（連結到另一個專案的變更集）
    • sandbox:commit:c6f4d0fd（連結到另一個專案識別碼中具有非數字雜湊的變更集）
  • 存放庫檔案
    • source:some/file（連結到專案存放庫中位於 /some/file 的檔案）
    • source:"某個檔案"（連結到路徑中包含非單字字元的檔案）
    • 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（連結到特定存放庫的檔案，適用於具有多個存放庫的專案）
    • sandbox:source:some/file（連結到專案識別碼「sandbox」中的檔案）
    • sandbox:source:repo_identifier|some/file（連結到專案識別碼「sandbox」中特定存放庫中路徑包含非單字字元的檔案）
    • export:some/file（強制下載檔案）
  • 論壇
    • forum#2（連結到 ID 為 2 的論壇）
    • forum:討論區（連結到名稱為「討論區」的論壇）
    • forum:"幫助和更多"（當論壇名稱包含空格時，可以使用雙引號）
  • 論壇訊息
    • message#1218（連結到 ID 為 1218 的訊息）
  • 新聞項目
    • news#1（連結到 ID 為 1 的新聞項目）
    • news:問候語（連結到名稱為「問候語」的新聞項目）
    • news:"eCookbook 首次發布！"（當新聞項目名稱包含空格時，可以使用雙引號）
  • 專案
    • project#3（連結到 ID 為 3 的專案）
    • project:某個專案（連結到名稱為「某個專案」的專案）
    • project:"多個單字的專案"（當專案名稱包含空格時，可以使用雙引號）
  • 使用者
    • Thomas Lecavelier （連結到 ID 為 2 的使用者）
    • 使用者：jsmith （連結到登入名稱為「jsmith」的使用者）
    • @jsmith （連結到登入名稱為「jsmith」的使用者）

跳脫字元

  • 您可以在 Redmine 連結前面加上一個驚嘆號來防止其被解析：！

外部連結

網址（http、https、ftp 和 ftps）會自動轉換為可點擊的連結網址也可以使用與連結本身不同的文字
  • 「Redmine 網站」:https://redmine.dev.org.tw -- 具有不同文字的外部連結：Redmine 網站
  • !https://redmine.dev.org.tw/attachments/7069/Redmine_logo.png(Redmine 網站)!:https://redmine.dev.org.tw -- 連結到網址的標題之外部連結圖片

Redmine web site

檔案 URI 可用於連結 UNC 路徑
  • "\\server\share$"：file://///server/share%24 -- 顯示 UNC 路徑的檔案 URI：\\server\share$
    您應該對特殊字元（例如空格、$、á、é、í、ó、ú 等）使用 URL 編碼。

電子郵件地址

電子郵件地址會自動轉換為可點擊的連結

可以將更複雜的電子郵件指示添加到電子郵件連結。可以定義預設主旨、預設內文和副本資訊。請注意，這些欄位中的任何空格都需要用程式碼 %20 替換。
  • 「寄送電子郵件給網站管理員和管理員」:mailto:webmaster@foo.bar?cc=admin@foo.bar -- 寄送電子郵件給網站管理員，副本給管理員：寄送電子郵件給網站管理員和管理員
  • 「寄送電子郵件給某人尋求幫助」:mailto:someone@foo.bar?subject=網站%20協助 -- 主旨為「網站協助」的電子郵件連結：寄送電子郵件給某人尋求幫助
  • 「寄送電子郵件給某人尋求幫助」:mailto:someone@foo.bar?subject=網站%20協助&body=我的%20問題%20是%20 -- 主旨為「網站協助」且具有預設內文的電子郵件連結：我的問題是

文字格式

對於標題、粗體、表格、清單等，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> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternative using HTML-codes: &#42;bold&#42; &#95;italic&#95; &#64;inlinemono&#64;
* <pre>*some lines*      some "link":https://redmine.dev.org.tw</pre>
* <pre><notextile></notextile>*some lines*      some "link":https://redmine.dev.org.tw</pre>

顯示

  • 粗體
  • 斜體
  • 粗斜體
  • 底線
  • 刪除線
  • 一般 上標
  • 一般 下標
  • 行內等寬字體
  • 一般 粗體 斜體 一般；E=mc 2
  • 一般粗體斜體一般；E=mc2
  • 跳脫字元：*粗體* _斜體_ @行內等寬字體@       使用 HTML 代碼的替代方法：*粗體* _斜體_ @行內等寬字體@
  • *some lines*      some "link":https://redmine.dev.org.tw
  • 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%

顯示

  • 紅色 綠色 黃色 藍色
  • 紅色綠色黃色藍色
  • 淺綠色背景 黃色背景
  • 淺綠色背景黃色背景

行內圖片

  • !圖片網址! 顯示位於圖片網址的圖片（Textile 語法）
  • !>image_url! 圖片靠右浮動
  • !image_url(圖片標題)! 顯示帶有替代文字/標題屬性的圖片
  • !image_url!:URL 顯示位於 image_url 的圖片，並添加連結網址

如果您有附加圖片到您的 Wiki 頁面，則可以使用其檔名內嵌顯示：!attached_image.png!

您也可以使用與 SPAN 相同的方式對圖片套用 CSS 樣式。程式碼 !{width: 100%}attached_image.png! 將使圖片調整為父元素的寬度。

標題

h1. Heading

h2. Subheading

h3. Subheading

Redmine 會為每個標題分配一個錨點，因此您可以使用「#標題」、「#子標題」等方式連結到它們。

段落

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 是一個全棧框架，用於根據模型-視圖-控制器模式開發資料庫支援的 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 是一個全棧框架，用於根據模型-視圖-控制器模式開發資料庫支援的 Web 應用程式。
要上線，您只需添加一個資料庫和一個 Web 伺服器。

太棒了！

無序列表

* Item 1
* Item 2
** Item 21
** Item 22
* Item 3

顯示

  • 項目 1
  • 項目 2
    • 項目 2.1
    • 項目 2.2
  • 項目 3

有序列表

# Item 1
# Item 2
# Item 3
## Item 3.1
## Item 3.2

顯示

  1. 項目 1
  2. 項目 2
  3. 項目 3
    1. 項目 3.1
    2. 項目 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 個空格）

使用者 ID 姓名 群組 屬性列表
從 一個 簡單的 行
IT 靠左對齊
1 Artur Pirozhkov 使用者 靠右對齊
2 Vasya Rogov 置中
3 John Smith 管理員
（root）		 垂直對齊頂部
4 - 無
（匿名使用者）		 垂直對齊底部

如果要在表格中包含管道符號（例如，用於 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 標籤的上下都需要一個空行，並且前後不能有其他文字。

範例


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

程式碼高亮

預設的程式碼高亮功能依賴於 Rouge，這是一個用純 Ruby 編寫的語法高亮函式庫。它支援許多常用的程式語言，例如 c、cpp (c++)、csharp (c#、cs)、css、diff (patch、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 頁面中高亮程式碼

<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 個修訂版本