wiki:syntax

文法

DokuWiki は、文章を可能な限り読みやすくできるよう、いくつかの簡単なマークアップ言語をサポートしています。このページには、あなたの編集作業で使用できるすべての文法例が含まれています。何はともあれ、このページの一番上か下にある 文書の編集 を押してソースを眺めてみてください。何か試したいことがあったら、playground ページを練習にお使いください。クイックボタンでも、簡単なマークアップを施すことができます。

テキストフォーマットの基本

DokuWiki では、太字斜体下線、それに 等幅 をテキストに指定できます。もちろん、それらの複合指定も可能です。

DokuWiki では、**太字**、//斜体//、__下線__、それに ''等幅'' をテキストに指定できます。
もちろん、それらの**__//''複合指定''//__**も可能です。

また、下つき上つきも指定できます。

また、<sub>下つき</sub>や<sup>上つき</sup>も指定できます。

他にも、削除した箇所を示すことができます。

他にも、<del>削除</del>した箇所を示すことができます。

段落は空行で作成できます。段落以外の任意の改行は『バックスラッシュ2個+半角スペース1個』で。

このテキストには、いくつかの強制改行が含まれて
います。 バックスラッシュ2個は、行末にある場合、
または直後に半角スペースがある場合のみ改行されます。
ただし、\\このような例では改行しません。

このテキストには、いくつかの強制改行が含まれて\\ います。
バックスラッシュ2個は、行末にある場合、\\
または直後に半角スペースがある場合のみ改行されます。\\
ただし、\\このような例では改行しません。

強制改行は、本当に必要とするときだけ使用することをお勧めします。

リンク

DokuWiki ではリンクを作る方法がいろいろあります。

Wiki外へのリンク

URLを書くだけで自動的に認識してリンクが張られます。例えば http://www.google.com あるいは単に www.google.com と書くとリンクになります。また、このリンクはGoogleを指すというように、リンク名を設定することもできます。andi@splitbrain.orgのように電子メールアドレスも自動的に認識されます。

URLを書くだけで自動的に認識してリンクが張られます。例えば http://www.google.com あるいは単に www.google.com と書くとリンクになります。また、[[http://www.google.com|このリンクはGoogleを指す]]というように、リンク名を設定することもできます。<andi@splitbrain.org>のように電子メールアドレスも自動的に認識されます。

Wiki内へのリンク

Wiki内のページへのリンクは半角のブラケット記号を使います。単にwiki:pagenameとページ名を書くだけでもよいですが、リンクのテキストを追加することもできます。Wikiのページ名はすべてアルファベットの小文字に変換(日本語を入力した場合、機械が自動的に読みがなのローマ字標記に変換)されます。ページ名に記号などを含めることはできません。

Wiki内部のページへのリンクは半角のブラケット記号を使います。単に[[doku>wiki:pagename]]とページ名を書くだけでもよいですが、[[doku>wiki:pagename|リンクのテキスト]]を追加することもできます。Wikiのページ名はすべてアルファベットの小文字に変換(このサーバーのWikiでは、日本語を入力した場合、機械が自動的に読みがなのローマ字標記に変換)されます。ページ名に記号などを含めることはできません。

ページ名の中にコロンを入れると、名前空間というものを使えます。

ページ名の中にコロンを入れると、[[wiki:namespaces|名前空間]]というものを使えます。

詳しくは、名前空間の説明ページをご覧ください。

ページの中のあるセクションにリンクすることもできます。HTMLでの記法と同様、ページ名の後ろに#記号とセクション名を続けて書きます。たとえばこれはこのセクションへのリンクです。

