專案

一般

個人檔案

動作
歷史

指南 » 使用者指南 »

Markdown 格式

以下是 Markdown 格式。關於 Textile 格式，請參閱 Textile 格式。
目前預設不允許使用 HTML 標籤。如需詳細資訊，請參閱 #15520 和 #20497。如需目前 Markdown 格式的其他限制，請參閱 #16373 和 #21443。

連結

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:Greetings（連結至標題為「Greetings」的文件）
    • document:"Some document"（當文件標題包含空格時，可以使用雙引號）
    • sandbox:document:"Some document"（連結至專案識別碼為「sandbox」中標題為「Some document」的文件）
  • 版本
    • 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:"file name.zip"（當文件名包含非單字字元時，可以使用雙引號）
    • 目前僅能參考當前物件的附件（如果您在一個議題中，則只能參考此議題的附件）
  • 變更集
    • r758（連結至一個變更集，顯示 r758）
    • commit:c6f4d0fd（連結至具有非數字雜湊值的變更集）
    • svn1|r758（連結至特定儲存庫的變更集，適用於具有多個儲存庫的專案）
    • commit:hg|c6f4d0fd（連結至特定儲存庫中具有非數字雜湊值的變更集）
    • sandbox:r758（連結至另一個專案的變更集）
    • sandbox: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（連結至特定儲存庫的檔案，適用於具有多個儲存庫的專案）
    • sandbox:source:some/file（連結至專案識別碼為「sandbox」中的檔案）
    • sandbox:source:repo_identifier|some/file（連結至專案識別碼為「sandbox」中特定儲存庫的路徑中包含非單字字元的檔案）
    • export:some/file（強制下載檔案）
  • 論壇
    • forum#2（連結至 ID 為 2 的論壇）
    • forum:Discussion（連結至名稱為「Discussion」的論壇）
    • forum:"Help and more"（當論壇名稱包含空格時，可以使用雙引號）
  • 論壇訊息
    • message#1218（連結至 ID 為 1218 的訊息）
  • 新聞項目
    • news#1（連結至 ID 為 1 的新聞項目）
    • news:Greetings（連結至名稱為「Greetings」的新聞項目）
    • news:"eCookbook first release !"（當新聞項目名稱包含空格時，可以使用雙引號）
  • 專案
    • project#3（連結至 ID 為 3 的專案）
    • project:someproject（連結至名稱為「someproject」的專案）
    • 專案：「包含多個字詞的專案」 （如果專案名稱包含空格，可以使用雙引號）
  • 使用者
    • Thomas Lecavelier （連結到 ID 為 2 的使用者）
    • 使用者：jsmith （連結到登入名稱為「jsmith」的使用者）
    • @jsmith （連結到登入名稱為「jsmith」的使用者）

跳脫

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

外部連結

網址（http、https、ftp 和 ftps）會自動轉換為可點選的連結

網址也可以使用與連結本身不同的文字

  • [Redmine 網站](https://redmine.dev.org.tw) -- 具有不同文字的外部連結：Redmine 網站
  • [![Redmine 網站](https://redmine.dev.org.tw/attachments/7069/Redmine_logo.png)](https://redmine.dev.org.tw) -- 連結到網址的標題外部圖片

Redmine web site

電子郵件地址

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

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

文字格式

對於標題、粗體、表格、清單等，Redmine 支援 Markdown 語法。如需使用任何這些功能的資訊，請參閱 http://daringfireball.net/projects/markdown/syntax、http://agea.github.io/tutorial.md/、http://stackoverflow.com/editing-help。以下包含一些範例，但引擎的功能遠不止於此。如需轉換，請參閱 Pandoc。使用的是 Redcarpet 格式化程式。

縮寫

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.dev.org.tw)</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.dev.org.tw)

注意：需要允許 HTML 標籤才能使用 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 標籤，需要允許 HTML 標籤 (<span>)。詳情請參閱 #15520-16 和 #15520-17。
更明確地說，您需要修補 Redmine，如 這篇文章 中所述。

行內圖像

  • ![](image_url) 顯示位於 image_url 的圖像（Textile 語法）
  • ![替代文字](image_url "可選標題") 顯示具有替代文字/標題屬性的圖像
  • [![](image_url)](URL) 顯示位於 image_url 的圖像，並添加了連結網址

如果您的 Wiki 頁面附加了圖像，則可以使用其檔名內嵌顯示：![](attached_image.png)。

截至撰寫本文時，Markdown 沒有用於指定圖像尺寸的語法；如果這對您很重要，您可以使用常規 HTML <img> 標籤。

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

注意： 若要使用 HTML 標籤，需要允許 HTML 標籤 (<img>)。詳情請參閱 #15520-16 和 #15520-17。
更明確地說，您需要修補 Redmine，如 這篇文章 中所述。

標題

# Heading

## Subheading

### Subheading

or

Heading
=======

Subheading
----------

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

段落

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

太棒了！

無序清單

無序清單使用星號 (*)、加號 (+) 和減號 (-) 作為清單標記

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

顯示

  • 項目 1
  • 項目 2
    • 項目 2.1
    • 項目 2.2
  • 項目 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 個空格）

使用者 ID（靠右對齊） 姓名（靠左對齊） 群組（置中對齊）
2 John Smith
3 Dave Lopper A 團隊
4 Robert Hill B 團隊

目錄

{{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 包含一個巨集系統，可讓您新增自訂函數，以在格式化文字中插入動態內容。您可以在 Redmine 巨集 中學習如何撰寫自己的巨集。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) 語言，其中括號內的文字為別名。如需支援語言的完整清單，請參閱 Redmine 程式碼醒目顯示語言。

您可以使用以下語法在您的 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 個修訂版本