miau's blog?

TracWiki の使い方についてちょっと一言

言っておこうかなと。

一番言いたいのは「[[BR]] なんか使うな」ってことになるかと。




■改行まわりの話

○基本的なところ

先月までのプロジェクトで「TracWiki による共有がいまいち盛んじゃないなー」と思って理由を聞いてみたところ、単純に習慣というのもあるんだけどそれ以外に
・Wiki って行がつながっちゃって使いにくい
・それを防ごうとすると [[BR]] とか入れる必要があってめんどくさい
みたいな意見があった。これは盲点・・・というか、目から鱗だった。この辺の意見を聞きやすい環境で本当によかった。

ちゃんと説明しておくと、行がつながるのは古来からある親切機能。ドキュメントは横幅 72 列とかのテキストファイルで書くけど、出力するときの横幅は 60 列かもしれないし 120 列かもしれない。なので出力フォーマッタはまず行を連結させて、出力先の横幅にあわせて改行を挿入しているわけです。そしてパラグラフ(段落)が変わる箇所では改行のみの行を入れておけば、出力時にちゃんとそこでパラグラフが分けられると。

この辺は知ってる限り roff(man で使われるフォーマッタ)からそうだし、Pod やその他 Wiki もこのようなルールになっているはず。

箇条書きにはそれ用の書式があるし、ちゃんとパラグラフを意識して書いてれば [[BR]] なんて要らないはずなんですよね。[[BR]] なんかを使うのは HTML で <br> を使うのと同じで、文書をちゃんと構造化できてないってこと。

・・・とまぁこの辺をちゃんと説明したところ、そのプロジェクトではみんな [[BR]] は使わなくなっていきました。思想を共有するのって大事ですね。

○TracWiki における例外

メールなんかを引用する場合に

> ○○をお願いします。
> # といっても××なので、
> # それほど急がなくてよいです。

こんな感じで行志向のコメントを貼り付けると、行が連結されちゃって見づらい。こういうケースだけは [[BR]] を使うこともあります。まあそれくらい例外的な事例ってことですけど。

○日本語特有の問題

英語圏での使用が前提なので、行を連結する際に間に単語同士がつながらないようにひとつスペースを入れちゃうんですよね。日本語の場合は文章中にいきなり空白が入ることになるので、少し気持ち悪いといえば気持ち悪いです。まあ慣れはするんですけど、気が向いたらソースとかいじりたいところ。

○今後は

Trac 0.11 で preserve_newlines なんてオプションができてる(新規構築環境ではデフォルトで yes の動作)ので、今後は改行が保持されるようになっちゃうのかもしれません。なんだかなぁ。

■Wiki での WYSIWYG について

Wiki はテキストベースで簡易な記述が行える、ってのが利点だと思うんですよね。テキスト編集のノウハウを最大限活かして文書の整形が行えるわけで、テキスト派にはたまらない魅力です。

WYSIWYG な編集だとなにかとかったるいですし、見た目が同じでも実は変なタグが入っていることがよくあって困ります。(diff なんかが無駄に見づらいです。)

そういう主義なもので、Deki Wiki の魅力がぜんぜんわからなかったり。「WYSIWYG な編集が行える」って、テキストでの編集ができないのであればそれは Wiki じゃなくてただのリッチエディットでしょ?と。

まあ、PC 等に詳しくない人にはそちらのほうが適切なのでしょうが、同業者には WYSIYWG は「Wiki 記法を覚えるまでの補助」くらいの気持ちで使ってほしいなー、と思うのでした。


(2009-07-14 追記)

Trac 側では os.linesep を挿入しているだけで、半角として表示しているのはブラウザ側のようです。

ブラウザの問題:半角スペース、全角スペース、改行コード、整形処理

によると、IE では全角文字と全角文字の間の改行は空白に置き換えない仕様になっているそうで。他のブラウザは常に空白に置き換えているので、IE と同じ動作にしてくれればよさげ。どちらが妥当かはわからないけど。
posted at 07:55:31 on 2009-02-06 by miau - Category: Trac No Trackbacks - Permalink

TrackBack

このエントリにトラックバックはありません
現在トラックバックは受け付けていません。

Comments

No comments yet

Add Comments

現在コメントは受け付けていません。
お手数ですが、 こちら のコメント欄にでも記載していただければと思います。