書式の表記法

DokuWikiは、いくつかのシンプルなマークアップ言語をサポートしています。それによって、可能な限りデータファイルに可読性を持たせています。このページには、ページの編集時に使用するすべての表記法が含まれています。上記に配置された「文書の編集」をクリックして、このページのソースを眺めるだけでも役に立つことでしょう。もし、書き込みの練習をしたいなら、PlayGroundのページを利用してください。基本的なものは、クイックボタンを使っても記述することができます。

【訳者注】 原作者のWikiに、ここと同様の日本語訳wiki:ja:syntaxがありました。こちらはこちらで保存したままにしておきます。

DokuWikiは、太字、斜体、アンダーラインそして、等倍文字をサポートしています。もちろん、それらすべてを組み合わせることも可能です。

DokuWikiは、**太字**、//斜体//、__アンダーライン__そして、''等倍文字''をサポートしています。
もちろん、それらすべてを**__//''組み合わせ''//__**ることも可能です。

さらに、_{下付き文字}や^{上付き文字}も使用できます。

さらに、<sub>下付き文字</sub>や<sup>上付き文字</sup>も使用できます。

取り消し線のようなものも可能です。

<del>取り消し線</del>のようなものも可能です。

段落は、空白行で作成されます。もし、強制的に改行したいのであれば、行末にバックスラッシュを２つ加えるか、半角スペースを１つ加えてください。

これは、いくつかの行で成り立っているテキストです。
注意してほしいのは、 バックスラッシュ２つは、行末でのみ有効ということです。
ただし、\\の後に半角スペースが続く場合は、改行されます。

これは、いくつかの行で成り立っているテキストです。\\ 注意してほしいのは、
バックスラッシュ２つは、行末でのみ有効ということです。\\
ただし、\\の後に半角スペースが続く場合は、改行されます。

本当に必要な場合にのみ、強制的な改行を使用すべきです。

DokuWikiは複数の方法でリンクを作成することが可能です。

外部リンクは、http://www.google.comや単純にwww.google.comのように自動的に認識されます。 Googleへのリンクのようにリンク名を含めることもできます。 メールアドレスもandi@splitbrain.orgのように自動的にリンクします。

