ドキュメンテーションの方針

こちらでは，ドキュメンテーションにあたって，特に Wiki 特有の事情に関わることを記します．
ページの作成と管理に関わることは，HowToWriteWikiに分割されました．

ページの編集

ページの編集について記します。 詳細については HelpOnEditing を参照してください．

署名

署名をつけてみてはどうでしょうか． @SIG@
署名をつけてみてはどうでしょうか． -- chmod 2010-12-18 03:23:35

時刻も挿入できます．@TIME@
時刻も挿入できます．2010-12-21 02:05:06

• 署名・時刻共にプレビューでは@SIG(TIME)@のままなので注意 -- neotaso 2014-03-05 02:39:58

見出し一覧

<<TableOfContents()>>

また，()のなかに数字を入れると，その高さの段落までになります．
e.g.

<<TableOfContents(2)>>

見出し

HelpOnHeadlines = 前後の空白に気をつけてください。

= Level 1 =
== Level 2 ==
=== Level 3 ===
...

警告

{{{#!wiki caution
'''警告を使いすぎないでください．'''

警告の使い過ぎに注意してください．警告だらけのページは落ち着きがありません．
}}}

{{{#!wiki warning
'''警告文です．'''

警告文のテストです．
}}}

{{{#!wiki important
'''重要文です．'''

重要文のテストです．
}}}

{{{#!wiki note
'''注釈文です．'''

これは注釈文です．
}}}

{{{#!wiki tip
'''Tip'''

ティップスです．
}}}

改行

HelpOnMacros 強制改行は，マクロとして実現されます．

いろはにほへと<<BR>>ちりぬるをわか<<BR>>よたれそつねな

いろはにほへと
ちりぬるをわか
よたれそつねな

ただし，強制改行は好ましくありません．空白行をはさむと段落として認識されるので，それに従って構造的な文章を記述するよう心がけてください．

箇条書き

HelpOnLists * 前後の空白に気をつけてください。

箇条書き

 * その1
 * その2
  * その2-1
   * その2-1-1
  * その2-2

• その1
• その2
  • その2-1
    • その2-1-1
  • その2-2

 1. その1
 1. その2

1. その1
2. その2

言葉の定義

言葉の定義には、こちらを使いましょう。

 Δt:: 相対的に微少量と見なせる時間のこと。
 die Nabe:: 折に触れて開催されるイベント。また、そこで振舞われる料理。

Δt

相対的に微少量と見なせる時間のこと。

die Nabe

折に触れて開催されるイベント。また、そこで振舞われる料理。

書体

HelpOnFormatting

リンク

HelpOnLinking リンクの作成方法を示します．
WikiName と呼ばれる名前(2単語以上を，空白なしで，語頭を大文字にしてつないだもの．)は，自動でリンクされます．

 * [[Home]]
 * [[Home|トップページ]]
 * [[http://www.uec.ac.jp/]]
 * [[http://www.uec.ac.jp/|電気通信大学]]

• Home

• トップページ

• http://www.uec.ac.jp/

• 電気通信大学

文字寄せ

後述のパーサーを利用します．

{{{#!wiki left
This is a left text.
}}}
{{{#!wiki center
This is a center text.
}}}
{{{#!wiki right
This is a right text.
}}}

枠

{{{#!wiki solid
This is a solid-applied text.
}}}
{{{#!wiki dashed
This is a dashed-applied text.
}}}
{{{#!wiki dotted
This is a dotted-applied text.
}}}

エスケープ

{{{`文字列`}}} あるいは `{{{文字列}}}`

等幅で，そのまま表示されます。(プロポーショナルなまま表示ではどうするのか．)

コードの貼り付け

HelpOnParsers ハイライトは、パーサーのひとつとして実装されています。その他利用可能なパーサーについては，以下を参照してください．

• HelpOnParsers

{{{#!highlight haskell
quicksort' :: Ord a => [a] -> [a]
quicksort' [] = []
quicksort' (x:xs) = quicksort' smaller ++ [x] ++ quicksort' larger
    where
        smaller = [a | a <- xs, a < x]
        larger = [a | a <- xs, a >= x]
}}}

   1 quicksort' :: Ord a => [a] -> [a]
   2 quicksort' [] = []
   3 quicksort' (x:xs) = quicksort' smaller ++ [x] ++ quicksort' larger
   4     where
   5         smaller = [a | a <- xs, a < x]
   6         larger = [a | a <- xs, a >= x]

内部的には，Pygmentsを使用してハイライトされます。

• HelpOnParsers#Available_highlight_lexers

• http://pygments.org/languages/

動画の埋め込み

http://moinmo.in/MacroMarket/YouTube

<<YouTube(ksi4jm_Gkjk)>>

実行例: Kagisys

カテゴリ一覧

http://moinmo.in/MacroMarket/CategoryCloud

<<CategoryCloud>>

CategoryDocument CategoryWikiBooks