レクチャー - wiki編集のすすめ

wiki編集の『レクチャー』ページです　
このページのソースを見る
参考ページ： @wikiプラグイン一覧 ， wikiの編集例

目次

目次を開く

目次を閉じる

---

Section 0　『wikiの最低限の知識』

@wikiの編集は、原則ほとんど知識は必要なくワープロ感覚で編集できます。改行も自動改行なので安心です。
高度な編集では、行頭に記号を入れたり、#や&で始まる独自の記法(プラグイン)を用いたりします。
ただし、さまざまな環境の人がいたり、追記で編集する人のことを考えると、「シンプルで済むならそれに越したことはない」ということを心に留めておきましょう。

---

Section 1　『基本的なwikiを作るために必要な知識』

情報を集める目的のwikiには、この内容だけ使用できれば十分です。

見出し

wikiの基本構造として、複数のページにそれぞれ項目を作るのが一般的です。
項目分けする際には見出しを使います。
行頭に「*」(半角アスタリスク)を1つ以上付けることで実装できます。

*見出し1（大見出し）
**見出し2（中見出し）
***見出し3（小見出し）

見出し1（大見出し）

見出し2（中見出し）

見出し3（小見出し）

目次機能

#contentsプラグインを使うと、ページ内のすべての見出しを階層構造で書き出し、ページ内リンクができます。

#contents()

リスト

見出しを補助する機能として、番号あり／なしリストがあります。
行頭に「-」(半角ハイフン)で番号なしリスト、「+」(半角プラス)で番号ありリストが実装できます。

-番号なしリスト1
-番号なしリスト2
-番号なしリスト3

• 番号なしリスト1
• 番号なしリスト2
• 番号なしリスト3

番号なしリストは、単純な列挙に向いています。

+番号ありリスト1
+番号ありリスト2
+番号ありリスト3

1. 番号ありリスト1
2. 番号ありリスト2
3. 番号ありリスト3

番号ありリストは、手順のように番号を付けたいときに有効です。
ただし、番号ありリストは途中に空行や無駄行があるときは番号がリセットされてしまいます。ご注意ください。

---

Section 2　『wikiを見やすく整形するための知識』

水平線

行頭から「-」(半角ハイフン)のみを4つ以上書くと水平線を引けます。
区切りを付けたいときに使います。

----
サンプル　サンプル　サンプル　サンプル　サンプル
----

---

サンプル　サンプル　サンプル　サンプル　サンプル

---

引用文・整形済み文

行頭に「>」(半角大なり)を入力すると引用文として処理されます。

>引用文だと、
>このように表示されます。

引用文だと、
このように表示されます。

行頭に「 」(半角スペース)を入力すると、整形済み文として処理されます。
wikiの構文が無効、長い文の自動改行の無効などの特徴があります。
ただし、あまりにも長い文は途中で途切れてしまうことがあるので注意が必要です。

 整形済み文だと、
 このように表示されます。

整形済み文だと、
このように表示されます。

表組み(基礎)

行頭から「|」(半角縦線)で項目を区切ることで、表組みができます。
一覧の表を作る際に大変有効です。多くのwikiで要になることの多い機能です。
長文・セル数・オプションなどで内容が増えると著しく可読性が落ちるので注意してください。

|セル1|セル2|セル3|

セル1

セル2

セル3

複数行の場合は、隣接する行のセル数が一致するときのみ連結します。

|~ヘッダ1|~ヘッダ2|~ヘッダ3|h
|セル1|セル2|セル3|
|セル4|セル5|セル6|
|セル7|セル8|セル9|セル10|

ヘッダ1	ヘッダ2	ヘッダ3
セル1	セル2	セル3
セル4	セル5	セル6

セル7

セル8

セル9

セル10

この例では最後の行だけ連結が外れてしまっています。
ちなみに、セル内で「&br()」と入力すると改行できます。
表組みの詳細（セルの連結や色の設定など）については こちら を参照してください。

---

Section 3　『高度な機能を使うための知識』

高度な機能を使うためには、さまざまなプラグインやオプションを設定する必要があります。
理解しやすいもの・汎用性の高いものを取り上げましたので、高度な機能を使う参考になれば幸いです。

