# Wiki 格式設定

## 連結

### Redmine 連結

在任何可以使用 Wiki 格式設定的地方， Redmine 都允許在資源（問題、變更集、 Wiki 頁面...）間建立超連結。

- 連結至一個問題： #124 (若該問題已經結束，則使用刪除線顯示連結： #124)
- 連結至一個問題的筆記： #124-6, or #124#note-6

Wiki 連結：

- [[Guide]] 顯示一個頁面名稱為 'Guide' 的連結： Guide
- [[Guide#further-reading]] 會連結至一個 "further-reading" 的 HTML 錨定 (anchor) 。每個標題文字都會被自動指定一個 HTML 錨定，以便您可以用來連結它們： Guide
- [[Guide|User manual]] 使用不同的文字來顯示一個頁面名稱為 'Guide' 的連結： User manual

您也可以連結至其他專案的 Wiki 頁面：

- [[sandbox:some page]] 顯示一個 Sanbox wiki 中頁面名稱為 'Some page' 的連結
- [[sandbox:]] 顯示 Sandbox wiki 首頁頁面的連結

當頁面不存在的時候， Wiki 連結會以紅色的方式顯示，例如： Nonexistent page.

連結至其他資源：

- 文件：
  - 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 的附加檔案)
  - 目前僅提供參考到目前物件中的附加檔案 (若您正位於一個問題中，僅可參考位於此問題中之附加檔案)

- 變更集：
  - 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 中包含空白字元時，使用雙引號來標示)
  - export:some/file (強制下載此檔案)
  - source:svn1|some/file (連結至指定儲存機制中的此檔案，用於專案使用多個儲存機制時之情況)
  - sandbox:source:some/file (連結至 "sandbox" 專案的儲存機制中，位於 /some/file 的檔案)
  - sandbox:export:some/file (強迫下載該檔案)

- 論壇訊息：
  - message#1218 (連結至編號 1218 的訊息)

- 專案：
  - project#3 (連結至編號為 3 的專案)
  - project:someproject (連結至名稱為 "someproject" 的專案)

逸出字元：

- 您可以在文字的前面加上驚嘆號 (!) 來避免該文字被剖析成 Remine 連結

### 外部連結

HTTP URLs 與電子郵件地址會自動被轉換成可被點擊的連結：

    http://www.redmine.org, someone@foo.bar

顯示為： http://www.redmine.org, someone@foo.bar

若您想要顯示指定的文字而非該 URL ，您可以使用下列標準的 textile 語法:

    "Redmine web site":http://www.redmine.org

顯示為： Redmine web site

## 文字格式設定

對於諸如標題、粗體、表格、清單等項目， Redmine 支援使用 Textile 語法。可參考 http://en.wikipedia.org/wiki/Textile_(markup_language) 中關於使用這些格式化功能的說明資訊。 下面包含了一些使用範例，但格式化引擎的處理能力遠多於這些簡單的使用範例。

### 字型樣式

    * *粗體*
    * _斜體_
    * _*粗斜體*_
    * +底線+
    * -刪除線-

顯示為：

- 粗體
- 斜體
- 粗斜體
- 底線
- 刪除線

### 內置圖像

- !圖像_url! 顯示一個位於 圖像_url 位址的圖像(textile 語法)
- !>image_url! 右側浮動圖像
- 若您附加了一個圖像到 Wiki 頁面中，可以使用他的檔案名稱來顯示成內置圖像： !attached_image.png!

### 標題

    h1. 標題
    h2. 次標題
    h3. 次次標題

Redmine 為每一種標題指定一個 HTML 錨定 (anchor) ，因此您可使用 "#Heading" 、 "#Subheading" 等方式連結至這些標題。

### 段落

    p>. 靠右對齊
    p=. 置中對齊

這是一個置中對齊的段落。

### 引用文字

使用 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 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.

### 目錄

    {{toc}} => 靠左對齊目錄
    {{>toc}} => 靠右對齊目錄

### 水平線

    ---

## 巨集

Redmine 內建下列巨集：

`hello_world`

  範例巨集。

`include`

  引入一個 wiki 頁面。例子：

      {{include(Foo)}}

`macro_list`

  顯示所有可用巨集的清單，若巨集有提供說明也會一併顯示。

## 程式碼醒目提示

預設使用 CodeRay 作為程式碼醒目提示的機制，它是一個使用 Ruby 撰寫的語法醒目提示函式庫。它目前支援 c 、 cpp 、 css 、 delphi 、 groovy 、 html 、 java 、 javascript 、 json 、 php 、 python 、 rhtml 、 ruby 、 scheme 、 sql 、 xml 與 yaml 等程式語言。

您可以使用下列語法，在 Wiki 頁面中將程式碼標示為醒目提示：

    <pre><code class="ruby">
      將程式碼放在這裡。
    </code></pre>

例子：

     1 # The Greeter class
     2 class Greeter
     3   def initialize(name)
     4     @name = name.capitalize
     5   end
     6
     7   def salute
     8     puts "Hello #{@name}!"
     9   end
    10 end