ヘルプ:編集

提供: ArchWiki
2020年4月22日 (水) 12:15時点におけるNy-a (トーク | 投稿記録)による版 (ヘルプ:スタイル/書式と記号 のリンクを日本語版に変更)
ナビゲーションに移動 検索に移動

関連記事

ArchWiki は MediaWiki で動いています。MediaWiki は PHP によって書かれたフリーソフトウェアの wiki パッケージであり、本来は Wikipedia のためにデザインされました。より細かいヘルプは MediaWiki のヘルプ:コンテンツWikipedia のヘルプ:目次 にあります。

このページは ArchWiki の編集についての簡単なチュートリアルです。ページを編集・作成する前に、ユーザーは、全体的な調子・レイアウト・存在しているページの文体に慣れるようにしてください。wiki 全体の一貫性が保たれるようにする配慮をお願いします。ArchWiki:貢献ヘルプ:スタイルヘルプ:読み方に一般的な文体の決まりごとの概要が書かれています。より詳しくはヘルプ:スタイルを見て下さい。試しに編集するには、サンドボックスを使ってください。wiki マークアップの総覧はヘルプ:チートシートを見て下さい。

アカウントの作成

ArchWiki のページを編集するためには、まずアカウントを作成する必要があります。captcha への回答は、最新の Arch Linux 環境が必要です。Arch Linux を使用していない場合でも自由にアカウントを作成して記事を編集できます。また、質問に答えるために例えば最新のインストールイメージから Arch のライブ環境を起動することができます。

アカウントを作成したら, 特別:ログイン からログインしてください。

編集

ページの編集を始めるには、ページ上部の編集タブをクリックします。又は、各セクションの右にある編集リンクをクリックすることで、ページの特定のセクションを編集することができます。表示される編集ページは、次のように構成されています:

  • 編集ツールバー (任意)
  • 編集ボックス
  • 編集内容の要約ボックス
  • 変更を保存, プレビューを表示, 差分を表示, 取り消しリンク

