* リストです
* 2番目の要素です
* 入れ子にもできます
* 次の要素です
- 番号付きリストです
- 次の要素です
- 入れ子にするにはインデントを深くします
- 以上です
[[doku>ja:faq:lists|リストに関する FAQ]] も参照してください。
===== テキストの変換 =====
DokuWiki は特定の文字や文字列を、画像や他のテキスト、HTML などに変換することができます。
テキストから画像への変換機能は、主にスマイリーで使用されます。テキストから HTML への変換機能は記号の変換に使用されますが、他の HTML に変換するように設定することもできます。
==== テキストから画像への変換 ====
DokuWiki は一般的に使用されている[[wp>empticon|顔文字]]を、同じような見た目を持つ画像に変換します。このような[[doku>ja:smileys|スマイリー]]や他の画像は、独自の設定で拡張することもできます。標準で使用できるスマイリーは以下の通りです。
* 8-) %% 8-) %%
* 8-O %% 8-O %%
* :-( %% :-( %%
* :-) %% :-) %%
* =) %% =) %%
* :-/ %% :-/ %%
* :-\ %% :-\ %%
* :-? %% :-? %%
* :-D %% :-D %%
* :-P %% :-P %%
* :-O %% :-O %%
* :-X %% :-X %%
* :-| %% :-| %%
* ;-) %% ;-) %%
* ^_^ %% ^_^ %%
* :?: %% :?: %%
* :!: %% :!: %%
* LOL %% LOL %%
* FIXME %% FIXME %%
* DELETEME %% DELETEME %%
==== テキストから HTML への変換 ====
記号: [[DokuWiki]] は、特定の文字列を活字表記的に同等な文字に変換することができます。以下に認識される文字列の例を示します。
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."
同様にして、どのような HTML でも[[doku>ja:entities|パターンファイル]]を設定しておけば生成することができます。
パターンファイル設定による変換には、3 つの例外があります。掛け算記号 (640x480)、'シングルクォート' および "ダブルクォート" です。これらの変換は、[[doku>:ja:config:typography|設定オプション]]からオフにすることができます。
===== 引用 =====
ある文が、返信であったり、コメントであるということを表現したい場合もあります。その場合、次の記法を使います。
やった方が良いと思うけど。
> いや、やるべきではない!
>> まあ、やるべきでしょうね。
> ほんとに?
>> 本気です!
>>> では、やりましょう!
やった方が良いと思うけど。
> いや、やるべきではない!
>> まあ、やるべきでしょうね。
> ほんとに?
>> 本気です!
>>> では、やりましょう!
===== 表 =====
簡単な記法で表を作成できます。
^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^
| 行 1 列 1 | 行 1 列 2 | 行 1 列 3 |
| 行 2 列 1 | 列の結合 (後の縦線が2つであることに注意) ||
| 行 3 列 1 | 行 3 列 2 | 行 3 列 3 |
表の各行は通常 ''|'' (縦線)ではじめます。見出し行については、 ''^'' (ハット記号)ではじめます。
^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^
| 行 1 列 1 | 行 1 列 2 | 行 1 列 3 |
| 行 2 列 1 | 列の結合 (後の縦線が2つであることに注意) ||
| 行 3 列 1 | 行 3 列 2 | 行 3 列 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 |
行を結合することもできます。行の結合をする場合は、結合対象セルの下のセルの中に '':::'' という文字列を入力します。
^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^
| 行 1 列 1 | 行の結合 | 行 1 列 3 |
| 行 2 列 1 | ::: | 行 2 列 3 |
| 行 3 列 1 | ::: | 行 2 列 3 |
これらのセルに '':::'' 以外の文字列を入力することはできません。
^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^
| 行 1 列 1 | 行の結合 | 行 1 列 3 |
| 行 2 列 1 | ::: | 行 2 列 3 |
| 行 3 列 1 | ::: | 行 2 列 3 |
表の内容の配置を指定できます。2個以上のスペースをテキストの反対側に置きます。
つまり、右揃えにするには左側に2個のスペースを、左揃えにするには右側に2個のスペースを置きます。
中央揃えにするにはテキストの両側に2個以上のスペースを置きます。
^ 配置を指定した表 ^^^
| 右| 中央 |左 |
|左 | 右| 中央 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
上記のソースは次のようになります。
^ 配置を指定した表 ^^^
| 右| 中央 |左 |
|左 | 右| 中央 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
===== 整形の無効化 =====
もし入力した通りに (何も整形せずに) 表示する必要がある場合は、''%%%%'' もしくは ''%%%%'' タグを使用することにより、コードブロックを記述することができます。
このテキストは 2 つの半角スペースによってインデントされています。
整形済みのコードです。スペースの数が次のように保持されます。例、 <- ここ
同様ですが、ファイルの内容を示すときに使います。
上記のブロックは以下のようなソースから作成されています。
このテキストは 2 つの半角スペースによってインデントされています。
整形済みのコードです。スペースの数が次のように保持されます。例、 <- ここ
同様ですが、ファイルの内容を示すときに使います。
===== 整形の無効化 =====
もし入力した通りに (何も整形せずに) 表示する必要がある場合は、''%%%%'' タグか、よりシンプルに 2 つの連続したパーセント記号 ''%% '' で挟みます。
このテキストには http://www.splitbrain.org のようなアドレスや**整形記法**を含みますが、実際には何も整形されません。
同様に %%//__この__スマイリー付きの//テキスト ;-)%% も整形されません。
このテキストには http://www.splitbrain.org のようなアドレスや**整形記法**を含みますが、実際には何も整形されません。
同様に %%//__この__スマイリー付きの//テキスト ;-)%% も整形されません。
===== コードブロック =====
2 つ以上の半角スペースでインデントするか、''%%%%'' もしくは ''%%%%'' タグを使用することにより、コードブロックを記述することができます。
このテキストは 2 つの半角スペースによってインデントされています。
整形済みのコードです。スペースの数が次のように保持されます。例、 <- ここ
同様ですが、ファイルの内容を示すときに使います。
上記のブロックは以下のようなソースから作成されています。
このテキストは 2 つの半角スペースによってインデントされています。
整形済みのコードです。スペースの数が次のように保持されます。例、 <- ここ
同様ですが、ファイルの内容を示すときに使います。
==== 構文のハイライト ====
ソースコードの構文をハイライト表示して、読みやすくすることができます。[[http://qbnz.com/highlighter/|GeSHi]] という汎用の構文ハイライトソフトを使用しており、GeSHi がサポートするすべての言語を扱うことができます。記法は、前述したコードブロックと同様ですが、言語の名称を ''
'' や '' '' のようにタグ内に記述します。
/**
* 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.
}
}
現在のところ、次の言語がサポートされています。//4cs, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, gdb, glsl, gml, gnuplot, groovy, gettext, haskell, hq9plus, html, idl, ini, inno, intercal, io, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, mapbasic, matlab, mirc, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, pascal, perl, perl6, per, php-brief, php, pike, pic16, pixelbender, plsql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, qbasic, rails, rebol, reg, robots, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xml, xorg_conf, xpp, z80//
==== ダウンロード可能なコードブロック ====
前述の ''%%%%'' や ''%%%%'' タグを使用した場合、示されているコードをダウンロード可能にしたいと思われるかもしれません。以下のように言語名の後にファイル名を記入することで、そのコードをダウンロード可能にすることができます。
構文のハイライトは不要だがダウンロードは可能にしたい場合は、''%%%%'' のように言語の名称としてハイフンマイナス (''-'') を使用してください。
===== HTML や PHP の埋込み =====
''%%%%'' タグおよび ''%%%%'' タグを使用することにより、HTML や PHP のコードを文書内に埋め込むことができます。ブロックレベルのコードを埋め込む場合は大文字のタグ (''%%%%'' および ''%%%%'') を使用してください。
HTML の例:
これは HTML インライン要素です。
これは HTML ブロックレベル要素です。
これは HTML インライン要素です。
これは HTML ブロックレベル要素です。
PHP の例:
echo 'PHP によって生成されたロゴ:';
echo '';
echo '(HTML インライン要素を生成)';
echo '同様ですが、ブロックレベル要素の中にあります: ';
echo ' ';
echo '
';
**注**: HTML と PHP の埋込みはデフォルトの設定では無効になっています。無効のままですと、コードは実行されずにそのまま表示されます。
===== RSS/ATOM フィードの取り込み =====
[[DokuWiki]]は外部のXMLフィードからのデータを統合できます。XMLフィードの解析には [[http://simplepie.org/|SimplePie]] を使っています。DokuWikiではSimplePieが解釈可能な全てのフォーマットが利用できます。スペースで区切られた複数の引数で表示をカスタマイズできます:
^ パラメータ ^ 意 味 ^
| 数字 | 最大表示数。デフォルト8 |
| reverse | 表示順を逆にする。 |
| author | 作者を表示する。 |
| date | 日付を表示する。 |
| description | 概要を表示する。 含まれる全てのHTMLタグは無効になります。 |
| 数字[dhm] | 更新間隔。数字の後の文字の意味は d=日、h=時間、m=分。(例 12h = 12時間) |
更新間隔のデフォルトは4時間です。10分未満の値は10分として扱われます。通常[[DokuWiki]]はページのキャッシュされたバージョンを提供しようとしますので、動的な外部の内容を含めるのは明らかに不適当です。このパラメータによって、ページが最後に描画されてから//更新間隔//以上経っていたら[[DokuWiki]]はキャッシュを破棄して再描画をします。
**例:**
{{rss>http://slashdot.jp/slashdotjp.rss 5 author date 1h }}
{{rss>http://slashdot.jp/slashdotjp.rss 5 author date 1h }}
===== 制御用のマクロ =====
いくつかの構文は、それ自身は出力されないものの、DokuWiki の動作に影響を及ぼします。以下のような制御用のマクロが利用可能です。
^ マクロ ^ 説明 |
| %%~~NOTOC~~%% | このマクロがページ上にあった場合、目次が生成されなくなります。 |
| %%~~NOCACHE~~%% | デフォルトでは、DokuWiki はすべての出力をキャッシュします。この動作は、場合によっては望まれないことがあります (%%%% タグが使用されている場合など)。このマクロを追加することにより、DokuWiki に毎回強制的にページを再描画させることができます。 |
===== 記法のプラグイン =====
DokuWiki の記法は、 [[doku>ja:plugins|プラグイン]] を使って拡張することができます。各プラグインの使用方法は、各プラグインの解説ページにあります。この DokuWiki では、次の記法プラグインが使用可能となっています。
~~INFO:syntaxplugins~~