「ヘルプ:編集」の版間の差分
(→ページの作成) |
Kusanaginoturugi (トーク | 投稿記録) (→コード: 例を▽ついか) |
||
| 298行目: | 298行目: | ||
===コード=== |
===コード=== |
||
| − | wiki にコードを加えるには、[[ヘルプ:テンプレート#テンプレートのコードフォーマット|テンプレートのコードフォーマット]]の一つを使って下さい。または、単純に、それぞれの行の冒頭に半角スペースを一つずつ加えて下さい。ただしその場合は文章は画面に適して自動では包まれ''ないので''注意してください。 |
+ | wiki にコードを加えるには、[[ヘルプ:テンプレート#テンプレートのコードフォーマット|テンプレートのコードフォーマット]]の一つを使って下さい。または、単純に、それぞれの行の冒頭に半角スペースを一つずつ加えて下さい。ただしその場合は文章は画面に適して自動では包まれ''ないので''注意してください。例： |
| + | <span style="border:1px dashed #a9abb0;"> </span>$ echo Hello World |
||
| + | |||
| + | [[Help:Style#Code formatting]] も参照してください。 |
||
===表=== |
===表=== |
||
2016年1月15日 (金) 08:29時点における版
ArchWiki は MediaWiki で動いています。MediaWiki は PHP によって書かれたフリーソフトウェアの wiki パッケージであり、本来は Wikipedia のためにデザインされました。このページは ArchWiki の編集についての簡単なチュートリアルです。より細かいヘルプは Help:Contents on MediaWiki や Help:Contents on Wikipedia にあります。
ページを編集するにはログインする必要があります。Special:UserLogin からアカウントを作成・ログインしてください。編集の練習は、サンドボックスを使って下さい。wiki マークアップの総覧はヘルプ:チートシートを見て下さい。wiki のタスクについては、ArchWiki:貢献 を見て下さい。
ページを編集・作成する前に、ユーザーは、全体的な調子・レイアウト・存在しているページの文体に慣れるようにしてください。wiki 全体の一貫性が保たれるようにする配慮をお願いします。ヘルプ:読み方に一般的な文体の決まりごとの概要が書かれています。より詳しくはヘルプ:スタイルを見て下さい。
目次
編集
ページの編集を始めるには、ページ上部の edit タブをクリックします。又は、毎セクションの右にある edit リンクをクリックすることで、ページの特定のセクションを編集することができます。表示される Editing ページは、次のように構成されています:
- 編集ツールバー (optional)
- 編集ボックス
- 編集内容の要約ボックス
- Save page, Show preview, Show changes, と Cancel リンク
編集ボックスには現行版のページやセクションの wikitext (サーバーがウェブページを作るための編集可能なソースコード) が入っています。編集するには:
- 必要なだけ wikitext を修正します (詳しくは下の #フォーマット を見て下さい)。
- 編集内容の要約ボックスに編集の説明を書きます （例: "typo の修正"、"xyz に関する情報の追加" (詳しくは Help:Edit summary を読んで下さい))。
- Show preview ボタンを使えば校正や保存する前のフォーマットの確認が楽にできます。
- その編集が表面的で議論の余地がない場合は、This is a minor edit ボックスをチェックして、編集を minor としてマークしてください。
- Save page をクリックして変更を保存します。不満足なら、代わりに Cancel をクリック（もしくは満足いくまで編集を繰り替え）します。
編集の取り消し
ページを誤って編集していまったときは、以下の作業でページを前の版にさし戻すことができます。ある１つの編集を戻すには:
- ページ上部の history タブ （edit タブの隣）をクリックします。版の一覧が表示されます。
- 問題の編集の右の undo リンクをクリックします。編集プレビューが表示され、左側に現在の版、右側に保存される文章が表示されます。
- 満足したら、ページ下部の Save page ボタンをクリックして下さい。
その wiki ページの状態がオリジナルに戻ったでしょうか。
場合によっては、一度に複数の編集を戻す必要があるかもしれません。前の版に記事を戻すには:
- ページ上部の history タブ （edit タブの隣）をクリックします。版の一覧が表示されます。
- 戻したい版（つまり最後の良い版）を見るために適切なタイムスタンプをクリックします。その版が表示されます。
- 満足したら、ページの一番上にある edit タブをクリックして下さい。警告が表示されます: このページの古い版を編集しています。 Save page ボタンをクリックすればその版に revert されます。
ページの作成
新しいページを作る前に、以下の点を考えて下さい:
- あなたのトピックは Arch Linux に関係ありますか？ 無関係な、役に立たない記事は削除されるでしょう。
- あなたのトピックは他の人にも役に立ちますか？ あなたが書きたいことだけでなく、他の人が読みたいことも考えましょう。個人的な事柄はあなたの user ページに。
- あなたのトピックは新しいページにする価値がありますか？ wiki に似たような記事がないか検索しましょう。もしあったなら、既に存在する記事に追記することを考えてみて下さい。
- あなたの貢献は意味をもつでしょうか？ 後で拡張するつもりがないスタブを作るのは避けましょう。
新しいページを作るには タイトル と適切な カテゴリ を決める必要があります。
ヘルプ:記事命名ガイドラインに記事の名前をつけるときのアドバイスが書かれています。
- タイトルには大文字を適切に使って下さい: Title for New Page; ダメな例 Title for new page.
- ページタイトルに "Arch Linux" やその変形を含んではいけません。ここは Arch Linux の wiki です、記事は Arch Linux に関係しているはずです。 (例: Installing Openbox; ダメな例 Installing Openbox in Arch Linux).
目次から適切なカテゴリを選びましょう。１つのページを複数のカテゴリに含めることもできます。
新しいページをあるカテゴリ (例: "My New Page" を "Some Category" へ) に追加するには:
- 新しいページを作るために新しいタイトルが入った https://wiki.archlinuxjp.org/index.php/My_New_Page をブラウズします (忘れずに "My_New_Page" を新しいタイトルに置き換えて下さい！)
- あなたのページの一番上に
[[Category:Some Category]]を加えます。
フォーマット
テキストのフォーマットは可能な限り wiki のマークアップで行います; HTML を覚える必要はありません。また普遍的なフォーマットのために様々なテンプレートも用意されています。テンプレートについてはヘルプ:テンプレートを見て下さい。ヘルプ:チートシートに一番重要なフォーマットオプションが要約されています。
見出しと小見出し
見出しと小見出しによって記事のまとまりを良くすることができます。別個のトピックが混ざっているなら、それぞれのセクションに見出しをつけて記事を分配できます。詳しい使い方はヘルプ:スタイル#セクションの見出しやヘルプ:効果的な見出しを見て下さい。
見出しはセカンドレベルから使うことができます:
==Second-level heading== ===Third-level heading=== ====Fourth-level heading==== =====Fifth-level heading===== ======Sixth-level heading======
記事に４つ以上見出しが存在すると、自動的に目次 (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 |
ends the list |
改行の使用についてはヘルプ:スタイル/空白を見て下さい。
太字と斜体
太字と斜体は、それぞれ２つ・３つのアポストロフィー (') で単語やフレーズを囲むことで表示できます:
| wikitext | rendering |
|---|---|
|
|
斜体 |
|
|
太字 |
|
|
太字かつ斜体 |
取り消し線
すでに無効・不適切な文章には取り消し線を用います。
| wikitext | rendering |
|---|---|
<s>取り消し文章</s> |
|
インデント
テキストをインデントするには、行頭にコロン (:) を付けます。コロンをつければつけるほど、テキストが深くインデントされます。行を変えるとインデントは解除されます。
| wikitext | rendering |
|---|---|
This is not indented at all. :This is indented slightly. ::This is indented more. |
This is not indented at all.
|
リスト
箇条書き
箇条書きでは、項目にはっきりとした順序がありません。条を加えるには、アスタリスク (*) を使います。複数の * を使えば階層を作れます。
| wikitext | rendering |
|---|---|
* First item * Second item ** Sub-item * Third item |
|
番号付きリスト
番号付きリストはリストの項目に番号をふって順序を作ります。順番に意味がないのならば、普通は順序なしのリストを使って下さい。
番号付きリストを作るには、ナンバーサインかハッシュ記号 (#) を使います。# を複数使えば、階層を作れます。
| wikitext | rendering |
|---|---|
# First item # Second item ## Sub-item # Third item |
|
# First item # Second item #* Sub-item # 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:
or
|
Use additional colons if a definition has multiple definitions: ; Term : First definition : Second definition |
Use additional colons if a definition has multiple definitions:
|
定義リストを単純にフォーマットのために使ってはいけません、W3's examples を見て下さい。
コード
wiki にコードを加えるには、テンプレートのコードフォーマットの一つを使って下さい。または、単純に、それぞれの行の冒頭に半角スペースを一つずつ加えて下さい。ただしその場合は文章は画面に適して自動では包まれないので注意してください。例： $ echo Hello World
Help:Style#Code formatting も参照してください。
表
効果的に使えば、表はデータをまとめるのに役立ちます。発展的な表の使い方については Help:Table を見て下さい。
| wikitext | rendering | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{| border="1"
|+ Tabular data
! Distro !! Color
|-
| Arch || Blue
|-
| Gentoo || Purple
|-
| Ubuntu || Orange
|}
|
| ||||||||||||||||||
{| class="wikitable" border="1" cellpadding="5" cellspacing="0"
! Filesystem !! Size !! Used !! Avail !! Use% !! Mounted on
|-
| rootfs || 922G || 463G || 413G || 53% || /
|-
| /dev || 1.9G || 0 || 1.9G || 0% || /dev
|}
|
|
リンク
サイトのナビゲーションとしてリンクは読者にとって重要です。一般的に、編集者は全ての記事それぞれに他の記事に出発するリンクを配置するべきです (dead-end pages を避ける)。そして他の記事から到着するためのリンクを貼りましょう (リンク元ページでどこからリンクが貼られているか確認できます)。
内部リンク
内部リンクを使うことで wiki のページを広くクロスリファレンスすることができます。存在するページはもちろん、将来作られるであろうページにもリンクを貼ることができます。
同じ wiki 内の違うページへのリンクを作るには、単純にタイトルを２つの括弧で括って下さい。
例えば、pacman 記事にリンクを貼りたい場合:
[[pacman]]
記事のタイトルとリンク文字を別にしたいときは、パイプ "|" の後にリンクにつける名前を加えて下さい (Shift + \ on English-layout and similar keyboards)。
例:
View [[Arch Linux|this]] article...
上のリンクの表示例:
- View this article...
リンクに記事タイトルの複数形（などの接尾辞）を使いたい場合、直接、括弧の外側に文字を加えることができます。
例:
makepkg is used in conjunction with [[PKGBUILD]]s.
上のリンクの表示例:
- makepkg is used in conjunction with PKGBUILDs.
ページのセクションへのリンク
文章のセクションへのリンクを作るには、セクションの見出しの頭に # を加えて下さい。
例:
[[ヘルプ:編集#ページのセクションへのリンク]]
上のリンクの表示例:
言語間リンク
ヘルプ:i18n#言語間リンク を見て下さい。
wiki間リンク
いわゆる wiki間リンク は、Wikipedia などの、外部 Wiki の記事にリンクするために使われます。このリンクを貼るには、wiki の名前の後にコロン、そしてリンクしたい記事、それら全体をふたつの括弧で包みます。
Wikipedia:Arch Linux にリンクしたい場合:
[[Wikipedia:Arch Linux]]
Arch Linux Wikipedia article のようにリンク文字を変えるにはパイプを使います:
[[Wikipedia:Arch Linux|Arch Linux Wikipedia article]]
See: Wikipedia:InterWikimedia links
外部リンク
外部サイトにリンクしたい場合、リンクしたいページの完全な URL を書けば十分です。
http://www.google.com/
URL をそのままリンクにするよりも、他の文字を表示したほうが見やすくなることはよくあります。括弧をつかって、URL の後ろに文字列を加えて下さい（スペースで区切ります(パイプではありません)）。Google search engine のようにリンクを表示するには:
[http://www.google.com/ Google search engine]
リダイレクト
違うページに自動的にリダイレクトさせるには、ページの冒頭に #REDIRECT とリダイレクト先のページへの内部リンクを加えて下さい。
例えば、"Cats" から "Cat" にリダイレクトさせたい場合:
#REDIRECT [[Cat]]
これで、検索ボックスからどちらをタイピングした人も "Cat" に着くようになります。
リダイレクトページのコンテンツは表示されません。しかし、カテゴリタグは機能するので、リダイレクトをカテゴリに含めることはできます。
Wiki 変数・マジックワード・テンプレート
MediaWiki は記事内の特定の文字列を認識して標準の振る舞いを変更します。例えば、__NOTOC__ を記事に加えると目次が作られなくなります。同じように、__TOC__ は目次を表示する位置を変えるのに使われます。詳しくは Help:Magic words を見て下さい。
テンプレートと変数は wikitext の一部として事前に定義されていてフォーマットされたコンテンツを表示するのに記事に挿入されます。
変数はシステムによって定義され、現在のページ・wiki・日付についての情報を表示するのに使われます。例えば、{{SITENAME}} を使うと wiki のサイト名を表示します（この wiki では: ArchWiki）。現在のページに他のタイトルヘッダを設定するには、他の wiki 変数を使います: {{DISPLAYTITLE:New Title}} (使用は大文字・小文字の変化をしたい時だけにしてください)。
一方、テンプレートは、ユーザによって定義されます。どのページでも、{{Namespace:Page Name}} を加えることで他のページを記事内に含めることができます。ただし Template 名前空間の外のページを使うのは稀です（名前空間が省かれる場合、Template を使います）。例えば、テンプレート:Note は記事内で次の wikitext によって用いられ:
{{Note|This is a note.}}
このように表示されます:
詳しくはヘルプ:テンプレートを見て下さい。
議論ページ
議論 ("talk") ページは他の ArchWiki ユーザーと連絡をするためのページです。
ページを議論するには、そのページに行って、ページ上部の "discussion" タブをクリックしてください。ページの最後に新しいコメントを加えるか、他のコメントに返信をすることができます。あなたの議論をフォーマットするためにインデントを使って下さい。標準的な慣習として、あなたの返信は返信先の人より１段インデントしてください。さらに、他の人がやっているように、コメントは返信するコメントの下に加えて下さい。
~~~~ でユーザー名とタイムスタンプを加えてコメントに署名をしましょう。他のユーザーのコメントを編集してはいけません。
サンドボックスの議論ページで実験することができます。
ユーザートークページ
ユーザーページとユーザートークページには違いがあります。全てのユーザーがユーザートークページを持ち、他の人がパブリックメッセージを残すことができます。トークページがあるユーザーになかった場合、あなたはコメントを残すためにページを作ることができます。誰かがあなたにメッセージを書いた時は、あなたは "You have new messages" の記述とあなたのユーザートークページへのリンクを見ることになるでしょう: この場合、あなたはメッセージに対して、適切なインデントを加えて、トークページに返信をするべきだと思います。別のトークページでの議論に返信することは避けてください、そのようにすると論題についての連絡したユーザーが持つ情報の流れを遮断してしまうことになります。
許可無く他人のユーザーページ (i.e. [[User:Name]]) を編集してはいけません;それらはパーソナルスペースとして提供されているからです。連絡をとるには"ユーザートークページ"を使って下さい（メールアドレスが記載されているならばEメールを送ることもできますが）。