架空のプログラム「NumberMagiQ」のテキスト版解説を考える。
ここでは、プログラムのファイル名が numbermagiq.rb
だと仮定しよう。テキスト版解説では利用者が最初に使うときに
すぐに知りたい内容を書く。たとえば、
を簡潔に記述する。そして、すぐに分かるようなファイル名にして置いておく。
良くある例としては、numbermagiq.txt のように拡張子を
.txt に変えたり、00README のように読みたくなる
ような名前にしておくものがある。
numbermagiq.txt
// NumberMagiQ //
Copyright 2014 by TeamKoeki
http://roy.e.koeki-u.ac.jp/~yuuji/2014/pf1/11/numbermagiq.html
What's this!?
-------------
NumberMagiQ は、コンピュータが宇宙からのメッセージを
もとに繰り出す数字を制限回数内に解明し地球を救うプロ
グラムだ。要するに数当てゲームだ! 笑うなそこ!
How to Call
-----------
このゲームのプログラムは numbermagiq.rb だ。こいつを
好きなディレクトリにコピーしてくれ。そしたらこんな風
に実行だ。
% ./numbermagiq.rb
おおっと、
Permission denied
なんて言われてしまったかい? 最初の一回はプログラムを実
行可能にしなければいけないかもしれない。怒られたら
% chmod +x numbermagiq.rb
としてくれ。それでもだめなら
% ruby numbermagiq.rb
とやってくれ。
How to Play
-----------
プログラムが始まるとこんな風に聞いてくるはずだ。
危機を救うキーナンバーを授かった。当ててみたまえ(1〜50)
止めるときは q だ。
1回目のチャレンジだ。いくつだと思う?:
ここにあるように、1〜50のうちこれだと思う番号を入れる。
もし、当たったら地球は救われる。当たるまで頑張れ!
何度やっても失敗する君は……あっち行っててくれ。
Further Information
-------------------
このプログラムについてもっと知りたい場合は、
http://roy.e.koeki-u.ac.jp/~yuuji/2014/pf1/11/numbermagiq.html
を見てくれ!
利用者が、このプログラムを最初に使うときに困らない程度 の説明を書くとよい。続いてHTML版解説書 を作成する。
Emacsで説明を書くときには text-mode にしておくと書きやすい。
テキスト版解説書のファイルを開いたら(C-x C-f)、
M-x text-mode[RET]
とすると現在の編集バッファが text-mode になる(ファイル名
の拡張子を.txtにした場合は自動的にtext-mode
になっている)。
テキストファイルで文章を書くときは、見やすいところで行末をそろえて
おく。text-mode では、行末をそろえたいときに M-q
をタイプすることで自動的に段落全体がきれいに整う。以下動作例を。
この度は本製品をお買い上げ頂きまことに ありがとうございます。 本製品は品質監理に万全の注意を払って製造したものですが 万一不良品を発見されましたら下記の住所まで 該当品を同封の上お送り下さい。折り返しお取り替え品をお送り 致します。
M-q
↓
この度は本製品をお買い上げ頂きまことにありがとう ございます。本製品は品質監理に万全の注意を払って 製造したものですが万一不良品を発見されましたら下 記の住所まで該当品を同封の上お送り下さい。折り返 しお取り替え品をお送り致します。
段落の境目がはっきりしている場合にはうまくいく。もし、予期せぬ結果に なったらすかさず、C-/ をタイプすると直前の状態に復帰する。