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

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

全般的なルール

以下の全般的なルールは常に #特定のケースより優先します。このガイドに書かれていないケースは、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 パッケージ形式を使います。

ファイル名とパス

Use monospace. Also device names and names with wildcards are affected. #ファイルの拡張子 are treated differently, though.

Examples

To test if you have booted into UEFI mode check if directory /sys/firmware/efi has been created.
All files and directories appear under the root directory /, even if they are stored on different physical devices.
Edit /etc/resolv.conf, substituting your name servers' IP addresses and your local domain name.
Before installing, you may want to edit the mirrorlist file and place your preferred mirror first.
For kernel modules to load during boot, place a .conf file with a name based on the program that uses them in /etc/modules-load.d/.
Each partition is identified with a number suffix. For example, sda1 specifies the first partition of the first drive, while sda designates the entire drive.

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

Use "typewriter quotes".

Example

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

GUI/TUI テキスト

Use italic. For example for menu entries. When representing navigation in menus, use the ">" symbol, still in italic, to separate the items.

Examples

Then, select Boot Arch Linux from the menu and press Enter in order to begin with the installation.
When using Gparted, selecting the option to create a new partition table gives an msdos partition table by default. If you are intending to follow the advice to create a GPT partition table then you need to choose Advanced and then select gpt from the drop-down menu.
Type yes and choose Quit (or press Q) to exit without making any more changes.
For plugins to be updated, you should check to have their update repositories enabled in Window > Preferences > Install/Update > Available Software Sites.

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

Use bold. Since these contents are code themselves, when referenced outside of the template, monospace should be preserved.

Example

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

You can replace $(uname -r) with any kernel not currently running.

キーボードキー

Use monospace.

Example

You have to press a key (usually Delete, F1, F2, F11, or F12) during the POST.

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

Use italic. Affected by #一番目の用例.

Example

The package wireless_tools then provides a basic set of tools for managing the wireless connection.

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

Use italic. When mentioning a variable outside of the template, monospace should be preserved.

Make sure that variables do not contain any spaces: underscores should be used in their place.

Ensure naming consistency with the rest of the article, which may already use a pseudo-variable. For example do not introduce a new keyboardlayout variable, if keyboard_layout is already used.

Example

```
# loadkeys keyboard_layout
```

[...] where keyboard_layout can be fr, uk, dvorak, be-latin1, etc.

Bring the interface up with ip link set interface up.
You can connect to the network with:

# wifi-menu interface_name

Where interface_name is the interface of your wireless chipset.

引用符

For inline quotations, use "typewriter quotes". For block quotations, use indentation through a line-initial colon without any additional punctuation or formatting.

Examples

"All your data belongs to us" – Google
From http://www.x.org/wiki/:

The X.Org project provides an open source implementation of the X Window System. The development work is being done in conjunction with the freedesktop.org community. The X.Org Foundation is the educational non-profit corporation whose Board serves this effort, and whose Members lead this work.

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

Use "typewriter quotes". When referencing section headings, however, use internal anchor links ([[#Section]]).

Example

The column "dm-crypt +/- LUKS" denotes features of dm-crypt for both LUKS ("+") and plain ("-") encryption modes. If a specific feature requires using LUKS, this is indicated by "(with LUKS)". Likewise "(without LUKS)" indicates usage of LUKS is counter-productive to achieve the feature and plain mode should be used.

リポジトリの名前

Use italic for repository names. Affected by #一番目の用例.

Example

To enable the testing repository, you have to uncomment the [testing] section in /etc/pacman.conf.
If you enable the testing repository, you must also enable the community-testing repository.

強調する語・文

Use italic for words whose importance in giving the meaning to a sentence would not be recognized otherwise; usually they would be pronounced in a stressed way if reading out loud.

When however particular attention is needed, words like "not", "only", "exactly", "strongly", "before"... can be highlighted in bold.

The same goes for very important statements that cannot be put in a separate Warning or Note as they are an essential part of the section itself.

Examples

Choose the best environment for your needs.
This command can synchronize the repository databases and update the system's packages.
If the screen does not go blank and the boot process gets stuck.
[...] so please type it exactly as you see it.
If you want, you can make it the only mirror available by getting rid of everything else.
Partitioning can destroy data. You are strongly cautioned and advised to backup any critical data before proceeding.
keep up to date with changes in Arch Linux that require manual intervention before upgrading your system.
When performing a system update, it is essential that users read all information output by pacman and use common sense.
This means that partial upgrades are not supported.

技術的用語

Use italic, except for all-caps terms (usually acronyms). Affected by #一番目の用例.

Examples

You are encouraged to type man command to read the man page of any command.
This article deals with so-called core utilities on a GNU/Linux system.
Primary partitions can be bootable and are limited to four partitions per disk or RAID volume.
This is already a separate partition by default, by virtue of being mounted as tmpfs by systemd.
You have to press a key (usually Delete, F1, F2, F11 or F12) during the POST (Power On Self-Test) phase.

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