編集方針

概要

当wiki全体の編集・表記方法について、編集談義や運営管理掲示板?等である程度共通認識、合意形成の取れた意見をまとめておくページです。

全体の編集について

現状wikiの更新は有志によって行われており、内容も各々の良心に任せる形です。
自分の編集した箇所が他人によって校正されたり、場合によっては丸々消されたりする事もあるかもしれません。
そのため、「あのページはこう書いているのにこっちのページでは別の書き方になっている」ことも多いです。
初見の方が読みやすい表示になるよう編集者一同心がけておりますが、納得のいかないこと、気になることがあれば編集談義や編集掲示板をご活用ください。

ページの作成・削除

• ページを削除したい場合は、編集からページの内容を全て削除し、ページの更新ボタンを押すことでページの削除が可能です。
• ページ名を間違えて作成した場合は、上記方法でページを削除し、正しいページ名で新規作成することで実質的に名前の変更が可能です。
  • ページの再作成を行わない方法でのページ名の変更には、管理者権限が必要です。
• ページ名を「既存のページ名/子ページ名」のように作成すると、そのページの階層の下に子ページを作成できます。
  • 階層化すると、親ページから相対パスで子ページを参照できます。例：＃include(./子ページ名)。
• ページ名において英字の大文字と小文字は区別されます。特定ページの下位にページを作成する際は特にご注意下さい。
  • 例えば 'SandBox' 'sandbox' 'SANDBOX' は全て別のページとして解釈されます。
• リンクを貼りやすいよう、不要な記号（半角スペース等）の使用はなるべく避けてください。
  • 例えばページ名を「しらす」とすると「[[しらす]]」という記述ではリンクされません。
• ページ名に一部の記号類は使用できません。（「有効なWikiNameではありません。」と表示されます）
  • 使用可能な記号

    括弧 ( ) 、ハイフン - 、アンダーバー _ 、感嘆符 ! ? 、一部の数学記号 + - * = %

  • 使用不可な半角記号

    ダブルクォート " 、シャープ # 、アンパサンド & 、不等号 < > 、コロン :

ページの編集

• WIKIWIKI(当Wikiが使用しているWikiサービス)独自のテキスト整形の仕方は整形ルールを参照して下さい。
  • よく使う記述方法をこちら?にまとめてあります。初心者の方は是非ご覧ください。
• 編集のテストはためしがきをご利用ください。大規模な編集を行う場合もまずはためしがきしてから行うと安全です。

箇条書き(リスト)の注意点

ためしがき/レイアウト崩れのテスト?の「崩れる例」のように、箇条書きの直後の行に横幅の長い記述(インライン要素、ブロック要素ともに)や空行を含む#regionを記述すると、ページ全体のレイアウトが崩れます。
このようなレイアウト崩れを起こした際は、「崩れない例」のように箇条書きの次の行に空行をはさんでください。

アンカーについて

