DokuWiki 記法概要

詳細は マニュアル/整形記法 を参照のこと。

概観

  • 見出しのランクは、見出し文字列をはさむ「=」の数で決まる。「H1」にあたるのが「======」で、以下、ひとつずつ減らす。この書式はソースのテキストファイルを直接開いたときに、見出しを判別しやすくするためとのこと。
  • ファイルに 名前空間 (ネームスペース)によるカテゴリ分けを使用するときは、「dokuwiki:example」のようにコロンでつなぐ。DokuWiki では、データファイルはネームスペースごとに別フォルダに保存される仕様。
    • ルートフォルダの項目へのリンクは「:example」となる。「example」は同一ネームスペース内ファイルへの移動。同一ネームスペース内のフォルダに移動するには「.:example」。
    • ひとつ上位のネームスペースのファイルに移動するには「..example」と書く。ネームスペース(フォルダ)の区切りは「:」なので、現在位置のとなりのフォルダ「next」の「example]の項目に移動するには「..next:example」と書く。
    • その他、ネームスペースの表記は 名前空間 を参照。
  • Wiki 内の他のページや、外部へのリンクは次のように表記。
    • 他のページ ― [[実体ファイル名(拡張子 .txt をのぞいた本体部分)]] (useheader 指定がされていると、そのファイルの最初の見出し(日本語可)がリンクに表示される。
    • 他のページの特定のセクションにリンク ― [[実体ファイル名#セクションアンカー|ラベル]] (セクションアンカーは見出しごとに日本語で生成されるが、アンカーとして機能しているもよう。)
    • 他のページに任意のラベルをつける ― [[実体ファイル名|ラベル]]
    • 外部リンク ― [[http://example.com/|外部リンクラベル]]

編集ウィンドウ

  • 編集ウィンドウの上に並んだボタンで各種タグが簡単に入力できる。(ブラウザの種類や設定によっては、ボタンが表示されない。)
  • 編集ウィンドウ(テキストエリア)の右下の矢印は左から、「編集ウィンドウを下に拡げる」、「編集ウィンドウを縮める」、「ウィンドウ内の自動折り返しオン・オフ」ができる。
  • 編集ウィンドウ下の「変更箇所概要」は RSS と差分記録における「概要」となる。
  • その右に「小変更」(マイナーチェンジ)にチェックを入れると、新しい編集記録としてはリストに出ない。
  • 編集ウィンドウ左下の「確認」で編集後の表示のプレビュー。

パラグラフ

  • テキストは空行があるまでひとつのパラグラフとして繋がる。
  • 強制改行は行末で「\\」。欧文フォントではバックスラッシュ、日本語フォントでは YEN マークを2つ。
  • 変換をかけずに書いたままを表示するには、行頭に 半角スペース2つ を入れる。
行頭に半角スペースふたつを入れたとき、
こんなふうにコード向けの表示になります。
このブロックの前後には空行が必要です。

文字修飾

  • ボールド(** ではさむ)、イタリック(// ではさむ)、下線(__ アンダーバー2つではさむ)、等幅(コード用、シングルクォート2つではさむ)が使え、組み合わせ可。
  • この他に、取り消し線(<del> </del>)、上付き文字(<sup> </sup>)、下付き文字(<sub> </sub>)もあり。
  • Wiki 書式変換したくない部分は半角パーセント記号2つではさむ。(上の項目のように、タグを表記したい場合など。)

リスト

  • 番号なしリスト(HTML タグの UL リスト)は、行頭から半角スペース2つ+アスタリスク。アスタリスク後の半角スペースはなくても可。
    • ネストするには、半角スペースを2つ単位で増やす。
      • さらにネスト。
        • さらにネスト。
          • さらにネスト。
            • さらにネスト。
              • さらにネスト。
                • さらにネスト。(なんかいくらでも行けそうです。)
  • 番号つきリスト(HTML タグの OL リスト)は、行頭から半角スペース2つ+ハイフン。
    1. 水は温度によって性質が変化します。
      1. 摂氏0度以下で氷になります。
        1. 上空の大気中で冷えて結晶すると雪になります。
    2. 水蒸気は透明です。
  • 番号つきリストのラベルの種類は design.css の中の div.dokuwiki ol {list-style-type: decimal} などの指定による。

脚注

脚注番号を入れたい場所に、脚注の内容となるテキストを (( と )) で囲んで記述する。1)

ファイル添付

イメージファイルの貼り付け

イメージファイルのファイル名は英数半角を推奨。リンクにキャプションをつけるのではなく、個別の画像にキャプションをつけたい場合は、画像ファイルをコメントが書き込める JPEG ファイルとし、あらかじめファイルに埋め込んでおくか、メディアマネージャから編集します。

  1. 編集ウィンドウ上部の「イメージやファイルの追加」(額縁のアイコン)をクリック。
  2. メディアマネージャ・ウィンドウがたちあがる。
    • 編集中のページがあるサブカテゴリがウィンドウ上部に表示されているので、確認する。
    • アップロードするサブカテゴリを移動する場合は、左ペインのツリー表示をクリックして選択。
    • 同じサブカテゴリにすでにアップロードされている他のファイルがウィンドウ下部に表示されている。
  3. 新規にファイルをアップロードして貼り付ける場合は、右ペインのアップロードするファイルを選ぶダイアログから、ファイルを選択。ファイルのリネームが必要であれば「名前を変更」に入力し、「アップロード」ボタンをクリック。
    • すでにアップロードしてあるファイルをページ内に表示するには、次の手順へ。必要であれば左ペインのツリーでサブカテゴリを移動する。
    • イメージファイルのサムネイルが右ペインに追加されるので確認する。JPEG ファイルの場合、「メタデータ編集」ができるので、必要であれば 鉛筆のアイコン をクリックして、イメージのタイトルおよびキャプションを入力。
  4. 右ペインのファイル名リンクをクリックすると、編集中のページにそのイメージへのリンクが挿入される。
  5. {{:サブカテゴリ:イメージファイル名|}} のように挿入されたリンクの「|」の右側にイメージのタイトル(ツールチップに表示される説明)を入力。タイトルが必要なければ「|」はいらない。

イメージリンクのオプション

  • センタリング、左寄せ、右寄せについては、リンク文字列の左右({{ と | の間、あるいは {{ と }} の間)の 両側 に半角スペースを入れると センタリング右だけ に入れると 左寄せ左だけ に入れると 右寄せ。(左寄せ、および、右寄せにした場合、反対側にその直後に書いたテキストが流し込まれる。
    • 右寄せ、左寄せ後の流し込み解除は、とくに記法がないようだ。
  • サイズを指定して表示するには、イメージへのリンク文字列に続けて「?横幅ピクセル数」と書く。縦サイズは自動的に決まる。
  • サイズ指定で「?横x縦」と書くと、横幅ピクセル数に合わせて縮小したのち、縦は指定したピクセル数を表示(中央より少し上の部分か)。
  • サイズ以外のオプションには次のものがある。
    • direct ― 画像をクリックしたときに、DokuWiki 標準のファイル情報つきの画像展示ページではなく、画像そのものを表示する。
    • nolink ― 画像を表示するのみで、リンクなし(クリックできない)。
    • linkonly ― 画像を表示せず、リンクのみを記述。
  • リンク文字列の後の「?」より後がオプションとなり、複数のオプションを組み合わせるときは最初は「?」で次からは「&」でつなぐ。
    • たとえば、{{:wiki:dokuwiki-128.png?nolink&100}} のように表記する。

資料ファイルのアップロード

  1. 編集ウィンドウ上部の「イメージやファイルの追加」(額縁のアイコン)をクリック。
  2. メディアマネージャ・ウィンドウがたちあがる。
    • 編集中のページがあるサブカテゴリがウィンドウ上部に表示されているので、確認する。
    • アップロードするサブカテゴリを移動する場合は、左ペインのツリー表示をクリックして選択。
  3. ページ内にアップロードしたファイルへのリンクを挿入するには、メディアマネージャ・ウィンドウ右ペインの該当ファイルのファイル名(リンクになっている)をクリックする。

新規フォルダ作成して、そこにファイルをアップロード

  1. 編集ウィンドウ上部の「イメージやファイルの追加」(額縁のアイコン)をクリック。
  2. メディアマネージャ・ウィンドウがたちあがる。
  3. 新規フォルダの親フォルダの場所に移動。
  4. アップロードするファイルをローカルで選択。
  5. アップロード後のファイル名の候補が表示されている窓(「名前を変更してアップロード」のところ)で、ファイル名の先頭に フォルダ名 (英数半角)を追加、その後に半角コロンを入れて、アップロードを実行。

これでファイルのアップロードと同時に、名前を指定した新規フォルダが作成されます。

1) 脚注の内容は、脚注番号の上にカーソルを合わせると、ツールチップに表示される。
 
dokuwiki/syntax_summary.txt · 最終更新: 2011/09/02 04:27 by kaburaya
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution 3.0 Unported
Recent changes RSS feed Creative Commons License Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki