ヘルプ:スタイル

関連記事

• ヘルプ:スタイル/書式と句読点
• ヘルプ:スタイル/空白
• ヘルプ:編集
• ヘルプ:読み方
• ヘルプ:議論
• ヘルプ:テンプレート

以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

記事のページ

タイトル

• タイトルは先頭だけを大文字にしてください。例: "Title for new page" は正しいですが、"Title for New Page" は誤っています。正式名称や大文字の頭字語に含まれている常用語は大文字にしてください。例えば "Advanced Linux Sound Architecture" が正しく、"Advanced Linux sound architecture" は誤っています。
  名前空間はタイトルの一部として考えません。したがって "ArchWiki:Example article" が正しく、"ArchWiki:example article" は誤っています。サブページの名前の先頭は大文字にします。したがって "My page/My subpage" が正しく、"My page/my subpage" は誤っています。
• 通常は、タイトルのトピックは単数形にしますが、何かのグループやクラスなどを表していて可算名詞の場合は複数形にします。
• 記事の主題がフルネームでも、省略形でもどちらの名前でも知られている場合、記事のタイトルにはフルネームの方を使うほうが適しています。フルネームと省略形の両方を (括弧を使って) タイトルに入れるのは止めてください。代わりに省略形のページからフルネームのページに転送するようにします。
• 翻訳されたページのタイトルは必ずヘルプ:i18n#記事のタイトルに従ってください。
• 詳しくはヘルプ:記事命名ガイドラインを見てください。

レイアウト

• 記事の構成は以下の順番とします:

1. #マジックワード (任意)
2. #カテゴリ
3. #言語間リンク
4. #記事の状態テンプレート (任意)
5. #関連記事ボックス (任意)
6. #前書きや導入
7. 目次 (自動)
8. 記事のセクション

マジックワード

• 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべてのマジックワード — はすべて記事の最上部に配置してください。
  このルールは特に {{DISPLAYTITLE:title}} と Template:Lowercase title に適用され、これらは前者を使用します。

カテゴリ

• どの記事も必ず最低1つ以上の現存しているカテゴリに分類してください。
• 1つの記事は複数のカテゴリに分類することができます。ただし、そのカテゴリ同士が親子関係であってはいけません。
• カテゴリは必ず記事の最上部 (何らかのマジックワードがあればそのすぐ下) に配置してください。
  ノート: これは、カテゴリを記事の最下部に配置する Wikipedia などの他の MediaWiki プロジェクトとは異なっています。
• カテゴリと本文の最初の行 (もしくは言語間リンクがある場合はそれ) の間に空行を含めないでください。記事の上部に余分な空白が挿入されてしまいます。
• 詳しくはヘルプ:カテゴリを見てください。

言語間リンク

• 記事が内部または外部の Arch Linux wiki で翻訳されていたら、必ず言語間リンクをカテゴリのすぐ下、本文の最初の行のすぐ上に配置してください。
  なお、言語間リンクは、実際にはページ左側の適切なカラムに表示されます。
• 言語間リンクと本文の最初の行の間に空行を含めないでください。記事の上部に余分な空白が挿入されてしまいます。
• 言語間リンクの追加、編集は、既に存在しているすべての翻訳記事に対して行ってください。
• 1つの言語に対して2つ以上の言語間リンクを記事に追加しないでください。
• 記事には、その記事の言語と同じ言語間リンクを追加しないでください。
• 言語間リンクは、言語の現地名ではなく、必ず言語タグ名に基づいてアルファベット順に並べてください。例えば、現地名では "Suomi" (フィンランド語) は "Français" (フランス語) の後に来ますが、言語タグ名では [[fi:Title]] (フィンランド語) は [[fr:Title]] (フランス語) の先に来ます。
• 詳しくは ヘルプ:i18n や Wikipedia:Help:Interlanguage links の記事を見てください。

記事の状態テンプレート

• 記事の状態テンプレートはカテゴリ (もしくは言語間リンクがある場合はそれ) のすぐ下、イントロダクション (もしくは関連記事ボックスがある場合はそれ) のすぐ上に配置します。
• 記事の状態テンプレートは、その使用法が適切であれば、記事のセクションの中でも使用することができます。
• 記事の状態テンプレートを使用する際は必ず専用の欄に短い説明を加えてください (例はそれぞれのテンプレートページにあります)。必要であればトークページで議論を始めます。

関連記事ボックス