外部リンクは、http://www.google.comや単純にwww.google.comのように自動的に認識されます。
[[http://www.google.com|Googleへのリンク]]のようにリンク名を含めることもできます。
メールアドレスも<andi@splitbrain.org>のように自動的にリンクします。

内部リンクは、角かっこを使用して作成します。 単にページ名でも、タイトルテキストを加えて使用することもできます。 Wikiのページ名は、自動的に小文字に変換されます。特殊文字は使用できません。【訳者注】リンク先は英語です。

外部リンクは、角かっこを使用して作成します。
単に[[:dokuwiki:ja:pagename]]でも、[[:dokuwiki:ja:pagename|タイトルテキスト]]を加えて使用することもできます。
Wikiのページ名は、自動的に小文字に変換されます。特殊文字は使用できません。

ページ名にコロンを使って、名前空間と表記することもできます。

ページ名にコロンを使って、[[:dokuwiki:ja:namespaces]]と表記することもできます。

名前空間に関する詳細は、wiki:namespaces(英語)を参照してください。

特定のセクションへのリンクも可能です。HTMLでおなじみのシャープ記号の後に、セクション名を加えるだけです。 このリンクは、このセクションを参照しています。

このリンクは、[[syntax#internal|このセクション]]を参照しています。

ノート:

• 存在するページは、存在しないページと異なる表示をします。
• DokuWikiは、デフォルトでCamelCaseを自動的にリンクにする処理はしません。しかし、設定ファイルで、有効にすることもできます。もし、DokuWikiがリンクになっている場合は、設定で有効になっています。
• セクションの見出しを変更した場合、ブックマークも変更してください。なので、過度にセクションのリンクに頼らないでください。

DokuWikiは、Interwikiリンクをサポートしています。他のWikiに素早くリンクできます。例えば、 Wikiでは、Wikiに関するWikipediaのページが表示されます。

DokuWikiは、[[doku>wiki:interwiki|Interwiki]]リンクをサポートしています。
他のWikiに素早くリンクできます。例えば、[[wp>Wiki]]では、
Wikiに関するWikipediaのページが表示されます。

thisのようにWindows共有を認識します。注意してほしいのは、これらが企業のイントラネット(Intranet)のように同種のグループに属していないと意味をなさないということです。

[[\\server\share|this]]のようにWindows共有を認識します。

注意:

• セキュリティの理由から、Windows共有の直接閲覧は、デフォルトではマイクロソフトのInternet Explorerでしか動作しません。(そして「ローカルゾーン」のみです)
• MozillaやFirefoxでは、設定オプションで有効にすることはできますが(security.checkloaduri)、お勧めしません。
• 追加情報は、151をご覧ください。

リンクの書式と画像(下記参照)と組み合わせて、別の内部または外部ページへのリンクに使用することもできます。

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

注意：画像の書式は、リンク名として容認された書式文法のみです。

すべての画像やリンクの文法がサポートされます。 (画像のサイズ変更や内部および外部の画像、そしてURLやInterWikiのリンクが含まれます)

二重かっこを使うと脚注を加えることができます。¹⁾

二重かっこを使うと脚注を加えることができます。((これが脚注です。))

５つの異なるレベルの見出しを使用することができます。もし、３つ以上の見出しを使っていたら、コンテンツのテーブルは自動的に作成されます。文書内に~~NOTOC~~という文字を含めると、無効にすることができます。

==== 第三見出し ====
=== 第四見出し ===
== 第五見出し ==

マイナス記号を4つ以上使用すると、横罫線を引くことができます。

【訳者注】ずいぶん地味なところに説明があるものだなぁ。

大かっこを使うと、外部または内部の画像を含めることができます。サイズを変えることもできます。

実サイズ:

幅を指定:

幅と高さを指定:

外部画像のリサイズ:

実サイズ:                        {{wiki:dokuwiki-128.png}}
幅を指定:            {{wiki:dokuwiki-128.png?50}}
幅と高さを指定: {{wiki:dokuwiki-128.png?200x50}}
外部画像のリサイズ:           {{http://de3.php.net/images/php.gif?200x50}}

右か左に半角スペースを入れると、寄せることもできます。

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

もちろん、タイトル(多くのブラウザでは、ツールチップに表示される)も追記することもできます。

{{ wiki:dokuwiki-128.png |This is the caption}}

もし、画像ファイル(gif, jpeg, png)ではないファイル名を指定した場合、リンクが表示されます。

画像で別のページにリンクしたい場合は、上記の画像リンクを参照してください。

Dokuwikiは、数字付きリストと数字なしリストをサポートしています。リストを作成するには、行頭に半角スペースを２つ使用して字下げをし、数字なしの場合は*を、数字付きの場合は-を、一つ付けてください。

• これがリストです。
• 2つ目の項目です。
  • 別のレベルの項目です。
    改行もできます。
• 別の項目です。

1. 同じリストですが、数字付きです。
2. 別の項目です。
   1. 深い階層にするには字下げをするだけです。
   2. スペースは２つ追加です。
3. 以上です。

  * これがリストです。
  * 2つ目の項目です。
    * 別のレベルの項目です。\\ 改行もできます。
  * 別の項目です。

  - 同じリストですが、数字付きです。
  - 別の項目です。
    - 深い階層にするには字下げをするだけです。
    - スペースは２つ追加です。
  - 以上です。

DokuWikiは、一般的に使われるemoticonをグラフィカルなものに変換します。スマイリをsmileyディレクトリに置き、conf/smileys.confファイルを設定することで、より多くのスマイリを表示させることができます。下記のものは、DokuWikiに含まれるスマイリです。

• 8-)
• 8-O
• :-(
• :-)
• =)
• :-/
• :-\
• :-?
• :-D
• :-P
• :-O
• :-X
• :-|
• ;-)
• ^_^
• :?:
• :!:
• LOL
• FIXME (修正)
• DELETEME (削除)

DokuWikiは、単純な文字列で、特殊な文字へ変換することができます。以下は、認識する文字列の例です。

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

注意：設定オプション(英語)やパターンファイル(英語)で、この変換をオフにすることもできます。

返信やコメントを表示するとき、テキストをマークしたいときがあるでしょう。そんなときは、以下の表記を使用してください。

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't

Well, I say we should

Really?

Yes!

Then lets do it!

DokuWikiは、テーブル作成のためのシンプルな文法をサポートしています。

テーブルの列は、通常行で|を、見出し行で ^を使い、行頭と行末を囲む必要があります。 【訳者注】|は、アルファベットのl(エル)でも数字の１(いち)でもありません。また、^は、カタカナの「ヘ」ではありません。

^ 見出し1      ^ 見出し2       ^ 見出し3          ^
| 行 1 列 1    | 行 1 列 2     | 行 1 列 3        |
| 行 2 列 1    | ２つの列にまたがっています ||
| 行 3 列 1    | 行 2 列 2     | 行 2 列 3        |

水平にセルを結合させるには、次のセルを上記のように空にします。セルの区切り文字の総数は同じになることを確認してください。

垂直にテーブルの見出しを指定することも可能です。

ご覧の通り、セルの区切りは、書式化で決まるセルの前になっています。

|            ^ 見出し1            ^ 見出し2          ^
^ 見出し3    | 行 1 列 2          | 行 1 列 3        |
^ 見出し4    | 今回は列をまたがっていません |        |
^ 見出し5    | 行 2 列 2          | 行 2 列 3        |

注意：縦のセル(列)の結合はできません。

テーブルの項目を寄せることもできます。2つ以上の半角スペースを加えるだけです。左にスペースを入れると右寄せになり、右にスペースを入れると左寄せになります。両方にスペースを入れると中央寄せになります。

ソースで見るとこうなります。

^           テーブルでの寄せ方             ^^^
|        右寄せ|   中央寄せ   |左寄せ        |
|左寄せ        |        右寄せ|   中央寄せ   |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

【訳者注】別に区切り文字を縦にそろえる必要はないようです。

最低２つの半角スペースにより字下げすることで、文書内に非解析ブロックを含ませることができます(前述の例で使用したもののように)。または、codeやfileというタグを使用することでも非解析ブロックにすることができます。

これは、すべてのスペースを保持するコードを使用しています。              <-this

こちらもよく似たものですが、ファイルを引用を示すために使用します。

完全に解析させないためには(言い換えれば、何も書式化しない)、nowikiタグで両端を囲むか、パーセント記号を２つ「%%」で囲むと可能となる。

これは、アドレスを含むテキストです。nowikiタグで囲ってあるので、http://www.splitbrain.org and **formatting**のように、何もしません。

これらのブロックの使い方は、このページのソースを参照してください。

DokuWiki は、ソースコードを強調し、可読性を高めることができます。GeSHi Generic Syntax Highlighter(包括的文法強調)を使用しています。GeSHiは多くの言語をサポートしています。文法は、前述のセクションのコードブロックとよく似たものですが、こちらは使用される言語は、タグの中に挿入されます。例えば、<code java>のように指定します。

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

現在のところ、次にあげる言語の文字列が認識されます。 actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html4strict, idl, ini, inno, java5, java, javascript, latex, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml

htmlやphpというタグを使うと、文書内にHTMLとPHPのコードをそのまま埋め込むことができます。

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

This is some <font color="red" size="+1">HTML</font>

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

注意：埋め込みHTMLとPHPは、デフォルトで設定を無効にしてあります。もし無効であれば、実行されずにコードが表示されます。

DokuWikiの文法は、プラグインで、拡張できます。インストールされたプラグインの使い方は、それぞれの解説ページをご覧ください。次にあげる文法プラグインが、このDokuwikiにインストールされ、有効になっています。

• Blog 2023-01-12 by Michael Hamann, Michael Klier, Gina Haeussge
  Use DokuWiki as blogging tool. (previous authors: Esther Brunner)
• Box Plugin 2022-08-16 by Christopher Smith
  Boxes with titles, colour and rounded corners. Syntax: <box width class colours|title> ... </box|caption> width, class, colours title & caption are optional. The title can include some wiki markup, the box contents can include almost any wiki markup.
• Gallery Plugin 2023-03-23 by Andreas Gohr
  Creates a gallery of images from a namespace or RSS/ATOM feed
• htmlok plugin 2023-05-10 by saggi, glen
  Allows embed HTML and PHP
• Indexmenu Plugin 2022-08-01 by Samuele Tognini
  Show a customizable and sortable index for a namespace
• Info Plugin 2020-06-04 by Andreas Gohr
  Displays information about various DokuWiki internals
• Wrap Plugin 2022-08-10 by Anika Henke
  Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.