たとえばこれは[[syntax#wikinaihenorinku|このセクション]]へのリンクです。

注意:

  • 存在するページへのリンクと存在しないページは違うスタイルで表示されます。
  • DokuWikiではキャメルケースで書かれた部分を自動的にリンクにするというルールは使いませんが、configファイルの設定で使えるようにもできます。もし、このDokuWikiという部分がリンクになっていたら、この機能が使えるように設定されています。
  • セクションの見出しを書き換えると、そのブックマーク(セクション名)も自動的に変わります。ですから、セクションへのリンクはあまり多用しないほうがいいでしょう。

インターウィキ

DokuWikiはインターウィキ(InterWiki)リンクをサポートしています。インターウィキとは、他のWikiに向けたリンクを簡単に作る記法です。例えば、WikiはWikipediaのWikiについてのページ、ウィキは日本語ウィキペディアのウィキについてのページへのリンクです。

DokuWikiは[[doku>wiki:interwiki|インターウィキ]](InterWiki)リンクをサポートしています。インターウィキとは、他のWikiに向けたリンクを簡単に作る記法です。例えば、[[wp>Wiki]]はWikipediaのWikiについてのページ、[[wpja>ウィキ]]は日本語ウィキペディアのウィキについてのページへのリンクです。

Windows共有

Windows共有は、このような形で認識することができます。この機能は、イントラネットのような単一のユーザグループでのみ使用できることに注意してください。

Windows共有は、[[\\server\share|このような形で]]認識することができます。

注意:

  • デフォルトでは、セキュリティ上の理由で、Windows共有で直接ブラウズできるのはMicrosoft Internet Explorerだけです(かつ、ローカルゾーンに指定された範囲だけです)。
  • MozillaやFirefoxでは、設定オプションのsecurity.checkloaduriで有効にすることができます。ただし、この方法は非推奨です。
  • 詳しくは151をご覧下さい。

画像リンク

次の例のようにリンクの書式と画像の書式を組合せて、画像にWiki内のページや他サイトのページへのリンクをつけることもできます。

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

留意点: リンク名のかわりに使えるのは画像の書式だけです。

画像リンクで使える補助書式(画像サイズの変更、内部画像、外部画像、URL、Interwikiリンクなど)はすべて使えます。

脚注(Footnotes)

脚注の入力 1) ができます。半角カッコ2つで括ってください。

脚注の入力 ((これが脚注となります)) ができます。

セクション

最大5レベルまでの見出しをつけて、本文に階層構造をつけることができます。本文中に見出しが3つ以上あると、自動的にそのページの目次が生成されます。本文中に~~NOTOC~~と書くと、目次の自動生成を止めることができます。

見出しレベル3

見出しレベル4

見出しレベル5
==== 見出しレベル3 ====
=== 見出しレベル4 ===
== 見出しレベル5 ===

半角ハイフンを4つ以上続けて書くと仕切り線が引けます。


画像その他のメディアファイルの埋め込み

Wiki 内外の画像を埋め込むには、カーリー(波括弧)を使います。オプションとして画像サイズを指定することもできます。

実物サイズ:

幅指定のリサイズ:

幅/高さ指定のリサイズ:

外部イメージのリサイズ:

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

align指定は、左/右に半角スペースを1個入れて指定します。

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

title指定(ツールチップ表示)もできます。
[翻訳時追記]title入力時のalign指定用スペースは画像ファイル名前後に入れる。

This is the caption

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

画像ファイル(gif,jpeg,png)以外のファイル名を指定した場合は、テキストリンクとなります。

画像リンク作成は上記の画像リンクを参照してください。

箇条書き

Dokuwiki では通し番号付きの箇条書きと番号なしの箇条書きが使えます。半角スペース2つでインデントして、その後に番号なしなら*を、番号付きなら-に続けて箇条書きにしたいテキストを書きます。

  • これは箇条書き
  • 二つ目の項目
    • レベルを変える事もできます
  • もうひとつ別の項目
  1. 同様に番号付き箇条書き
  2. 別の項目
    1. インデントをするだけでレベルが深くなります
  3. 以上!
  * これは箇条書き
  * 二つ目の項目
    * レベルを変える事もできます
  * もうひとつ別の項目

  - 同様に番号付き箇条書き
  - 別の項目
    - インデントをするだけでレベルが深くなります
  - 以上!

顔文字

DokuWikiは、よく使われる顔文字を自動的に顔のアイコンに変換します。顔のアイコンの種類を増やす場合は、smileyディレクトリーにアイコンのファイルを追加して、conf/smileys.confファイルでどの顔文字をどのアイコンに変換するかを設定します。DokuWikiに標準で入っている顔のアイコンは次の通りです。

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME 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 はシンプルな文法で表組みを実現します。

ヘッダ 1 ヘッダ 2 ヘッダ 3
行 1 列 1 行 1 列 2 行 1 列 3
行 2 列 1 列結合 (区切り文字は2つ入れる)
行 3 列 1 行 2 列 2 行 2 列 3

テーブル(表)の各行は、 始めと終わりに|を書きます。ヘッダ(見出し)行は^を代わりに書きます。

^ ヘッダ 1      ^ ヘッダ 2       ^ ヘッダ 3          ^
| 行 1 列 1    | 行 1 列 2     | 行 1 列 3        |
| 行 2 列 1    | 列結合 (区切り文字は2つ入れる) ||
| 行 3 列 1    | 行 2 列 2     | 行 2 列 3        |

横隣のセルをつなぎたいときは、上の『列結合』の例のように、区切り文字を続けて書いて、つなぎたいセルの中味を無しにします。すべての行の区切り文字の数が同じになるように気をつけてください。

表のヘッダ(見出し)を一番上の行だけではなく一番左の列に縦に並べることもできます。

ヘッダ 1 ヘッダ 2
ヘッダ 3 行 1 列 2 行 1 列 3
ヘッダ 4 列結合しないケース
ヘッダ 5 行 2 列 2 行 2 列 3

お気付きだと思いますが、セルの始まりの区切り文字に何を使うかによってそのせるがヘッダ(見出し)になるかどうかが決まります。

|              ^ ヘッダ 1            ^ ヘッダ 2          ^
^ ヘッダ 3    | 行 1 列 2          | 行 1 列 3        |
^ ヘッダ 4    | 列結合しないケース |                    |
^ ヘッダ 5    | 行 2 列 2          | 行 2 列 3        |

注意点: 行結合(rowspan)はサポートしていません。

セル内のalign指定(文字配置の横位置)が可能です。セル内テキストの前後に半角スペースを2つ入れて指定します。左に半角スペースを2つ入れると右寄せになり、右に半角スペースを2つ入れると左寄せとなります。左右の両方に半角スペースを2つ入れると中央揃えになります。

align指定の表サンプル
右寄せ 中央揃え 左寄せ
左寄せ 右寄せ 中央揃え
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

上記のソースは以下のようになっています:

^           align指定の表サンプル           ^^^
|         右寄せ|    中央揃え    |左寄せ          |
|左寄せ          |         右寄せ|    中央揃え    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

記述した内容そのままを表示する

文書の中の一部分の行の始めに半角スペースを2つ以上入れてインデントをつけるか、codeあるいはfileタグで囲むと、その部分だけWikiの文法解釈をせずに、記述した内容をそのまま表示させることができます。

プログラムのソースコードなどを書くときに使います。等幅フォントで表示されます。
         ←このように、入力したスペースがそのまま表示されます。
これもよく似た表示になります。ファイルの中身を引用するときなどに使います。

ある部分だけWikiの文法解釈を完全にしないようにするには、その部分をnowikiタグか、%%(パーセント記号2つ)で囲みます。

ここには http://www.splitbrain.org といったアドレスや **フォーマット記号** が書いてありますが、書いたままに表示されています。

このページのソースを表示すると、どういうふうに記述してあるかがわかります。

言語シンタックスハイライト表示

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, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, xml

HTMLとPHPの埋め込み

生のHTMLやPHPのコードを埋め込んでHTMLのまま表示させたりPHPスクリプトとして動作させるには次のようにhtmlphpタグを使います。

<html>
ここに埋め込みたい<font color="red" size="+1">HTML</font>を書く
</html>
ここに埋め込みたい<font color="red" size="+1">HTML</font>を書く
<php>
echo 'PHPスクリプトから表示したロゴ画像:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>
echo 'PHPスクリプトから表示したロゴ画像:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

注意: HTMLとPHPの埋め込みは、セキュリティ上危険ですので、デフォルトの設定ではできないようになっています。埋め込みができないように設定されている場合、埋め込んだコードを実行するのではなくソースのコードがそのまま表示されます。

記法を拡張するプラグイン

DokuWikiの記法はPluginsで拡張することが可能です。インストールしたプラグイン独自の記法は各々のプラグインの説明ページを参照してください。このサイトでは、下記の記法拡張プラグインがインストールされています:

  • Info Plugin 2005-08-03 by Andreas Gohr
    Displays information about various DokuWiki internals
  • Tree Plugin 2006-03-11 by Roland Hellebart
    Displays windows explorer styled tree.
    <tree|thpe your header>add the nodes</tree>
    Add folowing line in the meta area of your template:
    <script type="text/javascript" src="<?php echo DOKU_BASE; ?>lib/plugins/tree/dtree.js"></script>
    Special thanks to Geir Landr, this plugin uses the javascript dtree from him. [[http://www.destroydrop.com/javascripts/tree/]]
1) これが脚注となります
 
wiki/syntax.txt · 最終更新: 2006/04/01 02:56 by osamuh