ArchWiki - 利用者の投稿記録 [ja]

デバッグ

2016-10-26T16:12:54Z

168: /* Valgrind */ 翻訳

[[Category:開発]]
[[en:Step-by-step debugging guide]]
{{Related articles start}}
{{Related|一般的なトラブルシューティング}}
{{Related|バグ報告ガイドライン}}
{{Related|デバッグ - トレースを取得}}
{{Related|ブートデバッグ}}
{{Related articles end}}
このページはバグレポートに関連する情報を集める方法を主題にしています。"デバッグ"という言葉を使ってはいますが、開発においてプログラムをデバッグする方法を解説するガイドではありません。

== アプリケーションが落ちる場合 ==

=== コマンドラインから実行 ===

アプリケーションが突然クラッシュしたときは、[[アプリケーション一覧#ターミナルエミュレータ|ターミナルエミュレータ]]からアプリケーションを実行してみてください。小文字でアプリケーションの名前を入力します。パッケージの名前しか分からず、アプリケーションの実行可能ファイルの名前を知らない場合、以下のコマンドを実行することで実行可能ファイルの名前を確認できます。''packagename'' はパッケージの名前に置き換えてください:

for f in `pacman -Ql ''packagename'' | grep "/bin/" | cut -d" " -f2`; do file $f 2>/dev/null | grep -q executable && basename $f; done

=== コアダンプが利用可能か確認 ===

コアダンプは、プロセスが予期せず終了した時のプロセスのアドレス空間 (メモリ) の内容を記録したファイルです。アプリケーションがデバッグしやすい方法でコンパイルされている場合、どこで上手く動作しなくなったのかを見つけ出すために''コア''ファイルを使うことができます。

コアダンプの場所はオペレーティングシステムの設定によって異なることがあります。システムでコアダンプの出力が有効化されているかどうか、そしてそれがどこに出力されるかを見つけるには、[[コアダンプ]]を見てください。

== セグメンテーション違反 ==

何が間違っているのか見つけ出すのに使用できるテクニックがいくつかあります。鹿撃ち帽をかぶりましょう。

=== Gdb ===

{{Pkg|gdb}} は古典的で十分テストされたデバッグ用アプリケーションです。''appname'' をデバッグしたい実行可能ファイルの名前に置き換えてください:

$ gdb appname
r
(wait for segfault)
bt full

出力を [[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をバグレポートに含めてください。

=== gdb の出力を改善する ===

まず '''-g''', '''-O0''', '''-fbuiltin''' フラグを付けて問題のアプリケーションを[[Arch Build System|リコンパイル]]してください。PKGBUILD の options に "!strip" があることを確認して、パッケージをインストールして上述のように gdb を再度実行します。

options 行は以下のようになります:

options=('!strip')

'''-g''', '''-O0''', '''-fbuiltin''' を有効にするには PKGBUILD の build() 関数の一番始めに以下の二行を記述します:

export CFLAGS="$CFLAGS -O0 -fbuiltin -g"
export CXXFLAGS="$CXXFLAGS -O0 -fbuiltin -g"

フラグの意味は次のとおりです: '''-g''' はデバッグシンボルを有効にして '''-O0''' は最適化を無効にします ('''-O2''' が最もよく使われる最適化レベルです。[http://funroll-loops.info/ '''-O3''' は過剰] で [http://stackoverflow.com/questions/1778538/how-many-gcc-optimization-levels-are-there '''-O4''' 以上は '''-O3''' と全く同じ] です)。

"core" ファイルが存在する場合、gdb と一緒に使うことでバックトレースを取得できます:

$ gdb appname core
bt full

=== Valgrind ===

インライン展開された関数が無く strip されていないバイナリだとすれば、大抵の場合 {{Pkg|valgrind}} を使ってそのプログラムを実行することもよいアイデアといえます。 ''valgrind'' は CPU をエミュレートし、大抵の場合、どこでおかしくなったかを表示したり、gdb に加えてさらなる情報を提供してくれるツールです。

$ valgrind appname

プログラムがクラッシュした場合、これによって多くの有益なデバッグ出力が得られます。さらに詳しい情報が得るには {{ic|-v}} と {{ic|<nowiki>--leak-check=full</nowiki>}} を使うとよいでしょう。

または、次を使います:

$ valgrind --tool=callgrind appname

そして、{{Pkg|kdesdk-kcachegrind}} を使って出力ファイルを実行し、プログラムが使っている関数を視覚的に調査します。プログラムがハングした場合、これによってエラー箇所の特定が楽になります。

== 欠けているファイルやライブラリ ==

=== Strace ===

{{Pkg|strace}} はアプリケーションが実際に何をしているのかを細かく調査します。アプリケーションが存在しないファイルを開こうとしていた場合、strace でそのことを発見できます。

''appname'' という名前のプログラムが開こうとしたファイルを調査するには:

$ strace -eopen appname

出力を保存して、[[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をメモしてください。

{{Tip|If you wish to grep the output from strace, you can try:
{{ic|strace -o /dev/stdout appname <nowiki>|</nowiki> grep ''string''}}
}}

=== LD_DEBUG ===

Setting {{ic|<nowiki>LD_DEBUG=files</nowiki>}} gives another overview of what files an application is looking for. For an application named ''appname'':

LD_DEBUG=files appname > appname.log 2>&1

The output will end up in {{ic|appname.log}}.

詳しくは {{ic|man ld-linux}} を見てください。

=== Readelf ===

アプリケーションを実行した時に "no such file or directory" ｔ表示される場合は、次のコマンドを実行してみてください ({{ic|/usr/bin/appname}} は実行可能ファイルの場所に置き換えてください):

$ readelf -a /usr/bin/appname | grep interp

Make sure the interpreter in question (like /lib/ld-linux-x86-64.so.2) actually exists. Install {{AUR|ld-lsb}} from the [[AUR]] if need be.

== C や C++ ではなく Python で書かれている場合 ==

Use {{Pkg|file}} on the executable to get more information (replace "appname" with your executable):

$ file /usr/bin/''appname''

If it says "ELF" it's a binary exectuable and is usually written in C or C++. If it says "Python script" you know you're dealing with an application written in Python.

If it's a shell script, open up the shell script in a text editor and see (usually at the bottom of the file) if you can find the name of the real application (ELF file). You can then temporarily put "gdb" right in the shellscript, before the name of the executable, for debugging purposes. See the sections about gdb further up. Prefix the command with {{ic|gdb --args}} if the executable in question needs arguments as well.

For pure shell scripts, you can also use {{ic|bash -x ''script_name''}} or {{ic|bash -xv ''script_name''}}.

For Python applications, the output will often say which file and line number the crash occured at. If you're proficient with Python, you can try to fix this and include the fix in the bug report.

== バグの報告 ==

Please report a bug at https://bugs.archlinux.org and possibly also directly to the developers of the application in question, then include a link in the Arch Linux bug report. This helps us all.

However, if you think there's something wrong with the application itself, and not with how it is packaged, report the bug directly to upstream (which means the developers of the application). Normally, software streams from developers, through packagers/maintainers and down to users. Upstream means the other way, so for this case: directly to the developers of an application.

== 参照 ==

*[https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces Gentoo guide for getting useful backtraces]

デバッグ

2016-10-25T16:29:30Z

168: /* コアダンプが利用可能か確認 */

[[Category:開発]]
[[en:Step-by-step debugging guide]]
{{Related articles start}}
{{Related|一般的なトラブルシューティング}}
{{Related|バグ報告ガイドライン}}
{{Related|デバッグ - トレースを取得}}
{{Related|ブートデバッグ}}
{{Related articles end}}
このページはバグレポートに関連する情報を集める方法を主題にしています。"デバッグ"という言葉を使ってはいますが、開発においてプログラムをデバッグする方法を解説するガイドではありません。

== アプリケーションが落ちる場合 ==

=== コマンドラインから実行 ===

アプリケーションが突然クラッシュしたときは、[[アプリケーション一覧#ターミナルエミュレータ|ターミナルエミュレータ]]からアプリケーションを実行してみてください。小文字でアプリケーションの名前を入力します。パッケージの名前しか分からず、アプリケーションの実行可能ファイルの名前を知らない場合、以下のコマンドを実行することで実行可能ファイルの名前を確認できます。''packagename'' はパッケージの名前に置き換えてください:

for f in `pacman -Ql ''packagename'' | grep "/bin/" | cut -d" " -f2`; do file $f 2>/dev/null | grep -q executable && basename $f; done

=== コアダンプが利用可能か確認 ===

コアダンプは、プロセスが予期せず終了した時のプロセスのアドレス空間 (メモリ) の内容を記録したファイルです。アプリケーションがデバッグしやすい方法でコンパイルされている場合、どこで上手く動作しなくなったのかを見つけ出すために''コア''ファイルを使うことができます。

コアダンプの場所はオペレーティングシステムの設定によって異なることがあります。システムでコアダンプの出力が有効化されているかどうか、そしてそれがどこに出力されるかを見つけるには、[[コアダンプ]]を見てください。

== セグメンテーション違反 ==

何が間違っているのか見つけ出すのに使用できるテクニックがいくつかあります。鹿撃ち帽をかぶりましょう。

=== Gdb ===

{{Pkg|gdb}} は古典的で十分テストされたデバッグ用アプリケーションです。''appname'' をデバッグしたい実行可能ファイルの名前に置き換えてください:

$ gdb appname
r
(wait for segfault)
bt full

出力を [[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をバグレポートに含めてください。

=== gdb の出力を改善する ===

まず '''-g''', '''-O0''', '''-fbuiltin''' フラグを付けて問題のアプリケーションを[[Arch Build System|リコンパイル]]してください。PKGBUILD の options に "!strip" があることを確認して、パッケージをインストールして上述のように gdb を再度実行します。

options 行は以下のようになります:

options=('!strip')

'''-g''', '''-O0''', '''-fbuiltin''' を有効にするには PKGBUILD の build() 関数の一番始めに以下の二行を記述します:

export CFLAGS="$CFLAGS -O0 -fbuiltin -g"
export CXXFLAGS="$CXXFLAGS -O0 -fbuiltin -g"

フラグの意味は次のとおりです: '''-g''' はデバッグシンボルを有効にして '''-O0''' は最適化を無効にします ('''-O2''' が最もよく使われる最適化レベルです。[http://funroll-loops.info/ '''-O3''' は過剰] で [http://stackoverflow.com/questions/1778538/how-many-gcc-optimization-levels-are-there '''-O4''' 以上は '''-O3''' と全く同じ] です)。

"core" ファイルが存在する場合、gdb と一緒に使うことでバックトレースを取得できます:

$ gdb appname core
bt full

=== Valgrind ===

Assuming you have an unstripped binary without inlined functions, it's usually a good idea to also run that program through {{Pkg|valgrind}}. ''valgrind'' is a tool that emulates a CPU and usually shows where things go wrong or provide additional info in addition to gdb.

$ valgrind appname

it will provide a lot of helpful debug output if there is a crash. Consider {{ic|-v}} and {{ic|<nowiki>--leak-check=full</nowiki>}} to get even more info.

Alternatively, use:

$ valgrind --tool=callgrind appname

and run the output through {{Pkg|kdesdk-kcachegrind}} to graphically explore the functions the program uses. If a program hangs, this makes it easier to pinpoint the location of the error.

== 欠けているファイルやライブラリ ==

=== Strace ===

{{Pkg|strace}} はアプリケーションが実際に何をしているのかを細かく調査します。アプリケーションが存在しないファイルを開こうとしていた場合、strace でそのことを発見できます。

''appname'' という名前のプログラムが開こうとしたファイルを調査するには:

$ strace -eopen appname

出力を保存して、[[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をメモしてください。

{{Tip|If you wish to grep the output from strace, you can try:
{{ic|strace -o /dev/stdout appname <nowiki>|</nowiki> grep ''string''}}
}}

=== LD_DEBUG ===

Setting {{ic|<nowiki>LD_DEBUG=files</nowiki>}} gives another overview of what files an application is looking for. For an application named ''appname'':

LD_DEBUG=files appname > appname.log 2>&1

The output will end up in {{ic|appname.log}}.

詳しくは {{ic|man ld-linux}} を見てください。

=== Readelf ===

アプリケーションを実行した時に "no such file or directory" ｔ表示される場合は、次のコマンドを実行してみてください ({{ic|/usr/bin/appname}} は実行可能ファイルの場所に置き換えてください):

$ readelf -a /usr/bin/appname | grep interp

Make sure the interpreter in question (like /lib/ld-linux-x86-64.so.2) actually exists. Install {{AUR|ld-lsb}} from the [[AUR]] if need be.

== C や C++ ではなく Python で書かれている場合 ==

Use {{Pkg|file}} on the executable to get more information (replace "appname" with your executable):

$ file /usr/bin/''appname''

If it says "ELF" it's a binary exectuable and is usually written in C or C++. If it says "Python script" you know you're dealing with an application written in Python.

If it's a shell script, open up the shell script in a text editor and see (usually at the bottom of the file) if you can find the name of the real application (ELF file). You can then temporarily put "gdb" right in the shellscript, before the name of the executable, for debugging purposes. See the sections about gdb further up. Prefix the command with {{ic|gdb --args}} if the executable in question needs arguments as well.

For pure shell scripts, you can also use {{ic|bash -x ''script_name''}} or {{ic|bash -xv ''script_name''}}.

For Python applications, the output will often say which file and line number the crash occured at. If you're proficient with Python, you can try to fix this and include the fix in the bug report.

== バグの報告 ==

Please report a bug at https://bugs.archlinux.org and possibly also directly to the developers of the application in question, then include a link in the Arch Linux bug report. This helps us all.

However, if you think there's something wrong with the application itself, and not with how it is packaged, report the bug directly to upstream (which means the developers of the application). Normally, software streams from developers, through packagers/maintainers and down to users. Upstream means the other way, so for this case: directly to the developers of an application.

== 参照 ==

*[https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces Gentoo guide for getting useful backtraces]

デバッグ

2016-10-25T15:15:29Z

168: 同期

[[Category:開発]]
[[en:Step-by-step debugging guide]]
{{Related articles start}}
{{Related|一般的なトラブルシューティング}}
{{Related|バグ報告ガイドライン}}
{{Related|デバッグ - トレースを取得}}
{{Related|ブートデバッグ}}
{{Related articles end}}
このページはバグレポートに関連する情報を集める方法を主題にしています。"デバッグ"という言葉を使ってはいますが、開発においてプログラムをデバッグする方法を解説するガイドではありません。

== アプリケーションが落ちる場合 ==

=== コマンドラインから実行 ===

アプリケーションが突然クラッシュしたときは、[[アプリケーション一覧#ターミナルエミュレータ|ターミナルエミュレータ]]からアプリケーションを実行してみてください。小文字でアプリケーションの名前を入力します。パッケージの名前しか分からず、アプリケーションの実行可能ファイルの名前を知らない場合、以下のコマンドを実行することで実行可能ファイルの名前を確認できます。''packagename'' はパッケージの名前に置き換えてください:

for f in `pacman -Ql ''packagename'' | grep "/bin/" | cut -d" " -f2`; do file $f 2>/dev/null | grep -q executable && basename $f; done

=== コアダンプが利用可能か確認 ===

コアダンプは、プロセスが予期せず終了した時のプロセスのアドレス空間 (メモリ) の情報を含んだファイルのことを指します。アプリケーションがデバッグしやすい方法でコンパイルされている場合、どこで上手く動作しなくなったのかを見つけ出すために''コア''ファイルを使うことができます。

コアダンプの場所はオペレーティングシステムの設定によって異なることがあります。システムでコアダンプ出力が有効化されているかどうか、そしてそれがどこに出力されるかを見つけるには、[[コアダンプ]]を見てください。

== セグメンテーション違反 ==

何が間違っているのか見つけ出すのに使用できるテクニックがいくつかあります。鹿撃ち帽をかぶりましょう。

=== Gdb ===

{{Pkg|gdb}} は古典的で十分テストされたデバッグ用アプリケーションです。''appname'' をデバッグしたい実行可能ファイルの名前に置き換えてください:

$ gdb appname
r
(wait for segfault)
bt full

出力を [[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をバグレポートに含めてください。

=== gdb の出力を改善する ===

まず '''-g''', '''-O0''', '''-fbuiltin''' フラグを付けて問題のアプリケーションを[[Arch Build System|リコンパイル]]してください。PKGBUILD の options に "!strip" があることを確認して、パッケージをインストールして上述のように gdb を再度実行します。

options 行は以下のようになります:

options=('!strip')

'''-g''', '''-O0''', '''-fbuiltin''' を有効にするには PKGBUILD の build() 関数の一番始めに以下の二行を記述します:

export CFLAGS="$CFLAGS -O0 -fbuiltin -g"
export CXXFLAGS="$CXXFLAGS -O0 -fbuiltin -g"

フラグの意味は次のとおりです: '''-g''' はデバッグシンボルを有効にして '''-O0''' は最適化を無効にします ('''-O2''' が最もよく使われる最適化レベルです。[http://funroll-loops.info/ '''-O3''' は過剰] で [http://stackoverflow.com/questions/1778538/how-many-gcc-optimization-levels-are-there '''-O4''' 以上は '''-O3''' と全く同じ] です)。

"core" ファイルが存在する場合、gdb と一緒に使うことでバックトレースを取得できます:

$ gdb appname core
bt full

=== Valgrind ===

Assuming you have an unstripped binary without inlined functions, it's usually a good idea to also run that program through {{Pkg|valgrind}}. ''valgrind'' is a tool that emulates a CPU and usually shows where things go wrong or provide additional info in addition to gdb.

$ valgrind appname

it will provide a lot of helpful debug output if there is a crash. Consider {{ic|-v}} and {{ic|<nowiki>--leak-check=full</nowiki>}} to get even more info.

Alternatively, use:

$ valgrind --tool=callgrind appname

and run the output through {{Pkg|kdesdk-kcachegrind}} to graphically explore the functions the program uses. If a program hangs, this makes it easier to pinpoint the location of the error.

== 欠けているファイルやライブラリ ==

=== Strace ===

{{Pkg|strace}} はアプリケーションが実際に何をしているのかを細かく調査します。アプリケーションが存在しないファイルを開こうとしていた場合、strace でそのことを発見できます。

''appname'' という名前のプログラムが開こうとしたファイルを調査するには:

$ strace -eopen appname

出力を保存して、[[アプリケーション一覧#Pastebin_クライアント|Pastebin クライアント]]に投稿して URL をメモしてください。

{{Tip|If you wish to grep the output from strace, you can try:
{{ic|strace -o /dev/stdout appname <nowiki>|</nowiki> grep ''string''}}
}}

=== LD_DEBUG ===

Setting {{ic|<nowiki>LD_DEBUG=files</nowiki>}} gives another overview of what files an application is looking for. For an application named ''appname'':

LD_DEBUG=files appname > appname.log 2>&1

The output will end up in {{ic|appname.log}}.

詳しくは {{ic|man ld-linux}} を見てください。

=== Readelf ===

アプリケーションを実行した時に "no such file or directory" ｔ表示される場合は、次のコマンドを実行してみてください ({{ic|/usr/bin/appname}} は実行可能ファイルの場所に置き換えてください):

$ readelf -a /usr/bin/appname | grep interp

Make sure the interpreter in question (like /lib/ld-linux-x86-64.so.2) actually exists. Install {{AUR|ld-lsb}} from the [[AUR]] if need be.

== C や C++ ではなく Python で書かれている場合 ==

Use {{Pkg|file}} on the executable to get more information (replace "appname" with your executable):

$ file /usr/bin/''appname''

If it says "ELF" it's a binary exectuable and is usually written in C or C++. If it says "Python script" you know you're dealing with an application written in Python.

If it's a shell script, open up the shell script in a text editor and see (usually at the bottom of the file) if you can find the name of the real application (ELF file). You can then temporarily put "gdb" right in the shellscript, before the name of the executable, for debugging purposes. See the sections about gdb further up. Prefix the command with {{ic|gdb --args}} if the executable in question needs arguments as well.

For pure shell scripts, you can also use {{ic|bash -x ''script_name''}} or {{ic|bash -xv ''script_name''}}.

For Python applications, the output will often say which file and line number the crash occured at. If you're proficient with Python, you can try to fix this and include the fix in the bug report.

== バグの報告 ==

Please report a bug at https://bugs.archlinux.org and possibly also directly to the developers of the application in question, then include a link in the Arch Linux bug report. This helps us all.

However, if you think there's something wrong with the application itself, and not with how it is packaged, report the bug directly to upstream (which means the developers of the application). Normally, software streams from developers, through packagers/maintainers and down to users. Upstream means the other way, so for this case: directly to the developers of an application.

== 参照 ==

*[https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces Gentoo guide for getting useful backtraces]

TeX Live

2016-10-25T14:38:51Z

168: 同期

[[Category:TeX]]
[[en:TeX Live]]
[[fa:LaTeX]]
[[it:TeX Live]]
[[zh-cn:TeX Live]]
{{Related articles start}}
{{Related4|TeX Live FAQ}}
{{Related3|TeX Live and CJK|TeX Live と CJK}}
{{Related|Ooolatex}}
{{Related|アプリケーション一覧/ドキュメント}}
{{Related articles end}}
[http://www.tug.org/texlive/ TeX Live] は簡単に立ち上げて使える [[Wikipedia:ja:TeX|TeX]] 文章生成システムです。GNU/Linux を含むほとんどの Unix や Windows に対応したバイナリの包括的な TeX システムを提供します。主要な TeX 関連プログラム、マクロパッケージ、フォントなどを全て含み、世界中の言語をサポートしています。

TeX Live は [[Wikipedia:LaTeX|LaTeX]], [[Wikipedia:ConTeXt|ConTeXt]] などの最も人気のあるディストリビューションの一つです。

== インストール ==
[[公式リポジトリ]]では TeX Live のパッケージは2つのグループに分けられています:
* {{grp|texlive-most}} には TeX Live のアプリケーションが入っています。
* {{grp|texlive-lang}} には様々な文字セットや非英語圏の機能が入っています。

必須のパッケージ {{Pkg|texlive-core}} には基本的な texmf-dist ツリーが含まれており、{{Pkg|texlive-bin}} にはバイナリやライブラリ、texmf ツリーが含まれています。{{Pkg|texlive-core}} は上流のディストリビューションの “medium” インストールスキームに基づいています。他のパッケージは全て TeX Live の eponymous コレクションに基づいています。CTAN パッケージがそれぞれのパッケージに含まれているか確かめるには、次のファイルを調べて下さい:
/var/lib/texmf/arch/installedpkgs/<package>_<revnr>.pkgs

=== texlive-most ===
{| width="100%"
|- valign="top"
|
* {{Pkg|texlive-core}}
* {{Pkg|texlive-bibtexextra}}
* {{Pkg|texlive-fontsextra}}
* {{Pkg|texlive-formatsextra}}
* {{Pkg|texlive-games}}
|
* {{Pkg|texlive-genericextra}}
* {{Pkg|texlive-htmlxml}}
* {{Pkg|texlive-humanities}}
* {{Pkg|texlive-latexextra}}
* {{Pkg|texlive-music}}
|
* {{Pkg|texlive-pictures}}
* {{Pkg|texlive-plainextra}}
* {{Pkg|texlive-pstricks}}
* {{Pkg|texlive-publishers}}
* {{Pkg|texlive-science}}
|}

=== texlive-lang ===
* {{Pkg|texlive-langchinese}}
* {{Pkg|texlive-langcyrillic}}
* {{Pkg|texlive-langgreek}}
* {{Pkg|texlive-langjapanese}}
* {{Pkg|texlive-langkorean}}
* {{Pkg|texlive-langextra}}

{{note|{{Pkg|texlive-langextra}} はアフリカ・アラビア・アルメニア・クロアチア・ヘブライ・インド・モンゴル・チベット・ベトナムの言語サポートを提供します。}}

=== 手動インストール ===

[https://en.wikibooks.org/wiki/LaTeX/Installation#Custom_installation_with_TeX_Live LaTeX Wikibook] や [https://tug.org/texlive/doc/texlive-en/texlive-en.html#x1-140003 TeX Live Guide] を見てください。TeX Live のインストールが必要なプログラム (例: kile) を利用したいときは {{AUR|texlive-dummy}} パッケージを使うことができます。

== 使用方法 ==

以下のコマンドでインストールされたことを確認できます:

$ tex '\empty Hello world!\bye'
$ pdftex '\empty Hello world!\bye'

DVI と PDF ファイルが作成されるはずです。[[アプリケーション一覧/ドキュメント#科学論文|TeX エディタ]]を使うことでドキュメントを作成できます。

また、TeX Live がなくてもオンラインで TeX のドキュメントを作成できるウェブサイトも存在します:

* {{App|Authorea|科学論文・学術文献・技術文章などのオンライン共同エディタ。|https://www.authorea.com/|}}
* {{App|ShareLaTeX|オープンソースのオンライン LaTeX エディタ。自分でホストして、編集、リアルタイムの共同編集で LaTeX 文章をコンパイル出来るローカルバージョンを実行することも、公式ウェブサイトでホストされているバージョンを使うこともできます。|https://www.sharelatex.com/|}}
* {{App|Overleaf|リアルタイムプレビューが統合されたオンライン LaTeX エディタ (旧名 writeLaTeX)。|https://www.overleaf.com/|}}
* {{App|Papeeria|オンラインの LaTeX エディタ。|http://papeeria.com/|}}
* {{App|TeXBin| 最小主義のオンライン LaTeX エディタ。|https://texbin.io/|}}
* {{App|cloudTeX|クラウドでソーシャルな TeX。|https://cloud-tex.com/|}}{{Dead link|2016|05|16}}

[https://en.wikibooks.org/wiki/LaTeX/Installation#Online_solutions LaTeX wikibook] も見てください。

== 重要事項 ==

* biblatex の参考文献を扱うのに使われる {{Pkg|biber}} は分割パッケージとして提供されています。

* 2009年の9月から updmap のフォントマッピングを処理する方法は改善され、以前よりもインストールが信頼できるものになっています。もし、マップファイルが見つからないというエラーメッセージが表示されたときは、手動で {{ic|updmap.cfg}} ファイルから削除してください ({{Ic|updmap-sys --edit}} を使うのが理想)。また、{{Ic|updmap-sys --syncwithtrees}} を実行すれば設定ファイルから古くなったマップを自動でコメントアウトすることができます。

* (MKII や MKIV の) ConTeXt フォーマットはインストール時に自動で生成されません。[http://wiki.contextgarden.net '''ConTeXT wiki'''] の説明を見て下さい。

* ドキュメントやソースを含むパッケージを [community] リポジトリから取得することができます。また、オンラインで http://tug.org/texlive/Contents/live/doc.html や CTAN で見ることも可能です。

* (上流の) TeX Live は CTAN パッケージの差分更新をするためのツールを提供しています。私たちもパッケージを定期的に更新する予定です (作業をほぼ自動化するツールを書き出しています)。

* TeX Live に入っているツールやユーティリティには {{Pkg|ghostscript}}, {{Pkg|perl}}, {{Pkg|python2}}, {{Pkg|ruby}} に依存しているものがあります。

* TeX Live のヘルプや情報は次を参照してください: http://tug.org/texlive/doc.html と http://tug.org/texlive/doc/texlive-en/texlive-en.html

* システム全体の設定ファイルは {{ic|/usr/share/texmf-config}} にあります。ユーザー別の設定ファイルは {{ic|~/.texlive/texmf-config}} の下に置いて下さい。{{Ic|$TEXMFHOME}} は {{ic|~/texmf}} で {{Ic|$TEXMFVAR}} は {{ic|~/.texlive/texmf-var}} です。

* ローカルの texmf ツリーのスケルトンは {{ic|/usr/local/share/texmf}} にあります: このディレクトリは '''tex''' グループのメンバーに書き込みが許可されています。

===用紙サイズ===
デフォルトのページサイズを A4 以外 ("Letter" など) に設定したい場合は、次のコマンドを実行してください:
$ texconfig
このコマンドは他の便利な設定を変更するのにも使えます。

===アップデート時の "formats not generated" エラー===

[https://bugs.archlinux.org/task/16467 このバグレポート]を参照してください。
{{Note|実験的なエンジン ''LuaTeX'' を使っていない場合は、無視してかまいません。}}
ハイフネーションパターンの設定ファイル {{ic|language.def}} や {{ic|language.dat}} に {{Ic|texlive-core}} の初期リリースに入っているファイルへの参照が含まれているときにこのエラーがよく発生します。特に、名前が頻繁に変わるドイツ語の最新の実験的なハイフネーションパターンが原因です。現在はドイツ語のパターンは {{ic|dehyph{n,t}-x-2009-06-19.tex}} になっています。

この問題を解決するには、次のファイルを削除するか: {{ic|/usr/share/texmf-config/tex/generic/config/language.<nowiki>{def,dat}</nowiki>}}
新しいバージョンを使って更新する必要があります: {{ic|/usr/share/texmf/tex/generic/config/language.<nowiki>{def,dat}</nowiki>}}
その後、次を実行してください
# fmtutil-sys --missing

===フォント===

デフォルトでは、さまざまな TeX Live パッケージに入っているフォントを Fontconfig から自動で利用することができません。XeTeX や [[LibreOffice]] などからフォントを使えるようにしたいときは、以下のようにシンボリックリンクを作成するのが一番簡単です:
# ln -s /usr/share/texmf-dist/fonts/opentype/public/<some_fonts_you_want> ~/.fonts/OTF/ (or TTF or Type1)

fontconfig で利用できるようにするには、次を実行してください:
# fc-cache ~/.fonts
# mkfontscale ~/.fonts/OTF (or TTF or Type1)
# mkfontdir ~/.fonts/OTF (or TTF or Type1)

また、{{Pkg|texlive-core}} には TeX Live によって使用されるフォントディレクトリのリストが入ったファイル {{ic|/etc/fonts/conf.avail/09-texlive-fonts.conf}} が含まれています。このファイルを利用するには次を実行して:

{{bc|# ln -s /etc/fonts/conf.avail/09-texlive-fonts.conf /etc/fonts/conf.d/09-texlive-fonts.conf}}

それから fontconfig を更新してください:

{{bc|# fc-cache && mkfontscale && mkfontdir}}

{{Note|This may cause conflicts with XeTeX/XeLaTeX if the same fonts are (separately) available to both TeX and Fontconfig, i.e. if multiple copies of the same font are available on the search path.}}

== TeXLive Local Manager ==

TeXLive Local Manager は Firmicus によって提供されているユーティリティで、Arch Linux 上の TeX Live 環境を便利に管理することができます。
[[Arch User Repository|AUR]] の {{AUR|texlive-localmanager-git}} を見て下さい。

Usage: tllocalmgr
tllocalmgr [options] [command] [args]

Running tllocalmgr alone starts the TeXLive local manager shell
for Arch Linux. This shell is capable of command-line completion!
There you can look at the available updates with the command 'status'
and you can install individual CTAN packages using 'install' or 'update'
under $TEXMFLOCAL. This is done by creating a package texlive-local-<pkg>
and installing it with pacman. Note that this won’t interfere with your
standard texlive installation, but files under $TEXMFLOCAL will take
precedence.

Here are the commands available in the shell:

Commands:
status -- Current status of TeXLive installation
shortinfo * -- Print a one-liner description of CTAN packages
info * -- Print info on CTAN packages
update * -- Locally update CTAN packages
install * -- Locally install new CTAN packages
installdoc * -- Locally install documentation of CTAN packages
installsrc * -- Locally install sources of CTAN packages
listfiles * -- List all files in CTAN packages
search * -- Search info on CTAN packages
searchfiles * -- Search for files in CTAN packages
texhash -- Refresh the TeX file database
clean -- Clean local build tree
help -- Print helpful information
quit -- Quit tllocalmgr

The commands followed by * take one of more package names as arguments.
Note that these can be completed automatically by pressing TAB.

You can also run tllocalmgr as a standard command-line program, with
one of the above commands as argument, then the corresponding task will
be performed and the program will exit (except when the command is 'status').

tllocalmgr accepts the following options:

Options: --help Shows this help
--version Show the version number
--forceupdate Force updating the TeXLive database
--skipupdate Skip updating the TeXLive database
--localsearch Search only installed packages
--location #TODO?
--mirror CTAN mirror to use (default is mirror.ctan.org)
--nocolor #TODO

== .sty ファイルのインストール ==
TeX Live (と teTeX) は自前のディレクトリインデックス ({{ic|ls-R}} という名前のファイル) を使っているため、ファイルを TeX ツリーの中にコピーしたときはインデックスを更新する必要があります。そうしないと TeX はコピーしたファイルを認識できません。利用するコマンド:
{{bc|# mktexlsr}}
または
{{bc|# texhash}}
または
{{bc|# texconfig[-sys] rehash}}
インデックスを検索するコマンドラインプログラムは:
kpsewhich
これを使って特定のファイルを TeX が見つけているか確認できます:
kpsewhich <filename.sty>
出力はそのファイルのフルパスになります。

また、特定のユーザーの sty ファイルは {{ic|~/texmf/}} ツリーに入ります。例えば、latex パッケージの wrapfig の {{ic|wrapfig.sty}} は {{ic|~/texmf/tex/latex/wrapfig/wrapfig.sty}} にあります。{{ic|~/texmf}} は tex が実行されるたびに検索されるので {{ic|mktexlsr}} を実行する必要はありません。

=== 手動インストール ===
通常、新しい .sty ファイルは {{ic|/usr/share/texmf-dist/tex/latex/<package name>/*}} に入ります。このディレクトリがない場合は作成してください。*tex を実行するとディレクトリが自動で検索されます。詳しい説明は次を見て下さい: https://bbs.archlinux.org/viewtopic.php?id=85757

=== PKGBUILD を使う ===
コンピュータ全体で LaTeX パッケージをインストールするときは、メンテナンスを簡単にするために [[PKGBUILD]] を使いましょう。[[Arch User Repository|AUR]] の {{AUR|texlive-gantt}} パッケージなどがサンプルです。

== babelbib 言語定義の更新 ==
必要としている最新の言語定義が babelbib になく、全てをリコンパイルしたくはないという問題を抱えている場合、https://www.tug.org/texlive/devsrc/Master/texmf-dist/tex/latex/babelbib/ から手動で入手して {{ic|/usr/share/texmf-dist/tex/latex/babelbib/}} に配置することができます。例えば:

{{bc|
# cd /usr/share/texmf-dist/tex/latex/babelbib/
# wget https://www.tug.org/texlive/devsrc/Master/texmf-dist/tex/latex/babelbib/romanian.bdf
# wget [...all-other-language-files...]
# wget https://www.tug.org/texlive/devsrc/Master/texmf-dist/tex/latex/babelbib/babelbib.sty
}}

その後、{{ic|texhash}} を実行して TeX データベースを更新してください:
# texhash

電源管理/サスペンドとハイバネート

2016-10-24T15:27:05Z

168: 誤字修正など

[[Category:電源管理]]
[[en:Power management/Suspend and hibernate]]
{{Related articles start}}
{{Related|Uswsusp}}
{{Related|TuxOnIce}}
{{Related|systemd}}
{{Related|pm-utils}}
{{Related4|hibernate-script}}
{{Related|電源管理}}
{{Related articles end}}
現在サスペンドには3つの手法が存在します: '''suspend to RAM''' (通常は'''サスペンド'''とだけ呼ばれます)、'''suspend to disk''' (通常は'''ハイバネート'''と呼ばれます)、そして '''hybrid suspend''' ('''suspend to both''' とも呼ばれます):

* '''Suspend to RAM''' は RAM を除くマシンのほとんど全てのパーツの電源を切ります。RAM への電源はマシンの状態を保存するために必要です。電力を多く節約できるので、ラップトップでは、バッテリーでコンピュータが稼働していてフタが閉じられた時 (もしくはユーザーが長い間操作しなかった時) は自動的にこのモードに移行するのが得策でしょう。

* '''Suspend to disk''' はマシンの状態を[[スワップ|スワップ領域]]に保存してマシンの電源を完全にオフにします。マシンに電源を入れた時、状態が復元されます。それまでは、電力消費量はゼロです。

* '''Suspend to both''' はマシンの状態をスワップ領域に保存しますが、マシンの電源を切りません。代わりに、通常の suspend to RAM を呼び出します。これによって、バッテリーを使いきっても、システムを RAM から復帰することが可能です。バッテリーが枯渇した時は、システムはディスクから復帰し、RAM からの復帰に比べて時間がかかりますが、システムの状態が失われることはありません。

基本的な機能を提供する低レベルなインターフェイス (バックエンド) が複数存在し、問題のあるハードウェアドライバ・カーネルモジュール (例: ビデオカードの再初期化) を扱う機能を提供する高レベルなインターフェイスもいくつかあります。

== 低レベルインターフェイス ==

これらのインターフェイスは直接使うこともできますが、通常は[[#高レベルインターフェイス|高レベルインターフェイス]]を使ってサスペンド・ハイバネートを行うとよいでしょう。低レベルなインターフェイスを直接使うと、サスペンドの前や後に行うフック処理を全て実行する高レベルインターフェイスよりもかなり早くサスペンドが可能です。ただしフックはハードウェアクロックの設定や、ワイヤレスの復旧などを正しく処理することができます。

=== カーネル (swsusp) ===

直球の方法はカーネル内のソフトウェアサスペンドコード (swsusp) にサスペンド状態に入るよう直接伝えることです。実際の方法と状態はハードウェアサポートのレベルによります。最近のカーネルでは、サスペンドにするために {{ic|/sys/power/state}} に適切な文字列を書くことが主な方法になっています。

詳しくは [https://www.kernel.org/doc/Documentation/power/states.txt カーネルドキュメント] を参照してください。

=== uswsusp ===

uswsusp ('Userspace Software Suspend') はカーネルの suspend-to-RAM のラッパーで、サスペンドの前と復帰の後にユーザー空間からグラフィックアダプタの操作を行います。

[[Uswsusp]] の記事を参照してください。

=== tuxonice ===

TuxOnIce はサスペンド・ハイバネートのカーネル実装のフォークで、デフォルトの実装を改善するカーネルパッチを提供しています。これを使うためにはカスタムカーネルが必要です。

[[TuxOnIce]] の記事を参照してください。

== 高レベルインターフェイス ==

{{Note|これらのパッケージではサスペンド・ハイバネートを行うためのバイナリ・スクリプトを提供します。実際に電源ボタンやメニュークリック、ラップトップのカバーのイベントなどと結びつけるのは他のツールで行うのが通常です。（ラップトップのカバーが閉じられたり、バッテリーが枯渇するなど）特定の電源イベントで自動的にサスペンド・ハイバネートをするには、[[Acpid]] の実行について調べて下さい。}}

=== systemd ===

[[systemd]] はサスペンド・ハイバネート・ハイブリッドサスペンドを行うためのネイティブのコマンドを提供しています。詳しくは [[電源管理#systemd による電源管理]] を見て下さい。これは Arch Linux で使われているデフォルトのインターフェースです。

サスペンド・ハイバネートのフックの設定に関する情報は[[電源管理#スリープフック]]に載っています。{{ic|man systemctl}}, {{ic|man systemd-sleep}}, {{ic|man systemd.special}} もあわせて参照してください。

=== pm-utils ===

pm-utils はバックエンドのサスペンド・ハイバネート機能をカプセル化するシェルスクリプトのセットです。サスペンドの前後に行う設定やプロセスをカスタマイズするための様々なフックも入っています。

[[pm-utils]] の記事を参照してください。

== ハイバネーション ==

ハイバネーションを使うには、[[スワップ]]パーティションかファイルを作成する必要があります。{{ic|1=resume=}} カーネルパラメータを使ってスワップを指定する必要がなります。これはブートローダを通して設定されます。[[#initramfs の設定|initramfs]] も必要になります。これによりカーネルは初期ユーザー空間の指定したスワップからの復帰を試みます。これら3つのステップは以下で詳細に述べます。

=== スワップパーティション（ファイル）のサイズについて ===

スワップパーティションが RAM より小さかったとしても、ハイバネートが成功する可能性は高いと思われます。[https://www.kernel.org/doc/Documentation/power/interface.txt カーネルドキュメント] によると:

: ''{{ic|/sys/power/image_size}} は suspend-to-disk によって作成されるイメージのサイズを制御します。イメージサイズの上限として使われる負ではない整数 (バイト) を示す文字列で書くことが出来ます。suspend-to-disk はイメージサイズがその数字を超えないように出来る限りのことをします。ただし、それが無理だということがわかったら、とにかく出来る限り小さいイメージを使ってサスペンドを試みます。特に、このファイルに "0" と書かれていた場合、サスペンドのイメージは目一杯小さくなります。このファイルを読むと現在のイメージのサイズ制限が表示され、デフォルトでは利用可能な RAM の2/5に設定されています。''

(スワップパーティションを小さくして) {{ic|/sys/power/image_size}} の値を減らしてサスペンドのイメージを出来る限り小さくすることも、値を増やしてハイバネーションを高速化することも可能です。

=== 必要なカーネルパラメータ ===

カーネルパラメータ {{ic|1=resume=''swap_partition''}} を使う必要があります。{{ic|''swap_partition''}} にはスワップパーティションのカーネル名か、スワップパーティションの [[UUID]] を使うことができます。例:

* {{ic|1=resume=/dev/sda1}}
* {{ic|1=resume=UUID=4209c845-f495-4c43-8a03-5363dd433153}}
* {{ic|1=resume=/dev/mapper/archVolumeGroup-archLogicVolume}} -- LVM を使う場合の例

{{ic|resume}} パラメータで使われる命名法は通常 {{ic|root}} パラメータで使われるものと同じにしてください。

設定は使用している[[ブートローダー]]によって異なります。詳しくは[[カーネルパラメータ]]を参照してください。

==== スワップファイルにハイバネーション ====

{{Warning|[[Btrfs#スワップファイル|Btrfs]] はスワップファイルをサポートしていません。この警告に従わない場合、ファイルシステムが破損するおそれがあります。ループデバイスを経由してマウントしているときに Btrfs でスワップファイルを使うと、スワップパフォーマンスが著しく低下してしまいます。}}

スワップパーティションの代わりにスワップファイルを使うには追加のカーネルパラメータ {{ic|1=resume_offset=''swap_file_offset''}} が必要です。

{{ic|''swap_file_offset''}} の値は {{ic|filefrag -v ''swap_file''}} を実行することで取得できます。テーブル形式で出力され、必要な値は {{ic|physical_offset}} カラムの一番上の段にあります。例えば:
{{hc|# filefrag -v /swapfile|<nowiki>
Filesystem type is: ef53
File size of /swapfile is 4294967296 (1048576 blocks of 4096 bytes)
ext: logical_offset: physical_offset: length: expected: flags:
0: 0.. 0: 38912.. 38912: 1:
1: 1.. 22527: 38913.. 61439: 22527: unwritten
2: 22528.. 53247: 899072.. 929791: 30720: 61440: unwritten
...
</nowiki>}}

この例では {{ic|''swap_file_offset''}} の値は 2つのピリオドが付いている最初の {{ic|38912}} です。

{{ic|''swap_file_offset''}} の値は {{ic|swap-offset ''swap_file''}} でも取得することができます。''swap-offset'' バイナリは {{AUR|uswsusp-git}} パッケージに含まれています。

{{Note|
* カーネルパラメータ {{ic|resume}} にはスワップファイル自体ではなく、スワップファイルが含まれているパーティションのデバイスを記入する必要があることに注意してください。パラメータ {{ic|resume_offset}} は resume デバイスのどこからスワップファイルがあるかを示しています。これらを有効化するためには、最初のハイバネーションの前に再起動が必要です。
* [[uswsusp]] を使う場合、キー {{ic|resume device}} と {{ic|resume offset}} を使って {{ic|/etc/suspend.conf}} にこれら2つのパラメータを記述してください。この場合再起動は必要ありません。
}}

{{Tip|RAM 利用の拡大ではなく単にハイバネートを可能にしたい場合は、スワップファイルの [[スワップ#Swappiness]] を減らすこともできます。}}

=== initramfs の設定 ===

* [[initramfs]] で {{ic|base}} フックを使っている場合 (Arch ではデフォルトで使っています)、{{ic|/etc/mkinitcpio.conf}} に {{ic|resume}} フックを追加する必要があります。ラベルか UUID に関わらずスワップパーティションは udev デバイスノードとともに参照されるので、{{ic|resume}} フックは必ず {{ic|udev}} の後に続けて下さい。次の例はデフォルトのフック設定から始まっています:

:{{bc|1=HOOKS="base udev '''resume''' autodetect modconf block filesystems keyboard fsck"}}

:これらの変更を有効化するために [[mkinitcpio#イメージ作成とアクティベーション|initramfs の再生成]]を忘れずに行ってください。

:{{Note|[LVM] を使っているユーザーは {{ic|resume}} を {{ic|lvm2}} の次に追加してください。}}

* {{ic|systemd}} のフックで initramfs を使う場合は既に復帰機構が提供されているので、さらにフックを追加する必要はありません。

== トラブルシューティング ==

=== ACPI_OS_NAME ===

'''DSDT table''' を動作するように設定することができます。[[DSDT]] の記事を参照してください。

=== VAIO ユーザー ===

{{ic|1=acpi_sleep=nonvs}} カーネルフラグをブートローダに追加してください、これで OK です!

=== Suspend/hibernate doesn't work, or not consistently ===

There have been many reports about the screen going black without easily viewable errors or the ability to do anything when going into and coming back from suspend and/or hibernate. These problems have been seen on both laptops and desktops. This is not an official solution, but switching to an older kernel, especially the LTS-kernel, will probably fix this.

Sometimes the screen goes black due to device initialization from within the initramfs. Removing any modules you might have in [[en2:Mkinitcpio#MODULES|Mkinitcpio#MODULES]] and rebuilding the initramfs, can possibly solve this issue, specially graphics drivers for [[en2:Kernel_mode_setting#Early_KMS_start|early KMS]]. Initializing such devices before resuming can cause inconsistencies that prevents the system resuming from hibernation. This does not affect resuming from RAM. Also, check this [https://01.org/blogs/rzhang/2015/best-practice-debug-linux-suspend/hibernate-issues article] for the best practices to debug suspend/hibernate issues.

=== Wake-on-LAN ===

[[Wake-on-LAN]] が有効になっている場合、コンピュータがハイバネート状態になっていてもネットワークインターフェイスカードによって電力が消費されます。

=== Instantaneous wakeups from suspend ===

For some Intel Haswell systems with the LynxPoint and LynxPoint-LP chipset, instantaneous wakeups after suspend are reported. They are linked to erroneous BIOS ACPI implementations and how the {{ic|xhci_hcd}} module interprets it during boot. As a work-around reported affected systems are added to a blacklist (named {{ic|XHCI_SPURIOUS_WAKEUP}}) by the kernel case-by-case.[https://bugzilla.kernel.org/show_bug.cgi?id=66171#c6]

Instantaneous resume may happen, for example, if a USB device is plugged during suspend and ACPI wakeup triggers are enabled. A viable work-around for such a system, if it is not on the blacklist yet, is to disable the wakeup triggers. An example to disable wakeup through USB is described as follows.[https://bbs.archlinux.org/viewtopic.php?pid=1575617]

To view the current configuration:

{{hc|$ cat /proc/acpi/wakeup|
Device S-state Status Sysfs node
...
EHC1 S3 *enabled pci:0000:00:1d.0
EHC2 S3 *enabled pci:0000:00:1a.0
XHC S3 *enabled pci:0000:00:14.0
...
}}

The relevant devices are {{ic|EHC1}}, {{ic|EHC1}} and {{ic|XHC}} (for USB 3.0). To toggle their state you have to echo the device name to the file as root.

# echo EHC1 > /proc/acpi/wakeup
# echo EHC2 > /proc/acpi/wakeup
# echo XHC > /proc/acpi/wakeup

This should result in suspension working again. However, this settings are only temporary and would have to be set at every reboot. To automate this take a look at [[en2:systemd#Writing unit files|systemd#Writing unit files]]. See [https://bbs.archlinux.org/viewtopic.php?pid=1575617#p1575617 BBS thread] for a possible solution and more information.

電源管理/サスペンドとハイバネート

2016-10-24T15:19:52Z

168: 同期 (一部未翻訳)

[[Category:電源管理]]
[[en:Power management/Suspend and hibernate]]
{{Related articles start}}
{{Related|Uswsusp}}
{{Related|TuxOnIce}}
{{Related|systemd}}
{{Related|pm-utils}}
{{Related4|hibernate-script}}
{{Related|電源管理}}
{{Related articles end}}
現在サスペンドには3つの手法が存在します: '''suspend to RAM''' (通常は'''サスペンド'''とだけ呼ばれます)、'''suspend to disk''' (通常は'''ハイバネート'''と呼ばれます)、そして '''hybrid suspend''' ('''suspend to both''' とも呼ばれます):

* '''Suspend to RAM''' は RAM を除くマシンのほとんど全てのパーツの電源を切ります。RAM への電源はマシンの状態を保存するために必要です。電力を多く節約できるので、ラップトップでは、バッテリーでコンピュータが稼働していてフタが閉じられた時 (もしくはユーザーが長い間操作しなかった時) は自動的にこのモードに移行するのが得策でしょう。

* '''Suspend to disk''' はマシンの状態を[[スワップ|スワップ領域]]に保存してマシンの電源を完全にオフにします。マシンに電源を入れた時、状態が復元されます。それまでは、電力消費量はゼロです。

* '''Suspend to both''' はマシンの状態をスワップ領域に保存しますが、マシンの電源を切りません。代わりに、通常の suspend to RAM を呼び出します。これによって、バッテリーを使いきっても、システムを RAM から復帰することが可能です。バッテリーが枯渇した時は、システムはディスクから復帰し、RAM からの復帰に比べて時間がかかりますが、システムの状態が失われることはありません。

基本的な機能を提供する低レベルなインターフェイス (バックエンド) が複数存在し、問題のあるハードウェアドライバ・カーネルモジュール (例: ビデオカードの再初期化) を扱う機能を提供する高レベルなインターフェイスもいくつかあります。

== 低レベルインターフェイス ==

これらのインターフェイスは直接使うこともできますが、通常は[[#高レベルインターフェイス|高レベルインターフェイス]]を使ってサスペンド・ハイバネートを行うとよいでしょう。低レベルなインターフェイスを直接使うと、サスペンドの前や後に行うフック処理を全て実行する高レベルインターフェイスよりもかなり早くサスペンドが可能です。ただしフックはハードウェアクロックの設定や、ワイヤレスの復旧などを正しく処理することができます。

=== カーネル (swsusp) ===

直球の方法はカーネル内のソフトウェアサスペンドコード (swsusp) にサスペンド状態に入るよう直接伝えることです。実際の方法と状態はハードウェアサポートのレベルによります。最近のカーネルでは、サスペンドにするために {{ic|/sys/power/state}} に適切な文字列を書くことが主な方法になっています。

詳しくは [https://www.kernel.org/doc/Documentation/power/states.txt カーネルドキュメント] を参照してください。

=== uswsusp ===

uswsusp ('Userspace Software Suspend') はカーネルの suspend-to-RAM のラッパーで、サスペンドの前と復帰の後にユーザー空間からグラフィックアダプタの操作を行います。

[[Uswsusp]] の記事を参照してください。

=== tuxonice ===

TuxOnIce はサスペンド・ハイバネートのカーネル実装のフォークで、デフォルトの実装を改善するカーネルパッチを提供しています。これを使うためにはカスタムカーネルが必要です。

[[TuxOnIce]] の記事を参照してください。

== 高レベルインターフェイス ==

{{Note|これらのパッケージではサスペンド・ハイバネートを行うためのバイナリ・スクリプトを提供します。実際に電源ボタンやメニュークリック、ラップトップのカバーのイベントなどと結びつけるのは他のツールで行うのが通常です。（ラップトップのカバーが閉じられたり、バッテリーが枯渇するなど）特定の電源イベントで自動的にサスペンド・ハイバネートをするには、[[Acpid]] の実行について調べて下さい。}}

=== systemd ===

[[systemd]] はサスペンド・ハイバネート・ハイブリッドサスペンドを行うためのネイティブのコマンドを提供しています。詳しくは [[電源管理#systemd による電源管理]] を見て下さい。これは Arch Linux で使われているデフォルトのインターフェースです。

サスペンド・ハイバネートのフックの設定に関する情報は[[電源管理#スリープフック]]に載っています。{{ic|man systemctl}}, {{ic|man systemd-sleep}}, {{ic|man systemd.special}} もあわせて参照してください。

=== pm-utils ===

pm-utils はバックエンドのサスペンド・ハイバネート機能をカプセル化するシェルスクリプトのセットです。サスペンドの前後に行う設定やプロセスをカスタマイズするための様々なフックも入っています。

[[pm-utils]] の記事を参照してください。

== ハイバネーション ==

ハイバネーションを使うには、[[スワップ]]パーティションかファイルを作成する必要があります。{{ic|1=resume=}} カーネルパラメータを使ってスワップを指定する必要になります。これはブートローダを通して設定されます。[[#initramfs の設定|initramfs]] も必要になります。これによりカーネルは初期ユーザー空間の指定したスワップからの復帰を試みます。これら3つのステップは以下で詳細に述べます。

=== スワップパーティション（ファイル）のサイズについて ===

スワップパーティションが RAM より小さかったとしても、ハイバネートが成功する可能性は高いと思われます。[https://www.kernel.org/doc/Documentation/power/interface.txt カーネルドキュメント] によると:

: ''{{ic|/sys/power/image_size}} は suspend-to-disk によって作成されるイメージのサイズを制御します。イメージサイズの上限として使われる負ではない整数 (バイト) を示す文字列で書くことが出来ます。suspend-to-disk はイメージサイズがその数字を超えないように出来る限りのことをします。ただし、それが無理だということがわかったら、とにかく出来る限り小さいイメージを使ってサスペンドを試みます。特に、このファイルに "0" と書かれていた場合、サスペンドのイメージは目一杯小さくなります。このファイルを読むと現在のイメージのサイズ制限が表示され、デフォルトでは利用可能な RAM の2/5に設定されています。''

(スワップパーティションを小さくして) {{ic|/sys/power/image_size}} の値を減らしてサスペンドのイメージを出来る限り小さくすることも、値を増やしてハイバネーションを高速化することも可能です。

=== 必要なカーネルパラメータ ===

カーネルパラメータ {{ic|1=resume=''swap_partition''}} を使う必要があります。{{ic|''swap_partition''}} にはスワップパーティションのカーネル名か、スワップパーティションの [[UUID]] を使うことができます。例:

* {{ic|1=resume=/dev/sda1}}
* {{ic|1=resume=UUID=4209c845-f495-4c43-8a03-5363dd433153}}
* {{ic|1=resume=/dev/mapper/archVolumeGroup-archLogicVolume}} -- LVM を使う場合の例

{{ic|resume}} パラメータで使われる命名法は通常 {{ic|root}} パラメータで使われるものと同じにしてください。

設定は使用している[[ブートローダー]]によって異なります。詳しくは[[カーネルパラメータ]]を参照してください。

==== スワップファイルにハイバネーション ====

{{Warning|[[Btrfs#スワップファイル|Btrfs]] はスワップファイルをサポートしていません。この警告に従わない場合、ファイルシステムが破損するおそれがあります。ループデバイスを経由してマウントしているときに Btrfs でスワップファイルを使うと、スワップパフォーマンスが著しく低下してしまいます。}}

スワップパーティションの代わりにスワップファイルを使うには追加のカーネルパラメータ {{ic|1=resume_offset=''swap_file_offset''}} が必要です。

{{ic|''swap_file_offset''}} の値は {{ic|filefrag -v ''swap_file''}} を実行することで取得できます。テーブル形式で出力され、必要な値は {{ic|physical_offset}} カラムの一番上の段にあります。例えば:
{{hc|# filefrag -v /swapfile|<nowiki>
Filesystem type is: ef53
File size of /swapfile is 4294967296 (1048576 blocks of 4096 bytes)
ext: logical_offset: physical_offset: length: expected: flags:
0: 0.. 0: 38912.. 38912: 1:
1: 1.. 22527: 38913.. 61439: 22527: unwritten
2: 22528.. 53247: 899072.. 929791: 30720: 61440: unwritten
...
</nowiki>}}

この例では {{ic|''swap_file_offset''}} の値は 2つのピリオドが付いている最初の {{ic|38912}} です。

{{ic|''swap_file_offset''}} の値は {{ic|swap-offset ''swap_file''}} でも取得することができます。''swap-offset'' バイナリは {{AUR|uswsusp-git}} パッケージに含まれています。

{{Note|
* カーネルパラメータ {{ic|resume}} にはスワップファイル自体ではなく、スワップファイルが含まれているパーティションのデバイスを記入する必要があることに注意してください。パラメータ {{ic|resume_offset}} は resume デバイスのどこからスワップファイルがあるかを示しています。これらを有効化するために最初のハイバネーションの前に再起動が必要です。
* [[uswsusp]] を使う場合、キー {{ic|resume device}} と {{ic|resume offset}} を使って {{ic|/etc/suspend.conf}} にこれら2つのパラメータを記述してください。この場合再起動は必要ありません。
}}

{{Tip|RAM 利用の拡大ではなく単にハイバネートを可能にしたい場合は、スワップファイルの [[スワップ#Swappiness]] を減らすこともできます。}}

=== initramfs の設定 ===

* [[initramfs]] で {{ic|base}} フックを使っている場合 (Arch ではデフォルトで使っています)、{{ic|/etc/mkinitcpio.conf}} に {{ic|resume}} フックを追加する必要があります。ラベルか UUID に関わらずスワップパーティションは udev デバイスノードとともに参照されるので、{{ic|resume}} フックは必ず {{ic|udev}} の後に続けて下さい。次の例はデフォルトのフック設定から始まっています:

:{{bc|1=HOOKS="base udev '''resume''' autodetect modconf block filesystems keyboard fsck"}}

:これらの変更を有効化するために [[mkinitcpio#イメージ作成とアクティベーション|initramfs の再生成]]を忘れずに行ってください。

:{{Note|[LVM] を使っているユーザーは {{ic|resume}} を {{ic|lvm2}} の次に追加してください。}}

* {{ic|systemd}} のフックで initramfs を使う場合は既に復帰機構が提供されているので、さらにフックを追加する必要はありません。

== トラブルシューティング ==

=== ACPI_OS_NAME ===

'''DSDT table''' を動作するように設定することができます。[[DSDT]] の記事を参照してください。

=== VAIO ユーザー ===

{{ic|1=acpi_sleep=nonvs}} カーネルフラグをブートローダに追加してください、これで OK です!

=== Suspend/hibernate doesn't work, or not consistently ===

There have been many reports about the screen going black without easily viewable errors or the ability to do anything when going into and coming back from suspend and/or hibernate. These problems have been seen on both laptops and desktops. This is not an official solution, but switching to an older kernel, especially the LTS-kernel, will probably fix this.

Sometimes the screen goes black due to device initialization from within the initramfs. Removing any modules you might have in [[en2:Mkinitcpio#MODULES|Mkinitcpio#MODULES]] and rebuilding the initramfs, can possibly solve this issue, specially graphics drivers for [[en2:Kernel_mode_setting#Early_KMS_start|early KMS]]. Initializing such devices before resuming can cause inconsistencies that prevents the system resuming from hibernation. This does not affect resuming from RAM. Also, check this [https://01.org/blogs/rzhang/2015/best-practice-debug-linux-suspend/hibernate-issues article] for the best practices to debug suspend/hibernate issues.

=== Wake-on-LAN ===

[[Wake-on-LAN]] が有効になっている場合、コンピュータがハイバネート状態になっていてもネットワークインターフェイスカードによって電力が消費されます。

=== Instantaneous wakeups from suspend ===

For some Intel Haswell systems with the LynxPoint and LynxPoint-LP chipset, instantaneous wakeups after suspend are reported. They are linked to erroneous BIOS ACPI implementations and how the {{ic|xhci_hcd}} module interprets it during boot. As a work-around reported affected systems are added to a blacklist (named {{ic|XHCI_SPURIOUS_WAKEUP}}) by the kernel case-by-case.[https://bugzilla.kernel.org/show_bug.cgi?id=66171#c6]

Instantaneous resume may happen, for example, if a USB device is plugged during suspend and ACPI wakeup triggers are enabled. A viable work-around for such a system, if it is not on the blacklist yet, is to disable the wakeup triggers. An example to disable wakeup through USB is described as follows.[https://bbs.archlinux.org/viewtopic.php?pid=1575617]

To view the current configuration:

{{hc|$ cat /proc/acpi/wakeup|
Device S-state Status Sysfs node
...
EHC1 S3 *enabled pci:0000:00:1d.0
EHC2 S3 *enabled pci:0000:00:1a.0
XHC S3 *enabled pci:0000:00:14.0
...
}}

The relevant devices are {{ic|EHC1}}, {{ic|EHC1}} and {{ic|XHC}} (for USB 3.0). To toggle their state you have to echo the device name to the file as root.

# echo EHC1 > /proc/acpi/wakeup
# echo EHC2 > /proc/acpi/wakeup
# echo XHC > /proc/acpi/wakeup

This should result in suspension working again. However, this settings are only temporary and would have to be set at every reboot. To automate this take a look at [[en2:systemd#Writing unit files|systemd#Writing unit files]]. See [https://bbs.archlinux.org/viewtopic.php?pid=1575617#p1575617 BBS thread] for a possible solution and more information.

ネットワーク設定

2016-10-23T18:20:38Z

168: 同期

[[Category:ネットワーク]]
[[cs:Network configuration]]
[[el:Network configuration]]
[[en:Network configuration]]
[[es:Network configuration]]
[[fr:Connexions reseau]]
[[it:Network configuration]]
[[nl:Network configuration]]
[[pt:Network configuration]]
[[ro:Configurare retea]]
[[ru:Network configuration]]
[[sk:Network configuration]]
[[tr:Ağ Yapılandırması]]
[[zh-cn:Network configuration]]
[[zh-tw:Network configuration]]
{{Related articles start}}
{{Related|ジャンボフレーム}}
{{Related|ファイアウォール}}
{{Related|ワイヤレス設定}}
{{Related|ネットワークブリッジ}}
{{Related|アプリケーション一覧#ネットワーク管理}}
{{Related articles end}}

このページではネットワークの'''有線'''接続を設定する方法を説明しています。'''無線'''ネットワークを設定する必要がある場合は[[ワイヤレス設定]]のページを見てください。

== 接続の確認 ==

多くの場合、インストールするだけで動作するネットワーク設定がすでに作られています。それを確認するには、{{man|8|ping}} を使います:

{{hc|$ ping www.google.com|2=
PING www.l.google.com (74.125.132.105) 56(84) bytes of data.
64 bytes from wb-in-f105.1e100.net (74.125.132.105): icmp_req=1 ttl=50 time=17.0 ms
...
}}

ping が成功したことが確認できたら (上記の 64 bytes メッセージでわかります)、ネットワークは設定されています。{{ic|Control-C}} を押して ping を停止してください。

''Unknown hosts'' エラーで ping が失敗する場合、そのメッセージはあなたのマシンではドメインの解決ができなかったことを意味しています。おそらくあなたのサービスプロバイダやルーター・ゲートウェイに関連しています。マシンがインターネットにアクセスできることを証明するために固定 IP アドレスに ping して見てください:

{{hc|$ ping 8.8.8.8|<nowiki>
PING 8.8.8.8 (8.8.8.8) 56(84) bytes of data.
64 bytes from 8.8.8.8: icmp_req=1 ttl=53 time=52.9 ms
...
</nowiki>}}

{{ic|8.8.8.8}} に ping することができても {{ic|www.google.com}} に ping できない場合は、DNS の設定を確認してください。詳しくは [[resolv.conf]] を見てください。また、{{ic|/etc/nsswitch.conf}} の {{ic|hosts}} 行も確認してください。

上記どちらの ping も失敗する場合、まずケーブルに問題がないか確認してから更に詳しい診断を行なってください。

{{Note|
* ''ping'' を実行した時に {{ic|ping: icmp open socket: Operation not permitted}} のようなエラーが表示される場合、{{Pkg|iputils}} パッケージを再インストールしてみてください。
* {{ic|-c ''num''}} オプションを使うことで ping する回数を {{ic|''num''}} で指定できます。オプションを指定しなかった場合、永遠に ping し続けるため手動で終了する必要があります。詳しくは {{ic|man ping}} を参照。
* {{ic|8.8.8.8}} は覚えやすい固定アドレスです。このアドレスは Google のプライマリ DNS サーバーのアドレスで、信頼でき、コンテンツフィルタリングやプロクシによってブロックされることは通常ありえません。
}}

== ホストネームの設定 ==

[[Wikipedia:ja:ホスト名|hostname]] とは、ネットワーク上でマシンを識別するために作られる唯一の（ユニークな）名前であり、{{ic|/etc/hostname}} に設定します (詳しくは {{man|5|hostname}} と {{man|7|hostname}} を参照)。このファイルにはシステムのドメイン名を含めることもできます。ホストネームを設定するには {{ic|/etc/hostname}} を[[ヘルプ:読み方#追加, 作成, 編集そして source|編集]]し、{{ic|''myhostname''}} の1行を入れてください:

{{hc|/etc/hostname|
''myhostname''
}}

{{Tip|hostname の名称の付け方のアドバイスについては、[https://tools.ietf.org/html/rfc1178 RFC 1178] を見てください。}}

上記の方法の代わりに、{{man|1|hostnamectl}} を使うことができます:

# hostnamectl set-hostname ''myhostname''

hostname を一時的に (再起動するまで) 設定するには、{{Pkg|inetutils}} の {{man|1|hostname}} を使います:

# hostname ''myhostname''

"pretty" hostname とその他にマシンのメタデータを設定するには、{{man|5|machine-info|https://www.freedesktop.org/software/systemd/man/machine-info.html}} を参照してください。

== ローカルネットワークのホストネーム解決 ==

[[#ホストネームの設定]]が必須です。設定後は、ホストネーム解決がローカルシステムそれ自体により機能します:

{{hc|$ ping ''myhostname''|2=
PING myhostname (192.168.1.2) 56(84) bytes of data.
64 bytes from myhostname (192.168.1.2): icmp_seq=1 ttl=64 time=0.043 ms}}

他のマシンにも名前によってホストを割り当てるには、次のどちらかの操作が必要です:

* {{man|5|hosts}} ファイルを編集する、または
* ホストネームを解決するサービスを有効化する。

{{Note|1={{Pkg|systemd}} は {{ic|myhostname}} nss モジュールによるホストネーム解決を提供しています ({{ic|/etc/nsswitch.conf}} でデフォルトで有効になっています)。そのため基本的に {{ic|/etc/hosts}} のホストネームを変更する必要はありません。しかしながら、クライアントが現在でも {{ic|/etc/hosts}}に依存していることがあります。その例は [https://lists.debian.org/debian-devel/2013/07/msg00809.html] [https://bugzilla.mozilla.org/show_bug.cgi?id=87717#c55] を見てください。}}

hosts ファイルを設定するには、次の行を {{ic|/etc/hosts}} に追記します:

127.0.1.1 ''myhostname''.localdomain ''myhostname''

上記の操作により、システムは次の両方のエントリを決定します:

$ getent hosts
127.0.0.1 localhost
127.0.1.1 myhostname.localdomain myhostname

永続的な IP アドレスをもつシステムでは、その {{ic|127.0.1.1}} ではなくその永続アドレスを使ってください。

{{Note|1=もう一つの選択肢として、[[BIND]] や [[Unbound]] のような完全な DNS サーバーをセットアップすることが挙げられますが、ほとんどのシステムにとってこれはやりすぎであり、複雑すぎます。小さなネットワークと、ホストのネットワーク参加と離脱を伴う動的な柔軟性を求める環境には、[[Wikipedia::ja:Zeroconf|zero-configuration networking]] のサービスがより適切であるといえるでしょう:
*[[Samba]] は Microsoft の '''NetBIOS''' によるホストネーム解決を提供しています。これに必要なのは {{Pkg|samba}} のインストールと {{ic|nmbd.service}} サービスの有効化です。Windows、macOS または {{ic|nmbd}} が動作している Linux が動作してるコンピュータがマシンを見つけられるようになります。
*[[Avahi]] は '''zeroconf''' によるホストネーム解決を提供しており、Avahi または Bonjour として知られています。これは Samba よりも少しだけ複雑な設定が必要です (詳しくは [[Avahi#ホスト名の解決]] を参照)。macOS または Avahi デーモンが動作している Linux が動作しているコンピュータがマシンを見つけられるようになります。Windows には組み込みの Avahi クライアントやデーモンがありません。
}}

== デバイスドライバ ==

=== ドライバの状態の確認 ===

[[udev]] があなたのネットワークインタフェースカード ([[Wikipedia:ja:ネットワークカード|NIC]] を参照) を検知し、必要なモジュールを起動時に自動でロードします。{{ic|lspci -v}} のアウトプットから "Ethernet controller" エントリ（かそれに類似したもの）をチェックしてください。どのカーネルモジュールがネットワークデバイスのためのドライバを含んでいるかわかります。例:

{{hc|$ lspci -v|
02:00.0 Ethernet controller: Attansic Technology Corp. L1 Gigabit Ethernet Adapter (rev b0)
...
Kernel driver in use: atl1
Kernel modules: atl1}}

次に、{{ic|dmesg <nowiki>|</nowiki> grep ''module_name''}} でドライバがロードされたかチェックします。例:

$ dmesg | grep atl1
...
atl1 0000:02:00.0: eth0 link is up 100 Mbps full duplex

ドライバがきちんとロードされている場合は次のセクションはスキップしてください。そうでないならば、あなたの使っているモデルのために必要なモジュールを知る必要があります。

=== デバイスモジュールのロード ===

チップセットに必要なモジュール・ドライバをインターネットで検索してください。Realtek のチップセットを使っているカードには {{ic|8139too}} が、SiS のチップセットを使っているカードには {{ic|sis900}} が一般的に使われるモジュールです。どのモジュールを使うべきかがわかったら、[[カーネルモジュール#手動でモジュールを扱う|手動でモジュールをロード]]してみてください。モジュールが見つからないというエラーが表示される場合、Arch カーネルにドライバーが含まれていないのかもしれません。モジュールの名前で [[Arch User Repository|AUR]] を検索できます。

起動時に udev が自動で正しいモジュールを検知・ロードしない場合、[[カーネルモジュール#ロード]]を見てください。

== ネットワークインターフェース ==

=== デバイス名 ===

NIC が統合されたマザーボードでは、デバイス名を固定することが重要です。設定の問題の多くはインターフェイスの名前が変わってしまうことが原因です。

どのデバイスがどの名前になるかは [[udev]] によって決まります。Systemd v197 から [http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames Predictable Network Interface Names] が導入され、ネットワークデバイスに固定された名前を自動的に割り当てるようになりました。現在、インターフェースの名前は {{ic|enp0s25}} のように、先頭に {{ic|en}} (イーサネット) {{ic|wl}} (WLAN) {{ic|ww}} (WWAN) が付き、後ろに自動生成された識別子が付くようになっています。この名前の付け方を止めさせるにはカーネルコマンドラインに {{ic|1=net.ifnames=0}} を追加してください。

{{Note|インターフェイスの命名方法を変更する時は、ネットワークに関する全ての設定ファイルや、systemd のカスタムユニットファイルなども変更することを忘れないでください。特に、[[netctl#基本的な方法|netctl の固定プロファイル]]を有効にしている場合は、{{ic|netctl reenable ''profile''}} を実行してサービスファイルを更新してください。}}

==== 現在のデバイス名を取得 ====

現在の NIC の名前は {{ic|sysfs}} や {{ic|ip link}} で確認できます。例:

{{hc|$ ls /sys/class/net|
lo enp0s3
}}

{{hc|$ ip link|
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
2: enp0s3: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP mode DEFAULT group default qlen 1000
link/ether 08:00:27:23:6f:3a brd ff:ff:ff:ff:ff:ff
}}

無線デバイスの名前は {{ic|iw dev}} で取得できます。詳しくは[[ワイヤレス設定#情報を取得する]]を参照。

==== デバイス名の変更 ====

udev ルールを作ることで名前を手動で定義してデバイス名を変更することができます。例:

{{hc|/etc/udev/rules.d/10-network.rules|2=
SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="aa:bb:cc:dd:ee:ff", NAME="net1"
SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="ff:ee:dd:cc:bb:aa", NAME="net0"}}

上記のルールは起動時に自動的に適用されます。

注意事項:

* カードの MAC アドレスを取得するには、次のコマンドを使ってください: {{ic|cat /sys/class/net/''device-name''/address}}
* udev ルールでは小文字の16進数を使うようにしてください。大文字は使ってはいけません。

ネットワークカードに MAC が動的に割り当てられている場合は、{{ic|DEVPATH}} を使うことができます。例:

{{hc|/etc/udev/rules.d/10-network.rules|<nowiki>
SUBSYSTEM=="net", DEVPATH=="/devices/platform/wemac.*", NAME="int"
SUBSYSTEM=="net", DEVPATH=="/devices/pci*/*1c.0/*/net/*", NAME="en"
</nowiki>}}

ルールは起動時に複数回実行されることがあるので、デバイスのパスは新しいデバイス名と古いデバイス名両方にマッチする必要があります。例えば、2番目のルールで、{{ic|"/devices/pci*/*1c.0/*/net/enp*"}} と設定すると困ったことになります。名前が {{ic|en}} に変更されるとマッチしなくなるからです。システムのデフォルトルールだけが再度適用され、名前が {{ic|enp1s0}} などに戻ります。

ルールを[[Udev#ロードする前にルールをテストする|テスト]]したい場合、ユーザー空間から直接テストすることができます (例: {{ic|udevadm --debug test /sys/''DEVPATH''}})。名前を変更する前にインターフェイスは落としておいてください (例: {{ic|ip link set down enp1s0}})。

{{Note|固定の名前を付けるときに "eth''X''" や "wlan''X''" というような名前を使ってはいけません、起動時にカーネルと udev で競合状態が発生する可能性があります。代わりに、カーネルではデフォルトで使われないインターフェイス名を使うと良いでしょう、例: {{ic|net0}}, {{ic|net1}}, {{ic|wifi0}}, {{ic|wifi1}}。詳細は [http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames systemd] のドキュメントを参照してください。}}

==== 伝統的なデバイス名に戻す ====

eth0 などの伝統的なインターフェイス名に戻したい場合、次のコマンドで [http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames Predictable Network Interface Names] を無効にできます:

# ln -s /dev/null /etc/udev/rules.d/80-net-setup-link.rules

=== MTU とキューの長さの設定 ===
udev ルールを使って手動で定義することでデバイスの MTU とキューの長さを変更することができます。例:

{{hc|/etc/udev/rules.d/10-network.rules|2=
ACTION=="add", SUBSYSTEM=="net", KERNEL=="wl*", ATTR{mtu}="1480", ATTR{tx_queue_len}="2000"}}

=== ネットワークインターフェースの有効化・無効化 ===

ネットワークインターフェースを有効化・無効化するには以下のコマンドを使います:

# ip link set eth0 up
# ip link set eth0 down

結果を確認するには:

{{hc|$ ip link show dev eth0|
2: eth0: <BROADCAST,MULTICAST,PROMISC,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast master br0 state UP mode DEFAULT qlen 1000
...
}}

{{Note|デフォルトルートが {{ic|eth0}} インターフェイスを使っている場合、インターフェイスを落とすとルートも削除されます。インターフェイスを再度立ち上げてもデフォルトルートは自動的には再確立されません。再確立する方法は [[#手動で割り当てる]] を参照。}}

== IP アドレスの設定 ==

{{Warning|一つの方法のみを使ってネットワークを管理してください。複数の方法を使うと競合する恐れがあります。}}

2つ選択肢があります: [[Wikipedia:ja:Dynamic Host Configuration Protocol|DHCP]] を使った動的に割り当てられるアドレスか、不変の"固定"アドレスです。[[アプリケーション一覧#ネットワーク管理]]も参照してください。

=== 動的 IP アドレス ===

==== systemd-networkd ====

systemd による [[systemd-networkd]] を使って DHCP を簡単に設定することができます。[[systemd-networkd#基本的な DHCP ネットワーク]] を見てください。

==== dhcpcd ====

[[dhcpcd]] は Arch Linux の ISO で DHCP を設定するのに使われているデフォルトのクライアントです。これは様々な DHCP クライアントオプションの設定が可能な強力なツールです。インターフェース用に起動する方法は [[dhcpcd#実行]] を参照してください。

==== dhclient ====

{{Pkg|dhclient}} は Internet Systems Consortium の DHCP クライアントです。{{ic|dhclient@''interface''.service}} を[[有効化]]してください。{{ic|''interface''}} は有線の[[#デバイス名]]です。詳しくは {{man|8|dhclient|url=}} と {{man|5|dhclient.conf|url=}} を見てください。

==== netctl ====

[[netctl]] は、ユーザーが作成したプロファイルを通してネットワークの接続を設定・管理する CLI ベースのツールです。[[netctl#サンプルプロファイル]] で示されている例のようにプロファイルを作成し、[[netctl#基本的な方法]]で述べられているようにして有効化してください。

=== 固定 IP アドレス ===

Arch Linux に存在するネットワークツールのほとんどで固定アドレスを設定することができます。どのツールを選ぶかに関わらず、おそらく以下の情報が準備に必要になるでしょう:

* 固定 IP アドレス
* サブネットマスク、または場合によっては [[Wikipedia:Classless Inter-Domain Routing#CIDR notation|CIDR の表記]]。例えば {{ic|/24}} は {{ic|255.255.255.0}} の CIDR 表記です。
* [[Wikipedia:Broadcast_address|ブロードキャストアドレス]]
* [[Wikipedia:Default_gateway|ゲートウェイ]]の IP アドレス
* ネームサーバ (DNS) の IP アドレス。[[resolv.conf]] を参照。

プライベートネットワークを使っている場合、IP アドレスには {{ic|192.168.*.*}} を、サブネットマスクには {{ic|255.255.255.0}} を、ブロードキャストアドレスには {{ic|192.168.*.255}} を使う方が安全です。ゲートウェイは通例 {{ic|192.168.*.1}} か {{ic|192.168.*.254}} です。

{{Warning|
* 手動で割り当てた IP アドレスと DHCP によるアドレスが衝突しないように注意してください。[http://www.raspberrypi.org/forums/viewtopic.php?f=28&t=16797 このフォーラムスレッド] を参照。
* ルーターを使わずに Windows マシンとインターネット接続を共有する場合、LAN の問題を避けるために両方のコンピュータで固定 IP アドレスを使うようにしてください。
}}

{{Tip|アドレスは {{Pkg|ipcalc}} を用いて計算することができます。[[#アドレス計算]]を参照。}}

==== netctl ====

固定 IP の {{Pkg|netctl}} プロファイルを作成するには、{{ic|1=IP=static}} オプションを設定し、{{ic|Address}}、{{ic|Gateway}}、{{ic|DNS}} も同様に設定してください。 [[netctl#有線]]を見てください。

==== systemd-networkd ====

systemd により提供される [[systemd-networkd]] サービスは、シンプルな設定ファイルを使って固定 IP をセットアップすることができます。 [[systemd-networkd#有線アダプタで固定 IP を使用]]を見てください。

==== dhcpcd ====

[[en2:dhcpcd#Static profile|dhcpcd#Static profile]] を見てください。

==== 手動で割り当てる ====

{{Pkg|iproute2}} のみを使って固定 IP を手動でセットアップすることができます。この方法では再起動すると設定が消えるので、接続設定のテストするためのよい方法になります。まず[[#ネットワークインターフェース|ネットワークインターフェース]]を有効化します:

# ip link set ''interface'' up

コンソールから固定 IP アドレスを割り当てます:

# ip addr add ''IP_address''/''subnet_mask'' broadcast ''broadcast_address'' dev ''interface''

そしてゲートウェイ IP アドレスを追加します:

# ip addr add 192.168.1.2/24 broadcast 192.168.1.255 dev ''interface''

例:

# ip link set eth0 up
# ip addr add 192.168.1.2/24 broadcast 192.168.1.255 dev eth0
# ip route add default via 192.168.1.1

{{Note|{{ic|RTNETLINK answers: Network is unreachable}} というメッセージが表示された場合、ルート生成を次の2つのに分けてみてください:

# ip route add 192.168.1.1 dev eth0
# ip route add default via 192.168.1.1 dev eth0
}}

上記の手順を取り消すには (例えば動的 IP に切り替える前に)、まず割り当てた IP アドレスをすべて削除します:

# ip addr flush dev ''interface''

その次に割り当てたゲートウェイをすべて削除します:

# ip route flush dev ''interface''

そして最後にインターフェースを無効化します:

# ip link set ''interface'' down

オプションについての詳細は {{ic|ip(8)}} の man ページを見てください。これらのコマンドはスクリプトと [[systemd#カスタム .service ファイルを書く|systemd ユニット]]使って自動化できます

==== アドレス計算 ====

{{Pkg|ipcalc}} パッケージによって提供される {{ic|ipcalc}} を使うことで、より高度な設定のために、IP ブロードキャスト、ネットワーク、ネットマスク、ホストの範囲を計算することができます。例えば、firewire ごしのイーサネットを使って Windows マシンと Arch を接続している場合、セキュリティやネットワークの管理のために、ネットマスクとブロードキャストが設定されたネットワークに置くことでその２つのマシンだけがネットワークが使えるようになります。

このためにネットマスクとブロードキャストアドレスを計算するには、{{ic|ipcalc}} を使って、arch の firewire nic の IP {{ic|10.66.66.1}} で計算して、ホストが2つだけのネットワークを作成させます。

{{hc|$ ipcalc -nb 10.66.66.1 -s 1|<nowiki>
Address: 10.66.66.1

Netmask: 255.255.255.252 = 30
Network: 10.66.66.0/30
HostMin: 10.66.66.1
HostMax: 10.66.66.2
Broadcast: 10.66.66.3
Hosts/Net: 2 Class A, Private Internet
</nowiki>}}

== Tips and tricks ==

=== ラップトップのための ifplugd ===

{{Tip|[[dhcpcd]] は同じ機能を設定不要で提供します。}}

[[公式リポジトリ]]にある {{Pkg|ifplugd}} は、ケーブルが接続された時にイーサネットデバイスを自動で設定し、ケーブルが抜かれた時に自動で設定を解除するデーモンを提供します。これはオンボードのネットワークアダプタを持っているラップトップで役に立ちます。なぜならケーブルが実際に接続されているときだけインターフェースを設定するからです。他にも、ネットワークをリスタートしたいがコンピュータの再起動をしたりシェルを使いたくないときに役に立ちます。

デフォルトでは ifplugd は {{ic|eth0}} デバイスで動作するように設定されています。デバイスや遅延時間などは {{ic|/etc/ifplugd/ifplugd.conf}} で設定することができます。

{{Note|[[netctl]] パッケージに {{ic|netctl-ifplugd@.service}} が含まれています、もしくは {{Pkg|ifplugd}} パッケージの {{ic|ifplugd@.service}} を使うことができます。使用例: {{ic|# systemctl enable ifplugd@eth0.service}}。}}

=== ボンディングと LAG ===

[[netctl#ボンディング]] を見てください。

=== IP アドレスエイリアス ===

ひとつのネットワークインターフェースに複数の IP アドレスを加えることを IP エイリアスと呼びます。これをすることで、ネットワークのひとつのノードでネットワークに複数接続することができ、それぞれを別々に使うことができます。基本的に Web・FTP サーバーの仮想ホスティングや、サーバーの再構成 (他のマシンを更新しない、ネームサーバで有用) に使われます。

==== 例 ====

{{Pkg|iproute2}} ツールを使って NIC のエイリアスを手動で設定するには次を実行:

$ ip addr add 192.168.1.10/24 dev enp1s0 label enp1s0:1

設定したエイリアスを削除するには:

$ ip addr del 192.168.1.10/24 dev enp1s0:1

サブネットへ向かうパケットはデフォルトでプライマリエイリアスを使います。送信先 IP がセカンダリエイリアスのサブネット内のものである場合は、送信元 IP がそれぞれに設定されます。複数の NIC が存在する場合を考えた場合、{{ic|ip route}} でデフォルトルートを列挙することができます。

=== MAC/ハードウェアアドレスを変更する ===

[[MAC アドレス偽装]]を見てください。

=== インターネット共有 ===

[[インターネット共有]]を見てください。

=== ルーター設定 ===

[[ルーター]]を見てください。

=== プロミスキャスモード ===

[[wikipedia:ja:プロミスキャス・モード|プロミスキャスモード]]を有効にすると (無線) NIC は受信したトラフィックを全て OS に転送します。反対に"ノーマルモード"では受信されるべきでないとき NIC はフレームをドロップします。プロミスキャスモードは高度なネットワークのトラブルシューティングや[[wikipedia:Packet_sniffing|パケットスニッフィング]]などのために使われます。

{{hc|/etc/systemd/system/promiscuous@.service|<nowiki>
[Unit]
Description=Set %i interface in promiscuous mode
After=network.target

[Service]
Type=oneshot
ExecStart=/usr/bin/ip link set dev %i promisc on
RemainAfterExit=yes

[Install]
WantedBy=multi-user.target
</nowiki>}}

インターフェイス {{ic|eth0}} でプロミスキャスモードを有効にしたい場合、{{ic|promiscuous@eth0.service}} を有効化してください。

== トラブルシューティング ==

=== ケーブルモデムのコンピュータを交換 ===

ほとんどの国内 ISP (videotron など) はネットワークインターフェイスの MAC アドレスを使って、認識するクライアント PC を一つだけに絞るようにケーブルモデムを設定しています。ケーブルモデムが初めて PC (やケーブルモデムに接続された機器) の MAC アドレスを認識すると、それ以外の MAC アドレスには頑として返答しなくなります。その PC を別の PC (またはルーター) に交換すると、新しい PC (やルーター) ではケーブルモデムを使うことができません。新しい PC (やルーター) の MAC アドレスは昔の PC の MAC アドレスと異なるからです。新しい PC を認識させるためにケーブルモデムをリセットするには、ケーブルモデムの電源を一度切ってから再度入れる必要があります。ケーブルモデムが再起動してオンラインになったら (通知ランプがおとなしくなるのでわかります)、新しく接続した PC を再起動して DHCP のリクエストを行ったり、手動で新しい DHCP リースをリクエストしてください。

この方法が上手くいかない場合、元のマシンの MAC アドレスをクローンする必要があります。[[#MAC/ハードウェアアドレスを変更する|MAC/ハードウェアアドレスを変更する]]を参照。

=== TCP ウィンドウスケーリングの問題 ===

TCP パケットのヘッダには"ウィンドウ"値が含まれており、他のホストが返答として送信できるデータの量が示されています。この値は16ビットでしか表現できないので、ウィンドウサイズは最大 64 Kb です。TCP パケットはしばらくの間キャッシュに保存されますが (再度使われます)、メモリの量は（少なくとも昔は）限られているので、すぐに使いきってしまうことがあります。

1992年、利用できるメモリの量が大幅に増えるのにあわせて、この状態を改善するために [http://www.faqs.org/rfcs/rfc1323.html RFC 1323]: ウィンドウスケーリングが書かれました。全てのパケットに含まれている"ウィンドウ"の値を、スケールファクタ (Scale Factor) を定義することで、接続の初期段階で変更します。8ビットのスケールファクタなら、ウィンドウは 64Kb の32倍まで増やすことができます。

壊れたルーターやファイアウォールはスケールファクタを 0 に書き換えてしまうためホスト間での不和が発生します。Linux カーネル 2.6.17 ではスケールファクタを上げるための新しい算出方式が導入されましたが、それによってルーターやファイアウォールが壊れているときの影響が増え、極端に接続が遅かったり、全く接続できない状態が生まれています。

==== 問題の診断方法 ====

まず最初に問題をはっきりさせましょう: この問題は少々厄介です。ある条件下では、TCP 接続 (HTTP, FTP, ...) を全く使えないのに、他の条件では、特定の (ごく少数の) ホストとは通信できるというようなことが起こります。

この問題が発生していても、{{ic|dmesg}} の出力に問題はなく、ログに異常は見られず、そして {{ic|ip addr}} では通常状態だと報告されます。全てが問題ないように（表面上は）見えるわけです。

ウェブサイトが表示できないのに、ping は通る場合、この問題が発生している可能性は十分あるでしょう: ping は TCP の問題に影響されない ICMP を使っているためです。

[[Wireshark]] を使ってみてください。UDP と ICMP の接続は通るのに (ホストが海外の) TCP 接続は通らないはずです。

==== 修復方法 (悪い方法) ====

無理やり修正する方法として、スケールファクタの計算に使われている {{ic|tcp_rmem}} の値を変更することができます。ほとんどのホストではこれで問題ありませんが、全てのホストで上手く行くとは保証できません。特にホストが遠い場合に問題が起きやすいです。

# echo "4096 87380 174760" > /proc/sys/net/ipv4/tcp_rmem

==== 修復方法 (良い方法) ====

ウィンドウスケーリングを無効化してしまいます。ウィンドウスケーリングは TCP の素晴らしい機能なので、無効化してしまうのは忍びないですが、ルーターを修復できない場合は致し方ありません。ウィンドウスケーリングを無効化する方法は複数存在します。一番安牌の (ほとんどのカーネルで動作する) 方法としては {{ic|/etc/sysctl.d/99-disable_window_scaling.conf}} に以下の行を追加してください ([[sysctl]] を参照):

net.ipv4.tcp_window_scaling = 0

==== 修復方法 (最良の方法) ====

この問題の原因はルーターやファイアウォールの動作がおかしいせいなので、それらを変えてしまいましょう。専用の DSL ルーターを使っている場合に問題になることがあるという報告もあります。

==== 詳細 ====

このセクションは LWN の記事 [http://lwn.net/Articles/92727/ TCP window scaling and broken routers] と Kernel Trap の記事 [http://kerneltrap.org/node/6723 Window Scaling on the Internet] を基にしています。

また、LKML に関連するスレッドが複数存在します。

=== Realtek が使えない / WOL の問題 ===

Realtek 8168 8169 8101 8111(C) が搭載されている NIC (カード/オンボード) を使っている場合、起動時に NIC が無効化され、接続ランプが付かないという問題が発生することがあります。この問題は基本的に Windows をインストールしていると起こります (デュアルブート環境)。Windows における公式の Realtek ドライバー (2007年5月以降) の使用が問題の原因です。新しいドライバーでは Windows のシャットダウン時に NIC を無効化することによって Wake-On-LAN 機能を無効化しているのですが、これはつまり、Windows を起動するまでは NIC が無効のままになってしまうということです。Windows が起動するときに接続ランプが付いて、シャットダウン時に消えるようであれば、ずばりです。通常、システムの電源が入っていれば、(POST の間でも) 接続ランプは点きっぱなしになっています。この問題は新しいドライバーが入っていない他のオペレーティングシステムでも顔を出します (例: Live CD)。問題の解決方法は以下の通りです:

==== 方法 1 - Linux で NIC を直接有効にする ====

[[#ネットワークインターフェースの有効化・無効化]]に従ってインターフェイスを有効化してください。

==== 方法 2 - Windows ドライバをロールバック/変更する ====

Windows の NIC ドライバーを Microsoft が提供しているドライバーに戻したり、2007年5月以前の Realtek 公式ドライバーに戻すことができます (ハードウェアに付属している CD を使用)。

==== 方法 3 - Windows ドライバで WOL を有効にする ====

一番簡単な方法はおそらく Windows ドライバーで WOL の設定を変更することです。この方法はシステム全体で適用され、Arch 以外でも問題が解決します (例: ライブ CD や他のオペレーティングシステム)。Windows で、デバイスマネージャを開いて、Realtek ネットワークアダプタを探してダブルクリックしてください。"Advanced" タブ下、"Wake-on-LAN after shutdown" を "Enable" に変更してください。

Windows XP の場合
マイコンピュータを右クリックして"プロパティ"を選択
--> Hardware tab
--> Device Manager
--> Network Adapters
--> "double click" Realtek ...
--> Advanced tab
--> Wake-On-Lan After Shutdown
--> Enable

{{Note|新しい Realtek の Windows ドライバー (''Realtek 8111/8169 LAN Driver v5.708.1030.2008'' で確認。GIGABYTE のサイトから入手できる 2009/01/22　no
ドライバー) だとオプションが多少変わっていることがあります。例: ''Shutdown Wake-On-LAN --> Enable''。このオプションを {{ic|Disable}} にしても効果はないようです (Windows のシャットダウン時にリンクの光が消えることで確認できます)。あまり綺麗な方法ではありませんが、Windows を起動してからシステムをリセットする (無理やり再起動あるいはシャットダウンさせる) ことで Windows ドライバーに LAN を無効化する暇を与えないことで対処できます。Windows をまた起動してシャットダウンするまでは、リンクの光は消えないで POST 後も LAN アダプタにアクセスできるようになります。}}

==== 方法 4 - 新しい Realtek Linux ドライバを使う ====

Realtek のサイトに Linux 用の Realtek カードの新しいドライバーが存在します (テストしていませんがおそらく問題が解決されるはずです)。

==== 方法 5 - BIOS/CMOS で ''LAN Boot ROM'' を有効にする ====

BIOS/CMOS で ''Integrated Peripherals --> Onboard LAN Boot ROM --> Enabled'' を設定することで、Windows のドライバーが OS のシャットダウン時に無効化するのとは関係なく、システムの起動時に Realtek の LAN チップが有効化されます。

{{Note|上記の方法は GIGABYTE GA-G31M-ES2L マザーボードの BIOS バージョン F8 (2009/02/05 に公開) で何回か確認済みです。}}

=== Atheros チップセットで eth0 がない ===

Atheros のイーサネットチップセットは設定をしないと動作しないことがあります (2014年2月のインストールメディアを使う場合)。この問題を解決するには AUR から {{AUR|backports-patched}} パッケージをインストールしてください。

=== Broadcom BCM57780 ===

この Broadcom チップセットはモジュールをロードする順番を指定しないと上手く動作しないことが時々あります。モジュールは {{ic|broadcom}} と {{ic|tg3}} であり、前者を最初にロードする必要があります。

コンピューターにこのチップセットが載っている場合、以下の手順に従ってください:

* ''lspci'' の出力で NIC を確認:
$ lspci | grep Ethernet
02:00.0 Ethernet controller: Broadcom Corporation NetLink BCM57780 Gigabit Ethernet PCIe (rev 01)

* 有線ネットワークが機能しない場合、ケーブルを切断して以下を (root で) 実行:
# modprobe -r tg3
# modprobe broadcom
# modprobe tg3

* ネットワークケーブルを接続。これで問題が解決する場合 {{ic|broadcom}} と {{ic|tg3}} を (この順番で) {{ic|/etc/mkinitcpio.conf}} の {{ic|MODULES}} 行に追加することで設定を永続化できます:
MODULES=".. broadcom tg3 .."

* initramfs を再生成:
# mkinitcpio -p linux

* もしくは、{{ic|/etc/modprobe.d/broadcom.conf}} を作成:
softdep tg3 pre: broadcom

{{Note|以上の方法は、BCM57760 など、他のチップセットでも使えることがあります。}}

=== Realtek RTL8111/8168B ===

{{hc|<nowiki># lspci | grep Ethernet</nowiki>|
03:00.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL8111/8168B PCI Express Gigabit Ethernet controller (rev 02)
}}

このアダプタは {{ic|r8169}} モジュールによって認識されます。しかしながら、使われているチップによって、接続が出来たりできなかったりすることがあります。そのような場合は、[[公式リポジトリ]]にある {{Pkg|r8168}} を使うことで安定した接続をすることができます。{{ic|r8169}} を[[ブラックリスト]]に入れて、{{Pkg|r8168}} が [[udev]] によって自動でロードされない場合、[[カーネルモジュール#ロード]]を見てください。

このアダプタのいくつかのリビジョンのドライバにおけるもう1つの欠陥は IPv6 サポートが貧弱であることです。Web ページがハングしたり、回線が遅くなったりした場合は、[[IPv6#機能を無効にする]]が参考になります。

=== Gigabyte マザーボードと Realtek 8111/8168/8411 ===

Gigabyte GA-990FXA-UD3 などのマザーボードでは IOMMU をオフにして (デフォルトでオフになっていることもあります) 起動を行うと、ネットワークインターフェイスが不安定になって、接続が出来なかったり、通信速度が遅くなったりします。オンボードの NIC だけでなく、コンピュータに接続した他の PCI NIC でも起こりえます。IOMMU の設定はマザーボードに接続された全てのネットワークインターフェイスに影響を与えるからです。IOMMU を有効にしてインストールメディアで起動すると AMD I-10/xhci のページフォールトが数秒だけ表示されますが、その後通常通り起動して、オンボードの NIC が (r8169 モジュールを使用する場合でも) 完全に機能するようになるはずです。

インストール時にブートプロセスを設定する場合、起動時のエラーメッセージを排除して USB 3.0 を機能させるために[[カーネルパラメータ]]に {{ic|1=iommu=soft}} を追加してください。

== 参照 ==

* [https://www.debian.org/doc/manuals/debian-reference/ch05.ja.html Debian リファレンス: ネットワークの設定]
* [https://access.redhat.com/documentation/ja-JP/Red_Hat_Enterprise_Linux/7/html/Networking_Guide/ RHEL7: ネットワークガイド]

TFTP

2016-10-22T19:23:50Z

168: 同期

[[Category:File Transfer Protocol]]
[[en:TFTP]]
[[Wikipedia:ja:Trivial File Transfer Protocol|Trivial File Transfer Protocol]] (TFTP) はファイルを転送するための軽量なプロトコルです。一般的に [[PXE]] ブートの中で使われたり、ルーターやプリンターなどメモリが限られているデバイスの設定やファームウェアを更新するのに使われます。

== サーバー ==

TFTP のサーバー実装は複数存在します、以下はその一例です。また、 {{Pkg|iputils}} にも tftp の別実装があります。

{{Note|異なる TFTP の実装が同時に起動していないことを確認してください。デフォルトの TFTP ポート番号 {{ic|69}} をリッスンできるのは一つだけなので、{{ic|got more than one socket}} というエラーを出して起動に失敗してしまいます。}}

=== tftp-hpa ===

{{Pkg|tftp-hpa}} を[[インストール]]して {{ic|tftpd.service}} を[[起動]]してください。

サービスのパラメータを修正したいときは {{ic|/etc/conf.d/tftpd}} を編集します。

=== atftp ===

{{Pkg|atftp}} を[[インストール]]して {{ic|atftpd.service}} を[[起動]]してください。

サービスのパラメータを修正したいときは {{ic|/etc/conf.d/atftpd}} を編集します。

=== dnsmasq ===

[[en2:dnsmasq#TFTP server setup|dnsmasq#TFTP server setup]] を参照。

== クライアント ==

{{Pkg|tftp-hpa}} を[[インストール]]し、tftp で1日を過ごしましょう。

Gitweb

2016-10-22T18:46:38Z

168: 同期

[[Category:バージョン管理システム]]
[[en:Gitweb]]
Gitweb は [[git]] 自体に含まれているデフォルトのウェブインターフェイスであり [[cgit]], [[en2:gitosis|gitosis]] といった他の git スクリプトのベースにもなっています。

Gitweb は fcgi をネイティブでサポートしているため、cgi スクリプトとしてラッピングする必要はありません [http://repo.or.cz/w/alt-git.git?a=blob_plain;f=gitweb/INSTALL][https://sixohthree.com/1402/running-gitweb-in-fastcgi-mode]。

== インストール ==

Gitweb をインストールするには、まず {{Pkg|git}} とウェブサーバーをインストールしてください。ここで、テストを行いたい場合は、{{ic|git instaweb}} のヘルプを見て下さい。完全なセットアップをする場合、以下を読んで下さい。

ここでは {{Pkg|apache}} を例として用いますが {{Pkg|nginx}}, {{Pkg|lighttpd}} などを使うことも可能です。

現在の gitweb のデフォルトからウェブサーバーのディレクトリにリンクを作成する必要があります。次の例ではデフォルトのフォルダを使用します:
# ln -s /usr/share/gitweb /srv/http/gitweb

{{Note|1=サーバーのディレクトリはよく確認してシンボリックリンクを作成してください。}}

== 設定 ==

=== Apache 2.2 ===

以下を {{ic|/etc/httpd/conf/httpd.conf}} の最後に追加します:
<Directory "/srv/http/gitweb">
DirectoryIndex gitweb.cgi
Allow from all
AllowOverride all
Order allow,deny
Options ExecCGI
<Files gitweb.cgi>
SetHandler cgi-script
</Files>
SetEnv GITWEB_CONFIG /etc/gitweb/gitweb.conf
</Directory>

バーチャルホストを使っている場合、以下を {{ic|/etc/httpd/conf/extra/httpd-vhosts.conf}} に追加します:
<VirtualHost *:80>
ServerName gitserver
DocumentRoot /var/www/gitweb
<Directory /var/www/gitweb>
Options ExecCGI +FollowSymLinks +SymLinksIfOwnerMatch
AllowOverride All
order allow,deny
Allow from all
AddHandler cgi-script cgi
DirectoryIndex gitweb.cgi
</Directory>
</VirtualHost>

また、設定を {{ic|/etc/httpd/conf/extra/}} の設定ファイルに記述することもできますが、そうするかどうかはあなた次第です。

==== Apache 2.4 ====

Apache 2.4 の場合、{{Pkg|git}} と {{Pkg|apache}} に加えて {{AUR|mod_perl}} をインストールしてください。

{{ic|/etc/httpd/conf/extra/httpd-gitweb.conf}} を作成:
<IfModule mod_perl.c>
Alias /gitweb "/usr/share/gitweb"
<Directory "/usr/share/gitweb">
DirectoryIndex gitweb.cgi
Require all granted
Options ExecCGI
AddHandler perl-script .cgi
PerlResponseHandler ModPerl::Registry
PerlOptions +ParseHeaders
SetEnv GITWEB_CONFIG /etc/gitweb/gitweb.conf
</Directory>
</IfModule>

以下の行を {{ic|/etc/httpd/conf/httpd.conf}} のモジュールセクションに追記:
LoadModule perl_module modules/mod_perl.so

以下の行を {{ic|/etc/httpd/conf/httpd.conf}} の最後に追加:
# gitweb configuration
Include conf/extra/httpd-gitweb.conf

=== Lighttpd ===

以下を {{ic|/etc/lighttpd/lighttpd.conf}} に追加:
server.modules += ( "mod_alias", "mod_cgi", "mod_redirect", "mod_setenv" )
setenv.add-environment = ( "GITWEB_CONFIG" => "/etc/gitweb/gitweb.conf" )
url.redirect += ( "^/gitweb$" => "/gitweb/" )
alias.url += ( "/gitweb/" => "/usr/share/gitweb/" )
$HTTP["url"] =~ "^/gitweb/" {
cgi.assign = ( ".cgi" => "" )
server.indexfiles = ( "gitweb.cgi" )
}

また、GitWeb を正しく表示させるには {{ic|mimetype.assign}} の行に {{ic|".css" => "text/css"}} を追加する必要があります。

=== Nginx ===

Nginx に、この location を追加 (この location を変更するとよいでしょう):
{{hc|/etc/nginx/nginx.conf|
<nowiki>location /gitweb.cgi {
include fastcgi_params;
gzip off;
fastcgi_param SCRIPT_FILENAME /usr/share/gitweb/gitweb.cgi;
fastcgi_param GITWEB_CONFIG /etc/gitweb.conf;
fastcgi_pass unix:/var/run/fcgiwrap.sock;
}

location / {
root /usr/share/gitweb;
index gitweb.cgi;
}</nowiki>
}}
[[Nginx#CGI を動かす]]に従っている場合は {{ic|include fastcgi_params;}} を {{ic|include fastcgi.conf;}} に置き換えて下さい。

また、{{Pkg|fcgiwrap}} と {{Pkg|spawn-fcgi}} をインストールして fcgiwrap のサービスファイルを編集する必要があります:
{{hc|/usr/lib/systemd/system/fcgiwrap.service|
<nowiki>[Unit]
Description=Simple server for running CGI applications over FastCGI
After=syslog.target network.target

[Service]
Type=forking
Restart=on-abort
PIDFile=/var/run/fcgiwrap.pid
ExecStart=/usr/bin/spawn-fcgi -s /var/run/fcgiwrap.sock -P /var/run/fcgiwrap.pid -u http -g http -- /usr/sbin/fcgiwrap
ExecStop=/usr/bin/kill -15 $MAINPID

[Install]
WantedBy=multi-user.target</nowiki>
}}
最後に、サービスを有効化・再起動:
{{bc|systemctl enable nginx fcgiwrap
systemctl start nginx fcgiwrap}}

=== Gitweb の設定 ===

次に gitweb の設定ファイルを作成する必要があります。{{ic|/etc/gitweb/gitweb.conf}} ファイルを開いて (ファイルが存在しない場合は作成して) 以下のように記述してください:
{{hc|/etc/gitweb/gitweb.conf|<nowiki>
our $git_temp = "/tmp";

# The directories where your projects are. Must not end with a slash.
our $projectroot = "/path/to/your/repositories";

# Base URLs for links displayed in the web interface.
our @git_base_url_list = qw(git://<your_server> http://git@<your_server>);
</nowiki>}}

"blame" (ソースファイルの各行の著者を表示) を有効にするには、以下の行を追加:
$feature{'blame'}{'default'} = [1];

設定が完了したら、ウェブサーバーを再起動してください。apache の場合:
systemctl restart httpd

lighttpd の場合:
systemctl restart lighttpd

=== シンタックスハイライト ===

Gitweb でシンタックスハイライトを使うには、まず {{Pkg|highlight}} パッケージをインストールしてください。

highlight をインストールしたら、以下の行を {{ic|gitweb.conf}} に追加します:
{{bc|<nowiki>$feature{'highlight'}{'default'} = [1];</nowiki>}}

ファイルを保存すればハイライトが有効になります。

== リポジトリの追加 ==

リポジトリフォルダにリポジトリを追加するには、以下のようにリポジトリを作成:
mkdir my_repository.git
git init --bare my_repository.git/
cd my_repository.git/
touch git-daemon-export-ok
echo "Short project's description" > description

次に {{ic|config}} ファイルを開いて以下を追加:
[gitweb]
owner = Your Name

これで gitweb の "Owner" フィールドが入りますが、必須ではありません。

上記の設定では、このリポジトリをコミットのプッシュ先の"中央"リポジトリストレージとして扱っているので、オーバーヘッドを最小限に抑え、git デーモンを使えるようにするために git-daemon-export-ok と --bare を使っています。

上記の設定でリポジトリが作成できます。全て上手く設定できていれば http://localhost/gitweb で確認できます。gitweb の cgi スクリプトがリポジトリのフォルダを読み込むので、リポジトリを追加したときに apache を再起動する必要はありません。

== トラブルシューティング ==

=== An error occurred while reading CGI reply (no response received) ===

http://localhost/gitweb をブラウザで開いたときに、このエラーメッセージが表示されることがあります。コマンドラインで {{ic|gitweb.cgi}} を実行することで、完全なエラーメッセージを取得することができます ({{ic|ln -s /usr/share/gitweb /srv/http}} を実行している場合):

{{hc|$ perl /srv/http/gitweb/gitweb.cgi|
Can't locate CGI.pm in @INC (you may need to install the CGI module) (@INC contains: /usr/lib/perl5/site_perl
/usr/share/perl5/site_perl /usr/lib/perl5/vendor_perl /usr/share/perl5/vendor_perl /usr/lib/perl5/core_perl
/usr/share/perl5/core_perl .) at gitweb/gitweb.cgi line 13.
}}

この問題を解決するには、{{Pkg|perl-cgi}} をインストールしてください。バグレポートも存在します: {{Bug|45431}}。

== 参照 ==

* [http://www.howtoforge.com/how-to-install-a-public-git-repository-on-a-debian-server How To Install A Public Git Repository On A Debian Server] — このページは主に HowtoForge を基にしています。

ヘルプ:記事の書き方

2016-10-21T17:37:52Z

168: 翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求される前歴と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事に期待''できない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題について述べる文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、一方で''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならばいつでも関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義しなければなりません。

=== ハードウェアの要件 ===

ハードウェアの要件は大抵単純明快です。ダイアルアップモデム XYZ のドライバインストールについて述べていたら、モデム ZYX について話していると考える人は誰もいないでしょう。しかし、場合によっては明確なハードウェアの要件を挙げておくほうがよいことがあります。たとえば、XYZ-123 のドライバをインストールする記事を書いている場合、同じことが XYZ-456 には適用されない場合があることをユーザーに注意することができます。

記事で述べようとしているハードウェアの写真を追加するのもよい計らいといえます。

=== 読者が記事に期待''できない''こと ===

時々、記事のタイトルは誤解を招くことがあります。そのため、読者に記事の実際の主題を知らせ、可能であれば読者が探していた他記事へのリンクを提供する必要があります。

たとえば、この記事が wiki テキストを用いたページの整形の仕方に関するものだと思った読者がいるかもしれません。したがって、そのような読者にはこれが探しているページではないことを知らせ、適切なページヘのリンクを提供しました。

== フォーマット ==

記事のイントロダクションのフォーマットは、通常の [[ヘルプ:編集|ArchWiki の慣習]]に従ってください。しかし、より注意を払う必要がある細かい点がまだあります。

必要な条件を列挙する方法は2つあります。1つ目の方法では、条件とその他の導入メモを簡潔な (記事で使用する言語がここに入ります) で冗長に説明します。もう1つの方法は、よくまとまった条件のリストを提供します。

ヘルプ:記事の書き方

2016-10-21T02:57:10Z

168: /* ハードウェアの要件 */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求される前歴と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題について述べる文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、一方で''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならばいつでも関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義しなければなりません。

=== ハードウェアの要件 ===

ハードウェアの要件は大抵単純明快です。ダイアルアップモデム XYZ のドライバインストールについて述べていたら、モデム ZYX について話していると考える人は誰もいないでしょう。しかし、場合によっては明確なハードウェアの要件を挙げておくのがよいことがあります。たとえば、XYZ-123 のドライバをインストールする記事を書いている場合、同じことが XYZ-456 には適用されない場合があることをユーザーに注意することができます。

記事で述べようとしているハードウェアの写真を追加するのもよい計らいといえます。

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-21T02:33:09Z

168: /* 前歴と知識 */ 訳修正

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求される前歴と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題について述べる文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、一方で''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならばいつでも関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義しなければなりません。

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-20T20:47:40Z

168: /* システムの状態と設定 */ 訳修正

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求される前歴と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題を扱う文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならばいつでも関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義しなければなりません。

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-20T20:17:20Z

168: /* 記事のイントロダクション */ 訳語統一

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求される前歴と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題を扱う文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならば関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義する必要があります。

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-20T20:15:02Z

168: /* システムの状態と設定 */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求されるこれまでの経験と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題を扱う文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

パッケージ不足や設定が異なったシステム構成により、そのシステムで時々記事が全く役に立たなくなることがあります。したがって、可能ならば関連する (rc.config パラメータ、必要なパッケージなどのような) すべてのシステム設定を調べて定義する必要があります。

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-20T20:03:00Z

168: /* 前歴と知識 */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求されるこれまでの経験と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

前歴について述べる場合、この単語に2つの意味があることを頭に入れておく必要があります。1つ目の意味は、より一般的です。ある人のことをその人の知識・経験・評判から総合的に判断し、''初心者''や''グル''と呼ぶことがあります。もう1つの意味は、イベントや活動への参加 (そして、これらを通して得た知識) という具体的な経験を指します。実際的な理由から、後者の意味での前歴を要求するほうが望ましいです。ArchWiki のほとんどの記事には特定の主題を扱う文脈が存在します。ある文脈で、''初心者''が自分の熟練度を誇示したり、''グル''が関心がないことをあらわにするかもしれません。明確な前歴を要求すれば、読者が記事の続きについて行けるかどうかを判断できる可能性が高まります。

読者が記事を理解するために要求される知識を得る手助けになるような資料へのリンクを提供することもできます。

=== システムの状態と設定 ===

Sometimes, a missing package or a differently configured system component may render an article useless on some systems. Therefore, you need to track down and define all relevant system configuration (like, relevant rc.config parameters, required packages, etc) whenever possible.

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

Grafana

2016-10-20T19:04:56Z

168: 衍字削除

[[Category:ネットワーク監視]]
[[en:Grafana]]
{{Related articles start}}
{{Related|Zabbix}}
{{Related|Munin}}
{{Related articles end}}
Grafana はオープンソースの汎用ダッシュボード・グラフコンポーザーで、ウェブアプリケーションとして動作します。バックエンドとして graphite, influxdb, opentsdb をサポートしています。

== インストール ==

{{pkg|grafana}} パッケージを[[インストール]]してください。

インストールしたら {{ic|grafana}} サービスを[[起動]]・[[有効化]]してからローカルホストのアプリケーションにアクセスしてください。例: http://127.0.0.1:3000 。ウェブフロントエンドにアクセスするときのデフォルトのユーザー名は {{ic|admin}} でパスワードは {{ic|admin}} です。

== 使用例 ==

=== Influxdb のインストール ===

よく使われるバックエンドは {{AUR|influxdb}} です。インストールして {{ic|influxdb}} サービスを[[起動]]・[[有効化]]してください。ウェブインターフェイスは http://localhost:8083/ から利用できます。

=== データの収集 ===
Grafana と InfluxDB を組み合わせてスケーラブルなサーバーを監視する場合、[[collectd]] や statsd などのソフトウェアを選択します。大抵の観測データなら InfluxDB に収集して Grafana で表示できます。InfluxDB を複数のプログラミング言語で使用するためのモジュールやライブラリが存在し、''curl'' プログラムを使って http の post コマンドを実行することでデータを保存できます。

{{ic|example}} という名前のデータベースを作成:
$ curl -G http://localhost:8086/query --data-urlencode "q=CREATE DATABASE example"
{{ic|example}} データベースにデータを送信:
$ curl -i -XPOST 'http://localhost:8086/write?db=example' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000'

=== Grafana のダッシュボードの作成 ===
* ダッシュボードを作成する前に、データソースを追加する必要があります。左のメニューにある {{ic|Data sources}} をクリックしてから {{ic|Add new}} をクリックしてください。
* {{ic|influxdb}} などと名前を付けてタイプは {{ic|InfluxDB 0.9}} に設定してください。この例では、Http 設定の url は {{ic|http://localhost:8086}} とします。ここで設定するポートはウェブインターフェイスのポートではないので注意してください。データベースの名前は先に作成した名前に合わせてください (例: {{ic|example}})。変更していない場合、デフォルトのユーザー名とパスワードは {{ic|root}} です。
* {{ic|Test connection}} をクリックすると設定に問題ないか確認できます。{{ic|Save}} を押してください。
* 次に、フロントページに戻って、左上の {{ic|Home}} をクリックしてから {{ic|New}} をクリックしてください。
* 新しいダッシュボードを追加するために左側の小さな緑のボックスにマウスを移動してクリックして {{ic|Add panel}} から {{ic|Graph}} を選択してください。
* 新しいグラフのタイトルをクリックして {{ic|Edit}} を選択してください。
* グラフ設定の {{ic|Metrics}} では右下のデータソースで {{ic|influxdb}} を選んでください。
* 収集したデータを選択してクエリを作成してください。{{ic|FROM}} のとなりに存在する {{ic|select measurement}} をクリックします。ドロップダウンメニューにデータベースのテーブルのリストが表示されます (例: {{ic|localhost}})。何も表示されない場合、InfluxDB に接続できていないか、まだデータが何も収集されていません。
* 太字の {{ic|SELECT}} というテキストのところにある {{ic|value}} をクリックして観測データを選択してください (例: {{ic|uptime}})。
* 変更を保存するには、{{ic|Back to dashboard}} をクリックしてから、フロッピーディスクのアイコンを押してください。

== 参照 ==
* [http://grafana.org/ 公式ホームページ]

ヘルプ:記事の書き方

2016-10-20T19:02:11Z

168: /* テキスト */ 一部翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求されるこれまでの経験と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

既に記事のイントロダクションで述べるかもしれないことをいくつか挙げました。以下では、効果的で役に立つ記事のイントロダクションの作成に関わる問題を見ていきます。

=== 前歴と知識 ===

When talking about previous experience, you need to keep in mind that there are two meanings of the words. One is a more general meaning. We may call someone a ''newbie'' or a ''guru'' based on the overall knowledge/experience/reputation of that individual. The other is a concrete experience of participating in an event or activity (and the knowledge derived from that). For practical reasons, it is better to demand previous experience(s) in the latter sense. Most articles on ArchWiki talk about topics that are specific, and in some context. In a given context, a ''newbie'' may display proficiency, whereas a ''guru'' may show lack of interest. If you require specific previous experiences, readers have a better chance of judging their ability to follow the rest of the article.

You may also want to provide readers with links to resources that would help them gain knowledge required to understand the article.

=== システムの状態と設定 ===

Sometimes, a missing package or a differently configured system component may render an article useless on some systems. Therefore, you need to track down and define all relevant system configuration (like, relevant rc.config parameters, required packages, etc) whenever possible.

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:記事の書き方

2016-10-18T18:12:25Z

168: /* 記事のイントロダクション */ 修正

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある特定のやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求されるこれまでの経験と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

We have already mentioned some things you might mention in an article introduction. We will now take a look at some of the problems in formulating an effective and useful article introduction.

=== 前歴と知識 ===

When talking about previous experience, you need to keep in mind that there are two meanings of the words. One is a more general meaning. We may call someone a ''newbie'' or a ''guru'' based on the overall knowledge/experience/reputation of that individual. The other is a concrete experience of participating in an event or activity (and the knowledge derived from that). For practical reasons, it is better to demand previous experience(s) in the latter sense. Most articles on ArchWiki talk about topics that are specific, and in some context. In a given context, a ''newbie'' may display proficiency, whereas a ''guru'' may show lack of interest. If you require specific previous experiences, readers have a better chance of judging their ability to follow the rest of the article.

You may also want to provide readers with links to resources that would help them gain knowledge required to understand the article.

=== システムの状態と設定 ===

Sometimes, a missing package or a differently configured system component may render an article useless on some systems. Therefore, you need to track down and define all relevant system configuration (like, relevant rc.config parameters, required packages, etc) whenever possible.

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:スタイル

2016-10-18T17:13:34Z

168: 句読点、細かい修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は {{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは {{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きをはっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外ではデフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則として特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に ''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合はそのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法を書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認してページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは扱っている操作を完了させるには必要がないため無視しても問題ありません。
* 2つ以上のノート、警告またはヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りはテンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りはユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることでメンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときはアンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合はArch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合はその記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションはソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は自分で報告してください。そうすることでそのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれないソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は自分で報告してください。そうすることでバグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWiki はこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうがシンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが手順だけを示すより深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使いたいときはわれているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
* カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
* カテゴリは必ずカテゴリページの一番上に配置してください。
* カテゴリは、[[en2:Help:Procedures#Rename a category|リネーム]]されたときの一時的な場合を除き、リダイレクトしてはいけません。
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ)。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("集合"カテゴリ)。

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページはカテゴライズすることはできません。
* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページは、管理者の承認が得られない限り、''利用者''または''トーク''名前空間のページからしかリンクすることはできません。

== 共通ルール ==

=== 編集内容の要約 ===

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

=== HTML タグ ===
* HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。[[ヘルプ:編集]]を参照。
* {{ic|<nowiki><pre>code</pre></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{bc|code}}</nowiki>}} を使ってください。{{ic|<nowiki><tt>text</tt></nowiki>}} や {{ic|<nowiki><code>text</code></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{ic|text}}</nowiki>}} を使ってください。
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* {{ic|<nowiki> </nowiki>}} は必要なときにだけ使ってください: 新しい段落を始めたり改行するには、すぐ下に空行を挿入してください。 この規則によくある例外として、リストの項目内で改行する必要があるけれどサブ項目が使えない場合や、テンプレート内でリストを使うことができない場合などがあります。

ヘルプ:記事の書き方

2016-10-18T16:45:38Z

168: /* 記事のイントロダクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Writing article introductions]]
{{Related articles start}}
{{Related|ArchWiki:About}}
{{Related|ヘルプ:スタイル}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:記事命名ガイドライン}}
{{Related|ヘルプ:効果的な見出し}}
{{Related articles end}}

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。

== 記事のイントロダクション ==

記事のイントロダクションは (大抵は) 読者が始めに出くわすものであり、これには記事の主題を彼らに紹介する目的があります。

それぞれの記事は一連の仮定から始まっています。これらの仮定が大抵の読者に当てはまることはほとんどなく、記事のイントロダクションは著者の仮定を満たす読者をフィルタリングする目的をもっています。読者に記事の残り部分の紹介をする必要は特にありませんが、記事全体を何度読んでもはっきりしないままになるような部分を整理するのに役立つことがあります。

たとえば、ある決まったやり方によるシステムの設定についての記事を書いたとします。しかし、それは読者がクリーンで最新の Arch Linux をプライマリハードドライブにインストールしたことを想定していました。たとえば、もしカーネルがカスタマイズされていたら、その方法はどのような影響を受けるでしょうか。または、もしパッケージ X が存在していなかったら、手順3はどのように動作するでしょうか。

記事を書き始める前にその方法に必要な条件を考え、示す必要があります。これには2つの重要なメリットがあります:

#読者がその記事を読みたいかを、先に行き過ぎてしまう前に、判断できるようになります。
#主題からずれたことを多く入れすぎずに記事が書けるようになります。

2番目は読者のパフォーマンスに対して大きな影響を与え、現に記事がスリム化されます。

記事のイントロダクションに含めるべき内容はたくさんあると思われるかもしれませんが、ここではより重要なものをいくつか順不同で示します:

* 要求されるこれまでの経験と知識
* システムの状態と設定
* ハードウェアコンポーネントの所有権
* 読者がその記事で見つけ''られない''こと

== テキスト ==

We have already mentioned some things you might mention in an article introduction. We will now take a look at some of the problems in formulating an effective and useful article introduction.

=== 前歴と知識 ===

When talking about previous experience, you need to keep in mind that there are two meanings of the words. One is a more general meaning. We may call someone a ''newbie'' or a ''guru'' based on the overall knowledge/experience/reputation of that individual. The other is a concrete experience of participating in an event or activity (and the knowledge derived from that). For practical reasons, it is better to demand previous experience(s) in the latter sense. Most articles on ArchWiki talk about topics that are specific, and in some context. In a given context, a ''newbie'' may display proficiency, whereas a ''guru'' may show lack of interest. If you require specific previous experiences, readers have a better chance of judging their ability to follow the rest of the article.

You may also want to provide readers with links to resources that would help them gain knowledge required to understand the article.

=== システムの状態と設定 ===

Sometimes, a missing package or a differently configured system component may render an article useless on some systems. Therefore, you need to track down and define all relevant system configuration (like, relevant rc.config parameters, required packages, etc) whenever possible.

=== ハードウェアの要件 ===

Hardware requirements are usually fairly obvious. If you are talking about installing drivers for dial-up modem XYZ, nobody will ever think you are talking about a modem ZYX. However, in some cases it is good to mention the specific hardware requirements. For instance, if you are writing an article about installing drivers for XYZ-123, you may warn users that the same might not apply to XYZ-456.

It is also a nice touch to add the photo of the hardware your article is about to discuss.

=== 読者が記事に期待''できない''こと ===

Sometimes, the article's title may be slightly misleading. Therefore you may need to warn readers about the actual topic of the article, and possibly offer a link to other articles that readers might have been looking for.

For example, some readers might have thought this article was about how to format pages using wiki text. Therefore, those readers have been warned that this is not the page they were looking for, and the link to the right page was provided.

== フォーマット ==

The formatting of the article introduction follows the usual [[ヘルプ:編集|ArchWiki customs]]. However, there are still details that deserve closer attention.

When listing requirements, you have two approaches. One is to verbosely explain the requirements and other introductory notes in plain (your language here). The other method is to offer a well-organized list of requirements.

ヘルプ:スタイル

2016-10-15T09:30:22Z

168: /* カテゴリのページ */ 修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
* カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
* カテゴリは必ずカテゴリページの一番上に配置してください。
* カテゴリは、[[en2:Help:Procedures#Rename a category|リネーム]]されたときの一時的な場合を除き、リダイレクトしてはいけません。
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ)。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("集合"カテゴリ)。

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページはカテゴライズすることはできません。
* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページは、管理者の承認が得られない限り、''利用者''または''トーク''名前空間のページからしかリンクすることはできません。

== 共通ルール ==

=== 編集内容の要約 ===

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

=== HTML タグ ===
* HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。[[ヘルプ:編集]]を参照。
* {{ic|<nowiki><pre>code</pre></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{bc|code}}</nowiki>}} を使ってください。{{ic|<nowiki><tt>text</tt></nowiki>}} や {{ic|<nowiki><code>text</code></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{ic|text}}</nowiki>}} を使ってください。
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* {{ic|<nowiki> </nowiki>}} は必要なときにだけ使ってください: 新しい段落を始めたり改行するには、すぐ下に空行を挿入してください。 この規則によくある例外として、リストの項目内で改行する必要があるけれどサブ項目が使えない場合や、テンプレート内でリストを使うことができない場合などがあります。

ヘルプ:スタイル

2016-10-15T09:27:41Z

168: /* HTML タグ */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
* カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
* カテゴリは必ずカテゴリページの一番上に配置してください。
* カテゴリは、[[en2:Help:Procedures#Rename a category|リネーム]]されたときの一時的な場合を除き、リダイレクトしてはいけません。
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ)。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("主題"カテゴリ)。

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページはカテゴライズすることはできません。
* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページは、管理者の承認が得られない限り、''利用者''または''トーク''名前空間のページからしかリンクすることはできません。

== 共通ルール ==

=== 編集内容の要約 ===

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

=== HTML タグ ===
* HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。[[ヘルプ:編集]]を参照。
* {{ic|<nowiki><pre>code</pre></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{bc|code}}</nowiki>}} を使ってください。{{ic|<nowiki><tt>text</tt></nowiki>}} や {{ic|<nowiki><code>text</code></nowiki>}} を使いたいときは常に {{ic|<nowiki>{{ic|text}}</nowiki>}} を使ってください。
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* {{ic|<nowiki> </nowiki>}} は必要なときにだけ使ってください: 新しい段落を始めたり改行するには、すぐ下に空行を挿入してください。 この規則によくある例外として、リストの項目内で改行する必要があるけれどサブ項目が使えない場合や、テンプレート内でリストを使うことができない場合などがあります。

ArchWiki:サンドボックス

2016-10-15T09:08:51Z

168: タグのテスト

test
<pre>do not use this</pre>
{{bc|use this}}

ヘルプ:スタイル

2016-10-15T09:03:39Z

168: /* ユーザーのページ */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
* カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
* カテゴリは必ずカテゴリページの一番上に配置してください。
* カテゴリは、[[en2:Help:Procedures#Rename a category|リネーム]]されたときの一時的な場合を除き、リダイレクトしてはいけません。
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ)。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("主題"カテゴリ)。

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページはカテゴライズすることはできません。
* [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 利用者]名前空間にあるページは、管理者の承認が得られない限り、''利用者''または''トーク''名前空間のページからしかリンクすることはできません。

== 共通ルール ==

=== 編集内容の要約 ===

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

=== HTML タグ ===
* HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。[[ヘルプ:編集]]を参照。
* When tempted to use {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-15T08:22:24Z

168: /* カテゴリのページ */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
* カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
* カテゴリは必ずカテゴリページの一番上に配置してください。
* カテゴリは、[[en2:Help:Procedures#Rename a category|リネーム]]されたときの一時的な場合を除き、リダイレクトしてはいけません。
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ)。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("主題"カテゴリ)。

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-14T19:05:10Z

168: スタイル統一

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* 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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

GPhoto

2016-10-14T18:46:07Z

168: 誤字修正

[[Category:イメージング]]
[[en:Digital Cameras]]
[[es:Digital Cameras]]
[[it:Digital Cameras]]
[[ru:Digital Cameras]]
[[zh-cn:Digital Cameras]]
{{Related articles start}}
{{Related4|Jalbum}}
{{Related articles end}}
この記事ではデジタルカメラにアクセスするための {{ic|libgphoto2}} の設定について説明します。デジタルカメラによっては通常の [[USB ストレージデバイス]]としてマウントされるので libgphoto2 を使う必要がないかもしれません。

== libgphoto2 ==
[http://www.gphoto.org/proj/libgphoto2/ Libgphoto2] は Digikam や gphoto2 などの外部（フロントエンド）プログラムによってデジタルカメラにアクセスするために設計されています。現在'公式に'サポートしているカメラの一覧は[http://www.gphoto.org/proj/libgphoto2/support.php ここ]にあります（サポートされていないものにも動くものが多くあります）。

===インストール===
[[公式リポジトリ]]から {{Pkg|libgphoto2}} を[[pacman|インストール]]してください。[[GNOME Files]] の統合は {{Pkg|gvfs-gphoto2}} を、コマンドラインインターフェイスは {{Pkg|gphoto2}} をインストールしてください (任意)。{{Pkg|gvfs}} に依存している [[Nemo]], [[PCManFM]], [[Thunar]] などのパッケージは gvfs-gphoto2 を使うことができます。

===パーミッション問題===

ローカルセッションのユーザーにカメラのパーミッションを与えるのには [[アクセス制御リスト|ACL]] が使われます。これが機能しない場合は[[一般的なトラブルシューティング#セッションのパーミッション]]を見て下さい。

=== GPhoto2 の使い方 ===
GPhoto2 は libgphoto2 のコマンドラインクライアントです。GPhoto2 によってターミナルやスクリプトシェルから libgphoto2 ライブラリを利用してカメラの操作ができるようになります。これが主要なユーザーインターフェースになります。

GPhoto2 にはカメラドライバ開発者向けの便利なデバック機能もあります。

'''クイックコマンド'''
* {{ic|gphoto2 --list-ports}}
* {{ic|gphoto2 --auto-detect}}
* {{ic|gphoto2 --summary}}
* {{ic|gphoto2 --list-files}}
* {{ic|gphoto2 --get-all-files}}

高度なファイル操作をするには:
* {{ic|gphoto2 --shell}}

==== 他の libgphoto2 のフロントエンドアプリケーション ====

* {{App|darktable|RAW 画像を管理・処理できるユーティリティ。|http://darktable.org/|{{Pkg|darktable}}}}
* {{App|[[Digikam]]|[[KDE]] のデジタル写真管理アプリケーション。|https://www.digikam.org/|{{Pkg|digikam}}}}
* {{App|gphotofs|カメラをファイルシステムとしてマウントできる FUSE ({{Pkg|fuse}}) モジュール。|http://www.gphoto.org/proj/gphotofs/|{{AUR|gphotofs}}}}
* {{App|gThumb|[[GNOME]] の画像ブラウザ・ビューア。|http://wiki.gnome.org/gthumb|{{Pkg|gthumb}}}}
* {{App|GTKam|gphoto2 のグラフィカルな [[GTK+]] 2 フロントエンド。|http://www.gphoto.org/proj/gtkam/|{{AUR|gtkam}}}}
* {{App|Kamera|gphoto2 のカメラと [[KDE]] の統合。|https://github.com/KDE/kamera|{{Pkg|kamera}}}}
* {{App|Pantheon Photos|[[Pantheon]] の画像ビューア。|https://launchpad.net/pantheon-photos|{{Pkg|pantheon-photos}}}}
* {{App|Rawstudio|GTK+ で書かれたオープンソースの RAW 画像変換プログラム。gphoto2 によるテザー撮影をサポート。|https://rawstudio.org/|{{Pkg|rawstudio}}}}
* {{App|Shotwell|[[GNOME]] 用に作られたデジタル写真オーガナイザー。|http://wiki.gnome.org/Apps/Shotwell|{{Pkg|shotwell}}}}

== 参照 ==

* [http://www.gphoto.org/proj/libgphoto2/support.php gPhoto によってサポートされているカメラのリスト]
* [http://www.teaser.fr/~hfiguiere/linux/digicam.html another more detailed list]

ヘルプ:スタイル

2016-10-14T18:33:11Z

168: /* 言語使用域 */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳注: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
* (訳注: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't", "isn't", "you've" などは "do not", "is not", "you have" にしてください。
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。

== カテゴリのページ ==

* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
* 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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-14T16:53:40Z

168: /* 適切ではない記述 */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳注: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。 ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
** 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。

=== 言語使用域 ===

* 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-14T15:33:09Z

168: /* "参照" セクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳注: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。

=== 適切ではない記述 ===

* 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-14T15:13:56Z

168: /* "トラブルシューティング" セクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳注: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:56:59Z

168: /* "トラブルシューティング" セクション */ 誤字修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:50:56Z

168: /* "既知の問題" セクション */ 脱字修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自立性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知の問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:49:56Z

168: /* "トラブルシューティング" セクション */ 訳の修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自立性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:45:00Z

168: /* "既知の問題" セクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったであろう、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自立性の向上さえももたらすかもしれません。

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

* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
* タイトルは''既知問題''で統一してください。
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。

=== "参照" セクション ===

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:30:33Z

168: /* "Tips and tricks" セクション */ 訳の変更

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは ''Tips and tricks'' で統一してください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったであろう、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自立性の向上さえももたらすかもしれません。

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

* ''Known issues'' sections are used for known bugs or usage problems which do not have a solution yet (compare to [[#"トラブルシューティング" セクション]]).
* 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-13T17:28:34Z

168: /* "トラブルシューティング" セクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
* タイトルは''トラブルシューティング''で統一してださい。 Common misspellings that should be avoided are ''Trouble shooting'', ''Trouble-shooting'', and ''TroubleShooting''.
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。 バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったであろう、ソースに近い情報を見つけられるようになります。
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自立性の向上さえももたらすかもしれません。

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

* ''Known issues'' sections are used for known bugs or usage problems which do not have a solution yet (compare to [[#"トラブルシューティング" セクション]]).
* 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-12T16:52:14Z

168: リンク修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''Troubleshooting'' sections are used for frequently asked questions regarding the software or for solutions to common problems (compare to [[#"既知の問題" セクション]]).
* 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 [[#"トラブルシューティング" セクション]]).
* 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-12T16:06:25Z

168: /* ハイパーテキスト */ 英語版Wikipedia記事へのリンクを日本語版へ変更、細かい修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-12T16:00:43Z

168: /* コマンドラインのテキスト */ 翻訳、翻訳の改善

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

利用者:168

2016-10-11T15:46:32Z

168: ユーザーページ作成

以下のことをしています:
* ヘルプページの訳せるところの翻訳
* 未翻訳部分の訳せるところの翻訳
* その他細かい修正作業
* 慣れたら記事作成

ヘルプ:スタイル

2016-10-11T15:04:57Z

168: /* "Tips and tricks" セクション */ 翻訳の修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-11T14:53:41Z

168: /* "Tips and tricks" セクション */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "Tips and tricks" セクション ===

* ''Tips and tricks'' セクションでは、ソフトウェアの使用に関する高度なヒントや例を提供します。
* タイトルは標準の ''Tips and tricks'' にしてください。
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。

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

* ''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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-11T14:35:28Z

168: /* サポートするカーネルのバージョン */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

=== "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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-11T14:02:13Z

168: /* コーディングスタイル */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。

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

* Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current {{Pkg|linux-lts}} package in the ''core'' repository and the kernel on the latest [https://www.archlinux.org/download/ 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-11T05:24:40Z

168: /* ノート・警告・ヒント */ 翻訳の修正、改善

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* 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 {{ic|$()}} syntax for shell command substitution instead of the backticks/grave ({{ic|``}}) syntax.

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

* Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current {{Pkg|linux-lts}} package in the ''core'' repository and the kernel on the latest [https://www.archlinux.org/download/ 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-09T22:38:39Z

168: /*ハイパーテキスト*/ 誤訳修正

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、記事中でユーザー毎に当然のこととして期待することが異なる恐れがある箇所で情報を示すのに使います。これは、どちらかといえばとりわけ記事の本質から少々外れると考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。

=== コーディングスタイル ===

* 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 {{ic|$()}} syntax for shell command substitution instead of the backticks/grave ({{ic|``}}) syntax.

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

* Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current {{Pkg|linux-lts}} package in the ''core'' repository and the kernel on the latest [https://www.archlinux.org/download/ 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-09T18:37:12Z

168: /* ハイパーテキスト */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、記事中でユーザー毎に当然のこととして期待することが異なる恐れがある箇所で情報を示すのに使います。これは、どちらかといえばとりわけ記事の本質から少々外れると考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
* [[Wikipedia:system call|system call]] などの専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wikiの記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく記事のセクションへのものであることを明確に示せます。
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、インターウィキリンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、この種のリンクは最初にコロンが付きません。

=== コーディングスタイル ===

* 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 {{ic|$()}} syntax for shell command substitution instead of the backticks/grave ({{ic|``}}) syntax.

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

* Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current {{Pkg|linux-lts}} package in the ''core'' repository and the kernel on the latest [https://www.archlinux.org/download/ 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.

ヘルプ:スタイル

2016-10-09T16:11:32Z

168: /* シェル */ 翻訳

[[Category:ヘルプ]]
[[en:Help:Style]]
[[es:Help:Style]]
[[it:Help:Style]]
[[ru:Help:Style]]
[[zh-CN:Help:Style]]
[[zh-TW:Help:Style]]
{{Related articles start}}
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
{{Related|ヘルプ:編集}}
{{Related|ヘルプ:読み方}}
{{Related|ヘルプ:議論}}
{{Related|ヘルプ:テンプレート}}
{{Related articles end}}
以下のスタイルの取り決めは記事を引き締めて、まとめて、見た目を統一することが狙いです。ArchWiki を編集するときはできるかぎり守るようにしてください。

== 記事のページ ==

=== タイトル ===

* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "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#記事のタイトル]]に従ってください。
* 詳しくは[[ヘルプ:記事命名ガイドライン]]を見てください。

=== レイアウト ===

* 記事の構成は以下の順番とします:
# [[#マジックワード]] (任意)
# [[#カテゴリ]]
# [[#言語間リンク]]
# [[#記事の状態テンプレート]] (任意)
# [[#関連記事ボックス]] (任意)
# [[#前書きや導入]]
# 目次 (自動)
# 記事のセクション

=== マジックワード ===

* 挙動スイッチ — そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード] — はすべて記事の最上部に配置してください。 このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[Template:Lowercase title]] に適用され、これらは前者を使用します。

=== カテゴリ ===

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

=== 言語間リンク ===

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

=== 記事の状態テンプレート ===

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

=== 関連記事ボックス ===

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

=== 前書きや導入 ===

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

=== セクションの見出し ===

* 見出しは2段階目から使ってください ({{Ic|1===}})。1段目は記事のタイトルに予約されています。
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
:: 詳しくは[[メインページ|関連記事]]を参照してください。
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。

=== コードのフォーマット ===

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

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

$ sh ./hello_world.sh

Hello World

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

# Demo
echo "Hello World"}}
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
{{hc|$ sh ./hello_world.sh|Hello World}}
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
{{hc|~/hello_world.sh|<nowiki>
#!/bin/sh

# Demo
echo "Hello World"</nowiki>}}

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

* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。

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

* インラインコード ([[Template:ic]]) 使う場合、プロンプトシンボルを表示する必要はありませんが、パーミッションの注意書きはテキストの周囲に明示的に必ず追加してください。
* ブロックコード ([[Template:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は ''sudo'' が {{ic|-u}} フラグと一緒に使われるときです: in this case the prompt can match the others of the same code block, or default to {{ic|$}}.
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
** 極端に長いコードを書くのは避けてください。可能であれば、改行をうまく使ってください。
* ユーザが [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') を使うと決めてかからないでください。

=== ファイル編集の記述 ===

* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
::{{bc|clear reset}}
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集そして source]] へのリンクを追加するのも良いでしょう。

=== キーボードキー ===

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

=== パッケージ管理の記述 ===

==== 公式パッケージ ====

* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
: 代わりに、以下のような記述を使ってください:
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
: もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
:: ''MyApplication'' は {{Pkg|my-app-pkg}} パッケージで[[インストール]]できます。
: 複数のパッケージをインストールするように書きたいときは以下のようになります:
:: {{Pkg|foobar1}}, {{Pkg|foobar2}}, {{Pkg|foobar3}} パッケージを[[インストール]]してください。
: パッケージグループを参照するときは以下を使用:
:: {{Grp|foobar}} グループを[[インストール]]してください。
: 記事に合わせて言い回しを変えても構いません。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。

==== AUR パッケージ ====

* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
: 代わりに、以下のように簡潔に述べてください:
:: {{AUR|foobar}} パッケージをインストールします。
: 記事に合わせて言い回しを変えても構いません。より多くの例については[[#公式パッケージ]]を見てください。
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。

==== 非公式リポジトリ ====

* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
: パッケージが [[AUR]] からもインストールできる場合:
:: {{AUR|foobar}} パッケージをインストールしてください。このパッケージは [[非公式ユーザーリポジトリ#example|example]] リポジトリからインストールすることもできます。
: パッケージが [[AUR]] とは違う名前で存在している場合:
:: {{AUR|aurpkg}} パッケージをインストールしてください。[[非公式ユーザーリポジトリ#example|example]] リポジトリの ''builtpackage'' でもインストールできます。
: 記事に合わせて言い回しを変えても構いません。
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。

=== systemd ユニットの操作 ===

* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.service}}。
: 記事に合わせて言い回しを変えても構いません。
: [[systemd#ユニットを使う]] の記事セクションへのリンクを、直接、または {{ic|<nowiki>[[start]]</nowiki>}} や {{ic|<nowiki>[[enable]]</nowiki>}}、 {{ic|<nowiki>[[stop]]</nowiki>}} のような専用の[https://wiki.archlinuxjp.org/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。

=== ノート・警告・ヒント ===

* [[テンプレート:Note|ノート]]は、記事中でユーザー毎に当然のこととして期待することが異なる恐れがある箇所で情報を示すのに使います。これは、どちらかといえばとりわけ記事の本質から少々外れると考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
:{{Tip|
:* ヒント例 #1.
:* ヒント例 #2.}}

=== シェル ===

* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。

=== ハイパーテキスト ===

* 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 [[Wikipedia:system call|system call]], not covered by an article in the ArchWiki, link to the relevant Wikipedia page.
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki Article]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。 内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
** Do not hide the anchor symbol in same-page section links (e.g. {{ic|<nowiki>[[#Links to sections of a document|Links to sections of a document]]</nowiki>}}). 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 [[systemd|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 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} in a Hungarian article is wrong, while {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} 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 {{ic|$()}} syntax for shell command substitution instead of the backticks/grave ({{ic|``}}) syntax.

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

* Do not remove any notes or adaptations regarding kernel versions greater than or equal to the minimum version between the current {{Pkg|linux-lts}} package in the ''core'' repository and the kernel on the latest [https://www.archlinux.org/download/ 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 {{Ic|*}}, 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 [http://www.asciiflow.com/ 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 [[Wikipedia:Shortening (grammar)|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 [[en2:Help:Procedures#Rename a category|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).

== リダイレクトのページ ==

* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。

== ユーザーのページ ==

* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
* Pages in the [https://wiki.archlinux.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 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 {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。 コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
* Use {{ic|<nowiki> </nowiki>}} 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.