「ヘルプ:スタイル」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
細 (スタイル統一)
 
(5人の利用者による、間の44版が非表示)
3行目: 3行目:
 
[[es:Help:Style]]
  
[[es:Help:Style]]
 
[[it:Help:Style]]
  
[[it:Help:Style]]
  +
[[pt:Help:Style]]
 
[[ru:Help:Style]]
  
[[ru:Help:Style]]
−
[[zh-CN:Help:Style]]
 +
[[zh-hans:Help:Style]]
−
[[zh-TW:Help:Style]]
  
 
{{Related articles start}}
  
{{Related articles start}}
−
{{Related3|Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点}}
 +
{{Related|ヘルプ:スタイル/書式と記号}}
−
{{Related3|Help:Style/White space|ヘルプ:スタイル/空白}}
 +
{{Related|ヘルプ:スタイル/空白}}
 
{{Related|ヘルプ:編集}}
  
{{Related|ヘルプ:編集}}
 
{{Related|ヘルプ:読み方}}
  
{{Related|ヘルプ:読み方}}
20行目: 20行目:
 
=== タイトル ===
  
=== タイトル ===
   
−
* タイトルは[[Wikipedia:Letter case#Usage|先頭だけを大文字]]にしてください。例: "Title for new page" は正しいですが、"Title for New Page" は誤っています。正式名称や大文字の頭字語に含まれている常用語は大文字にしてください。例えば "Advanced Linux Sound Architecture" が正しく、"Advanced Linux sound architecture" は誤っています。<br>名前空間はタイトルの一部として考えません。したがって "ArchWiki:Example article" が正しく、"ArchWiki:example article" は誤っています。サブページの名前の先頭は大文字にします。したがって "My page/My subpage" が正しく、"My page/my subpage" は誤っています。
 +
* タイトルは[[Wikipedia:Sentence case|sentence case]]にしてください。例: "Title for new page" は正しいですが、"Title for New Page" は誤っています。正式名称や大文字の頭字語に含まれている常用語は大文字にしてください。例えば "Advanced Linux Sound Architecture" が正しく、"Advanced Linux sound architecture" は誤っています。<br>名前空間はタイトルの一部として考えません。したがって "ArchWiki:Example article" が正しく、"ArchWiki:example article" は誤っています。サブページの名前の先頭は大文字にします。したがって "My page/My subpage" が正しく、"My page/my subpage" は誤っています。
 
* 通常は、タイトルのトピックは単数形にしますが、何かのグループやクラスなどを表していて可算名詞の場合は複数形にします。
  
* 通常は、タイトルのトピックは単数形にしますが、何かのグループやクラスなどを表していて可算名詞の場合は複数形にします。
 
* 記事の主題がフルネームでも、省略形でもどちらの名前でも知られている場合、記事のタイトルにはフルネームの方を使うほうが適しています。フルネームと省略形の両方を (括弧を使って) タイトルに入れるのは止めてください。代わりに省略形のページからフルネームのページに[[ヘルプ:編集#リダイレクト|転送]]するようにします。
  
* 記事の主題がフルネームでも、省略形でもどちらの名前でも知られている場合、記事のタイトルにはフルネームの方を使うほうが適しています。フルネームと省略形の両方を (括弧を使って) タイトルに入れるのは止めてください。代わりに省略形のページからフルネームのページに[[ヘルプ:編集#リダイレクト|転送]]するようにします。
38行目: 38行目:
 
# 記事のセクション
  
# 記事のセクション
   
−
=== マジックワード ===
 +
==== マジックワード ====
   
 
* 挙動スイッチ&#8202;&mdash;&#8202;そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード]&#8202;&mdash;&#8202;はすべて記事の最上部に配置してください。<br> このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。
  
* 挙動スイッチ&#8202;&mdash;&#8202;そして一般に、記事に内容を追加するためには使用せず、その表示のされ方や挙動を変えるために使用するすべての[https://www.mediawiki.org/wiki/Help:Magic_words マジックワード]&#8202;&mdash;&#8202;はすべて記事の最上部に配置してください。<br> このルールは特に {{ic|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} と [[テンプレート:Lowercase title]] に適用され、これらは前者を使用します。
   
−
=== カテゴリ ===
 +
==== カテゴリ ====
   
 
* どの記事も必ず最低1つ以上の現存しているカテゴリに分類してください。
  
* どの記事も必ず最低1つ以上の現存しているカテゴリに分類してください。
50行目: 50行目:
 
* 詳しくは[[ヘルプ:カテゴリ]]を見てください。
  
* 詳しくは[[ヘルプ:カテゴリ]]を見てください。
   
−
=== 言語間リンク ===
 +
==== 言語間リンク ====
   
 
* 記事が内部または外部の Arch Linux wiki で翻訳されていたら、必ず言語間リンクをカテゴリのすぐ下、本文の最初の行のすぐ上に配置してください。<br>なお、言語間リンクは、実際にはページ左側の適切なカラムに表示されます。
  
* 記事が内部または外部の Arch Linux wiki で翻訳されていたら、必ず言語間リンクをカテゴリのすぐ下、本文の最初の行のすぐ上に配置してください。<br>なお、言語間リンクは、実際にはページ左側の適切なカラムに表示されます。
60行目: 60行目:
 
* 詳しくは [[ヘルプ:i18n]] や [[Wikipedia:ja:言語間リンク|Wikipedia:Help:言語間リンク]] の記事を見てください。
  
* 詳しくは [[ヘルプ:i18n]] や [[Wikipedia:ja:言語間リンク|Wikipedia:Help:言語間リンク]] の記事を見てください。
   
−
=== 記事の状態テンプレート ===
 +
==== 記事の状態テンプレート ====
   
−
* [[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]はカテゴリ (もしくは言語間リンクがある場合はそれ) のすぐ下、イントロダクション (もしくは関連記事ボックスがある場合はそれ) のすぐ上に配置します。
 +
* ページ全体に影響する[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]はカテゴリ (もしくは言語間リンクがある場合はそれ) のすぐ下、イントロダクション (もしくは関連記事ボックスがある場合はそれ) のすぐ上に配置します。
  +
* ページの一部のみに影響する記事の状態テンプレートは、その部分の上のできるだけ近くで、段落・コードブロック・既にある他のテンプレートを破壊しないような適切な位置に配置してください。
−
* 記事の状態テンプレートは、その使用法が適切であれば、記事のセクションの中でも使用することができます。
  
 
* 記事の状態テンプレートを使用する際は必ず専用の欄に短い説明を加えてください (例はそれぞれのテンプレートページにあります)。必要であればトークページで議論を始めます。
  
* 記事の状態テンプレートを使用する際は必ず専用の欄に短い説明を加えてください (例はそれぞれのテンプレートページにあります)。必要であればトークページで議論を始めます。
   
−
=== 関連記事ボックス ===
 +
==== 関連記事ボックス ====
   
 
* ArchWiki 内部にある関連記事のシンプルなリストを提供します。
  
* ArchWiki 内部にある関連記事のシンプルなリストを提供します。
74行目: 74行目:
 
* もっと完全で詳しいリストがほしいときは [[#"参照" セクション|"参照" セクション]] を使ってください。リンクの説明と wiki 間または外部サイトへリンクを含めることができます。
  
* もっと完全で詳しいリストがほしいときは [[#"参照" セクション|"参照" セクション]] を使ってください。リンクの説明と wiki 間または外部サイトへリンクを含めることができます。
   
−
=== 前書きや導入 ===
 +
==== 前書きや導入 ====
   
−
* 記事の主題を記述します。<br> ソフトウェアの説明は、(偏った見方になる可能性があるので) 自分の言葉で言い換えたり書いたりするより、アップストリームの著者が書いたものを使うとよいでしょう。これは (もし存在すれば) 大抵プロジェクトのホームページや about ページにあります。例として [[MediaTomb]] が挙げられます。
 +
* 記事の主題を記述します。<br> ソフトウェアの説明は、(偏った見方になる可能性があるので) 自分の言葉で言い換えたり書いたりするより、アップストリームの著者が書いたものを使うとよいでしょう。これは (もし存在すれば) 大抵プロジェクトのホームページや about ページにあります。例として [[WireGuard]] が挙げられます。[[ImageMagick]] のように、Wikipedia の説明を使用することもできます。
 
* 記事の最初のセクションのすぐ上に配置してください。
  
* 記事の最初のセクションのすぐ上に配置してください。
 
* 明示的に {{Ic|1===Introduction==}} や {{Ic|1===Preface==}} セクションを作らずに、最初のセクションの見出しの上に配置してください。目次は、十分な数のセクションが記事にあれば、自動的に前書きと最初のセクションの間に表示されます。
  
* 明示的に {{Ic|1===Introduction==}} や {{Ic|1===Preface==}} セクションを作らずに、最初のセクションの見出しの上に配置してください。目次は、十分な数のセクションが記事にあれば、自動的に前書きと最初のセクションの間に表示されます。
 
* 詳しくは[[ヘルプ:記事の書き方]]を見てください。
  
* 詳しくは[[ヘルプ:記事の書き方]]を見てください。
  +
  +
==== 標準のセクション ====
  +
  +
===== "インストール" セクション =====
  +
  +
* ''インストール'' セクションはソフトウェアをインストールする方法を提供します。[[#パッケージ管理の記述]]も参照してください。
  +
* タイトルは''インストール''で統一して、ページの始めに配置してください。
  +
  +
===== "既知の問題" セクション =====
  +
  +
* ''既知の問題'' セクションは既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
  +
* タイトルは''既知の問題''で統一して、ページの始めの方に配置してください。
  +
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は自分で報告してください。そうすることでバグが修正される可能性が増します。
  +
* 日付やバージョンに言及することは可能な限り避けてください(例えば、"Linux カーネル 3.17 は2014年8月現在デバイス XYZ をサポートしていません")。繰り返しますが、代わりにより詳しい情報のためにバグ報告などへのリンクを提供してください。
  +
  +
===== "ヒントとテクニック" セクション =====
  +
  +
* ''ヒントとテクニック'' セクションでは高度なヒントやソフトウェアの使用例を提供します。
  +
* タイトルは ''ヒントとテクニック'' で統一してください。
  +
* ヒントとテクニック の内容が多岐にわたる場合、サブセクションにしてまとめてください。
  +
  +
===== "トラブルシューティング" セクション =====
  +
  +
* ''トラブルシューティング''セクションはソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
  +
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
  +
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告 (またはそれに似た適切な情報元、例えば応急処置を含むフォーラムの投稿) へのリンクを提供することが ''必須'' です。まだ報告されていない場合は自分で報告してください。そうすることでそのバグが適切に修正される可能性が増します。<br> 日付やバージョンに言及することは可能な限り避けてください。バグ報告をリンクすることは読者と編集者の双方にとって大きなメリットがあります:
  +
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれないソースに近い情報を見つけられるようになります。
  +
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。
  +
  +
===== "参照" セクション =====
  +
  +
* ''参照''セクションでは追加情報の参考文献とソースのリストを提供します。
  +
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
  +
* タイトルは''参照''で統一して、セクションをページの最後に配置してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。
   
 
=== セクションの見出し ===
  
=== セクションの見出し ===
86行目: 120行目:
 
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
  
* サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
 
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
  
* 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
−
* 見出しにリンクは使わないでください。スタイルが崩れます。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
 +
* 見出しにリンクは使わないでください。スタイルが崩れますし、あまりうまく目立ちません。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
 
:: 詳しくは[[メインページ|関連記事]]を参照してください。
  
:: 詳しくは[[メインページ|関連記事]]を参照してください。
−
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[en2:Help:Style/Formatting and punctuation|ヘルプ:スタイル/書式と句読点]]も参照。
 +
: 同じく、HTML や wiki のマークアップコード、あるいは[[#コードのフォーマット|コードをフォーマットする]]テンプレートを見出しに使わないで下さい。[[ヘルプ:スタイル/書式と記号]]も参照。
 
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。
  
* 詳しくは[[ヘルプ:効果的な見出し]]を見てください。
   
−
=== コードのフォーマット ===
 +
=== フォーマット ===
  +
  +
==== コードのフォーマット ====
   
−
* 短いコードやファイル名、コマンド名、変数などのインラインで表示したいものは {{ic|<nowiki>{{ic|code}}</nowiki>}} を使います。例: <br> コンソールで {{ic|sh ./hello_world.sh}} を実行してください。
 +
* 短いコード・ファイル名・パス・設定項目・変数・[[ヘルプ:スタイル/書式と記号#等幅|他のケース]]などのインラインで表示したいものは [[テンプレート:ic]] を使います。例: <br> コンソールで {{ic|sh ./hello_world.sh}} を実行してください。
   
 
* (コマンドラインの入出力するコードやファイルの中身など) コードが一行で適切なフレームを付ける場合、半角スペースを前に付けます。[[ヘルプ:編集#コード]]を見てください。例:
  
* (コマンドラインの入出力するコードやファイルの中身など) コードが一行で適切なフレームを付ける場合、半角スペースを前に付けます。[[ヘルプ:編集#コード]]を見てください。例:
101行目: 137行目:
 
Hello World
  
Hello World
   
−
* 複数行のコード (コマンドラインの入出力やファイルの中身) に適切なフレームを付ける場合、{{ic|<nowiki>{{bc|code}}</nowiki>}} を使います。例:
 +
* 複数行のコード (コマンドラインの入出力やファイルの中身) に適切なフレームを付ける場合、[[テンプレート:bc]] を使います。例:
 
{{bc|#!/bin/sh
  
{{bc|#!/bin/sh
   
 
# Demo
  
# Demo
 
echo "Hello World"}}
  
echo "Hello World"}}
−
* コマンドラインの入力と出力を両方表示する必要がある場合は、{{ic|<nowiki>{{hc|input|output}}</nowiki>}} を使います。例:
 +
* コマンドラインの入力と出力を両方表示する必要がある場合は [[テンプレート:hc]] を使います。例:
 
{{hc|$ sh ./hello_world.sh|Hello World}}
  
{{hc|$ sh ./hello_world.sh|Hello World}}
−
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは、{{ic|<nowiki>{{hc|filename|content}}</nowiki>}} を使うことで、見出しにファイル名を表示することもできます。例:
 +
* ファイルの中身を表示する必要があり、そのコードがどのファイルを指しているか読者に伝わらないかもしれないときは [[テンプレート:hc]] を使うことで見出しにファイル名を表示することもできます。例:
 
{{hc|~/hello_world.sh|<nowiki>
  
{{hc|~/hello_world.sh|<nowiki>
 
#!/bin/sh
  
#!/bin/sh
119行目: 155行目:
 
* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。
  
* 詳しくは[[ヘルプ:テンプレート]]を見てください。{{ic|1==}} や {{ic|<nowiki>|</nowiki>}} などテンプレートを破壊する文字の対処法についても載っています。
   
−
=== コマンドラインのテキスト ===
 +
==== コマンドラインのテキスト ====
   
−
* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きを、はっきりとわかるように追加してください。
 +
* インラインコード ([[テンプレート:ic]]) 使う場合、プロンプト記号を表示する必要はありませんが、テキストの周囲に必ずパーミッションの注意書きをはっきりとわかるように追加してください。
 
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
  
* ブロックコード ([[テンプレート:bc]] や空白文字で始まる行) を使う場合、一般ユーザのコマンドのプロンプトとして {{ic|$}} を、root のコマンドのプロンプトとして {{ic|#}} を使います。{{Note|{{ic|#}} はテキストファイル内のコメントを示すのにも使われるため、通常はコマンドを実行するのかテキストファイルのコメントを示すのかを明確に説明し、曖昧な表現は必ず避けるようにしてください。}}
−
** コマンドブロックの前置きとなる文の最後は、通常 {{ic|:}} にしたほうがよいです。
 +
** コマンドブロックの前置きとなる文の最後は通常 {{ic|:}} にしたほうがよいです。
−
** 特別な事情がない限り、次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
 +
** 特別な事情がない限り次を使います: {{bc|# ''command''}} 次は使いません: {{bc|$ sudo ''command''}}
−
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外では、デフォルトの {{ic|$}} を使ってください。
 +
** root プロンプトと ''sudo'' コマンドを次のように一緒に使わないでください: {{bc|# sudo ''command''}} 唯一の例外は、''sudo'' が {{ic|-u}} フラグと一緒に使われる場合です: この場合、プロンプトを同じコードブロックの他のプロンプトに合わせることができます。それ以外ではデフォルトの {{ic|$}} を使ってください。
 
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
  
** コマンドを含む同じ囲みにコメントを付け足さないでください。例: {{bc|# pacman -S foo #パッケージ foo をインストール}}
 
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
  
** 極端に長いコードを書くのは避けてください。可能であれば改行をうまく使ってください。
 
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。
  
* ユーザーの [[sudo]] や他の権限昇格ユーティリティ (例: ''gksu'', ''kdesu'') の使用を前提としないでください。
   
−
=== ファイル編集の記述 ===
 +
==== キーボードキー ====
   
  +
* 記事内でのキーボードキーの表示は通常 [[テンプレート:ic]] のインスタンスを使います。
−
* テキストファイルの編集する必要がある場合、原則、特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
  
−
* テキストファイルを編集する必要がある場合、厳密な理由がない限り、間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
  
−
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
  
−
::{{bc|clear<br>reset}}
  
−
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集 そして source]] へのリンクを追加するのも良いでしょう。
  
−  
−
=== キーボードキー ===
  
−  
−
* 記事内でのキーボードキーの表示は、通常、[[テンプレート:ic]] のインスタンスを使います。
  
 
* 文字キーは小文字で表示します: {{ic|a}}。大文字を表示するには {{ic|Shift+a}} を使います。{{ic|Shift+A}} や {{ic|A}} は使いません。
  
* 文字キーは小文字で表示します: {{ic|a}}。大文字を表示するには {{ic|Shift+a}} を使います。{{ic|Shift+A}} や {{ic|A}} は使いません。
−
* キーの ''組み合わせ'' は、{{ic|+}} 記号を用い、その両端に空白文字を付けずにそれぞれのキーを結合するのが正しい表示の仕方です: {{ic|Ctrl+c}}。<br> {{ic|Ctrl + c}}, {{ic|Ctrl}}+{{ic|c}}, {{ic|Ctrl-c}} は準拠していない書式なので、使用は避けてください。
 +
* キーの ''組み合わせ'' は {{ic|+}} 記号を用い、その両端に空白文字を付けずにそれぞれのキーを結合するのが正しい表示の仕方です: {{ic|Ctrl+c}}。<br> {{ic|Ctrl + c}}, {{ic|Ctrl}}+{{ic|c}}, {{ic|Ctrl-c}} は準拠していない書式なので使用は避けてください。
−
* キー入力の ''流れ'' は、冗長に説明 (例: {{ic|Shift+t}} に続けて {{ic|g}} を押します) するか、それぞれのキーにテンプレートの別々のインスタンスを用いて、それらを1個の半角スペースで区切って簡潔に説明するのが正しい表示の仕方です: {{ic|g}} {{ic|Shift+t}}。
 +
* キー入力の ''流れ'' は冗長に説明 (例: {{ic|Shift+t}} に続けて {{ic|g}} を押します) するか、それぞれのキーにテンプレートの別々のインスタンスを用い、それらを1個の半角スペースで区切って簡潔に説明するのが正しい表示の仕方です: {{ic|g}} {{ic|Shift+t}}。
 
* 特別なキーの組み合わせの標準的な表示方法を以下にいくつか示します:
  
* 特別なキーの組み合わせの標準的な表示方法を以下にいくつか示します:
 
** {{ic|Shift}} ({{ic|SHIFT}} ではありません)
  
** {{ic|Shift}} ({{ic|SHIFT}} ではありません)
157行目: 185行目:
 
** {{ic|Del}} ({{ic|DEL}} や {{ic|Delete}} ではありません)
  
** {{ic|Del}} ({{ic|DEL}} や {{ic|Delete}} ではありません)
 
** {{ic|PrintScreen}}
  
** {{ic|PrintScreen}}
  +
** {{ic|Up}} ({{ic|↑}} や {{ic|Up Arrow}} ではありません) – 他の方向キーも同様
 
** {{ic|PageUp}}
  
** {{ic|PageUp}}
 
** {{ic|PageDown}}
  
** {{ic|PageDown}}
  +
** {{ic|Fn}} ({{ic|FN}} や {{ic|fn}} ではありません) – 多くのラップトップにある [[Wikipedia:ja:Fnキー|Fnキー]]
  +
** {{ic|Home}} ({{ic|HOME}} や {{ic|Beginning}} ではありません)
  +
** {{ic|End}} ({{ic|END}} ではありません)
   
−
=== パッケージ管理の記述 ===
 +
==== ノート・警告・ヒント ====
   
  +
* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
−
==== 公式パッケージ ====
  
  +
: ノートは、重要であるけれど主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
  +
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
  +
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは多くの場合ノートを使ったほうがよいです。
  +
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは扱っている操作を完了させるには必要がないため無視しても問題ありません。
  +
* 2つ以上のノート、警告またはヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りはテンプレートを積み重ねないでください。例:
  +
:{{Tip|
  +
:* ヒント例 #1.
  +
:* ヒント例 #2.}}
   
  +
==== 表 ====
−
* 公式パッケージのインストールの説明に、''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
  
  +
  +
構文については [[mw:Help:Tables]] を参照してください。
  +
  +
* 表は一般的に {{ic|wikitable}} クラスが付けられる必要があります。
  +
* 比較の表は追加で {{ic|sortable}} クラスが付けられる必要があります。
  +
* 適切であれば表の見出しや[[ヘルプ:テンプレート#テーブルテンプレート|テーブルセルテンプレート]]を使ってください。
  +
* 表の見出しは先頭が大文字である必要があります。
  +
* 表の凡例は定義リストを使い、表より前に配置する必要があります。
  +
  +
=== 手順の記述 ===
  +
  +
==== ファイル編集の記述 ====
  +
  +
* テキストファイルの編集する必要がある場合、原則として特定のテキストエディタ (''nano'', ''vim'', ''emacs'' など) の使用を前提としないでください。
  +
* テキストファイルを編集する必要がある場合、厳密な理由がない限り間接的なコマンドを使わないでください。例えば {{ic|$ echo -e "clear\nreset" >> ~/.bash_logout}} は次のようにします:
  +
::{{ic|~/.bash_logout}} に以下の行を付け加えます:
  +
::{{bc|clear<br>reset}}
  +
:一般的な例外には、複雑でシステムによって異なる出力が関わっているコマンド、例えば {{ic|genfstab -U /mnt >> /mnt/etc/fstab}} などがあります。
  +
:適切な場所に [[ヘルプ:読み方#追加, 作成, 編集 そして source]] へのリンクを追加するのも良いでしょう。
  +
  +
==== パッケージ管理の記述 ====
  +
  +
===== 公式パッケージ =====
  +
  +
* 公式パッケージのインストールの説明に ''pacman'' のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、[[pacman]] の記事内容を知っておくべきです)、そして {{Ic|pacman -Sy package}} のようなコマンドで起こりうるエラーや、{{Ic|pacman -S package}} か {{Ic|pacman -Syu package}} のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、''pacman'' のフロントエンドやラッパーの使用を提案してはいけません。
 
: 代わりに、以下のような記述を使ってください:
  
: 代わりに、以下のような記述を使ってください:
 
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
  
:: {{Pkg|foobar}} パッケージを[[インストール]]してください。
175行目: 240行目:
 
: 記事に合わせて言い回しを変えても構いません。
  
: 記事に合わせて言い回しを変えても構いません。
 
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
  
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:Pkg]] を使ってください。例: {{ic|<nowiki>{{Pkg|foobar}}</nowiki>}}。
−
* パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
 +
: パッケージグループの参照する場合は、代わりに [[テンプレート:Grp]] を使ってください。例: {{ic|<nowiki>{{Grp|foobar}}</nowiki>}}。
−
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に、Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
 +
* 上記の例では[[インストール]]のリンクを利用しています (例: {{ic|<nowiki>[[install]]</nowiki>}}): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
−
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合は、そのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
 +
* メンテナンスを容易にするために、パッケージが ''core''、''extra''、または ''community'' リポジトリでホストされている場合はそのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (''multilib''、''testing'' など) でホストされている場合は、以下のようにして言及する必要があります:
 
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。
  
::{{Pkg|foobar}} パッケージを公式の [[multilib]] リポジトリから[[インストール]]してください。
   
−
==== AUR パッケージ ====
 +
===== AUR パッケージ =====
   
−
* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは、事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
 +
* AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは事前に [[Arch User Repository]] に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
 
: 代わりに、以下のように簡潔に述べてください:
  
: 代わりに、以下のように簡潔に述べてください:
 
:: {{AUR|foobar}} パッケージをインストールします。
  
:: {{AUR|foobar}} パッケージをインストールします。
188行目: 253行目:
 
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。
  
* 言及したパッケージのリンクは必ず貼り、[[テンプレート:AUR]] を使ってください。例: {{ic|<nowiki>{{AUR|foobar}}</nowiki>}}。
   
−
==== 非公式リポジトリ ====
 +
===== 非公式リポジトリ =====
   
−
* ビルド済みのパッケージをインストールするために、非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法は書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認して、ページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
 +
* ビルド済みのパッケージをインストールするために非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法を書かないでください。そのリポジトリが[[非公式ユーザーリポジトリ]]にかかれていることを確認してページヘのリンクを張ってください。また、[[#公式パッケージ|公式パッケージ]]と同様に、''pacman'' コマンドの例は不要です。例:
 
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
  
:: [[非公式ユーザーリポジトリ#example|example]] リポジトリから ''foobar'' パッケージをインストールしてください。
 
: パッケージが [[AUR]] からもインストールできる場合:
  
: パッケージが [[AUR]] からもインストールできる場合:
199行目: 264行目:
 
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。
  
* [[非公式ユーザーリポジトリ]]へのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: {{ic|<nowiki>[[Unofficial user repositories#example|example]]</nowiki>}}。
   
−
=== systemd ユニットの操作 ===
 +
==== systemd ユニットの操作 ====
   
−
* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに、関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
 +
* ''systemctl'' を用いた [[systemd]] ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
 
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
  
:: ブート時に GDM を起動させるには、{{ic|gdm.service}} を[[有効化]]してください。例:
 
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
  
: または、ユニットがインスタンス化する必要があるテンプレートである場合:
 
:: 無線インターフェイスの ''netctl'' プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して {{ic|netctl-auto@.service}} のインスタンスを[[有効化]]してください。例: {{ic|netctl-auto@wlan0.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 リダイレクト] を通して必ず貼ってください。
 +
: [[systemd#ユニットを使う]] の記事セクションへのリンクを直接、または {{ic|<nowiki>[[開始]]</nowiki>}} や {{ic|<nowiki>[[有効化]]</nowiki>}}、 {{ic|<nowiki>[[停止]]</nowiki>}} のような専用の[https://wiki.archlinux.jp/index.php?title=特別:リンク元/Systemd&hidelinks=1&hidetrans=1 リダイレクト] を通して必ず貼ってください。
−  
−
=== ノート・警告・ヒント ===
  
−  
−
* [[テンプレート:Note|ノート]]は、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
  
−
: ノートは、重要であるけれど、主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
  
−
* [[テンプレート:Warning|警告]]は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は、起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
  
−
: 基本的には警告を多用しないでください: 警告を使用するべきかわからないときは、多くの場合ノートを使ったほうがよいです。
  
−
* [[テンプレート:Tip|ヒント]]は、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは、扱っている操作を完了させるには必要がないため、無視しても問題ありません。
  
−
* 2つ以上のノートや警告、ヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りは、テンプレートを積み重ねないでください。例:
  
−
:{{Tip|
  
−
:* ヒント例 #1.
  
−
:* ヒント例 #2.}}
  
   
 
=== シェル ===
  
=== シェル ===
   
−
* 本当に必要でない限りは、ユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は、可能な限りどのシェルでも実行できるようにしてください。
 +
* 本当に必要でない限りはユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は可能な限りどのシェルでも実行できるようにしてください。
   
 
=== ハイパーテキスト ===
  
=== ハイパーテキスト ===
   
  +
内部・wiki 間・外部 wiki へのリンクの構文は [[ヘルプ:編集#リンク]] を参照してください。
−
* 書いた記事を、テキスト中に様々なキーワードを用いて、可能な限り多くの他の記事に内部リンクしてください。
  
  +
−
* 新しい記事へのリンクは記事作成後にしてください。基本的に存在しない記事へのリンクは作成しないでください。
  
−
* [[Wikipedia:ja:システムコール|システムコール]]などの専門用語で、ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
 +
* 書いた記事を、テキスト中に様々なキーワードを用いて可能な限り多くの他の記事に内部リンクしてください。
−
* wiki の他の記事にリンクするときは、URL を使ってはいけません。内部リンクを利用するようにしてください: {{Ic|<nowiki>[[Wiki の記事]]</nowiki>}}。wiki エンジンが内部リンクを追跡できるようにすることで、メンテナンスが楽になります。<br>内部リンクの使用法に関する詳細は[[ヘルプ:編集#リンク]]を見てください。
 +
* 新しい記事へのリンクは記事作成後にしてください。リンク切れを見つけたら、修正してください。リンク切れと思われる外部リンクは [[テンプレート:Dead link]] を付けてください。
−
** 同じページのセクションにリンクするときは、アンカー記号を隠さないでください (例: {{ic|<nowiki>[[#ドキュメントのセクションへのリンク|ドキュメントのセクションへのリンク]]</nowiki>}})。書式の再設定が不要になるのに加え、アンカーによってリンク先が完全な1つの記事ではなく、記事のセクションへのものであることを明確に示せます。
  
 
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
  
* できる限り間接的なリンクはしないでください。例えば、"詳しくは[[systemd|ここ]]を見てください" ではなく "詳しくは [[systemd]] の記事を見てください" のように指示します。
−
* 稀なケースを除いて、記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
  
−
* 記事に具体的な処理を書いたり、特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は、内容を重複させずにその記事にリンクしてください。
  
−
* 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合は、Arch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
  
−
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。<br> 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。<br> 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。
  
   
  +
リンクは以下の2つの方法で使うことができます。
−
=== コーディングスタイル ===
  
   
  +
* ''トピックの参照'' として、リンクが用語・文章の一部で、文法の影響を受けやすい場合は、必要であればリンクにラベルを付けてください。wiki 内部/wiki 間リンクは、[[#リダイレクトのページ|リダイレクト]]があればそれにリンクしてください。
−
* コマンドやスクリプトを追加するときは、記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合は、その記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
  
  +
* ''ページ/セクションの参照'' としてであれば、リンクのラベルを使わないでください。また、[[テンプレート:Lowercase title]] が使われているときにはそれに従ってタイトルを表記してください。特に、同じページのセクションにリンクするときは {{ic|#}} 記号を隠さないでください。悪い例: {{ic|<nowiki>[[#ハイパーテキスト|ハイパーテキスト]]</nowiki>}}。
−
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。
  
   
  +
以下の例を見てください。
−
=== サポートするカーネルのバージョン ===
  
   
  +
{| class="wikitable"
−
* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinuxjp.org/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。
  
  +
! トピックの参照 !! ページ/セクションの参照
  +
|-
  +
| [[SSH 鍵#SSH エージェント|SSH エージェント]] を使うと認証を高速化できます
  +
| 認証を高速化するには [[SSH 鍵#SSH エージェント]] を参照してください
  +
|-
  +
| [[フォント設定#サブピクセルレンダリング|サブピクセルレンダリング]] はほとんどのモニターでサポートされています
  +
| [[フォント設定#サブピクセルレンダリング]] に記載されている方法でサブピクセルレンダリングを有効化してください
  +
|-
  +
| ''initramfs'' の中に [[dm-crypt/デバイスの暗号化#キーファイル|キーファイル]] を含めてください
  +
| [[dm-crypt/デバイスの暗号化#キーファイル]] に手順があります
  +
|-
  +
| [[Wikipedia:Mouse keys|マウスキー]] は標準で無効化されていることに気を付けてください
  +
| 詳細は [[Wikipedia:Mouse keys]] を参照してください
  +
|-
  +
| リンクに適用される [[#ハイパーテキスト|スタイルルール]] があります
  +
| [[#ハイパーテキスト]] セクションにはリンクに適用されるスタイルルールがあります
  +
|}
   
  +
* 記事に具体的な処理を書いたり特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は内容を重複させずにその記事にリンクしてください。さらに:
−
=== "Tips and tricks" セクション ===
  
  +
** 専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
  +
** 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合はArch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
  +
::良い例: "[[カーネルパラメータ]] は起動時に [[Wikipedia:ja:システムコール|システムコール]] を発行するために使われます。完全なリストは [https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html Linux カーネルドキュメント] を参照してください。"
  +
:一般に、[[ヘルプ:読み方#編成]] との一貫性を保ってください。
  +
* 稀なケースを除いて記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
  +
* 編集中の記事と同じ言語でローカライズされたページヘのリンクには、[[特別:リンク元]]ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では {{ic|<nowiki>[[Main page (Magyar)]]</nowiki>}} を使うのが正しく、 {{ic|<nowiki>[[:hu:Main page]]</nowiki>}} を使うのは誤っています。<br> 分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。<br> 最後に、この種のリンクと [[#言語間リンク]] との違いについて言及しますが、言語間リンクには最初にコロンが付きません。
  +
* 短い "w:" 接頭辞よりも "Wikipedia:" wiki 間接頭辞を推奨します。
   
  +
==== Man ページ ====
−
* ''Tips and tricks'' セクションでは、高度なヒントやソフトウェアの使用例を提供します。
  
−
* タイトルは ''Tips and tricks'' で統一してください。
  
−
* Tips and tricks の内容が多岐にわたる場合、サブセクションにしてまとめてください。
  
   
  +
* [[Man ページ]] は [[テンプレート:man]] を使って参照してください。
−
=== "トラブルシューティング" セクション ===
  
   
  +
=== コーディングスタイル ===
−
* ''トラブルシューティング''セクションは、ソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います ([[#"既知の問題" セクション]] と比べてみてください)。
  
−
* タイトルは''トラブルシューティング'' (訳註: 英語版は ''Troubleshooting'') で統一してださい。(訳註: 英語版では) ''Trouble shooting''、''Trouble-shooting''、そして ''TroubleShooting'' は、よくあるスペルミスなので使わないでください。
 
−
* 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告へのリンクを提供することが強く望まれます。まだ報告されていない場合は、自分で報告してください。そうすることで、そのバグが適切に修正される可能性が増します。<br> バグ報告をリンクすることは、読者と編集者の双方にとって大きなメリットがあります:
  
−
** 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれない、ソースに近い情報を見つけられるようになります。
  
−
** Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。
  
   
  +
* コマンドやスクリプトを追加するときは記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合はその記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
−
=== "既知の問題" セクション ===
  
  +
* 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ ({{ic|``}}) 構文は使わず、{{ic|$()}} 構文を使ってください。
  +
* スクリプトは可能な限り最も明確な方法で、必須のタスクを実行するために最小限必要なことのみを記述してください。スクリプトは柔軟性や拡張性を考えてデザインされるべきではありません。実際の変数よりも [[ヘルプ:読み方#コード例で使われる疑似変数|疑似変数]] を使うことが推奨されます。引数の処理や出力のフォーマットといった関係のない処理を追加しないでください。
  +
* スクリプトはページ内のテキストの冗長な説明が十分に明確で正確にならないときに、主に教育的目的で追加されるべきです。スクリプトは、例えば複雑なコマンドがどのように使われることを意図しているか示したり、関連する・相互に依存するコマンドがどのように組み合わされるかを示すために便利です。
  +
* スクリプトがページに価値を追加すると思われるが、上記に合致しない場合、外部にリンクすることができます。[https://gist.github.com gist] に公開するとよいでしょう。
  +
* ディレクトリの名前やパスを表現する場合、スラッシュで終わらせるか、明示的に "ディレクトリ" や "フォルダ" といった言葉を付けてください。例:
  +
:* 良い例: "{{ic|/sys/firmware/efi}} ディレクトリがあるか確認してください"、悪い例: "{{ic|/sys/firmware/efi}} があるか確認してください"
  +
:* 良い例: "{{ic|/etc/modules-load.d/}} に ''.conf'' ファイルを配置してください"、悪い例: "{{ic|/etc/modules-load.d}} に ''.conf'' ファイルを配置してください"
  +
* スペースを含む引数は二重引用符で囲む必要があります。良い例: {{ic|cd "foo bar"}}、悪い例: {{ic|cd foo\ bar}}
   
  +
=== サポートするカーネルのバージョン ===
−
* ''既知の問題'' セクションは、既知のバグやまだ解決策が存在しない利用上の問題のために使います ([[#"トラブルシューティング" セクション]] と比べてみてください)。
  
−
* タイトルは''既知の問題''で統一してください。
  
−
* バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は、自分で報告してください。そうすることで、バグが修正される可能性が増します。
  
   
  +
* ''core'' リポジトリにある最新の {{Pkg|linux-lts}} パッケージと最新の[https://www.archlinux.jp/download/ インストールメディア]のうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。
−
=== "参照" セクション ===
  
−  
−
* ''参照''セクションでは、追加情報の参考文献とソースのリストを提供します。
  
−
* リストのそれぞれの項目は {{Ic|*}} から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
  
−
* タイトルは''参照''で統一してください。''外部リンク''や''さらなる資料''などのその他の類似したタイトルは使わないでください。
  
   
 
=== 適切ではない記述 ===
  
=== 適切ではない記述 ===
   
−
* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWikiはこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。<br> ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
 +
* 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWiki はこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。<br> ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために''参照''セクションを使うことができます。
−
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタを使うこともできます。論拠:
 +
* 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は [http://www.asciiflow.com/ Asciiflow] のような ASCII エディタや [[テンプレート:Text art]] を使うこともできます。論拠:
 
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
  
** メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
 
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
  
** 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
281行目: 349行目:
 
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
  
** アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
 
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
  
** 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
−
** シンプリシティ: テキストのみの記事のほうが、シンプルで整って見えます。
 +
** シンプリシティ: テキストのみの記事のほうがシンプルで整って見えます。
  +
  +
=== スペル ===
  +
  +
* 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
  +
* 単語の不必要な[[Wikipedia:Clipping (morphology)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。<br> 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。[[ヘルプ:スタイル/書式と記号#設定パラメータ・変数・オプション・プロパティ等]] も参照してください。
  +
* プロジェクト・アプリケーション・実行ファイル等の名前は、主にそれらの公式ドキュメントのスタイル通りに、特に大文字小文字も含めて正確に記述する必要があります。これは公式ドキュメントが名前を一般名詞のように扱っている場合も含みます。例えば、文の先頭にあるときは先頭を大文字にして、他の場合は小文字の場合です。公式ドキュメントが一貫したスタイルを持たない場合、ArchWiki で既に使われているスタイルに従ってください。ArchWiki に名前が使われていない場合や、ArchWiki でも一貫したスタイルが使われていない場合、スタイルを選択してページ全体で統一してください。可能であれば、名前に言及している他のページも更新してください。Git を例にすると、プロジェクト・ソフトウェアについての一般的なことに言及する場合には大文字で始めて("Git")、コンパイルされたプログラムについて言及する場合は全て小文字で斜体にする("''git''")こともできます。大文字のルールが議論を呼ぶ場合、明示的にページの議論ページにスタイルを定義してください。[[ヘルプ:スタイル/書式と記号#実行ファイル/アプリケーションの名前]] も参照してください。
   
 
=== 言語使用域 ===
  
=== 言語使用域 ===
   
 
* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
  
* 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
−
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが、手順だけを示すよりも、より深く知識を伝えることができます。
 +
* ''どうやって''だけではなく''なぜ''も説明するようにしてください。情報を説明するほうが手順だけを示すより深く知識を伝えることができます。
−
* (訳註: 主に英語を使用する場合は、) 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
  
−
* 単語の不必要な[[Wikipedia:Shortening (grammar)|短縮]]はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。<br> 同様に、''まれな''コマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。
  
 
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
  
* 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれに''リポジトリ''を付け加えます。
 
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
  
* "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
 
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
  
* 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
−
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も、同じようにしてください。
 +
* 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も同じようにしてください。
 
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。
  
* さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。
  +
* 読者や一般の人を指すときには、[[Wikipedia:Singular they|they/them]] のような中性的な代名詞を使うようにしてください。
   
 
== カテゴリのページ ==
  
== カテゴリのページ ==
   
 
* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
  
* 全ての[[ヘルプ:カテゴリ|カテゴリ]]は最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ ([[:カテゴリ:アーカイブ]], [[:カテゴリ:目次]], [[:カテゴリ:メンテナンス]]) は例外です。
  +
* カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
−
* A category can be categorized under more than one category, provided one is not ancestor of the others.
  
  +
* 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
−
* 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]].
  
  +
* 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ、例えば [[:カテゴリ:シミュレーション]])。複数形は、単数形がその中の''1つ''であるとして使える場合に使ってください ("集合"カテゴリ、例えば [[:カテゴリ:ブートローダー]])。
−
* 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).
  
   
 
== リダイレクトのページ ==
  
== リダイレクトのページ ==
   
  +
* 既存のページの略語や文法的な変化形や、より一般的なページのサブセクションにある用語やトピックのためのリダイレクトページを作成することが推奨されます。例えば、[[ALSA]]・[[デーモン一覧]]・[[AIGLX]]などです。リダイレクトはラベル付きリンクを単純化できます。例えば {{ic|<nowiki>[[Advanced Linux Sound Architecture|ALSA]]</nowiki>}}・{{ic|<nowiki>[[デーモン|デーモン一覧]]</nowiki>}}・{{ic|<nowiki>[[Xorg#コンポジット|AIGLX]]</nowiki>}} といった例と比べてみてください。
 
* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
  
* 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
 
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
  
** [[ArchWiki:アーカイブ|アーカイブ]]ページはリダイレクトですが、[[:カテゴリ:アーカイブ]]にカテゴライズされます。
  +
** [[ヘルプ:操作手順#カテゴリ名を変更する|リネームされたカテゴリ]] は [[テンプレート:Archive]] フラグを含むことができます。
 
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
  
* リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
 
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。
  
:言語間リンクを使用するリダイレクトは[[ヘルプ:i18n]] の決まりにしたがって[[ArchWiki:管理者]]からの許可が得られた場合にのみ例外的に可能となります。
  +
* より詳しい情報は [[ヘルプ:編集#リダイレクト]] を参照してください。
   
 
== ユーザーのページ ==
  
== ユーザーのページ ==
   
  +
* [[特別:前方一致ページ一覧/User:|利用者]]名前空間にあるページはカテゴライズすることはできません。
−
* Pages in the [https://wiki.archlinuxjp.org/index.php?title=Special%3APrefixIndex&prefix=&namespace=2 User] namespace cannot be categorized.
  
  +
* [[特別:前方一致ページ一覧/User:|利用者]]名前空間にあるページは、管理者の承認が得られない限り、''利用者''または''トーク''名前空間のページからしかリンクすることはできません。
−
* 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.
  
  +
* [[特別:前方一致ページ一覧/User:|利用者]]名前空間にあるページは、他の名前空間から[[ヘルプ:編集#リダイレクト|リダイレクト]]することができません。
   
 
== 共通ルール ==
  
== 共通ルール ==
321行目: 398行目:
 
=== 編集内容の要約 ===
  
=== 編集内容の要約 ===
   
−
[[ヘルプ:編集]]を見てください。
 +
[[ArchWiki:貢献#3つの基本的なルール]]を見てください。
   
 
=== HTML タグ ===
  
=== HTML タグ ===
 
* HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。[[ヘルプ:編集]]を参照。
  
* 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>}}.
 +
* {{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><!-- comment --></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。<br>コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
  
* 特に HTML コメントは使わないようにしてください ({{ic|<nowiki><!-- comment --></nowiki>}}): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。<br>コメントを書くところには適当な[[ヘルプ:テンプレート#記事の状態テンプレート|記事の状態テンプレート]]を追加してください。
  +
* {{ic|<nowiki><br></nowiki>}} は必要なときにだけ使ってください: 新しい段落を始めたり改行するには、すぐ下に空行を挿入してください。<br> この規則によくある例外として、リストの項目内で改行する必要があるけれどサブ項目が使えない場合や、テンプレート内でリストを使うことができない場合などがあります。
−
* Use {{ic|<nowiki><br></nowiki>}} only when necessary: to start a new paragraph or break a line, put a blank line below it. <br> 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.
  
  +
  +
{{TranslationStatus|Help:Style|2022-06-03|723192}}

2022年6月6日 (月) 10:21時点における最新版

関連記事

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

記事のページ

タイトル

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

レイアウト

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

マジックワード

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

カテゴリ

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

言語間リンク

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

記事の状態テンプレート

  • ページ全体に影響する記事の状態テンプレートはカテゴリ (もしくは言語間リンクがある場合はそれ) のすぐ下、イントロダクション (もしくは関連記事ボックスがある場合はそれ) のすぐ上に配置します。
  • ページの一部のみに影響する記事の状態テンプレートは、その部分の上のできるだけ近くで、段落・コードブロック・既にある他のテンプレートを破壊しないような適切な位置に配置してください。
  • 記事の状態テンプレートを使用する際は必ず専用の欄に短い説明を加えてください (例はそれぞれのテンプレートページにあります)。必要であればトークページで議論を始めます。

関連記事ボックス

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

前書きや導入

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

標準のセクション

"インストール" セクション
  • インストール セクションはソフトウェアをインストールする方法を提供します。#パッケージ管理の記述も参照してください。
  • タイトルはインストールで統一して、ページの始めに配置してください。
"既知の問題" セクション
  • 既知の問題 セクションは既知のバグやまだ解決策が存在しない利用上の問題のために使います (#"トラブルシューティング" セクション と比べてみてください)。
  • タイトルは既知の問題で統一して、ページの始めの方に配置してください。
  • バグが既知の問題として報告されている場合、その報告へのリンクを提供することが強く望まれます; 報告されていない場合は自分で報告してください。そうすることでバグが修正される可能性が増します。
  • 日付やバージョンに言及することは可能な限り避けてください(例えば、"Linux カーネル 3.17 は2014年8月現在デバイス XYZ をサポートしていません")。繰り返しますが、代わりにより詳しい情報のためにバグ報告などへのリンクを提供してください。
"ヒントとテクニック" セクション
  • ヒントとテクニック セクションでは高度なヒントやソフトウェアの使用例を提供します。
  • タイトルは ヒントとテクニック で統一してください。
  • ヒントとテクニック の内容が多岐にわたる場合、サブセクションにしてまとめてください。
"トラブルシューティング" セクション
  • トラブルシューティングセクションはソフトウェアやよくある問題の解決策に関する、頻繁に尋ねられる質問のために使います (#"既知の問題" セクション と比べてみてください)。
  • タイトルはトラブルシューティング (訳註: 英語版は Troubleshooting) で統一してださい。(訳註: 英語版では) Trouble shooting、Trouble-shooting、そして TroubleShooting は、よくあるスペルミスなので使わないでください。
  • 既知のバクに対する一時的な応急処置を報告することもできますが、その場合、そのバグ報告 (またはそれに似た適切な情報元、例えば応急処置を含むフォーラムの投稿) へのリンクを提供することが 必須 です。まだ報告されていない場合は自分で報告してください。そうすることでそのバグが適切に修正される可能性が増します。
    日付やバージョンに言及することは可能な限り避けてください。バグ報告をリンクすることは読者と編集者の双方にとって大きなメリットがあります:
    • 読者にとって、この Wiki が停止点ではなくなります: リンクしなければ頑張って検索しても見逃してしまったかもしれないソースに近い情報を見つけられるようになります。
    • Wiki の編集者にとって、報告されたバグが依然として問題になっているかどうかを確認する手間が省け、整理が楽になります: これは、読者が新しい情報を見つけ、wiki を編集しに戻って来るようになった場合、自律性の向上さえももたらすかもしれません。
"参照" セクション
  • 参照セクションでは追加情報の参考文献とソースのリストを提供します。
  • リストのそれぞれの項目は * から始めてください。これを使うことで MediaWiki の箇条書きリストが生成されます。
  • タイトルは参照で統一して、セクションをページの最後に配置してください。外部リンクやさらなる資料などのその他の類似したタイトルは使わないでください。

セクションの見出し

  • 見出しは2段階目から使ってください (==)。1段目は記事のタイトルに予約されています。
  • サブセクションを作成するときは段階を飛ばさないでください。2段目のサブセクションは3段と続いていきます。
  • 見出しは先頭だけ大文字にしてください。例: "My new heading" は正しいですが、"My New Heading" は誤っています。
  • 見出しにリンクは使わないでください。スタイルが崩れますし、あまりうまく目立ちません。普通は見出しではなくセクションの中身にアンカーテキストを記述します。以下のような文章を使って下さい:
詳しくは関連記事を参照してください。
同じく、HTML や wiki のマークアップコード、あるいはコードをフォーマットするテンプレートを見出しに使わないで下さい。ヘルプ:スタイル/書式と記号も参照。

フォーマット

コードのフォーマット

  • 短いコード・ファイル名・パス・設定項目・変数・他のケースなどのインラインで表示したいものは テンプレート:ic を使います。例:
    コンソールで sh ./hello_world.sh を実行してください。
  • (コマンドラインの入出力するコードやファイルの中身など) コードが一行で適切なフレームを付ける場合、半角スペースを前に付けます。ヘルプ:編集#コードを見てください。例:
$ sh ./hello_world.sh

Hello World
  • 複数行のコード (コマンドラインの入出力やファイルの中身) に適切なフレームを付ける場合、テンプレート:bc を使います。例:
#!/bin/sh

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

# Demo
echo "Hello World"
  • 設定ファイルのようなコードブロックについては、読者を関連のある行に集中させ、それ以外の周囲の無関連な内容を省略する (...) ことを考えてください。
  • 詳しくはヘルプ:テンプレートを見てください。= や | などテンプレートを破壊する文字の対処法についても載っています。

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

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

キーボードキー

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

ノート・警告・ヒント

  • ノートは、当然のこととして期待するようなことが、ユーザー毎に異なる恐れがある記事中の箇所で情報を示すのに使います。これは、特に、使わなければ記事の本筋から少々外れてしまうと考えられるものに関する詳細な情報を示すのにも使います。もう1つの例として、パッケージ名の変更のような一時的なアナウンスを告知する必要がある場合が挙げられます。
ノートは、重要であるけれど主題の領域に関してよく知らない場合に見落としやすい情報を目立たせるのに使うこともできます。
  • 警告は、説明された手順によって元に戻すことがかなり難しくなったり、システムにダメージを与えてしまうような深刻な結果をもたらしてしまう可能性がある箇所で使用します。通常、警告は起こりうる最悪のケースが発生するような、またはそれを避けるような状態だけではなく、そのようなケースのシナリオの両方を示します。
基本的には警告を多用しないでください: 警告を使用するべきかわからないときは多くの場合ノートを使ったほうがよいです。
  • ヒントは、役に立ち、誰かのメリットになるような方法や手順を示すときに使います。これは扱っている操作を完了させるには必要がないため無視しても問題ありません。
  • 2つ以上のノート、警告またはヒントを記事の同じ箇所に連続して表示する必要がある場合、1つのテンプレート中のリストにテキストをまとめてください。それらの内容に関連性が全くない限りはテンプレートを積み重ねないでください。例:
ヒント:
  • ヒント例 #1.
  • ヒント例 #2.

表

構文については mw:Help:Tables を参照してください。

  • 表は一般的に wikitable クラスが付けられる必要があります。
  • 比較の表は追加で sortable クラスが付けられる必要があります。
  • 適切であれば表の見出しやテーブルセルテンプレートを使ってください。
  • 表の見出しは先頭が大文字である必要があります。
  • 表の凡例は定義リストを使い、表より前に配置する必要があります。

手順の記述

ファイル編集の記述

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

パッケージ管理の記述

公式パッケージ
  • 公式パッケージのインストールの説明に pacman のコマンド例を挙げないでください: この規則は、シンプルであるために (すべての Arch ユーザは、pacman の記事内容を知っておくべきです)、そして pacman -Sy package のようなコマンドで起こりうるエラーや、pacman -S package か pacman -Syu package のどちらを選ぶかのような、起こるかもしれない終わりのない議論を避けるために作られました。そのため、pacman のフロントエンドやラッパーの使用を提案してはいけません。
代わりに、以下のような記述を使ってください:
foobar パッケージをインストールしてください。
もしくは、アプリケーションの名前がパッケージの名前と異なっている場合:
MyApplication は my-app-pkg パッケージでインストールできます。
複数のパッケージをインストールするように書きたいときは以下のようになります:
foobar1, foobar2, foobar3 パッケージをインストールしてください。
パッケージグループを参照するときは以下を使用:
foobar グループをインストールしてください。
記事に合わせて言い回しを変えても構いません。
  • 言及したパッケージのリンクは必ず貼り、テンプレート:Pkg を使ってください。例: {{Pkg|foobar}}。
パッケージグループの参照する場合は、代わりに テンプレート:Grp を使ってください。例: {{Grp|foobar}}。
  • 上記の例ではインストールのリンクを利用しています (例: [[install]]): インストールの指示が初めて出てくるところでは必ずリンクを使うことを推奨します。特に Arch 初心者がアクセスするようなページのときはリンクを絶対に付けてください。
  • メンテナンスを容易にするために、パッケージが core、extra、または community リポジトリでホストされている場合はそのリポジトリを参照しないでください。パッケージが別のリポジトリに移されるのはよくあることです。ただし、そのパッケージがデフォルトでは有効化されていない公式リポジトリ (multilib、testing など) でホストされている場合は、以下のようにして言及する必要があります:
foobar パッケージを公式の multilib リポジトリからインストールしてください。
AUR パッケージ
  • AUR パッケージのインストール手順の例は挙げないでください。公式の手順を説明したり、AUR ヘルパーについて述べたりしないでください。非公式パッケージをインストールしようとする全てのユーザーは事前に Arch User Repository に目を通しておき、システムで起こりうるあらゆる結果を把握しておいてください。
代わりに、以下のように簡潔に述べてください:
foobarAUR パッケージをインストールします。
記事に合わせて言い回しを変えても構いません。より多くの例については#公式パッケージを見てください。
  • 言及したパッケージのリンクは必ず貼り、テンプレート:AUR を使ってください。例: {{AUR|foobar}}。
非公式リポジトリ
  • ビルド済みのパッケージをインストールするために非公式リポジトリの使用を提案するときは、リポジトリを有効化する方法を書かないでください。そのリポジトリが非公式ユーザーリポジトリにかかれていることを確認してページヘのリンクを張ってください。また、公式パッケージと同様に、pacman コマンドの例は不要です。例:
example リポジトリから foobar パッケージをインストールしてください。
パッケージが AUR からもインストールできる場合:
foobarAUR パッケージをインストールしてください。このパッケージは example リポジトリからインストールすることもできます。
パッケージが AUR とは違う名前で存在している場合:
aurpkgAUR パッケージをインストールしてください。example リポジトリの builtpackage でもインストールできます。
記事に合わせて言い回しを変えても構いません。
  • 非公式ユーザーリポジトリへのリンクは絶対で、適切なリポジトリセクションにリンクしてください。例: [[Unofficial user repositories#example|example]]。

systemd ユニットの操作

  • systemctl を用いた systemd ユニットの有効化、起動、またはその他の基本的操作の例は挙げないでください。代わりに関連するユニットを挙げて簡潔に説明してください。他のユニットとの依存関係または競合、そして行うべき操作についての説明が必要な場合は述べてください。
ブート時に GDM を起動させるには、gdm.service を有効化してください。例:
または、ユニットがインスタンス化する必要があるテンプレートである場合:
無線インターフェイスの netctl プロファイルを自動的に切り替えるようにするには、インターフェイスの名前を指定して netctl-auto@.service のインスタンスを有効化してください。例: netctl-auto@wlan0.service。
記事に合わせて言い回しを変えても構いません。
systemd#ユニットを使う の記事セクションへのリンクを直接、または [[開始]] や [[有効化]]、 [[停止]] のような専用のリダイレクト を通して必ず貼ってください。

シェル

  • 本当に必要でない限りはユーザーのシェルとして特定のシェル (例: Bash) の使用を前提としないでください: 記事を書いたり編集する場合は可能な限りどのシェルでも実行できるようにしてください。

ハイパーテキスト

内部・wiki 間・外部 wiki へのリンクの構文は ヘルプ:編集#リンク を参照してください。

  • 書いた記事を、テキスト中に様々なキーワードを用いて可能な限り多くの他の記事に内部リンクしてください。
  • 新しい記事へのリンクは記事作成後にしてください。リンク切れを見つけたら、修正してください。リンク切れと思われる外部リンクは テンプレート:Dead link を付けてください。
  • できる限り間接的なリンクはしないでください。例えば、"詳しくはここを見てください" ではなく "詳しくは systemd の記事を見てください" のように指示します。

リンクは以下の2つの方法で使うことができます。

  • トピックの参照 として、リンクが用語・文章の一部で、文法の影響を受けやすい場合は、必要であればリンクにラベルを付けてください。wiki 内部/wiki 間リンクは、リダイレクトがあればそれにリンクしてください。
  • ページ/セクションの参照 としてであれば、リンクのラベルを使わないでください。また、テンプレート:Lowercase title が使われているときにはそれに従ってタイトルを表記してください。特に、同じページのセクションにリンクするときは # 記号を隠さないでください。悪い例: [[#ハイパーテキスト|ハイパーテキスト]]。

以下の例を見てください。

トピックの参照 ページ/セクションの参照
SSH エージェント を使うと認証を高速化できます 認証を高速化するには SSH 鍵#SSH エージェント を参照してください
サブピクセルレンダリング はほとんどのモニターでサポートされています フォント設定#サブピクセルレンダリング に記載されている方法でサブピクセルレンダリングを有効化してください
initramfs の中に キーファイル を含めてください dm-crypt/デバイスの暗号化#キーファイル に手順があります
マウスキー は標準で無効化されていることに気を付けてください 詳細は Wikipedia:Mouse keys を参照してください
リンクに適用される スタイルルール があります #ハイパーテキスト セクションにはリンクに適用されるスタイルルールがあります
  • 記事に具体的な処理を書いたり特別なことを述べる前に、それらを詳細に扱った記事が既に存在していないか常に確認してください: 存在する場合は内容を重複させずにその記事にリンクしてください。さらに:
    • 専門用語で ArchWiki の記事でカバーされていないものは、Wikipedia の関連するページにリンクしてください。
    • 記事の主題がアップストリームのドキュメントによく書かれ維持されている場合はArch 特有の対応だけを記述し、一般的な情報については公式ドキュメントにリンクしてください。
良い例: "カーネルパラメータ は起動時に システムコール を発行するために使われます。完全なリストは Linux カーネルドキュメント を参照してください。"
一般に、ヘルプ:読み方#編成 との一貫性を保ってください。
  • 稀なケースを除いて記事を行き止まりページ (他のどの記事にもリンクしていない記事) や孤児ページ (他のどの記事からもリンクされていない記事) のままにしないでください。
  • 編集中の記事と同じ言語でローカライズされたページヘのリンクには、特別:リンク元ページに表示されなくなってしまうので、wiki 間リンクを使わないでください。例えば、ハンガリー語の記事では [[Main page (Magyar)]] を使うのが正しく、 [[:hu:Main page]] を使うのは誤っています。
    分離された wiki が将来作られたときに、記事をその wiki に移動させやすくするため、代わりにこの種のリンクを他言語間に使うのは容認されています。
    最後に、この種のリンクと #言語間リンク との違いについて言及しますが、言語間リンクには最初にコロンが付きません。
  • 短い "w:" 接頭辞よりも "Wikipedia:" wiki 間接頭辞を推奨します。

Man ページ

コーディングスタイル

  • コマンドやスクリプトを追加するときは記事全体を通して一貫したコーディングスタイルを用いてください。特に、他に関連のある記事がある場合はその記事にもこれが当てはまります。使用する言語の公式または最も一般的なコーディングスタイルのガイドラインが利用可能であれば、それを順守してください。
  • 使用するプログラミング/スクリプト言語の非推奨な機能は使わないでください。例: シェルのコマンド置換には、バックティック/グレイヴ (``) 構文は使わず、$() 構文を使ってください。
  • スクリプトは可能な限り最も明確な方法で、必須のタスクを実行するために最小限必要なことのみを記述してください。スクリプトは柔軟性や拡張性を考えてデザインされるべきではありません。実際の変数よりも 疑似変数 を使うことが推奨されます。引数の処理や出力のフォーマットといった関係のない処理を追加しないでください。
  • スクリプトはページ内のテキストの冗長な説明が十分に明確で正確にならないときに、主に教育的目的で追加されるべきです。スクリプトは、例えば複雑なコマンドがどのように使われることを意図しているか示したり、関連する・相互に依存するコマンドがどのように組み合わされるかを示すために便利です。
  • スクリプトがページに価値を追加すると思われるが、上記に合致しない場合、外部にリンクすることができます。gist に公開するとよいでしょう。
  • ディレクトリの名前やパスを表現する場合、スラッシュで終わらせるか、明示的に "ディレクトリ" や "フォルダ" といった言葉を付けてください。例:
  • 良い例: "/sys/firmware/efi ディレクトリがあるか確認してください"、悪い例: "/sys/firmware/efi があるか確認してください"
  • 良い例: "/etc/modules-load.d/ に .conf ファイルを配置してください"、悪い例: "/etc/modules-load.d に .conf ファイルを配置してください"
  • スペースを含む引数は二重引用符で囲む必要があります。良い例: cd "foo bar"、悪い例: cd foo\ bar

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

  • core リポジトリにある最新の linux-lts パッケージと最新のインストールメディアのうち、低いほうのバージョン以上のカーネルバージョンに関わるあらゆるノートや対応は削除してはいけません。

適切ではない記述

  • 記事に署名したり、記事の著者のクレジットを付けないでください: ArchWiki はこのコミュニティの成果物であり、それぞれの記事の編集履歴に貢献者のクレジットがしっかりと記されています。
    ただし、記事を書くのに用いたソースを報告するのは、よいプラクティスといえます: このために参照セクションを使うことができます。
  • 通常のユーザーのファイルアップロードは無効化されており、記事に既存の画像を含めるのは許可されていません: 代替手段として外部の画像やギャラリーへのリンクを貼ることができ、シンプルな図表が要る場合は Asciiflow のような ASCII エディタや テンプレート:Text art を使うこともできます。論拠:
    • メンテナンス: Arch はローリングリリースであり、画像を使うと記事の更新が非常に困難になると考えられます。
    • 必要性: Arch は GUI アプリケーションの開発と保守は一切していません。したがって、スクリーンショットを表示する必要性は全くありません。
    • 管理: 自由形式の画像アップロードは、大きすぎたり不適切な画像の削除に時間がとられてしまうと考えられます。
    • アクセシビリティ: 私たちは、低速回線、テキスト専用ブラウザ、読み上げソフト、およびこれらに類似するものを用いるユーザーをサポートします。
    • 効率: 画像はサーバーの帯域と保存スペースを多く消費します。
    • シンプリシティ: テキストのみの記事のほうがシンプルで整って見えます。

スペル

  • 短縮形を使わないでください: "don't"、"isn't"、"you've" などは "do not"、"is not"、"you have" にしてください。
  • 単語の不必要な短縮はしないでください。例: "repo"、"distro"、"config" ではなく "repository"、"distribution"、"configuration" を使います。
    同様に、まれなコマンドラインオプションには、1文字形式のオプションではなく長い形式のものを使ってください。ヘルプ:スタイル/書式と記号#設定パラメータ・変数・オプション・プロパティ等 も参照してください。
  • プロジェクト・アプリケーション・実行ファイル等の名前は、主にそれらの公式ドキュメントのスタイル通りに、特に大文字小文字も含めて正確に記述する必要があります。これは公式ドキュメントが名前を一般名詞のように扱っている場合も含みます。例えば、文の先頭にあるときは先頭を大文字にして、他の場合は小文字の場合です。公式ドキュメントが一貫したスタイルを持たない場合、ArchWiki で既に使われているスタイルに従ってください。ArchWiki に名前が使われていない場合や、ArchWiki でも一貫したスタイルが使われていない場合、スタイルを選択してページ全体で統一してください。可能であれば、名前に言及している他のページも更新してください。Git を例にすると、プロジェクト・ソフトウェアについての一般的なことに言及する場合には大文字で始めて("Git")、コンパイルされたプログラムについて言及する場合は全て小文字で斜体にする("git")こともできます。大文字のルールが議論を呼ぶ場合、明示的にページの議論ページにスタイルを定義してください。ヘルプ:スタイル/書式と記号#実行ファイル/アプリケーションの名前 も参照してください。

言語使用域

  • 記事は、正式でプロらしい簡潔な文体で書いてください。編集確認と校正を行い、文法とスペルの間違いをなくすよう心がけてください。
  • どうやってだけではなくなぜも説明するようにしてください。情報を説明するほうが手順だけを示すより深く知識を伝えることができます。
  • 正確ではっきりした意味をもつ文にするために必要な言葉を省かないでください。例えば、リポジトリ名について言及する場合は、必ずそれにリポジトリを付け加えます。
  • "現在"や"執筆時点で"、"すぐに"のような言葉で、限定されない時間の言及はしないでください。"2015年5月時点で"のような明確な表現で置き換えてください。
  • 客観的に書いてください: 記事に個人的なコメントを含めないでください。それには議論ページを使います。通常は1人称視点で書いてはいけません。
  • 内容を編集する場合、文体はその記事の残りの部分で使われているものに合わせてください。例えば、2人称を使って読者に言葉をかけている場合、追加する内容にもこのスタイルを採用してください。3人称または受動態が記事全体を通して使われている場合も同じようにしてください。
  • さまざまな選択肢 (複数あるソフトウェアや方法など) の中から1つを提案する場合、他の選択肢よりもはっきりと推奨することはしないでください。しかし、それぞれの長所短所を客観的に記述することで、読者が自分に合った最善の判断をする手助けになります。
  • 読者や一般の人を指すときには、they/them のような中性的な代名詞を使うようにしてください。

カテゴリのページ

  • 全てのカテゴリは最低でも一つの親カテゴリの下にカテゴライズされなければなりません。ただし、ルートカテゴリ (カテゴリ:アーカイブ, カテゴリ:目次, カテゴリ:メンテナンス) は例外です。
  • カテゴリは複数のカテゴリにカテゴライズすることができます。ただし、そのカテゴリ同士が親子関係であってはなりません。
  • 循環参照はしないでください: 2つのカテゴリを相互に親カテゴリにすることはできません。
  • カテゴリをそのカテゴリ自身でカテゴライズしないでください (自身にカテゴライズされたカテゴリ)。
  • カテゴリは必ずカテゴリページの一番上に配置してください。
  • カテゴリは、リネームされたときの一時的な場合を除き、リダイレクトしてはいけません。
  • 通常、カテゴリ名は単数形にしてください ("主題"カテゴリ、例えば カテゴリ:シミュレーション)。複数形は、単数形がその中の1つであるとして使える場合に使ってください ("集合"カテゴリ、例えば カテゴリ:ブートローダー)。

リダイレクトのページ

  • 既存のページの略語や文法的な変化形や、より一般的なページのサブセクションにある用語やトピックのためのリダイレクトページを作成することが推奨されます。例えば、ALSA・デーモン一覧・AIGLXなどです。リダイレクトはラベル付きリンクを単純化できます。例えば [[Advanced Linux Sound Architecture|ALSA]]・[[デーモン|デーモン一覧]]・[[Xorg#コンポジット|AIGLX]] といった例と比べてみてください。
  • 転送ページにはリダイレクトのコード以外は含めてはいけません。唯一の例外:
  • リダイレクトは内部の記事に限ります。wiki 間のリダイレクトは作成してはいけません。
言語間リンクを使用するリダイレクトはヘルプ:i18n の決まりにしたがってArchWiki:管理者からの許可が得られた場合にのみ例外的に可能となります。

ユーザーのページ

  • 利用者名前空間にあるページはカテゴライズすることはできません。
  • 利用者名前空間にあるページは、管理者の承認が得られない限り、利用者またはトーク名前空間のページからしかリンクすることはできません。
  • 利用者名前空間にあるページは、他の名前空間からリダイレクトすることができません。

共通ルール

編集内容の要約

ArchWiki:貢献#3つの基本的なルールを見てください。

HTML タグ

  • HTML タグの利用は基本的に推奨されません。できるかぎり wiki のマークアップとテンプレートを使うようにしてください。ヘルプ:編集を参照。
  • <pre>code</pre> を使いたいときは常に {{bc|code}} を使ってください。<tt>text</tt> や <code>text</code> を使いたいときは常に {{ic|text}} を使ってください。
  • 特に HTML コメントは使わないようにしてください (<!-- comment -->): HTML コメントで追加するようなノートは記事の議論ページに投稿してください。
    コメントを書くところには適当な記事の状態テンプレートを追加してください。
  • <br> は必要なときにだけ使ってください: 新しい段落を始めたり改行するには、すぐ下に空行を挿入してください。
    この規則によくある例外として、リストの項目内で改行する必要があるけれどサブ項目が使えない場合や、テンプレート内でリストを使うことができない場合などがあります。
翻訳ステータス: このページは en:Help:Style の翻訳バージョンです。最後の翻訳日は 2022-06-03 です。もし英語版に 変更 があれば、翻訳の同期を手伝うことができます。
「https://wiki.archlinux.jp/index.php?title=ヘルプ:スタイル&oldid=25821」から取得