<code>要素での改行を防ぐ
Preventing line breaks in <code> elements (alexwlchan.net)
要約
ウェブサイトでコードスニペットを表示する際、特にインラインコードでハイフンやスペースが含まれる場合に、意図しない改行が発生して読みにくくなる問題があります。この記事では、短いコードスニペットに対して`nowrap` CSSクラスを適用し、`text-wrap: nowrap;` プロパティで改行を防ぐ方法を紹介しています。これにより、コードの可読性と正確性が向上します。
全文翻訳
<code>要素での改行防止
このウェブサイトにおける、私が気に入っている小さな工夫の一つは、非改行スペースの利用です。私は、「5 cm」、「New York」、あるいは「Objective-C」のようなフレーズを探し出し、非改行スペースやハイフンを挿入することで、それらが複数の行にまたがって分割されないようにしています。
これは、もし私が固定レイアウトの印刷書籍を執筆していたなら、プロの組版者が処理してくれるような、タイポグラフィ上の繊細な配慮ですが、ウェブサイトはそうではありません。私のウェブサイトは様々なサイズで閲覧され、ブラウザが表示する場所で改行を決定します。私はこれらの非改行文字を追加することで、ブラウザに不格好な改行を避けるよう指示しています。
以前は、この工夫を本文テキストにのみ適用していましたが、今日、<code>要素に対しても同様のことを実装しました。
前回の投稿では、多くのインラインコードスニペットを使用しました。レビュー中に、それらのスニペットのいくつかに、役に立たない改行が入っていることに気づきました。例えば、(?-u:…) が (?- と u:…) に分割されたり、フラグ --multiline が - が一方の行に、multiline がもう一方の行に分かれたりしました。これらの改行は、何の利点もなく、投稿を読みにくくしています。
なぜこれらが起こったのかは理解できます。ブラウザは改行できる文字を探し、英語ではハイフンもその一つです。ハイフンでつながれた単語を複数行に分割するのは通常問題ありませんが、コード内でそれが起こると迷惑です。
<code>内のハイフンを非改行ハイフンに置き換えることでこれを修正できましたが、人々はコードスニペットをコピー&ペーストするため、意味が変わってしまう可能性があります。
代わりに、短い <code> 要素で改行文字を含むものを探し出し、nowrap CSSクラスを追加するチェックを作成しました。
import re
def add_nowrap(match: re.Match[str]) -> str:
"""
`<code>`要素に改行文字が含まれている場合、`nowrap`クラスを追加する。
"""
contents = match.group("contents")
if "-" in contents or " " in contents:
return f"<code class=\"nowrap\">{contents}</code>"
return match.group(0)
text: str
# 短くて改行文字を含む`<code>`スニペットに`nowrap`クラスを追加する。
#
# 15文字という制限は任意です。より長いコードスニペットでは、
# 前の行に過剰な空白を残さないようにするために、折り返しが好ましいです。
text = re.sub(r"<code>(?P<contents>[^<]{1,15})</code>", add_nowrap, text)
これは、text-wrap プロパティを使用して、ブラウザに改行しないように指示するCSSルールと組み合わされています。
code.nowrap {
text-wrap: nowrap;
}
これは必須ではありませんでしたが、サイトがわずかに良くなったと思います。