<%= stylesheet_link_tag "wiki_syntax_detailed.css" %>

Wiki記法 (CommonMark Markdown (GitHub Flavored))

Links

Redmine内のリンク

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の詳細は CommonMark を参照してください。なお文法のなかには、いくつかGitHub flavored Markdownと呼ばれる拡張が追加されています。拡張については GitHub Flavored Markdown Spec を参照してください。以下にいくつかのサンプルを提示しますが、実際にはここで取り上げた以外の記法にも対応しています。

文字の書式

* **太字**
* *斜体*
* ***太字で斜体***
* ~~取り消し線~~

表示例:

画像

見出し

# 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)}}
issue

チケットへのリンクをカスタマイズ可能なテキストとともに挿入します。以下は使用例です:

{{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
recent_pages

最近更新された Wikiページを表示します。オプションがない場合は直近7日間に更新されたページを表示します。以下は使用例です:

{{recent_pages}}            -- 直近7日間に更新されたページを表示します
{{recent_pages(days=3)}}    -- 直近3日間に更新されたページを表示します
{{recent_pages(limit=5)}}   -- 表示するページの数を5件までに制限します
{{recent_pages(time=true)}} -- 直近7日間に更新されたページを更新時間とともに表示します

コードハイライト

RedmineはRubyで記述されたコードハイライト用ライブラリ Rouge を使用しています。Rougeは 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

HTMLを直接使用する

複数の行や列がが結合している表のような複雑なフォーマットを記述したいときはMarkdown記法を使わずHTMLを直接書くこともできます。


    <table width="50%">
      <tr><td rowspan="2">Two rows</td><td>foo</td></tr>
      <tr><td>bar</td></tr>
      <tr><td align="center" colspan="2">bar</td></tr>
    </table>

以下のようになります

Two rowsfoo
bar
bar

HTMLを直接書く場合は固有なスタイル設定のためにstyle属性を使用できます。以下のCSSプロパティが使用できます。


  color background-color
  width min-width max-width
  height min-height max-height
  padding padding-left padding-right padding-top padding-bottom
  margin margin-left margin-right margin-top margin-bottom
  border border-left border-right border-top border-bottom border-radius border-style border-collapse border-spacing
  font font-style font-variant font-weight font-stretch font-size line-height font-family
  text-align
  float

アラートボックス

注釈
> [!NOTE]
> Wikiページを編集すると履歴が保存されます。必要な場合は以前のバージョンに戻すこともできます。

Note

Wikiページを編集すると履歴が保存されます。必要な場合は以前のバージョンに戻すこともできます。

助言
> [!TIP]
> チケットの更新履歴をざっくり振り返るには、「履歴」タブを見るのが便利です。

Tip

チケットの更新履歴をざっくり振り返るには、「履歴」タブを見るのが便利です。

注意
> [!WARNING]
> チケットは削除してしまうと復旧できません。削除する前に本当に必要かどうかを必ず確認してください。

Warning

チケットは削除してしまうと復旧できません。削除する前に本当に必要かどうかを必ず確認してください。

重要
> [!IMPORTANT]
> ロールの権限を変更すると全てのプロジェクトに影響します。潜在的な影響に注意してください。

Important

ロールの権限を変更すると全てのプロジェクトに影響します。潜在的な影響に注意してください。

警告
> [!CAUTION]
> プラグインをインストールするときは互換性を検証するように注意してください。バージョンの相違によって予想できない挙動をする可能性があります。

Caution

プラグインをインストールするときは互換性を検証するように注意してください。バージョンの相違によって予想できない挙動をする可能性があります。