RedmineはWiki記法が使える箇所のどこからでも、チケット・チェンジセット・Wikiページなどのリソースへのリンクができます。
Wikiへのリンク:
別のプロジェクトのwikiへのリンクも可能です:
存在しないwikiページへのリンクは赤で表示されます。 例: Nonexistent page.
そのほかのリソースへのリンク:
エスケープ:
URL(starting with: www, http, https, ftp, ftps, sftp and sftps)とメールアドレスは自動的にリンクになります:
http://www.redmine.org, someone@foo.bar
上記記述の表示例です: http://www.redmine.org, someone@foo.bar
URLのかわりに別のテキストを表示させたい場合は、通常のMarkdown記法が利用できます:
[Redmine web site](http://www.redmine.org)
上記記述の表示例です: Redmine web site
見出し、太字、テーブル、リスト等は、RedmineはMarkdownでの記述に対応しています。Markdownの詳細は http://daringfireball.net/projects/markdown/syntax を参照してください。Markdownの一例を以下に示しますが、実際にはここで取り上げた以外の記法にも対応しています。
* **太字** * *斜体* * ***太字で斜体*** * ~~取り消し線~~
表示例:
# Heading ## Subheading ### Subsubheading
Redmineは見出しにアンカーを設定するので、"#Heading", "#Subheading"のように記述して見出しへのリンクが行えます。
段落を > で開始してください。
> 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
サンプルのマクロです。
macro_list
利用可能なマクロの一覧を表示します。マクロの説明があればそれも表示します。
child_pages
子ページの一覧を表示します。引数の指定が無ければ現在のwikiページの子ページを表示します。以下は使用例です:
{{child_pages}} -- wikiページでのみ使用可能です
{{child_pages(depth=2)}} -- 2階層分のみ表示します
include
別のWikiページの内容を挿入します。 以下は使用例です:
{{include(Foo)}}
別プロジェクトのWikiページを挿入することもできます:
{{include(projectname:Foo)}}
collapse
折り畳まれた状態のテキストを挿入します。以下は使用例です:
{{collapse(詳細を表示...)
この部分はデフォルトでは折り畳まれた状態で表示されます。
リンクをクリックすると展開されます。
}}
thumbnail
添付ファイルのクリック可能なサムネイル画像を表示します。以下は使用例です:
{{thumbnail(image.png)}} {{thumbnail(image.png, size=300, title=Thumbnail)}}
Redmineのコードハイライトは CodeRay という、Rubyで記述された高速なライブラリを使用しています。現時点では c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml, yaml (yml) に対応しています。括弧内の名前はコードハイライトの指定時に利用できる別名です。
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