vimdoc-ja-working [RFC] 記号で囲まれた文字列の前後に空白を入れる/入れないの意識を統一する

Vim ドキュメント翻訳者の手引き https://github.com/vim-jp/vimdoc-ja-working/wiki/Guide

現状では関連するのは以下の記述のみ

"～" や '～' のように引用符でくくられている部分は、くくられている部分を明確にするため、前後に空白を入れる。

`～`と|～|と{～}と<～>については前後に空白は不要である旨の記述を足しませんか？ (実際、空白が入っていない部分が多いように見受けられる)

Jan 15 '17 13:01 h-east

それは、

文中に英数字がある場合には前後に空白を入れる。例: 文の中に 1 つの English が混ざる。But 句読点の前後は空白なし。他の翻訳プロジェクトでも空白を入れているところ多しただ、空白を入れないほうが書きやすいし読みやすいと感じる

とも関連しますがどうしますかね。英数字の前後に空白を入れるのならそれらにも入れるべきでしょうし、入れないのなら入れないと。あと、[～] は空白を入れないと色が付かない場合があったりしますね。

Jan 15 '17 14:01 k-takata

highlightされるもの([～]も含む)については前後が日本語であれば空白要らないかなと思いました。

Jan 15 '17 14:01 h-east

[～]は（中身によっては）前後が日本語だと色が付かない場合があってやっかいです。直前が「。」でも色が付かなかったりして、先日ハマりました。syntaxファイルを直すべきかもしれませんが。

Jan 15 '17 15:01 k-takata

@k-takata

直前が「。」でも色が付かなかったりして、

Win(enc=cp932)とFedora(enc=utf-8)で試してみましたが再現出来ませんでした。他に何か条件あるんでしょうか？

Jan 15 '17 15:01 h-east

あぁ、[group]で試してました。 [group]はruntime/syntax/help.vim : 72-86で個別に指定されているからhighlightされるんですね。上記以外のものは直前に空白ないとダメなのですね。 68行目

syn match helpSpecial           "\s\[[-a-z^A-Z0-9_]\{2,}]"ms=s+1

Jan 15 '17 15:01 h-east

from https://github.com/vim-jp/vimdoc-ja-working/pull/758#discussion_r361854262

丸括弧は全角の「（」および「）」ではなく半角括弧+空白「 (」および「) 」を使う。

全角を使わずに半角括弧を使うのは同意ですが、前後が日本語の場合は空白はなくてもいいんじゃないかなぁ。という提案。(というかwikiにこの記述があるのを知らなかった:grin:)

Dec 30 '19 13:12 h-east

（横から失礼します）

参考程度ですが、半角英数字と全角文字の間には、スペースを入れることが多いようです。

https://www.jtf.jp/jp/style_guide/log/comparison_table.htm

個人的には、英数字の前後には空白があったほうが見やすいかなとは思います。:bow:

)、 or )。 の場合には、空白を入れない方針は、wiki に記載なかったと思うので。方針を決めて、記載したほうが良いかなと思います。

Dec 31 '19 00:12 hnishi

参考程度ですが、半角英数字と全角文字の間には、スペースを入れることが多いようです。

と言いましたが、改めて手元の技術書を見ると、半角スペースなしで詰めて書いているものが結構あった。

Jan 08 '20 03:01 hnishi

vimdoc-ja-working vimdoc-ja-working copied to clipboard