編集ボックスには現行版のページやセクションの wikitext (サーバーがウェブページを作るための編集可能なソースコード) が入っています。編集するには:

  1. 必要なだけ wikitext を修正します (詳しくは下の #フォーマット を見て下さい)。
  2. 編集内容の要約ボックスに編集の説明を書きます (例: "typo の修正"、"xyz に関する情報の追加" (詳しくは Help:要約欄 を読んで下さい))。
    ノート: 編集には全て要約の記述を付け加えるべきです。要約により他のユーザーによるレビューを楽にします。詳しくは ArchWiki:貢献#3つの基本的なルール を参照してください。
  3. プレビューを表示ボタンを使えば校正や保存する前のフォーマットの確認が楽にできます。
  4. その編集が表面的で議論の余地がない場合は、「細部の編集」ボックスをチェックして、編集を 細部の編集 としてマークしてください。
  5. 変更を保存をクリックして変更を保存します。不満足なら、代わりに取り消しをクリック(もしくは満足いくまで編集を繰り替え)します。
ノート: 記事には署名をつけてはいけません、なぜなら共同の成果物だからです。一人の編集者が他の貢献者をさしおいて自分の名前を冠することは許されません。
ヒント: vim などの外部エディタを使うつもりがないのならば、wikEd を使うことで、MediaWiki の標準エディタを代替して、シンタックスハイライトや正規表現などの機能を使うことができます。この greasemonkey スクリプトは問題なく ArchWiki で動きます。自動化したタスクは常にダブルチェックすることを忘れないでください。

編集の取り消し

ページを誤って編集してしまったときは、以下の作業でページを前の版にさし戻すことができます。ある1つの編集を戻すには:

  1. ページ上部の履歴タブ (編集タブの隣)をクリックします。版の一覧が表示されます。
  2. 問題の編集の右の取り消しリンクをクリックします。編集プレビューが表示され、左側に現在の版、右側に保存される文章が表示されます。
  3. 編集の要約欄に、編集を取り消す理由を書いてください。
  4. 満足したら、ページ下部の変更を保存ボタンをクリックして下さい。

その wiki ページは元の状態に戻ったはずです。

場合によっては、一度に複数の編集を戻す必要があるかもしれません。前の版に記事を戻すには:

  1. ページ上部の履歴タブ (編集タブの隣)をクリックします。版の一覧が表示されます。
  2. 戻したい版(つまり最後の良い版)を見るために適切なタイムスタンプをクリックします。その版が表示されます。
  3. ページの一番上にある編集タブをクリックして下さい。警告が表示されます: このページの古い版を編集しています。
  4. 編集の要約欄に、版のタイムスタンプ(ページの一番上に表示されています)とページの状態を戻す理由を書いてください。
  5. 満足したら、変更を保存ボタンをクリックすればその版に revert されます。
ノート: 取り消しと編集を同時に行わないで下さい! まず編集を戻し、それから追記してください; 版のプレビューを編集してはいけません。

ページの作成

新しいページを作る前に、以下の点を考えて下さい:

  1. あなたのトピックは Arch Linux に関係ありますか? 無関係な、役に立たない記事は削除されるでしょう。
  2. あなたのトピックは他の人にも役に立ちますか? あなたが書きたいことだけでなく、他の人が読みたいことも考えましょう。個人的な事柄はあなたの user ページに。
  3. あなたのトピックは新しいページにする価値がありますか? wiki に似たような記事がないか検索しましょう。もしあったなら、既に存在する記事に追記することを考えてみて下さい。
  4. あなたの貢献は意味をもつでしょうか? 後で拡張するつもりがないスタブを作るのは避けましょう。

新しいページを作るには タイトル と適切な カテゴリ を決める必要があります。

ヘルプ:記事命名ガイドラインヘルプ:スタイル#タイトルに記事の名前をつけるときのアドバイスが書かれています。ページタイトルに "Arch Linux" やその変形を含んではいけません。ここは Arch Linux の wiki です、記事は Arch Linux に関係しているはずです。 (例: Installing Openbox; ダメな例 Installing Openbox in Arch Linux).

目次から適切なカテゴリを選びましょう。1つのページを複数のカテゴリに含めることもできます。

新しいページをあるカテゴリ (例: "新規ページ" を "とあるカテゴリ" へ) に追加するには:

  1. 新しいページを作るために新しいタイトルが入った https://wiki.archlinux.jp/index.php/新規ページ をブラウズします (忘れずに "新規ページ" を新しいタイトルに置き換えて下さい!)
  2. あなたのページの一番上に [[Category:とあるカテゴリ]] を加えます。
ノート: カテゴリがないページを作ってはいけません!全てのページは少なくとも1つのカテゴリに属している必要があります。適切なカテゴリが見つからない場合は、新しいカテゴリを作って下さい。

この段階では、新しいページはまだ孤立しているとみなされます。完了させるには、もう少し時間を取って他のページからのリンクを追加してください。ページがより見つかりやすくなり、より多くのユーザーに貢献してもらうことができます。関連するソフトウェアのページ、より一般的な概要のページ、またはアプリケーション一覧のようなシンプルなリストがリンク元の候補となるでしょう。

いくつかのケースでは代わりにサブページを作った方がよいこともあります。サブページは他のページの子となるページで、タイトルが親のページのタイトルと "/" (スラッシュ)の文字で分離されています。これは自分のユーザーページの子として下書きを準備するときにも便利です。例: https://wiki.archlinux.jp/index.php/特別:利用者ページ/新しいサブページ

フォーマット

テキストのフォーマットは可能な限り wiki のマークアップで行います; HTML を覚える必要はありません。また普遍的なフォーマットのために様々なテンプレートも用意されています。テンプレートについてはヘルプ:テンプレートを見て下さい。ヘルプ:チートシートに一番重要なフォーマットオプションが要約されています。

見出しと小見出し

見出しと小見出しによって記事のまとまりを良くすることができます。別個のトピックが混ざっているなら、それぞれのセクションに見出しをつけて記事を分配できます。詳しい使い方はヘルプ:スタイル#セクションの見出しヘルプ:効果的な見出しを見て下さい。

見出しはセカンドレベルから始めなければいけません。以下のように作ることができます:

==Second-level heading==
===Third-level heading===
====Fourth-level heading====
=====Fifth-level heading=====
======Sixth-level heading======
ノート: ファーストレベルの見出しは使えません、記事のタイトルのために予約されているからです。

記事に4つ以上見出しが存在すると、自動的に目次 (table of contents, TOC) が作られます。これを消すには、__NOTOC__ を加えて下さい。TOC がどうなるかはサンドボックスで試すことができます。

改行

空行によってパラグラフを分けることができます。標準のパラグラフにおいて、ただの改行では意味がありません。

HTML タグ <br> を使って手動で改行することもできますが、できるだけそれは避けましょう。手動での改行は、リストのような他のフォーマットで使うべきです。

wikitext rendering
This sentence
is broken into
three lines.

This sentence is broken into three lines.

This is paragraph number one.

This is paragraph number two.

This is paragraph number one.

This is paragraph number two.

* This point <br> spans multiple lines
* This point
ends the list
  • This point
    spans multiple lines
  • This point

ends the list

改行の使用についてはヘルプ:スタイル/空白を見て下さい。

太字と斜体

太字斜体は、それぞれ2つ・3つのアポストロフィー (') で単語やフレーズを囲むことで表示できます:

wikitext rendering

''斜体''

斜体

'''太字'''

太字

'''''太字かつ斜体'''''

太字かつ斜体

取り消し線

すでに無効・不適切な文章には取り消し線を用います。

wikitext rendering
<s>取り消し文章</s>

取り消し文章

リスト

wiki シンタックスは複数行のリストの項目をサポートしていません。改行の文字はリスト項目の定義を終了します。リスト項目の中で新しい行を始めるには、<br> タグを使ってください。リスト項目の中に複数行のコードブロックを入れるには、 テンプレート:bc を使って、内容は <nowiki> タグでエスケープしてください。en2:Help:Style/White spaceヘルプ:テンプレート も参照してください。

箇条書き

箇条書きでは、項目にはっきりとした順序がありません。

条を加えるには、アスタリスク (*) を使います。複数の * を使えば階層を作れます。

wikitext rendering
* First item 
* Second item 
** Sub-item
* Third item 
  • First item
  • Second item
    • Sub-item
  • Third item

番号付きリスト

番号付きリストはリストの項目に番号をふって順序を作ります。順番に意味がないのならば、普通は順序なしのリストを使って下さい。 番号付きリストを作るには、ナンバーサインかハッシュ記号 (#) を使います。# を複数使えば、階層を作れます。

wikitext rendering
# First item 
# Second item 
## Sub-item
# Third item 
  1. First item
  2. Second item
    1. Sub-item
  3. Third item
# First item
# Second item
#* Sub-item
# Third item
  1. First item
  2. Second item
    • Sub-item
  3. Third item

定義リスト

定義リストは、項目名にセミコロン (;)、それに続く文章にコロン (:) を付けます。

wikitext rendering
Definition lists:
; Keyboard: Input device with buttons or keys
; Mouse: Pointing device for two-dimensional input
or
; Keyboard
: Input device with buttons or keys
; Mouse
: ointing device for two-dimensional input

Definition lists:

Keyboard
Input device with buttons or keys
Mouse
Pointing device for two-dimensional input

or

Keyboard
Input device with buttons or keys
Mouse
Pointing device for two-dimensional input
Use additional colons if a definition has multiple definitions:
; Term
: First definition
: Second definition

Use additional colons if a definition has multiple definitions:

Term
First definition
Second definition

定義リストを単純にフォーマットのために使ってはいけません、W3's examples を見て下さい。

インデント

テキストをインデントするには、行頭にコロン (:) を付けます。コロンをつければつけるほど、テキストが深くインデントされます。行を変えるとインデントは解除されます。

wikitext rendering
This is not indented at all.
:This is indented slightly.
::This is indented more.

This is not indented at all.

This is indented slightly.
This is indented more.
ノート: 望んだレイアウトにするためにどうしても必要なときだけインデントを使ってください。議論ページでは、返信をインデントするために使ってください。ヘルプ:議論を参照してください。

コード

wiki にコードを加えるには、テンプレートのコードフォーマットの一つを使って下さい。または、単純に、それぞれの行の冒頭に半角スペースを一つずつ加えて下さい。例:

 $ echo Hello World

ヘルプ:スタイル#コードのフォーマットも参照してください。

ヒント: 自動的に表を生成するには Mediawiki Tables Generator を参照してください。

効果的に使えば、表はデータをまとめるのに役立ちます。発展的な表の使い方については Wikipedia:ja:Help:表の作り方 を見て下さい。

wikitext rendering
{| class="wikitable"
|+ Tabular data
! Distro !! Color
|-
| Arch || Blue
|-
| Gentoo || Purple
|-
| Ubuntu || Orange
|}
Tabular data
Distro Color
Arch Blue
Gentoo Purple
Ubuntu Orange
{| class="wikitable"
! Filesystem !! Size !! Used !! Avail !! Use% !! Mounted on
|-
| rootfs || 922G || 463G || 413G || 53% || /
|-
| /dev || 1.9G || 0 || 1.9G || 0% || /dev
|}
Filesystem Size Used Avail Use% Mounted on
rootfs 922G 463G 413G 53% /
/dev 1.9G 0 1.9G 0% /dev

リンク

サイトのナビゲーションとしてリンクは読者にとって重要です。一般的に、編集者は全ての記事それぞれに他の記事に出発するリンクを配置するべきです (行き止まりページは作らないようにしてください)。そして他の記事から到着するためのリンクを貼りましょう (リンク元ページでどこからリンクが貼られているか確認できます)。ヘルプ:スタイル/書式と記号#一番目の用例 も参照してください。

内部リンク

内部リンクを使うことで wiki のページを広くクロスリファレンスすることができます。同じ wiki 内の違うページへのリンクを作るには、単純にタイトルを2つの括弧で括って下さい。

例えば、pacman 記事にリンクを貼りたい場合:

[[pacman]]
ノート: リンク先のページが存在しない場合、赤いリンクとして表示されます。ヘルプ:スタイル#ハイパーテキスト に従って回避する必要があります。

記事のタイトルとリンク文字を別にしたいときは、パイプ "|" の後にリンクにつける名前を加えて下さい。

例:

The [[ArchWiki:About|ArchWiki]] is the primary documentation source for Arch Linux.

上のリンクの表示例:

The ArchWiki is the primary documentation source for Arch Linux.
ヒント: パイプ文字、あるいはバーティカルバー("|")は、英語キーボードやそれに似ているレイアウトでは Shift+\ で入力することができます。

リンクに記事タイトルの複数形(などの接尾辞)を使いたい場合、直接、括弧の外側に文字を加えることができます。

例:

makepkg is used in conjunction with [[PKGBUILD]]s.

上のリンクの表示例:

makepkg is used in conjunction with PKGBUILDs.

ページのセクションへのリンク

文章のセクションへのリンクを作るには、セクションの見出しの頭に # を加えて下さい。

例:

[[ヘルプ:編集#ページのセクションへのリンク]]

上のリンクの表示例:

ヘルプ:編集#ページのセクションへのリンク
ヒント: 同じページ内のセクションにリンクする場合、ページ名は省略できます (例: [[#ページのセクションへのリンク]])。

パイプの裏技

いくつかのケースでは、パイプの裏技を使って wiki リンクのラベルの指定を省略することができます。ArchWiki で使用可能な重要なケースは以下の通りです。

  1. ページのタイトルでは、言語の接尾辞を隠すことができます。例えば、[[Main page (Česky)|]]Main page と表示されます。
  2. 異なる名前空間や wiki へのリンクでは、接頭辞を隠すことができます。例えば、[[ArchWiki:About|]]About と、[[wikipedia:Help:Pipe trick|]]Help:Pipe trick と表示されます。

ページが保存されるとき、パイプの裏技はリンクに自動的にラベルを生成して、対応する wikitext を変更します。

言語間リンク

ヘルプ:i18n#言語間リンク を見て下さい。

wiki間リンク

いわゆる wiki間リンク は、Wikipedia などの、外部 Wiki の記事にリンクするために使われます。このリンクを貼るには、wiki の名前の後にコロン、そしてリンクしたい記事、それら全体をふたつの括弧で包みます。

Wikipedia:Arch Linux にリンクしたい場合:

[[Wikipedia:Arch Linux]]

Arch Linux Wikipedia article のようにリンク文字を変えるにはパイプを使います:

[[Wikipedia:Arch Linux|Arch Linux Wikipedia article]]
ノート: パイプリンクは長い URL を略すために使って下さい。

参照: Wikipedia:Interwiki links

ArchWiki で有効なインターウィキのリストは 特別:インターウィキAPI 経由 で確認することができます。

ヒント: デフォルトでは、全ての Wikipedia のページへのインターウィキリンクは英語版へのリンクと解釈されます。他の言語のページへのリンクを作りたい場合は、ページ名の前に言語の接頭辞を付けることができます。例えば、日本語のページへのリンクは ja 接頭辞を付けてください。
[[Wikipedia:ja:Arch Linux]]

Wikipedia:ja:Arch Linux と表示されます。

言語の接頭辞は、対象の wiki の interwiki configuration に依存することに注意してください。全ての wiki で機能するわけではありません。ただし、Wikipedia では機能します。

外部リンク

外部サイトにリンクしたい場合、リンクしたいページの完全な URL を書けば十分です。

http://www.google.com/

URL をそのままリンクにするよりも、他の文字を表示したほうが見やすくなることはよくあります。括弧をつかって、URL の後ろに文字列を加えて下さい(スペースで区切ります(パイプではありません))。Google search engine のようにリンクを表示するには:

[http://www.google.com/ Google search engine]

自動で連番のラベルを生成することも可能です。単に一重の角括弧で URL を囲んでください。これは「ここを参照してください」といった表現よりも好ましいことが多いです。「[1]を参照してください」といった表現(番号はページ内でのリンクの順番によって変わります)のように見せたいときは、単に以下のように入力してください。

[https://www.google.com/]を参照してください
ノート: ArchWiki や Wikipedia のページにリンクする時は、外部リンクではなく #内部リンク#wiki間リンク を使って下さい!つまり、 https://wiki.archlinux.org/ で始まるリンクには内部リンクを使って下さい; http://en.wikipedia.org/ で始まるリンクには wiki間リンクを使って下さい!

リダイレクト

違うページに自動的にリダイレクトさせるには、ページの冒頭に #redirect とリダイレクト先のページへの内部リンクを加えて下さい。

例えば、"Penguins" から "Penguin" にリダイレクトさせたい場合:

#redirect [[Penguin]]

これで、検索ボックスからどちらをタイピングした人も "Penguin" に着くようになります。

リダイレクトはリンクが作られた理由を追跡することもできます。例えばリンクをリンク元ページにまとめて、セクション名が変更されたときにそのリンクをすばやく更新することができます。リダイレクトの欠点は、ブラウザに完全なリンク先を表示しないことです。

リダイレクトを作る前に、既存の同じようなリダイレクトを探すことができます。例: Xorg

ヘルプ:スタイル#リダイレクトのページヘルプ:操作手順#ページをリダイレクトした後の議論ページの扱い も参照してください。

ノート:

Wiki 変数・マジックワード・テンプレート

MediaWiki は記事内の特定の文字列を認識して標準の振る舞いを変更します。例えば、__NOTOC__ を記事に加えると目次が作られなくなります。同じように、__TOC__ は目次を表示する位置を変えるのに使われます。詳しくは ヘルプ:マジックワード を見て下さい。

テンプレートと変数は wikitext の一部として事前に定義されていてフォーマットされたコンテンツを表示するのに記事に挿入されます。

変数はシステムによって定義され、現在のページ・wiki・日付についての情報を表示するのに使われます。例えば、{{SITENAME}} を使うと wiki のサイト名を表示します(この wiki では: ArchWiki)。現在のページに他のタイトルヘッダを設定するには、他の wiki 変数を使います: {{DISPLAYTITLE:New Title}} (しかし、その使用はかなり制限されています。大文字・小文字・アンダースコアを変更したい時だけ使用するようにしてください。標準化されたタイトルは実際のページの名前と一致していなければなりません。一致していなければ機能しません。タイトルの始めの文字を小文字で表示するには、{{Lowercase title}} テンプレートを使ってください。)

一方、テンプレートは、ユーザによって定義されます。どのページでも、{{名前空間:ページ名}} を加えることで他のページを記事内に含めることができます。ただし Template 名前空間の外のページを使うのは稀です(名前空間が省かれる場合、テンプレート を使います)。例えば、テンプレート:Note は記事内で次の wikitext によって用いられ:

{{Note|This is a note.}}

このように表示されます:

ノート: This is a note.

詳しくはヘルプ:テンプレートを見て下さい。テンプレート:Tipテンプレート:Warning といった利用可能なテンプレートのリストがあります。