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

2020年4月19日 (日) 11:35時点における版

全般的なルール

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

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

一番目の用例

The first relevant appearance of a term or name in an article (e.g. executable names) can be highlighted (see below) if regarded as worthy of particular attention, considering the topic of the article or the specific section. The first "relevant" appearance may not be the absolute first appearance of the name: its choice is left to the editor.
The preferable way of highlighting the name is using a link to a closely related article in the wiki or to an external page, like Wikipedia; if there are no possible pertinent links, bold can be used as a fallback solution.

Package and package group names should make use of テンプレート:Pkg, テンプレート:AUR or テンプレート:Grp.

If the name is already introduced by the title of the article or by a section heading, its first relevant appearance in the body can only be used as a link anchor, but not simply highlighted in bold, except in the case of #名前/用語集.
First-instance highlighting can be applied only to the #特定のケース that explicitly allow it.

リンク

No formatting shall be applied to the anchor text of links.

名前/用語集

It is allowed, not mandatory, to keep consistent formatting in lists of names or terms, even if normally not all of the items would require to be formatted. This can involve for example all-caps terms, which should not be italic-ized by themselves, or names in a list where most of the items are formatted according to #一番目の用例.
"List" is to be intended in a broad sense, so that for example also all the initial words of a series of subsequent paragraphs could be considered forming a list of terms.

フォーマット/句読点のケース

Cases marked by ¹ are affected by #一番目の用例. Cases marked by ^m apply to monospaced text.

斜体

Use the MediaWiki syntax ''italic text'' instead of <i> tags.

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

太字

Use the MediaWiki syntax '''bold text''' instead of <b> tags.

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

等幅

Use テンプレート:ic {{ic|monospace text}} instead of <code> tags for text outside of code blocks.

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

引用符

Use typewriter quotes "quoted text" instead of single quotes 'quoted text' or typographic quotes “quoted text”.

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

特定のケース

#全般的なルール always override the following rules.

略語の展開

Use italic.

Examples

Pacman is the Arch Linux package manager.
cat (catenate) is a standard Unix utility that concatenates and lists files.

コマンド行

Use monospace. Must be inline command examples, not simple mentions of #実行ファイル/アプリケーションの名前. Also console output and text that may reasonably be useful to paste in a terminal.

Examples

You are encouraged to type man command to read the man page of any command.
You can use the command ip link to discover the names of your interfaces.
If you get a ping: unknown host error, first check if there is an issue with your cable or wireless signal strength.
Type yes and choose Quit (or press Q) to exit without making any more changes.
Execute pacman -Syu with root privileges.

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

Use monospace. Also affects command options, user groups, IP addresses, environment variables and variables in general.

When both the short and long form of a command option have to be represented, use the "/" symbol without spaces to separate them, for example -a/--anything.

Examples

By default, the keyboard layout is set to us.
[...] where layout can be fr, uk, dvorak, be-latin1, etc.
As of v197, udev no longer assigns network interface names according to the wlanX and ethX naming scheme.
In this example, the Ethernet interface is enp2s0f0.
If you are unsure, your Ethernet interface is likely to start with the letter "e", and unlikely to be lo or start with the letter "w".
Currently, you may include a maximum of three nameserver lines.
You will need to create an extra BIOS Boot Partition of size 1007 KiB and EF02 type code.
All files should have 644 permissions and root:root ownership.
The -i switch can be omitted if you wish to install every package from the base group without prompting.
Adding your user to groups (sys, disk, lp, network, video, audio, optical, storage, scanner, power, etc.) is not necessary for most use cases with systemd.
If you are behind a proxy server, you will need to export the http_proxy and ftp_proxyenvironment variables.
To use other locales for other LC_* variables, run locale to see the available options and add them to locale.conf. It is not recommended to set the LC_ALL variable. See Locale#Setting the system locale for an advanced example.
[...] this roughly equates to what you included in the DAEMONS array.
If you are running a private network, it is safe to use IP addresses in 192.168.*.* for your IP addresses, with a subnet mask of 255.255.255.0 and a broadcast address of 192.168.*.255. The gateway is usually 192.168.*.1 or 192.168.*.254.
By giving the -net nic argument to QEMU, it will, by default, assign a virtual machine a network interface with the link-level address 52:54:00:12:34:56.

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

Use monospace.

Example

The dhcpcd.service starts the daemon for all network interfaces.
Some unit names contain an @ sign (e.g. name@string.service).

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

Use italic, but only for full lower-case names. Affected by #一番目の用例.

Note that this rule applies to executables only when they represent the application/file itself, not when used in #コマンド行. In particular pay attention to executables that are usually run without any arguments. See also ヘルプ:スタイル#スペル.

Examples

Uncomment the selected locale in /etc/locale.gen and generate it with the locale-gen utility.
Uncomment the selected locale in /etc/locale.gen and generate it with locale-gen.
As of v197, udev no longer assigns network interface names according to the wlanX and ethX naming scheme.
The Arch Linux install media includes the following partitioning tools: fdisk, gdisk, cfdisk, cgdisk, parted.
If pacman fails to verify your packages, check the system time with cal.
Set a root password with passwd.

ファイルの内容

Use monospace for content that can be both read or written on a file or that may reasonably be useful to copy from or paste in a text editor.

Examples

At the end of the string type nomodeset and press Enter. Alternatively, try video=SVIDEO-1:d which, if it works, will not disable kernel mode setting.
Remove the # in front of the locale you want from /etc/locale.gen.

ファイルの拡張子

Use italic.

Example

Pacman is written in the C programming language and uses the .pkg.tar.xz package format.

ファイル名とパス

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.

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