「*」で見出しを付けるとアンカー部分([#英数字文字列])が自動で付与されます。手動で命名しても構いません。
これはリンクを貼ったときに該当のアンカー位置へ自動的に飛ばすときに用いられるものです。
よって同一ページ内では同じアンカー名を用いないことが基本です。見出し行を丸ごとコピー＆よその行へペーストしないようにしてください。
ただし、他ページとアンカー名が被るのは大丈夫なので、冗長性を無くすためにprefixはつけないようにしてください。

• 例：○ [#MitoTsukino]　✖ [#mmd_MitoTsukino]

また、存在しないアンカーに対してもリンクは張られますが、数字から始まるアンカー名をつけることはできません。

• 例：○しらす#hoge?　✖[[しらす#2434]]

anameを使うことで、見出しではない場所にもアンカーを設置することができます。

• 例：

  &aname(anchor_test);

  こう書くと
  
  ↑に飛ばされる

逆に、見出しの直前・直後にanameでアンカーを指定する必要はありません。特に、見出しと同じアンカー名でanameを使うことはやめてください。

エピソード・主な関連人物の記述について

• 長文で書いてしまうと追記や情報更新が難しくなります。長文は避け、なるべく箇条書きで書くようにしてください。
• 可能であれば、なるべく出典としてツイートや配信(時刻付きであればなお良いです)のリンクを付けてください。
  • ただし、ニコニコ動画等のいわゆる切り抜き動画に類するものは貼らないでください。*1
• 一般論として「最近」「以前は」などといった時間を抽象的に表す言葉を単独で用いると、いつのエピソードなのかが分からず混乱を招きます。できるだけ具体的に記載するよう心がけましょう。

リンクの貼り方について

• 見出し部分（「**」等で始まる行）にリンクを貼るとページ自体が存在することに気付かれない可能性があります。
  • 一方、見出し部分にリンクを置かない方がページを導きやすい場合や、編集の一環として敢えて見出し部分にリンクを置いた方がいい場合も双方考えられます。
  • 導線を導きやすいのはどちらなのか検討してください。

プラグイン使用時に注意してもらいたいこと

プラグイン（「#～～」で記述しているもの）を使うことで、wikiをより見やすく彩ることができます。
PukiWiki由来のプラグイン、およびWikiWiki独自の仕様について説明がありますので、初めて使うプラグインは解説ページを読んでから使うといいかもしれません。
他にもSonots' PukiWiki プラグインに載っているプラグインが使えたり使えなかったりするかもしれません。

#include

• 他のページの内容を引っ張ってきて1つのページかのように見せるプラグインですが、1つのページに使えるのは40個が上限です。
  • #pcommentもコメント欄表示に別ページ参照の挙動をしているためか、40個のカウントに入るようです。
  • 40個を超えることが予想されうる場合、代わりにリンクを貼るなどして予め対応してください。
  • ※後述の#ecacheを使用することで上限数を回避することも可能です。
• #include内の見出しは#contentsでは表示されません。#contentsを使用しているページでの#includeの使用には注意しましょう。 2020年3月末頃からinclude先の見出しも#contentsに表示されるようになりました。
  • #contentsを使用せずにanameでアンカーを手動で設定することによって目次を作ることもできます。実例：Tokiプロダクション語録集?

#ecache

• ページ表示負荷が重いページを毎回キャッシュをリセットさせないことで軽くしたり、上記include数上限を解放できます。
  wikiwiki公式の説明
  • reset=on でキャッシュをリセット
  • reset=off で常にキャッシュを更新しない include系プラグインの上限緩和
  • reset=new ページがキャッシュよりも新しければ更新する include系プラグインの上限緩和
  • reset=秒数 で指定秒数毎にキャッシュを強制リセット(new の効果もある) 3600秒超過でinclude系プラグインの上限緩和*2
• 使用法 (ページがキャッシュよりも新しければ更新する、さらに1時間ごとにキャッシュを強制的に更新する)

  #ecache(reset=3600){{
  内容
  }}

  • 親ページではプレビューをしただけでキャッシュが保存されてしまうので、編集を取り止める場合は、編集前のソースでプレビューし直してキャッシュを戻してください。
  • includeされた子ページを更新しても親ページ側のキャッシュはすぐには更新されず、反映されるまで最大1時間掛かります。#recent等の中身が自動更新されるプラグインも同様です。
• 適用させたいページ全体の最初と最後を、上記のとおりecacheで囲みます。
• 過去に、ecacheを使用しているページを、TITLEを使用している複数ページからincludeした際に、ページタイトルにバグが発生したことがあります。
  • 編者がバグをWIKIWIKI運営に報告し、運営により現在バグは修正済みです。詳細は編集談義/配信予定リストのタイトルバグ?を参照ください。
• 現在wiki内ほぼ全てのベージに使用されています。

#fold

#fold(タイトル){{
hogehoge
fugafuga
}}

• ページを読み込んだ際に最初から開いた状態になるようにするには、タイトルの横に「,open」を付け加え、

  #fold(タイトル,open){{
  内容
  }}

  のようにします
• foldやaccordionなどの {{ を使うプラグインを使ってレイアウトが大きく崩れた場合、開始の {{ に対応する終了の }} を付け忘れている場合があります。また、開始の { が3つ以上の場合、終了の } は開始の { と同数(あるいはそれ以上)でなければなりません。

  #fold(ダメな例){{{
  この場合、次の「}}}」かページの終端まで折りたたまれてしまいます
  }}

  
  

  #fold(良い例){{{
  foldやaccordionの中にfoldを作る場合によく使われます
  #fold(良い例の中のfold){{{
  ただし過剰に折り畳むとページが閲覧しにくくなるので使いすぎには注意
  }}
  }}}

  良い例

  foldやaccordionの中にfoldを作る場合によく使われます

  良い例の中のfold

  ただし過剰に折り畳むとページが閲覧しにくくなるので使いすぎには注意

• 2020年2月まで#region #endregionというプラグインが使われていました。機能は#foldと同じですが、複数の問題があったために非推奨とされました。古いプラグインと新しいプラグインの対応は以下の表のとおりです。
  置き換え早見表

  前	後
  ＃region	＃fold(){{
  ＃region(名前,opened)	＃fold(名前,opened){{
  ＃endregion	}}
  ＃accordion_start(～)	＃accordion(～){{
  ＃accordion_end	}}

• regionを多用すると負荷の原因となる問題がありました。サブページ化、上記のecacheの利用で軽減を図っていました。foldへの置き換えで概ね問題は解消されているようです。
  
  

#skin

• ページ単位でスキン(CSS)を変更するwikiwiki独自実装の仕様非公開プラグインですが、種々の問題があることから使用はお控えください。(編集談義/自由討議? 2022-02-08 (火) 09:07:20)
  
  

その他

• 日付を書く際は年も書くようにしてください。ただし、前後から明らかな場合や冗長になる場合はその限りではありません。
• 丸印はU+25EF「◯」、バツ印はU+2715「✕」が推奨されます。ただし、掛け算の意味でのバツ印はU+00D7「×」です。
• 白背景に溶け込ませるために隠し文字を仕込む場合、Whiteで文字色指定するとiPhone・iPad環境では範囲選択しても文字が浮き上がりません。よほど隠したい内容ではない限り、SilverかGrayを使うことを推奨しています。