vimdoc-ja
vimdoc-ja copied to clipboard
文体が統一されていない
恐らく歴史的経緯でこうなっていて、労力の関係で放置されているものと思われますが、実際にやるかどうかは別としてIssueとして登録しておきます。 ここでは、統一するとしたらどの方向に統一すべきか議論できれば、と思います。決まったことは Wiki にまとめましょう。
最低限、「です・ます」と「だ・である」は統一すべき。 個人的には「です・ます」に1票。マニュアルなどは「です・ます」調で書かれていることが多い印象があります。
以下は意見表明じゃなくて、現状の概要を説明しているだけです。
最初はリファレンスマニュアルは「だ、である」で書いてました。 リファレンスということで紋切り型の説明が多かったのと文字数調整の意味もあります。 なので「です・ます」に直すと修正箇所はかなり量があるかも。
一方、ユーザマニュアルは、おそらく「です・ます」でまとまってると思います。 読み物の体裁である&清水さん(でしたっけ)が一人で手をつけておられたので、ある程度整っているかと。
以下意見。統一には賛成。どちらであるかはそんなに問わない。 それどころかユーザマニュアルとリファレンスで違っても、大丈夫だとは思う。
「だ・である」に1票。理由:ストイックな感じがカッコイイからw。 初心者には威圧的に感じるのかなぁ。 「Vim=ストイック」というイメージにシビれるあこがれるって感じで近づいて来てる人いませんかね。
options.jax はほぼ「だ・である」ですね。
青山(mm)です。色んな名前を使っていてまぎらわしくてすみませんが、gitでのユーザーIDはこれになっています。 私が翻訳していたときは、既存のファイルについてはすでに使われているほう、新規のファイルについては私とnakadairaさんとも敬体を使っていたと思います。 私は敬体のほうが好みです。その方が翻訳しているときの気分もやさしくなって、翻訳が丁寧になるという効果がありました(私の場合)。
その他覚えていること ・ASCIIの範囲にある文字(半角英数・記号)は全角でなく半角を使う。 ・半角と全角の間にスペースを入れるか?→KoRoNさんはなし派。私とnakadairaさんはあり派。 ・1行は78桁以下になるように(KaoriYa版に付属のformat.vimを使って整形すると楽です) ・ヘルプファイルでは「help-context」や「|help-context|」のように_と|がマーカーに使われているので見落とさないように注意 今はconcealで消えるようになっているので、 ~/.vim/after/ftplugin/help.vimで setlocal conceallevel=0 syn match Error /%>79v._/ のように設定しておくといいかもしれません。
あれ? Notifications が送られて来ない...
青山さんのコメントで回答をもらったようなものですが、下記のような質問を書いていました。各人の conceallevel の設定によって列が揃わなくなってしまいますね...。
端末の幅を半角 80 文字としているのですが、稀に一行が 80 文字を越える文章と出会います。また、カラムの行頭が揃わない文章もあります。例えば下記のような場所です。
intro.jax の line 551 改行の位置
index.jax の line 1625, 1626, 1629, 1631, 1634 改行の位置
various.jax の line 352, 354, 355, 356, 358 タブの数
自分は conceallevel や concealcursor を設定しておらず、バーティカルバーが(見えないけれど)表示された状態になっているので、その分表示が多くなってしまうのでしょうが、中途半端に右折り返しされるために美しくなく困っています。79 文字目で改行し直しても良いものでしょうか?
また、例えば重複文字の修正等で文字を削除した場合に、それが 1 文字であったとしても段落全体を(一行78文字に)修正し直した方が良いでしょうか?(1文字なら大目に見る、2文字も許容範囲、3文字なら段落を直す...とか。ヘルプの初級編ではかなりキッチリと78文字が守られていた気がしますが)
ごめんなさい閉じてしまいました。
@nakinor それ文体の統一からは少し外れてますから、新しいissue起こしてもらえませんか? conceal使うとフォーマット変だよ、ってなことで (なんかVim本体の問題にもなりそうなw)
conceal については issues の # 115 で議論されてませんでしたっけ?
ややこしいけどそれは issues で、かつsyntax絡みなんですわw。こっちのconceallevelでヘルプの見た目が崩れるよね、ってのはまた別の問題としてエントリしておくべきだと思いました。
質問の内容については文体の話になっていると思うのですが、「各人の conceallevel の設定によって列が揃わなくなってしまいますね...。」という部分が余計でしたね。これについては自分の環境だけかもしれないのでスクリーンショット撮って記事書きます。
質問の内容については文体の話になっていると思う
おっと。ちゃんと読むと文体じゃなくて「改行位置があっていない」っていうフォーマットの話だw それはそれで別にissueがあったほうがよさそうです… 申し訳ないですがそっちのissueもお任せしちゃっていいですか?
現状では、
- リファレンスマニュアル -- 「だ・である」
- ユーザーズマニュアル -- 「です・ます」
になっているのがほとんどかと思いますが、一部、1つのファイルの中で文体が混じっているものがありとても気になっています。 全マニュアルを統一するのは正直なところ現実的とは思えないのですが、少なくともファイル単位では統一できればと。
insert.jax, mbyte.jax内の文体を統一しました。 (repeat.jax内の文体も統一したいが、あまりにも激しく混ざっていてどうしたものだか…)
・半角と全角の間にスペースを入れるか?→KoRoNさんはなし派。私とnakadairaさんはあり派。
印刷物では、半角と全角の間は四分アキ(半角の半分)が正当なやり方のようですが、エディタでは無理ですから意見が分かれるのも仕方ないですね。(私はあり派。)
ただし、"~" や(~) など、引用符や括弧の前後にはスペースを入れたいです。 また、コロンやセミコロンを含め、半角の句読点類は、前には空白を入れず、後ろには入れるようにしたいです。 参考: http://www.w3.org/TR/jlreq/ja/ 日本語組版処理の要件(日本語版) (特に第3章)
最終的には以下が満たされれば良いと考えています。
- (必須) レイアウトルールがWikiに記載され共有されている
- (オプション) レイアウトをチェックするツールがある
- (オプション) レイアウトを自動修正するツールがある
ルールの選択、決定はVim内で読みやすいかどうかが決めてもらえれば良いでしょう。
"~" と '~' の前後にスペースを入れるように統一しました。 " と ' は始めと終わりの区別がないので、引用符でくくった文字列がスペース無しに連続すると、どこからどこまでがくくってある部分なのかが非常に分かりにくかったです。(実際には '~' は色がつくので、問題なのは " の方ですが。)
グッジョブb
別の Issue で調べることがあったので、こちらに貼っておきます。
マニュアル | 文体 | 備考 |
---|---|---|
quickref | ダデアル調 | リファレンスマニュアル。クイックリファレンスなので簡潔な記述になっている |
tutor | usr_01.jax へのリンクでした。カウントから外します | |
copying | uganda.jax へのリンクでした。カウントから外します | |
iccf | uganda.jax へのリンクでした。カウントから外します | |
sponsor | ですます調 | リファレンスマニュアル。お願いの文章なので「ですます調」なのかな? |
www | intro.jax へのリンクでした。カウントから外します | |
bugs | intro.jax へのリンクでした。カウントから外します | |
usr_toc | ですます調 | ユーザーマニュアル |
usr_01 | ですます調 | ユーザーマニュアル |
usr_02 | ですます調 | ユーザーマニュアル |
usr_03 | ですます調 | ユーザーマニュアル |
usr_04 | ですます調 | ユーザーマニュアル |
usr_05 | ですます調 | ユーザーマニュアル |
usr_06 | ですます調 | ユーザーマニュアル |
usr_07 | ですます調 | ユーザーマニュアル |
usr_08 | ですます調 | ユーザーマニュアル |
usr_09 | ですます調 | ユーザーマニュアル |
usr_10 | ですます調 | ユーザーマニュアル |
usr_11 | ですます調 | ユーザーマニュアル |
usr_12 | ですます調 | ユーザーマニュアル |
usr_20 | ですます調 | ユーザーマニュアル |
usr_21 | ですます調 | ユーザーマニュアル |
usr_22 | ですます調 | ユーザーマニュアル |
usr_23 | ですます調 | ユーザーマニュアル |
usr_24 | ですます調 | ユーザーマニュアル |
usr_25 | ですます調 | ユーザーマニュアル |
usr_26 | ですます調 | ユーザーマニュアル |
usr_27 | ですます調 | ユーザーマニュアル |
usr_28 | ですます調 | ユーザーマニュアル |
usr_29 | ですます調 | ユーザーマニュアル |
usr_30 | ですます調 | ユーザーマニュアル |
usr_31 | ですます調 | ユーザーマニュアル |
usr_32 | ですます調 | ユーザーマニュアル |
usr_40 | ですます調 | ユーザーマニュアル |
usr_41 | ですます調 | ユーザーマニュアル |
usr_42 | ですます調 | ユーザーマニュアル |
usr_43 | ですます調 | ユーザーマニュアル |
usr_44 | ですます調 | ユーザーマニュアル |
usr_45 | ですます調 | ユーザーマニュアル |
usr_90 | ですます調 | ユーザーマニュアル |
intro | ですます調 | リファレンスマニュアル。若干「ダデアル調」が残っている |
help | ですます調 | ヘルプファイルのトップ |
helphelp | ですます調 | リファレンスマニュアル。ヘルプのヘルプ |
index | ダデアル調 | リファレンスマニュアル。全コマンドの簡潔な説明 |
help-tags | - | tags ファイル。文体はない |
howto | - | リファレンスマニュアル。文体はどちらとも判別できない |
tips | ですます調 | リファレンスマニュアル。howto と似ていなくもない |
message | ダデアル調 | リファレンスマニュアル |
quotes | ダデアル調 | リファレンスマニュアル。Vim を褒め称えよ! |
todo | - | 日本語訳なし |
debug | ですます調 | リファレンスマニュアル |
develop | ダデアル調 | リファレンスマニュアル。ドキュメントは、わかりやすく、理解できるものであるべきだ。例を使うことが推奨される。文章を不必要に長くしてはならない。短い文章は、その項目を見つけやすくする。 |
uganda | ですます調 | リファレンスマニュアル。Vim はチャリティーウェア |
starting | ダデアル調 | リファレンスマニュアル |
editing | ダデアル調 | リファレンスマニュアル |
motion | ですます調 | リファレンスマニュアル |
scroll | ダデアル調 | リファレンスマニュアル |
insert | ダデアル調 | リファレンスマニュアル |
change | ダデアル調 | リファレンスマニュアル |
indent | ダデアル調 | リファレンスマニュアル |
undo | ですます調 | リファレンスマニュアル |
repeat | ダデアル調 | リファレンスマニュアル |
visual | ダデアル調 | リファレンスマニュアル |
various | ですます調 | リファレンスマニュアル |
recover | ダデアル調 | リファレンスマニュアル |
cmdline | ダデアル調 | リファレンスマニュアル |
options | ダデアル調 | リファレンスマニュアル |
pattern | ですます調 | リファレンスマニュアル |
map | ですます調 | リファレンスマニュアル |
tagsrch | ダデアル調 | リファレンスマニュアル |
quickfix | ダデアル調 | リファレンスマニュアル |
windows | ダデアル調 | リファレンスマニュアル |
tabpage | ですます調 | リファレンスマニュアル |
syntax | ダデアル調 | リファレンスマニュアル |
spell | 「ダデアル調」にて翻訳作業中 | リファレンスマニュアル |
diff | ダデアル調 | リファレンスマニュアル |
autocmd | ダデアル調 | リファレンスマニュアル |
filetype | ダデアル調 | リファレンスマニュアル |
eval | ダデアル調 | リファレンスマニュアル |
fold | ダデアル調 | リファレンスマニュアル |
ですます調 | リファレンスマニュアル | |
remote | ダデアル調 | リファレンスマニュアル |
term | ですます調 | リファレンスマニュアル |
digraph | ダデアル調 | リファレンスマニュアル |
mbyte | ダデアル調 | リファレンスマニュアル |
mlang | ダデアル調 | リファレンスマニュアル |
arabic | ですます調 | リファレンスマニュアル |
farsi | ですます調 | リファレンスマニュアル |
hebrew | - | リファレンスマニュアル。日本語訳なし |
russian | ですます調 | リファレンスマニュアル |
ft_ada | ダデアル調 | リファレンスマニュアル |
ft_sql | ですます調 | リファレンスマニュアル |
hangulin | ですます調 | リファレンスマニュアル |
rileft | ダデアル調 | リファレンスマニュアル |
gui | ダデアル調 | リファレンスマニュアル |
gui_w16 | ダデアル調 | リファレンスマニュアル |
gui_w32 | ダデアル調 | リファレンスマニュアル |
gui_x11 | ダデアル調 | リファレンスマニュアル |
if_cscop | ダデアル調 | リファレンスマニュアル |
if_lua | ですます調 | リファレンスマニュアル |
if_mzsch | ですます調 | リファレンスマニュアル |
if_perl | ですます調 | リファレンスマニュアル |
if_pyth | ですます調 | リファレンスマニュアル |
if_sniff | ですます調 | リファレンスマニュアル |
if_tcl | ダデアル調 | リファレンスマニュアル |
if_ole | ダデアル調 | リファレンスマニュアル |
if_ruby | ダデアル調 | リファレンスマニュアル |
debugger | ダデアル調 | リファレンスマニュアル |
workshop | ダデアル調 | リファレンスマニュアル |
netbeans | ですます調 | リファレンスマニュアル |
sign | ダデアル調 | リファレンスマニュアル |
vi_diff | ですます調 | リファレンスマニュアル |
version4 | ですます調 | リファレンスマニュアル |
version5 | - | リファレンスマニュアル。日本語訳なし |
version6 | - | リファレンスマニュアル。日本語訳なし |
version7 | - | リファレンスマニュアル。日本語訳なし |
os_390 | ダデアル調 | リファレンスマニュアル |
os_amiga | ですます調 | リファレンスマニュアル |
os_beos | ダデアル調 | リファレンスマニュアル |
os_dos | ダデアル調 | リファレンスマニュアル |
os_mac | ですます調 | リファレンスマニュアル |
os_mint | ですます調 | リファレンスマニュアル |
os_msdos | ダデアル調 | リファレンスマニュアル |
os_os2 | ダデアル調 | リファレンスマニュアル |
os_qnx | ダデアル調 | リファレンスマニュアル |
os_risc | ですます調 | リファレンスマニュアル |
os_unix | ですます調 | リファレンスマニュアル |
os_vms | ダデアル調 | リファレンスマニュアル |
os_win32 | ダデアル調 | リファレンスマニュアル |
pi_getscript | ですます調 | リファレンスマニュアル |
pi_gzip | ですます調 | リファレンスマニュアル |
pi_netrw | ですます調 | リファレンスマニュアル |
pi_paren | ですます調 | リファレンスマニュアル |
pi_tar | ですます調 | リファレンスマニュアル |
pi_vimball | ですます調 | リファレンスマニュアル |
pi_zip | ですます調 | リファレンスマニュアル |
vim_faq | ですます調 | リファレンスマニュアル |
ですます調 | ダデアル調(作業中を含む) | どちらともいえない・日本語訳なし |
---|---|---|
74 | 51 | 7 |
- | ですます調 | ダデアル調(翻訳中を含む) | 日本語訳なし | 判別不能 |
---|---|---|---|---|
ユーザーマニュアル | 33 | 0 | 0 | 0 |
リファレンスマニュアル | 40 | 51 | 4 | 1(howto) |
ヘルプファイルトップ | 1 | 0 | 0 | 0 |
TODO | 0 | 0 | 1 | 0 |
tags | 0 | 0 | 0 | 1 |
計 | 74 | 51 | 5 | 2 |
Last Updated: 2013-04-02
うほ。よく調べたなw
ですます 79ファイルの内、usr_* は 33ファイルなので、リファレンスマニュアルだけだと 46ファイルですか。 リファレンスマニュアルに限ればダデアルの方がずっと多いと思っていたので意外でした。 (おそらくファイル数ではなく実際の分量で見ればダデアルの方が多いのではないかと予想していますが。)
@k-takata すみませんっ!急ぎでやったので間違いが(かなり)ありました。 そろそろ方向を決めないと現状維持のままで close しそうです(半年も放置...)。
リファレンスマニュアル、40:50か どうすべきだろう? 私はダデアル調に1票で