====== 整形記法 ====== 文章の整形を行うには、シンプルなマークアップ記法を用います。 [[wiki:DokuWiki]] の記法は、ソース自体もできるだけ読みやすくなるよう考慮されています。 画面の上部か下部にある //編集// ボタンをクリックすると、ページのソースを見ることができます。 このページでは、編集にあたって利用できる記法をすべて説明します。 ためしに編集をしてみたい場合には、 [[playground:playground|playground]] ページを使ってください。 主な記法は、[[doku>wiki:quickbuttons|クイックボタン]] からも利用できます。 ===== 基本的なテキスト整形 ===== 文字飾りとして **太字**、 //斜体//、 __下線__ 、''等幅'' を利用できます。 もちろん **__//''組み合わせる''//__** こともできます。 文字飾りとして **太字**、 //斜体//、 __下線__ 、''等幅'' を利用できます。 もちろん **__//''組み合わせる''//__** こともできます。 さらに 上付き と 下付き も使えます。 さらに 上付き と 下付き も使えます 取り消し線 も利用できます。 取り消し線 も利用できます。 空行をおくと、**段落** となります。 段落内で **強制的に改行** するには、バックスラッシュ（日本語環境では円記号￥） を 2 つ連ねた後に空白文字を置くか改行します。 この文は改行\\ を含んでいます。2 連バックスラッシュが 改行として処理されるのは、空白文字が続く\\ か行の最後\\ にある場合だけで、\\それ以外はそのまま表示されます。 この文は改行\\ を含んでいます。2 連バックスラッシュが 改行として処理されるのは、空白文字が続く\\ か行の最後\\ にある場合だけで、\\それ以外はそのまま表示されます。 強制改行は、どうしても必要な場合だけ使ってください。 ===== リンク ===== リンクの記述には様々な方法があります。 ==== 外部リンク ==== http://www.google.com や、よりシンプルに www.google.com のように文書中の URL は、 外部リンクとして自動的に認識されます。表題を指定して、 [[http://www.google.com|googleへのリンク]] のようにもできます。 メールアドレスも、不等号で括ると、 のように自動的に認識されます。 http://www.google.com や、よりシンプルに www.google.com のように文書中の URL は、 外部リンクとして自動的に認識されます。表題を指定して、 [[http://www.google.com|googleへのリンク]] のようにもできます。 メールアドレスも、不等号で括ると、 のように自動的に認識されます。 ==== 内部リンク ==== この DokuWiki 内のページへのリンクには 2 連角カッコを使います。ページ名そのままで [[doku>wiki:pagename]] とするか、[[doku>wiki:pagename|表題]] を指定します。 ページ名は自動的に小文字に変換されます。特殊文字は使えません。 この DokuWiki 内のページへのリンクには 2 連角カッコを使います。ページ名そのままで [[doku>wiki:pagename]] とするか、[[doku>wiki:pagename|表題]] を指定します。 ページ名は自動的に小文字に変換されます。特殊文字は使えません。 ページ名をコロンで区切ると [[doku>wiki:namespaces]]（名前空間）を利用できます。 ページ名をコロンで区切ると [[doku>wiki:namespaces]]（名前空間）を利用できます。 詳細は [[doku>wiki:namespaces]] をご覧ください。 ページ中の特定のセクションにリンクすることも可能です。ハッシュ記号（#）に続けてセクション名を記述します。 [[syntax#内部リンク|このセクション]] へのリンクです。 [[syntax#内部リンク|このセクション]] へのリンクです。 注: * [[wiki:syntax|既存のページ]] へのリンクと [[wiki:存在しないページ]] へのリンクとは表示が異なります。 * デフォルト設定では [[wp>CamelCase]] をリンクとして扱いません。config ファイルで変更できます。もし、「DokuWiki」 がリンクになっていれば有効になっています。 * セクションの見出しが変更されると、そこへのリンク名も変化します。セクションへのリンクは多用しないほうが良いでしょう。 ==== Interwiki ==== [[doku>wiki:interwiki|Interwiki]] リンクも利用できます。 InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 [[wp>Wiki]] は Wikipedia のページへのリンクです。 [[doku>wiki:interwiki|Interwiki]] リンクも利用できます。 InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 [[wp>Wiki]] は Wikipedia のページへのリンクです。 ==== Windows共有フォルダ ==== Windows 共有フォルダも [[\\server\share|this]] のように使えます。 ただし、[[wp>Intranet|イントラネット]] 内のように、仲間内でしか正常に使えませんので、注意してください。 Windows 共有フォルダも [[\\server\share|this]] のように使えます。 注: * セキュリティ上、Windows 共有フォルダを直接ブラウズできるのは、デフォルトでは Microsoft Internet Explorer（の「ローカルゾーン」）のみに限られます。 * 推奨はしませんが、Mozilla や Firefox では設定オプションの [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]] から有効にできます。 * 詳しくは [[bug>151]] をご覧ください。 ==== 画像にリンク ==== リンク記法と [[#images_and_other_files|画像]] （後述）を組み合わせると、 次のように、画像に内外部へのリンクをつけることができます。 [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] 注: リンクの表題については、この画像以外の整形記法は使えません。 [[#画像やその他のファイル|画像]] と [[#リンク|リンク]] の記法はすべてサポートされます （画像のサイズ変更や、内外部イメージ、URL 指定や interwiki リンクなど）。 ===== 脚注 ===== 脚注 ((これが脚注です)) には、2 連の丸カッコを用います。 脚注 ((これが脚注です)) には、2 連の丸カッコを用います。 ===== セクション見出し ===== 最大 5 つのレベルまでの見出しを使って、文章の構造化を行えます。 3 つ以上の見出しを記述すると、目次が自動的に生成されます。 文書中に ''~~NOTOC~~'' という文字列を書くと 目次の生成を止めることができます。 ==== 第 3 見出し ==== === 第 4 見出し === == 第 5 見出し == ==== 第 3 見出し ==== === 第 4 見出し === == 第 5 見出し == ダッシュ (-) を四つ以上続けると、水平線が書けます。 ---- ===== 画像やその他のファイル ===== 波カッコを使って、[[doku>images|画像]] を記述できます（画像ファイルが wiki 内部にあっても外部でもかまいません）。オプションで、画像サイズも指定できます。 実サイズ: {{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?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}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }} さらに、タイトルも指定できます（ほとんどのブラウザで、ツールチップで表示されます）。 {{ wiki:dokuwiki-128.png |キャプションです}} {{ wiki:dokuwiki-128.png |キャプションです}} 画像 (''gif,jpeg,png'') 以外のファイル名を指定すると（ファイルが内外部いずれでも）、そのファイルへのリンクとして表示されます。 画像を他のページへのリンクとするには、上記の [[#画像にリンク]] をご覧ください。 ===== リスト ===== リスト（番号付き・番号無し）を利用できます。行頭にスペースを 2 つ連ねた後に、''*'' （番号無し）または ''-'' （番号付き）を記述します。 * リストです * 2番目の要素です * 入れ子にもできます * 次の要素です - 番号付きリストです - 次の要素です - 入れ子にするにはインデントを深くします - 以上です * リストです * 2番目の要素です * 入れ子にもできます * 次の要素です - 番号付きリストです - 次の要素です - 入れ子にするにはインデントを深くします - 以上です ===== スマイリー ===== [[wp>emoticon|感情]] を画像でもって表現するのがスマイリーです。スマイリーは ''smiley'' ディレクトリにたくさん収録されており、 ''conf/smileys.conf'' ファイルで設定されています。 使用できるスマイリーは次のとおりです。 * 8-) %% 8-) %% * 8-O %% 8-O %% * :-( %% :-( %% * :-) %% :-) %% * =) %% =) %% * :-/ %% :-/ %% * :-\ %% :-\ %% * :-? %% :-? %% * :-D %% :-D %% * :-P %% :-P %% * :-O %% :-O %% * :-X %% :-X %% * :-| %% :-| %% * ;-) %% ;-) %% * ^_^ %% ^_^ %% * :?: %% :?: %% * :!: %% :!: %% * LOL %% LOL %% * FIXME %% FIXME %% * DELETEME %% DELETEME %% ===== 記号===== 記号を、普通の文字の組み合わせで記述することができます。認識される記号の例を次に示します。 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..." -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..." 注： [[doku>wiki:config#typography|設定オプション]] と [[doku>wiki:entities|パターンファイル]] を変更すると、この記号への変換を停止することができます。 ===== 引用 ===== ある文が、返信であったり、コメントであるということを表現したい場合もあります。その場合、次の記法を使います。 やった方が良いと思うけど。 > いや、やるべきではない！ >> まあ、やるべきでしょうね。 > ほんとに？ >> 本気です！ >>> では、やりましょう！ やった方が良いと思うけど。 > いや、やるべきではない！ >> まあ、やるべきでしょうね。 > ほんとに？ >> 本気です！ >>> では、やりましょう！ ===== 表 ===== 簡単な記法で表を作成できます。 ^ 見出し 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 | 注: 縦方向の結合 (行の結合) はできません。 表の内容の配置を指定できます。2個以上のスペースをテキストの反対側に置きます。 つまり、右揃えにするには左側に2個のスペースを、左揃えにするには右側に2個のスペースを置きます。 中央揃えにするにはテキストの両側に2個以上のスペースを置きます。 ^ 配置を指定した表 ^^^ | 右| 中央 |左 | |左 | 右| 中央 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 上記のソースは次のようになります。 ^ 配置を指定した表 ^^^ | 右| 中央 |左 | |左 | 右| 中央 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | ===== 整形されないブロック ===== 整形が行われないブロックを記述することができます。2 つ以上のスペースでインデントする（前記の例を参照）か、''code'' タグか ''file'' タグを使います。 整形済みのコードです。スペースの数が次のように保持されます。例、　　　　　　　　　　　　<- ここ 同様ですが、ファイルの内容を示すときに使います。 ある範囲に対して整形を完全に行わないようにするには、その範囲を ''nowiki'' タグで括るか、2 連のパーセント記号 ''%%'' で括ります。 たとえば、アドレスを http://www.splitbrain.org のように記述したり、 **整形** と書いても、何も処理がされません。 これらのブロックの使用については、このページのソースを見ると良いでしょう。 ===== 構文のハイライト ===== ソースコードの構文をハイライト表示して、読みやすくすることができます。[[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. } } 現在のところ、次の言語がサポートされています。//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'' タグを次のように使います。 This is some HTML This is some HTML echo 'A logo generated by PHP:'; echo 'PHP Logo !'; echo 'A logo generated by PHP:'; echo 'PHP Logo !'; **注**: HTML と PHP の埋込みは、デフォルトの設定では無効になっており、コードは実行されず、そのまま表示されます。 ===== 記法のプラグイン ===== DokuWiki の記法は、 [[doku>wiki:plugins|プラグイン]] を使って拡張することができます。各プラグインの使用方法は、各プラグインの解説ページにあります。この DokuWiki では、次の記法プラグインが使用可能となっています。 ~~INFO:syntaxplugins~~ ===== 翻訳 ===== //english version: dokuwiki-2006-03-09. // //Add your email here if you created translated or modified whole or part of this page.// //このページを作成・変更した方は、次にメールアドレスを追記してください。// * //[[haruki@planewave.org|Haruki SETOYAMA]] 2006-08-18 created//