Wiki記法の問題点、および一解決策

ラボ社内でWiki記法の問題について議論する機会があったので、それを紹介したいと思います。Wikiは開発者やIT技術に深い人にとっては便利なドキュメント管理ツールであるが、それ以外の人達の層にはなかなか普及しているとは言いがたい。普及を妨げている点の１つがWiki記法ではないだろうか。

Wiki記法の問題点として、以下のような意見があがった。

1. 記法を覚えなければならない
   
2. 入力を完了しないと、思ったとおり表示されるか確認できない
   

1.に関しては「覚えなければならない」という点もそうであるが、多種多様なWikiが存在し、Wiki記法の方言の問題もあると思う。

そこで、2.の点に関しては解決の方法にはならないが、1.の点に関する解決の方法として、記法をシンプルにすることによって、解決を図れないか検討してみた。

検討した記法は、以下の考え方である。

1. 整形後に消えてしまう文字列は極力なくす
   
2. つまり、**太字** が <strong>太字</strong> などに変換されると、** という文字列が消えてしまうが、このような記法は排除する
   

上記の点を重視して、以下のような機能に絞り込んでみました。

1. フォントは全て等幅フォント
   
   • TEXTAREAのフォントは通常等幅フォントなので、表示時と同様の視覚効果が得られる
     
2. 改行は <br />
   
3. パラグラフは <p>
   
4. 「・」「* 」で始まる行は、箇条書きリスト（ulタグ）
   
5. 「(数字).」「#.」で始まる行は、番号付きリスト（olタグ）
   
6. スペースで始まるパラグラフはソースコードまたはコマンドラインと解釈して、preタグを使用
   
   • ただし、blockquote を期待する場合もあると思うので、CSSで word-wrap: break-word /* IE5.5- */ または white-space: pre-wrap; /* CSS3 */ としておく
     
7. http://, https:// で始まる文字列はaタグでリンクを生成
   

記法自体をこの程度にとどめておくと、プレーンテキストとして表示させた場合と近い表示を維持できる。また、記法を気にせずに記述した場合でも、想定外の表示になるケースもまれなので、Wikiに慣れていない人にも使用可能であると考えます。