• ArchWiki 内部にある関連記事のシンプルなリストを提供します。
• 使用する場合は、カテゴリ (もしくは言語間リンクや記事の状態テンプレートがあればそれ) のすぐ下に配置してください。
• 関連記事ボックスは テンプレート:Related articles start と テンプレート:Related と テンプレート:Related articles end のみで構成されています。各ページのガイドラインを参照してください。
• 英語以外の言語で書かれた記事は、そのリンクの文字列を翻訳するために テンプレート:Related2 を使うことができます。
• もっと完全で詳しいリストがほしいときは "参照" セクション を使ってください。リンクの説明とインターウィキや外部サイトへリンクを含めることができます。

前書きや導入

• 記事の主題を記述します。
  ソフトウェアの説明は、(偏った見方になる可能性があるので) 自分の言葉で言い換えたり書いたりするより、アップストリームの著者が書いたものを使うとよいでしょう。これは (もし存在すれば) 大抵プロジェクトのホームページや about ページにあります。例として MediaTomb が挙げられます。
• 記事の最初のセクションのすぐ上に配置してください。
• 明示的に ==Introduction== や ==Preface== セクションを作らずに、最初のセクションの見出しの上に配置してください。目次は、十分な数のセクションが記事にあれば、自動的に前書きと最初のセクションの間に表示されます。
• 詳しくはヘルプ:記事の書き方を見てください。

セクションの見出し

• 見出しは2段階目から使ってください (==)。1段目は記事のタイトルに予約されています。
• サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
• 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
• 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:

詳しくは関連記事を参照してください。

同じく、HTML や wiki のマークアップコード、あるいはコードをフォーマットするテンプレートを見出しに使わないで下さい。ヘルプ:スタイル/書式と句読点も参照。

• 詳しくはヘルプ:効果的な見出しを見てください。

コードのフォーマット

• 短いコードやファイル名、コマンド名、変数などのインラインで表示したいものは {{ic|code}} を使います。例:
  コンソールで sh ./hello_world.sh を実行してください。

• (コマンドラインの入出力するコードやファイルの中身など) コードが一行で適切なフレームを付ける場合、半角スペースを前に付けます。ヘルプ:編集#コードを見てください。例:

$ sh ./hello_world.sh

Hello World

• 複数行のコード (コマンドラインの入出力やファイルの中身) に適切なフレームを付ける場合、{{bc|code}} を使います。例:

#!/bin/sh

# Demo
echo "Hello World"

• コマンドラインの入力と出力を両方表示する必要がある場合は、{{hc|input|output}} を使います。例:

$ sh ./hello_world.sh

Hello World

• ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{hc|filename|content}} を使うことで、見出しにファイル名を表示することもできます。例:

~/hello_world.sh

#!/bin/sh

# Demo
echo "Hello World"

• 設定ファイルのようなコードブロックについては、読者を関連のある行に集中させ、それ以外の周囲の無関連な内容を省略する (...) ことを考えてください。

• 詳しくはヘルプ:テンプレートを見てください。= や | などテンプレートを破壊する文字の対処法についても載っています。

コマンドラインのテキスト

