「ヘルプ:スタイル/書式と記号」の版間の差分

2020年4月21日 (火) 10:48時点における版

全般的なルール

以下の全般的なルールは常に #特定のケースより優先します。このガイドに書かれていないケースは、Wikipedia:ja:Wikipedia:スタイルマニュアルを情報源として参照してください。

それぞれのルールで明示的に許可されている場合を除いて、2つ以上の強調方法を組み合わせないでください。
このルールは既に CSS ルールによって書式がセットされている場合にも適用されます。例えば、定義リストの太字などです。ルールによって標準の CSS 書式が許されていない場合(例: #ファイル名とパスでの太字)、他の適合する wiki マークアップ(例: 定義リストの代わりに箇条書き)に変える必要があります。
このマニュアルで定義されているものとは違う強調方法を使わないでください。例としては、下線・点滅・全て大文字の語・色・アスタリスク・感嘆符・絵文字・style 属性を持つ HTML タグなどがありますが、これに限定されません。

一番目の用例

ページ内での関連する用語や名前(例: 実行ファイル名)の初めての出現は、そのページやセクションのトピックを考慮した上で注意を引く価値があると考えられる場合には強調 (以下を参照)することができます。関連する 初めての出現は厳密な初めての出現ではないかもしれません。その選択は編集者に委ねられています。
推奨される名前の強調の方法は、wiki 内や外部の強く関連するページ(例: Wikipedia)へのリンクを使うことです。適切なリンクがなければ、代わりに太字を使うことができます。

パッケージとパッケージグループの名前はテンプレート:Pkg・テンプレート:AUR・テンプレート:Grp を使う必要があります。

名前がページのタイトルやセクション見出しにより既に導入されている場合、本文内での関連する初めての出現はリンクとしてのみ強調することができます。#名前/用語集のケースを除いて、単純に太字で強調することはできません。
初めての具体例の強調は、#特定のケースで明示的に許可されている場合にのみ適用することができます。

リンク

リンクになっているテキストには書式を適用することができません。

名前/用語集

名前や用語のリスト内で書式の一貫性を維持することは、通常全ての項目に書式を適用する必要がなかったとしても許されていて、強制ではありません。これは例えば、通常斜体にするべきではない全て大文字の語や、ほとんどの項目が #一番目の用例に従って書式が適用されている場合も含まれます。
"リスト" は広い意味を意図していて、例えば連続する段落の初めの単語も用語のリストを形成しているとみなすことができます。

書式/記号のケース

¹ の付いているケースは #一番目の用例の影響を受けます。 ^m の付いているケースは等幅テキストが適用されます。

斜体

<i> タグの代わりに MediaWiki の構文 ''斜体のテキスト'' を使ってください。

#実行ファイル/アプリケーションの名前¹
#ファイルの拡張子
#リポジトリの名前¹
#パッケージとグループの名前¹
#ファイルやコマンドラインの疑似変数^m
#GUI/TUI テキスト
#技術的用語¹
#強調する語・文
#略語の展開

太字

<b> タグの代わりに MediaWiki の構文 '''太字のテキスト''' を使ってください。

#ファイルやコマンドラインの内容の重要な部分^m
#強調する語・文
#一番目の用例

等幅

コードブロックの外のテキストには、<code> タグの代わりにテンプレート:ic {{ic|等幅テキスト}} を使ってください。

#ファイル名とパス
#デーモン/サービス、カーネルモジュール
#設定パラメータ・変数・オプション・プロパティ等
#コマンド行
#ファイルの内容
#キーボードキー

引用符

'引用テキスト' や曲線形の引用符 “引用テキスト” の代わりに直線形の引用符 "引用テキスト" を使ってください。

#タイトルや見出しへの参照
#単なる"テキストそのもの"への参照としての単語・文字
#正しくない・疑わしい方法で使われる一般的な単語
#引用

特定のケース

#全般的なルールは常に以下のルールより優先します。

略語の展開

斜体を使ってください。

例

pacman は Arch Linux の package manager (パッケージマネージャ) です。
cat (catenate) はファイルを連結してリスト化する標準 Unix ユーティリティです。

コマンド行

等幅 を使ってください。インラインのコマンド例である必要があり、#実行ファイル/アプリケーションの名前の単純な言及であってはいけません。あるいは、コンソールの出力やターミナルに貼り付けるために十分便利なテキストでも構いません。

例

コマンドの man ページを読むために man コマンド を入力することが推奨されます。
ip link コマンドを使ってインターフェースの名前を調べることができます。
ping: unknown host エラーが出た場合、まずケーブルや無線の信号強度に問題がないか確認してください。
それ以上変更しないで終了するには、yes を入力して Quit を選んで (または Q を押して) ください。
pacman -Syu を root 権限で実行してください。

設定パラメータ・変数・オプション・プロパティ等

等幅 を使ってください。コマンドオプション・ユーザーグループ・IP アドレス・環境変数・一般的な変数にも適用されます。

短い形式と長い形式の両方のコマンドオプションが表現される必要があるときは、間にスペースを入れずに "/" 記号を使ってください。例: -a/--anything。

例

標準では、キーボードレイアウトは us にセットされています。
[...] このとき、layout は fr・uk・dvorak・be-latin1 などに置き換えてください。
v197 以降、udev は wlanX や ethX といった名前の付け方でネットワークインターフェースに名前を割り当てません。
この例では、イーサネットインターフェースは enp2s0f0 です。
確証が持てないのであれば、イーサネットインターフェースはほとんどの場合 "e" の文字から始まり、lo や "w" の文字から始まるものであることはほとんどないでしょう。
現在、最大3つの nameserver の行を含めることができます。
追加で、サイズが 1007KiB でタイプコードが EF02 の BIOS ブートパーティションを作る必要があるでしょう。
全てのファイルはパーミッションが 644 で所有者が root:root である必要があります。
base-devel グループの全てのパッケージを確認なしでインストールしたい場合は -i スイッチを省略することができます。
ユーザーをグループ (sys・disk・lp・network・video・audio・optical・storage・scanner・powerなど) に追加することは、systemd を使っているほとんどのケースで必要 ありません。
プロキシサーバーを使っている場合、http_proxy と ftp_proxy 環境変数を export する必要があります。
他の LC_* 変数に他のロケールを使うには、locale を実行して有効な選択肢を表示して、locale.conf に追加してください。LC_ALL 変数をセットするのは推奨されません。発展的な例はロケール#システム全体のロケールを設定するを参照してください。
[...] これは DAEMONS 配列に含まれているものと大体同じです。
プライベートネットワークを使っている場合、IP アドレスは 192.168.*.* の中から使い、サブネットマスクを 255.255.255.0 にセットして、ブロードキャストアドレスに 192.168.*.255 を使うと無難です。ゲートウェイは普通 192.168.*.1 か 192.168.*.254 です。
QEMU に -net nic 引数を与えると、QEMU は通常仮想マシンにリンクレベルアドレスとして 52:54:00:12:34:56 を持ったネットワークインターフェースを割り当てます。

デーモン/サービス、カーネルモジュール

等幅 を使ってください。

例

dhcpcd.service は全てのネットワークインターフェースに対してデーモンを起動します。
いくつかのユニット名は @ 記号を含みます (例: name@string.service)。

実行ファイル/アプリケーションの名前

全て小文字の名前の場合のみ斜体を使ってください。#一番目の用例の影響を受けます。

このルールはアプリケーション/ファイルそのものを表現するときのみ実行ファイルに適用され、#コマンド行で使われるときには適用されません。特に、通常何の引数も付けずに実行される実行ファイルに気を付けてください。ヘルプ:スタイル#スペルも参照してください。

例

/etc/locale.gen の中の選択したロケールをアンコメントして、locale-gen ユーティリティでロケールを生成してください。
/etc/locale.gen の中の選択したロケールをアンコメントして、locale-gen でロケールを生成してください。
v197 以降、udev は wlanX や ethX といった名前の付け方でネットワークインターフェースに名前を割り当てません。
Arch Linux のインストールメディアは、fdisk・gdisk・cfdisk・cgdisk・parted のようなパーティショニングツールを含んでいます。
pacman がパッケージの検証に失敗する場合、cal でシステムの時間を確認してください。
passwd で root のパスワードをセットしてください。

ファイルの内容

ファイルから読み込み・書き込みの両方を行うことができるか、テキストエディタからコピー・貼り付けするのに十分便利な内容には 等幅 を使ってください。

例

文字列の最後に nomodeset を入力して、Enter を押してください。あるいは、もし機能すればカーネルモードセッティングを無効化しない video=SVIDEO-1:d を試してみてください。
/etc/locale.gen ファイル内の使いたいロケールの前にある # を削除してください。

ファイルの拡張子

斜体を使ってください。

例

pacman はプログラミング言語の C 言語で書かれていて、.pkg.tar.xz パッケージ形式を使います。

ファイル名とパス

等幅 を使ってください。デバイス名と、ワイルドカードを含む名前にも適用されます。しかし、#ファイルの拡張子は違った方法で扱われます。

例

UEFI モードで起動しているか確認するには、ディレクトリ /sys/firmware/efi が作成されているか確認してください。
全てのファイルとディレクトリは、異なる物理デバイスに保存されていたとしても、ルートディレクトリ / の下に現われます。
/etc/resolv.conf を編集して、ネームサーバーの IP アドレスとローカルドメイン名を置き換えてください。
インストールの前に、mirrorlist ファイルを編集して適切なミラーを一番上に配置するとよいでしょう。
カーネルモジュールを起動中に読み込むためには、/etc/modules-load.d/ にモジュールを使用するプログラム名を基に名前を付けた .conf ファイルを配置します。
それぞれのパーティションは末尾の数字で区別されます。例えば、sda1 は1番目のドライブの1番目のパーティションを示し、sda はドライブ全体を差し示します。

正しくない・疑わしい方法で使われる一般的な単語

"直線形の引用符" を使ってください。

例

単なる "テキストそのもの" への参照としての単語・文字。

GUI/TUI テキスト

斜体を使ってください。例としてはメニューの項目などがあります。メニューの中でのナビゲーションを表現するときは、斜体のまま ">" 記号を使って、項目を分離してください。

例

その後、メニューから Boot Arch Linux を選んで Enter を押すと、インストールが開始されます。
Gparted を使う場合は、新しいパーティションテーブルを作る選択肢を選ぶと標準で msdos パーティションテーブルが作られます。アドバイスに従って GPT パーティションを作ることを意図している場合は、Advanced を選んでから、ドロップダウンから gpt を選ぶ必要があります。
それ以上変更しないで終了するには、yes を入力して Quit を選んで (または Q を押して) ください。
プラグインをアップデートするためには、それらのアップデートリポジトリが Window > Preferences > Install/Update > Available Software Sites で有効化されていることを確認してください。

ファイルやコマンドラインの内容の重要な部分

太字を使ってください。内容はコードそのもののため、テンプレートの外で参照するときには 等幅 を維持して同時に使用する必要があります。

例

# ln -s /usr/src/linux-$(uname -r)/include/generated/uapi/linux/version.h /usr/src/linux-$(uname -r)/include/linux/

$(uname -r) を現在実行していないカーネルに置き換えることができます。

キーボードキー

等幅 を使ってください。

例

POST が実行されている間にキー (通常 Delete・F1・F2・F11・F12) を押す必要があります。

パッケージとグループの名前

斜体を使ってください。 #一番目の用例の影響を受けます。

例

パッケージ wireless_tools が無線接続の管理のための基本的なツールセットを提供します。

ファイルやコマンドラインの疑似変数

斜体を使ってください。テンプレートの外で変数に言及するときは、等幅 を維持して同時に使用する必要があります。

変数がスペースを含まないようにしてください。代わりにその場所にアンダースコアを使ってください。

既に疑似変数が使われている場合、ページの他の部分と名前の一貫性を保つようにしてください。例えば、既に keyboard_layout が使われているのであれば、新しい keyboardlayout を導入しないでください。

例

```
# loadkeys keyboard_layout
```

[...] このとき、keyboard_layout は fr・uk・dvorak・be-latin1 などに置き換えてください。

ip link set interface up でインターフェースを起動してください。
以下のコマンドでネットワークに接続することができます。

# wifi-menu interface_name

このとき、interface_name はワイアレスチップセットのインターフェースに置き換えてください。

引用

インラインの引用には、"直線形の引用符" を使ってください。ブロックの引用には行をコロンで始めて、それ以外の記号や書式を適用しないインデントを使ってください。

例

"全てのユーザーのデータは私達に属します" – Google
http://www.x.org/wiki/ から:

X.Org プロジェクトは X Window System のオープンソース実装を提供しています。開発作業は freedesktop.org コミュニティと共同で行われています。X.Org Foundation は教育的な非営利の団体で、委員長がこの取り組みを担当して、委員がこれを機能するように導いています。

タイトルや見出しへの参照

"直線形の引用符" を使ってください。しかし、セクション見出しに言及するときは、内部アンカーリンク ([[#セクション]]) を使ってください。

例

カラム "dm-crypt +/- LUKS" は LUKS ("+") とプレーン ("-") の両方の暗号化モードのための dm-crypt の機能を示しています。その機能が LUKS の使用を必要とする場合、"(with LUKS)" と表示されます。同じように "(without LUKS)" は、その機能は LUKS の使用が逆効果でプレーンモードが使われるべきであることを示しています。

リポジトリの名前

リポジトリの名前には斜体を使ってください。 #一番目の用例の影響を受けます。

例

testing リポジトリを有効にするには、/etc/pacman.conf の中の [testing] セクションをアンコメントする必要があります。
testing リポジトリを有効にした場合、community-testing リポジトリも有効にする必要があります。

強調する語・文

他の方法で文の意味の重要性が認識されない場合には斜体を使ってください。通常声に出して読む場合は強調して発音されます。

しかし、特定の注意が必要な、"ではありません"・"だけ"・"厳密に"・"強く"・"前に" などの単語の場合には、太字で強調することができます。

とても重要で、警告やノートとして分離しておくことができない、セクション自体のなくてはならない部分についても同じことが適用できます。

例

あなたの ニーズに一番合う環境を選んでください。
このコマンドはリポジトリデータベースを同期して、かつシステムのパッケージをアップデートします。
スクリーンが空白に ならずに ブートプロセスが止まってしまった場合です。
[...] そのため、見たものを 正確に 入力するようにしてください。
他の全てを削除することで、そのミラーだけを有効にすることも、希望するのであれば可能です。
パーティショニングはデータを破壊する可能性があります。強く気をつける必要があり、進める前に重要なデータのバックアップを取っておくとよいでしょう。
システムをアップグレードする前に手動の操作が必要となる Arch Linux での変更に追従しておいてください。
システムをアップデートするとき、ユーザーは pacman の出力する全ての出力を読んで、判断力を働かせることが重要です。
これは部分アップグレードが サポートされていない ことを意味します。

技術的用語

全て大文字の語(通常は略語)を除いて斜体を使ってください。#一番目の用例の影響を受けます。

例

コマンドの man ページを読むために man コマンド を入力することが推奨されます。
このページでは、GNU/Linux システムにおけるいわゆる core ユーティリティを扱います。
プライマリ パーティションは起動可能で、ディスクや RAID ボリュームあたり4つのパーティションに制限されています。
これは、systemd によって tmpfs としてマウントされているおかげで、標準で既に分割されたパーティションになっています。
POST (Power On Self-Test) フェーズの間にキー (通常 Delete・F1・F2・F11・F12) を押す必要があります。

単なる"テキストそのもの"への参照としての単語・文字