文字装飾・文字配置

文字サイズ、太字(強調)、文字色に背景色など、文字装飾に関するプラグインは多々あります。
入れ子で組み合わせられますが、画面が見づらくならないように注意が必要です。
文字装飾系のプラグインの中でも特に汎用性が高いのは多くのオプションがある&fontプラグインです。
&fontプラグインの書式は「&font(オプション1,オプション2, ... ){テキスト}」でオプションは順不同です。

&font(b){太字}、&font(red){文字色変更}、&font(#0f0,#333333){文字色変更+背景色変更}、&font(150%){文字サイズ変更}
&font(i){斜体}、&font(u){下線}、&font(l){取り消し線}、&font(o){上線}
&font(b,#0f0,#333333,150%,i,u,l,o){すべて複合させたテキスト}

太字、文字色変更、文字色変更+背景色変更、文字サイズ変更
斜体、下線、取り消し線、上線
すべて複合させたテキスト

文字配置には、左寄せ・中央寄せ・右寄せがあります(基本的に行頭からのみ有効)。
それぞれの書式は「#left(){テキスト}」「#center(){テキスト}」「#right(){テキスト}」です。

#center(){中央寄せテキスト}
#right(){右寄せテキスト1
右寄せテキスト2
}

中央寄せテキスト

右寄せテキスト1
右寄せテキスト2

これ以外は、 @wikiプラグイン一覧 か wikiの編集例 を参考にしてください。

リンク

リンクはwikiにおいて基本的かつ重要な要素です。
リンク先も、ページ内、同じwikiの別のページ、一般のURLの3通り考えられます。

ページ内リンク

閲覧しているページ内で一番上へ移動したり項目へ移動したりしたいと思うことはよくあります。
しかし、これは編集が少々複雑・煩雑になる恐れもあり、あまり多用しないことを勧めます。
具体的な方法としては、アンカーの作成(&anchor)とアンカーへ移動(&link_anchor)の2つセットです。

&anchor(sample,option=nolink){ここにアンカーを作成}
&link_anchor(sample){アンカーまで移動}

ここにアンカーを作成
アンカーまで移動

#contentsプラグインが優秀なので、基本的にはこちらを使いましょう。詳しくは プラグイン一覧 を参照してください。

別のページへのリンク（同じwikiの中限定）

書式は「[[リンク先ページ名]]」または「[[表示する文字>リンク先ページ名]]」です。

例：[[トップページ]]または[[最初のページへ飛ぶ>トップページ]]

例：トップページまたは最初のページへ飛ぶ

一般のURLへのリンク

書式は「[[表示する文字>URL]]」です。

例：[[Googleで検索する>https://www.google.co.jp/]]

例： Googleで検索する

ちなみに、「>」を「>>」にすると新規タブで開くようになります。

画像貼り付け

画像や動画用のプラグインも多数存在しますが、オプションも多く動作条件も複雑です。
その中で標準的かつ使用頻度が高いのが&refプラグインです。
URLでもページ内のファイル名でも表示でき、リンクに飛ぶこともできます。
書式は「&ref(ファイル名orURL,ページ名,その他オプション)」です。

例1：&ref(https://img.atwiki.jp/baku_th/pub/photo/gtd_banner_s.jpg,title=@N-Factory HP へジャンプ,http://atn-factory.jp/,blank)
例2：&ref(BANNER.jpg)&ref(BANNER.jpg,,width=50)&ref(紅魔館前.jpg,紅魔館前,height=100)

例1：
例2：

---

Section 4　『その他の有用な情報』

これ以上は編集者それぞれの志向などによってまちまちなので、紹介程度にします。
Section 3までを応用して作ることが第一で、無理に複雑にはしないほうがいいでしょう。

有用なプラグイン一覧

比較的有用なプラグインや使用頻度の高い機能を列挙します。
それぞれ詳しく解説しないので、細かい仕様については各自でご確認ください。

プラグイン/機能	説明
#region/#endregion	複数行を折りたたみまとめることができる。#endregionを忘れると大変！ この辺の機能はDirectXが絡むので重要なところには使わないのが無難 折りたたむ機能はopenclose系、treemanu系もある。違いを見極めて使うべし
表組みの書式	COLORやBGCOLORなどいろいろある。ただでさえ1行当たりが長い表組みが、 さらに長くなるので多用は禁物。表組み全体の装飾なら#table_styleプラグインを利用すること
&anchor/&link_anchor	ページ内にリンク(スクロール)できる wiki内なら他のページのアンカーへも飛べる
#include	他のページをそのまま載せることができる。1つのページを使いまわすことが可能
//(コメントアウト)	行頭にスラッシュを2つ書くとその行はページに反映されない 編集者へのコメントや一時的に機能をOFFにするときなどに使用 上級者向けだが空行を挟まずにブロック要素を分断する用途としても使用できる
comment系	いわゆるコメント欄。何種類かあるがログの保存場所の違いが主 似た機能で投票(#vote)もある
memo系	自由にテキストボックス内を編集できる。ホワイトボード的で使い勝手がいい #memoは簡単実装用。カスタマイズ可能なのが&memox
動画系	プレイ動画などを動画サイトのURLなどを引数にして動画をwiki内で見られる。 プラグイン仕様も複雑かつでさまざまで、動画サイトの仕様が変わったりして 上手く動かないこともあるので過信はできない

自分のやりたいことを実現する方法

@wikiではかなり多くのプラグインを実装しており、ユーザの意見を組み入れて今も新着プラグインとして増え続けている。
しかし、いざある動作を思い浮かべてそれを実現するプラグインを探すとなると、そう上手くいくことは意外と少ない。

知ってる人を探す？

現在さまざまな掲示板や質問サイトがあるが、@wiki関係は盛んでないと言える。
汎用プログラミング言語なら、詳しい説明サイトがあるがこれはそうはいかない。
特定の人に聞いても、特殊なプラグインまで把握してることは少ない。
最良と思われる２つの方法は、

1. すでにある参考になりそうな@wikiを見つけ、編集ページを見て学習
2. プラグイン一覧を熟読（思いがけないところに使えるプラグインがあったりする）

wikiの整理方法の悪さ

理由の一つは、@wiki側の整理の仕方に問題がある。
典型的なのは#opencloseと&openclose2についてだ。

• 表示切り替え(openclose)
• インライン表示切替(openclose2)

—  プラグイン一覧 より引用

隣り合うプラグインすら、統一する姿勢がない。
また例えば掲示板を作りたいときに、「情報を集めるプラグイン」を探し、「その他・未分類のプラグイン」を探した挙句に、「フォームを設置するプラグイン」へたどり着くようなこともある。
全体の分類の仕方も分かりづらく未分類は本当にカオスだ。
欲しいプラグインを探すときは、時に根気よくプラグイン一覧を一つずつ見る覚悟が必要だ。

プラグインの仕様がまちまち

各プラグインは、丸カッコ内のオプションや波カッコ内の内容などの仕様にしばしば差異がある。
それも同じような機能のプラグインでも差があり、上手く作動しない、最悪そのプラグインが使えないということもよくあること。
典型例としては、#table_zebraと#table_sorterのカラーコードの指定方法、#regionと#opencloseの初期開閉状態の指定方法、&videoと&youtubeの表示サイズの指定方法など。
そのほか、sizeなどが何を表しているか、「,http://....」と打つのか「,URL=http://....」なのか、ということも。
対策は、プラグイン一覧のその項目をよく見ることくらいしかない。仕様かもしれない。
よくある例を一つ挙げる。上手くいかないときは仕様をよく確認すること。

失敗例：&ref(BANNER.jpg,width=400,height=40)
成功例：&ref(BANNER.jpg,,width=400,height=40)

失敗例：

#ref error ：ご指定のページがありません。ページ名を確認して再度指定してください。

成功例：

---

このページのソースを見る
もっと詳しく知りたい方は @wikiプラグイン一覧 を参考にしてください。
この他、編集画面の下にもよく使うものの説明がありますし、編集画面のすぐ上のプラグインボタンでは直接書いてくれます(やや使い勝手は悪い)。

---

---