• インラインコード (Template:ic) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
• ブロックコード (Template:bc や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして $ を、root のコマンドのプロンプトとして # を使います。
  ノート: # はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。
  • コマンドブロックの前置きとなる文の最後は通常 : にしたほうがよいです。
  • 特別な事情がない限り、次を使います:

    # command

    次は使いません:

    $ sudo command

  • root プロンプトと sudo コマンドを次のように一緒に使わないでください:

    # sudo command

    唯一の例外は sudo が -u フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to $.
  • コマンドを含む同じ囲みにコメントを付け足さないでください。例:

    # pacman -S foo  #パッケージ foo をインストール

  • 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
• ユーザが sudo や他の権限昇格ユーティリティ (例: gksu, kdesu) を使うと決めてかからないでください。

ファイル編集の記述

• テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (nano, vim, emacs など) の使用を前提としないでください。
• テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば $ echo -e "clear\nreset" >> ~/.bash_logout は次のようにします:

~/.bash_logout に以下の行を付け加えます:

clear
reset

適切な場所に ヘルプ:読み方#追加, 作成, 編集 そして source へのリンクを追加するのも良いでしょう。

キーボードキー

• 記事内でのキーボードキーの表示は、通常、Template:ic のインスタンスを使います。
• 文字キーは小文字で表示します: a。大文字を表示するには Shift+a を使います。Shift+A や A は使いません。
• キーの 組み合わせ は、+ 記号を用い、その両端に空白文字を付けずにそれぞれのキーを結合するのが正しい表示の仕方です: Ctrl+c。
  Ctrl + c, Ctrl+c, Ctrl-c は準拠していない書式なので、使用は避けてください。
• キー入力の 流れ は、冗長に説明 (例: Shift+t に続けて g を押します) するか、それぞれのキーにテンプレートの別々のインスタンスを用いて、それらを1個の半角スペースで区切って簡潔に説明するのが正しい表示の仕方です: g Shift+t。
• 特別なキーの組み合わせの標準的な表示方法を以下にいくつか示します:
  • Shift (SHIFT ではありません)
  • Ctrl (CTRL や Control ではありません)
  • Alt (ALT でありません)
  • Super (Windows や Mod ではありません)
  • Enter (ENTER や Return ではありません)
  • Esc (ESC や Escape ではありません)
  • Space (SPACE ではありません)
  • Backspace
  • Tab
  • Ins (INS や Insert ではありません)
  • Del (DEL や Delete ではありません)
  • PrintScreen
  • PageUp
  • PageDown

パッケージ管理の記述

公式パッケージ

• 公式パッケージのインストールの説明に、以下の例のような pacman のコマンドを使わないでください: この規則は、シンプルであるために (すべての Arch ユーザは、pacman の記事内容を知っておくべきです)、そして pacman -Sy package のようなコマンドで起こりうるエラーや、pacman -S package か pacman -Syu package のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、pacman のフロントエンドやラッパーの使用を提案してはいけません。

代わりに、以下のような記述を使ってください:

foobar パッケージをインストールしてください。

もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:

MyApplication は my-app-pkg パッケージでインストールできます。

複数のパッケージをインストールするように書きたいときは以下のようになります:

foobar1, foobar2, foobar3 パッケージをインストールしてください。

パッケージグループを参照するときは以下を使用:

foobar グループをインストールしてください。

記事に合わせて言い回しを変えても構いません。

• 言及したパッケージのリンクは必ず貼り、テンプレート:Pkg を使ってください。例: {{Pkg|foobar}}。
• パッケージグループの参照する場合は、代わりに テンプレート:Grp を使ってください。例: {{Grp|foobar}}。
• 上記の例ではインストールのリンクを利用しています (例: [[install]]): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
• メンテナンスを容易にするために、パッケージが core、extra、または community リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (multilib、testing など) でホストされている場合は、以下のようにして言及する必要があります:

foobar パッケージを公式の multilib リポジトリからインストールしてください。

AUR パッケージ

• Please avoid using examples of how to install AUR packages, neither with the official method nor mentioning AUR helpers. Every user who installs unofficial packages should have read the Arch User Repository article and be aware of all the possible consequences on his system.

Instead, just use a simple statement like:

Install the foobar^AUR package.

You are granted the flexibility to adapt the wording to your specific article. See the section on #Official packages for more examples.

• Links to the referenced packages are mandatory and should be created using Template:AUR (e.g. {{AUR|foobar}}).

非公式リポジトリ

• ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが非公式ユーザーリポジトリにかかれていることを確認して、ページヘのリンクを張ってください。また、公式パッケージと同様に、pacman コマンドの例は不要です。例:

example リポジトリから foobar パッケージをインストールしてください。

パッケージが AUR からもインストールできる場合:

foobar^AUR パッケージをインストールしてください。このパッケージは example リポジトリからインストールすることもできます。

パッケージが AUR とは違う名前で存在している場合:

aurpkg^AUR パッケージをインストールしてください。example リポジトリの builtpackage でもインストールできます。

You are granted the flexibility to adapt the wording to your specific article.

• 非公式ユーザーリポジトリへのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: [[Unofficial user repositories#example|example]]。

systemd ユニットの操作

• Do not give examples of how to enable, start, or perform any other basic operations with systemctl on systemd units. Instead, use a simple sentence listing the units involved, possibly remarking dependencies or conflicts with other units, and a description of the actions to be performed. For example:

ブート時に GDM を起動させるには、gdm.service を有効化してください。

Or, if for example the unit is a template that needs instantiation:

無線インターフェイスの netctl プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して netctl-auto@.service のインスタンスを有効化してください。例: netctl-auto@wlan0.service。

You are granted the flexibility to adapt the wording to your specific article.

• Make sure to link to the systemd#Using units article section, either directly or through a dedicated redirect like [[start]], [[enable]] or [[stop]].

ノート・警告・ヒント

• A Note should be used for information that somehow diverges from what the user would naturally expect at some point in the article. This includes also information that gives more in-depth knowledge on something in particular that otherwise would be considered a bit extraneous to the article. Another example is when needing to point out a temporary announcement like a change in the name of a package.

A Note can also be used to highlight information that is important but easily overlooked by someone new to the subject area.

• A Warning should be used where the described procedure could carry severe consequences such as being reasonably difficult to undo or resulting in damage to the system. Warnings should generally indicate both the worst case scenarios as well as the conditions that could lead to or avoid such worst cases.

In general, do not abuse Warnings: if you are undecided, chances are high that you should use a Note.

• A Tip should indicate a method or procedure that could be useful and bring benefits to somebody, albeit not needed to complete the operation being dealt with, and therefore safely ignorable.
• When two or more notes, warnings or tips have to appear one after each other at the same point of an article, prefer grouping their texts in a list inside a single template, avoiding stacking the templates unless they are completely unrelated. For example:

ヒント:

• Tip example #1.
• Tip example #2.

シェル

• Do not assume a particular shell as the user's shell (e.g. Bash), except when really needed: try to be as shell-neutral as possible when writing or editing articles.

ハイパーテキスト

• Try to interlink your article with as many others as you can, using the various keywords in the text.
• Only link to a new article after creating it. In general, do not create links to non-existent articles.
• For technical terms, such as system call, not covered by an article in the ArchWiki, link to the relevant Wikipedia page.
• wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: [[Wiki Article]]。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。
  内部リンクの使用法に関する詳細はヘルプ:編集#リンクを見てください。
  • Do not hide the anchor symbol in same-page section links (e.g. [[#Links to sections of a document|Links to sections of a document]]). Besides the needless reformat, the anchor gives a clear indication that the link points to an article section, rather than a full article.
• Avoid implicit links whenever possible. For example, prefer instructions like "See the systemd article for more information" instead of "See here for more information".
• Except in rare cases, you should not leave an article as a dead-end page (an article that does not link to any other) or an orphan page (an article that is not linked to from any other).
• Before writing a specific procedure in an article or describing something in particular, always check if there is already an article that treats that part in detail: in that case, link that article instead of duplicating its content.
• If the upstream documentation for the subject of your article is well-written and maintained, prefer just writing Arch-specific adaptations and linking to the official documentation for general information.
• Do not use interwiki links for links to localized pages of the same language of the article being edited because they will not be shown in Special:WhatLinksHere pages. For example, using [[:hu:Main page]] in a Hungarian article is wrong, while [[Main page (Magyar)]] is correct.
  Using this kind of links between different languages is instead acceptable because this would make it easier to move the articles to a separate wiki in case a separate wiki is created in the future.
  Finally, note the difference of this kind of links from #Interlanguage links, which do not have the colon at the beginning.

コーディングスタイル

• When adding commands or scripts, use a consistent coding style throughout the article, possibly also referring to the other articles, especially if there are any related ones. If available, respect the official or most common coding style guidelines for the language.
• Avoid deprecated features of the programming/scripting language you are using: for example, use the $() syntax for shell command substitution instead of the backticks/grave (``) syntax.

サポートするカーネルのバージョン

• Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current linux-lts package in the core repository and the kernel on the latest installation media.

"Tips and tricks" セクション

• Tips and tricks sections provide advanced tips or examples of using the software.
• Use the standard title of Tips and tricks.
• The various tips and tricks should be organized in subsections.

"トラブルシューティング" セクション

• Troubleshooting sections are used for frequently asked questions regarding the software or for solutions to common problems (compare to #"Known issues" sections).
• Use the standard title of Troubleshooting. Common misspellings that should be avoided are Trouble shooting, Trouble-shooting, and TroubleShooting.
• You can also report temporary workarounds for known bugs, but in this case, it is very desirable that you provide a link to the bug report. In case it has not been reported yet, you should report it yourself, thus increasing the chances that the bug will be properly fixed.
  There are great benefits in linking to a bug report both for readers and editors:
  • For readers, the Wiki does not become a stopping point: they can find more information close to the source that may have otherwise been missed by their search efforts.
  • For Wiki editors, it makes cleanup easier by reducing the effort involved in researching whether the reported bug is still an issue; this can even lead to greater autonomy if the reader finds new information and comes back to edit the wiki.

"既知の問題" セクション

• Known issues sections are used for known bugs or usage problems which do not have a solution yet (compare to #"Troubleshooting" sections).
• Use the standard title of Known issues.
• If a bug report exists for the known issue, it is very desirable that you provide a link to it; otherwise, if it does not exist, you should report it yourself, thus increasing the chances that the bug will be fixed.

"参照" セクション

• See also sections contain a list of links to references and sources of additional information.
• This should be a list where each entry is started with *, which creates a MediaWiki bulleted list.
• Use the standard title of See also. Other similar titles such as External links, More resources, etc. should be avoided.

適切ではない記述

• Please do not sign articles, nor credit article authors: the ArchWiki is a work of the community, and the history of each article is enough for crediting its contributors.
  Reporting the sources used to write an article, though, is good practice: you can use the "See also" section for this purpose.
• Uploading files is disabled for normal users, and including the existing images in articles is not allowed. As an alternative you can include links to external images or galleries, and if you need to draw simple diagrams you may use an ASCII editor like Asciiflow. Rationale:
  • Maintenance: Arch is rolling release, and images would make updating articles much more difficult.
  • Necessity: Arch does not develop nor maintain any sort of GUI application, so we do not need to display any screenshot.
  • Moderation: free image upload would require time to be spent removing oversized or inappropriate images.
  • Accessibility: we support users with slow connections, text-only browsers, screen readers and the like.
  • Efficiency: images waste server bandwidth and storage space.
  • Simplicity: text-only articles just look simpler and tidier.

言語使用域

• Articles should be written using formal, professional, and concise language. Care should be taken to remove grammar and orthography errors through edit previews and proofreading.
• Remember not only to answer how, but also why. Explanatory information always goes further toward imparting knowledge than does instruction alone.
• Avoid contractions: "don't", "isn't", "you've", etc. should be "do not", "is not", and "you have", for example.
• Avoid unnecessary shortening of words: for example, instead of "repo", "distro", and "config", prefer "repository", "distribution", and "configuration".
  In the same fashion, prefer using the long form of uncommon command options instead of their single-character counterpart.
• Do not omit terms that are necessary to give an exact, unambiguous meaning to a sentence. For example, always add the word "repository" when mentioning the name of a repository.
• Do not use indefinite time references such as "currently", "at the time of writing" or "soon"; replace them with definite expressions such as "as of May 2015" etc.
• Write objectively: do not include personal comments on articles; use discussion pages for this purpose. In general, do not write in first person.
• When editing content, be consistent with the style used in the rest of the article. For example, if the reader is always addressed using the second person, this style should be adopted by the added content; the same goes if third person or passive voice are clearly dominant throughout the article.
• When offering a choice among different options (pieces of software, methods to do something, etc.) do not explicitly recommend one over the others, but objectively describe the advantages and disadvantages of each, thus helping the reader to make the best decision for his personal case.

カテゴリのページ

• 全てのカテゴリは最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ (カテゴリ:アーカイブ, カテゴリ:目次, カテゴリ:メンテナンス) は例外です。
• A category can be categorized under more than one category, provided one is not ancestor of the others.
• Avoid circular relationships: two categories cannot be reciprocal ancestors.
• Do not categorize a category under itself (self-categorized category).
• Categories must be included at the top of the category page.
• Categories should not redirect, except temporarily during renaming.
• By default, category names should be in the singular form ("topic" categories); they should be in the plural form if the singular form can be used to describe one of its members ("set" categories).

リダイレクトのページ

• 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
  • アーカイブページはリダイレクトですが、カテゴリ:アーカイブにカテゴライズされます。
• リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。

言語間リンクを使用するリダイレクトはヘルプ:i18n の決まりにしたがってArchWiki:管理者からの許可が得られた場合にのみ例外的に可能となります。

ユーザーのページ

• Pages in the User namespace cannot be categorized.
• Pages in the User namespace can only be linked from other pages in the User or talk namespaces, unless authorization to do otherwise is given by Administrators.

共通ルール

編集内容の要約

ヘルプ:編集を見てください。

HTML タグ

• HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。ヘルプ:編集を参照。
• When tempted to use <pre>code</pre>, always resort to {{bc|code}}. When tempted to use <tt>text</tt> or <code>text</code>, always resort to {{ic|text}}.
• 特に HTML コメントは使わないようにしてください (<!-- comment -->): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。
  コメントを書くところには適当な記事の状態テンプレートを追加してください。
• Use <br> only when necessary: to start a new paragraph or break a line, put a blank line below it.
  Common exceptions to this rule are when it is necessary to break a line in a list item and you cannot use a sub-item, or inside a template and you cannot use a list.