編集のコツ

Last-modified: 2023-10-21 (土) 11:05:10

整形ルールに載っていない構文やこのwiki独自の編集方法などのメモ書き。
プラグイン解説はこちら

interwikinameの活用

前作wikiにリンクを繋げたい場合、URLを入力する必要はない。

[[前作wiki:(ページ名)]]

のように打ち込めば、そのページへのリンクが貼れる。
↓例
前作wiki:フェス

[[(表示したい名前)>前作wiki:(ページ名)]]

とすれば
こんなふうにできる。

また、別ページから部分編集を行うリンクを設置する際は

[[部分編集:(ページ名)&id=(見出しID)]]

とするとよい。
見出しIDは#を含まない。

汎用画像の使い方

ブキやギアパワーなどの汎用性の高い画像はiconというページに纏めて添付されている。

&attachref(icon/(画像名).png,nolink,16x16);

のように記述することで、他のページにおいても画像をいちいちアップロードすることなく使用できる。

負荷対策

大量の画像を使ったり、includeプラグインで他ページから引用を多数行なったりしていると、そのページを表示する際に時間がかかるなど負荷の面で問題が発生する。

これを対策するためには、以下のプラグインを使用すると良い。

#ecache(reset=3601){{
(重い記述)
}}

このプラグインを使用したページでは、編集構文を表示ページに変換した際の結果を一時的に保存(キャッシュ)し、毎度変換して表示するのではなく保存した内容を直接表示する、というような挙動になる。

このキャッシュは、次の編集が行われてタイムスタンプが更新されるか、指定した秒数(上記であれば3601秒=1時間1秒)経過すると更新される。
ただし、設置ページのタイムスタンプが更新されない更新、例えばinclude先のページの更新や、[[]]で囲うリンクが繋がったかどうかなどではキャッシュは更新されないことに留意する必要がある。
そのような場合ではreset=の秒数を調整する必要があるだろう。

また、副次効果として3601秒以上にすると1ページに使用できるincludeプラグインの最大個数制限が解除されるというものもある。

使用する目安としては、ページ右上に表示されている速度計アイコンが緑色から灰色に変わる、表示速度100.00ms以上が良いのではないだろうか。

自動リンクをはがす(AutoAliasの無効化)

テッキュウがセンキュウ

AutoAliasName*1ページに登録されている単語を記述した場合、強制的にリンクが付与され文字色が黒に固定される。
このリンクをはがすには、AutoAliasされる単語の文字を1つ以上選択し、編集画面下の「&#」ボタンを押せばよい。選択部分が AutoAliasの影響を受けない数値参照文字に置き換わり、結果としてリンクがはがれる。


出力前

&color(silver){テッキュウがセンキュウ};
&color(silver){テッキュウがセンキュウ};

出力後
テッキュウがセンキュウ
テッキュウがセンキュウ


この裏技は、整形ルールの数値参照文字を応用したもの。
「ウ」のように『&#(数字);』となっている文字列は数値参照文字と呼ばれ、テキスト生成時にUnicodeの数値を参照し自動で文字に変換される機能がある。
このとき、数値参照文字を含む単語はAutoAliasの影響を受けず、AutoAliasが反応しなくなる特徴がある。本項はこれを応用したものだ。

あとから編集する時の見つけやすさを考えると、語尾の1文字だけを数値参照文字に置き換えることをオススメする。

リンクは残したまま色をつけたい場合

リンクは切りたくないが文字色は指定したい場合、AutoAliasの代わりにリンクのプラグインを使うと良い。
リンク内で文字色の指定をしよう。


出力前

メインウェポンの ボールドマーカーは、射出口の…
メインウェポンの &color(darkorange){ボールドマーカー};は、射出口の…
メインウェポンの [[&color(darkorange){ボールドマーカー};>ブキ/ボールドマーカー]]は、射出口の…

出力後
メインウェポンの ボールドマーカーは、射出口の…
メインウェポンの ボールドマーカーは、射出口の…
メインウェポンの ボールドマーカーは、射出口の…


まとめて置換

「編集」の場所.webp
編集画面左上の「編集」→「置換」
または、「編集」→「すべて置換」
を使うことで、ページ内のキーワードを一気に置換することができる。

キーボードショートカット

キーボードショートカット[出典]

操作WindowsMac
置換Shift + Ctr + FCmd + Option + F
全て置換Shift + Ctr + RShift + Cmd + Option + F

編集画面の下部に、入力欄「置換:」もしくは「全て置換:」が現れるので、そこに置換前のキーワードを入力してエンターキーを押し、その次に現れる「置換文字:」に置換後のキーワードを入力してエンターキーを押す。「すべて置換」の場合はそれで完了。
「置換」の場合は、その後上部に「置換しますか? はい いいえ すべて 停止」と出る。これを押すまで置換は行われない。
一連の操作中にページ内の関係ない場所をクリックすると、置換されずに最初からやり直しになることがある。

キーワードの指定には正規表現を使うことができる。正規表現についてはこちら(プラグイン解説)
検索キーワード(置換前のキーワード)に正規表現を使う場合、最初と最後を/で囲む必要がある。

添付画像の軽量化あれこれ

添付する画像の容量はなるべく小さくなるように手を加え、wikiwikiの帯域を圧迫することや閲覧者のモバイルデータ通信量を減らすことが望ましい。
そのための工夫を以下に示す。

拡張子選択

画像の拡張子の種類としては「png」「jpg」「webp」などが存在する。
有名で主に画像に使用される拡張子はpngだが、この拡張子は画像を綺麗に表示できる代わりに容量が大きくなりがち。
switchのスクリーンショットなどで用いられているjpgなら容量を格段に削減できるが、代わりに保存を繰り返すとどんどん画質が劣化してしまう。
そこで当Wikiでは「webp」という拡張子の使用を勧めている。
これはウェブページ上で画像を高速表示することに特化した拡張子であり、画質をあまり劣化させないままpngよりも軽量化できる特徴がある。
しかし未だ一般に浸透しておらず、変換にはフリーソフトなどを探す必要があるのが難点。
Google Chrome Labsが開発したSquooshというサイトなら、Chrome以外のブラウザでも動作する、webp変換に対応したツールであるため、これの使用をお勧めする。

注意点として、webpにはLossy(非可逆圧縮)とLossless(可逆圧縮)という2種類の形式が存在する。
Webp LossyはJPEGと同じく必ず画質が劣化し、スクリーンショットのような情報量の多い画像に向いている。
WebP LosslessはPNGと同じく画質がまったく(あるいはほとんど)劣化せず、アイコンのような色の変化の少ない画像に向いている特徴がある。
Lossyの方が容量を削減できるが、jpgと同じく保存を繰り返すと劣化が激しくなってしまう。ステージの解説画像など上から更に記述を加えるような画像については、Losslessで保存することを強く推奨する。

画像サイズについて

このwikiwikiにて、PC表示で画面いっぱいに画像を大きく添付した場合の画像サイズは614x343pxになる模様。
そのため、特に画質を高く維持したい事情がある場合を除いて、大きな画像は614x343pxまで縮小すると容量削減に繋がる。

画像の自動最適化の仕様

wikiに添付した画像はページ内でインライン表示する時、解像度・ファイルサイズ・形式に応じて自動で最適化された画像が表示されることがある。
https://zawazawa.jp/wikiwiki-request/topic/184/11

現状次のような挙動をする様子(今後変更されるかもしれない)

  • WebP Lossyは原則最適化をパスする?
  • WebP Lossless、JPEGは最適化されることがある
  • 最適化をパスする基準は総ピクセル数とファイルサイズで、正確な式は不明だが近似値は( (横幅px * 縦幅px)^0.65 * 0.021 + 5) KB
    (例として614x343のJPEG画像は約65KB以上から自動最適化が働く)
  • 最適化された画像はWebP Lossy 品質80程度
  • 「インライン表示の解像度」とあるがref()での指定サイズは関係なく画像解像度が条件

*1 指定した単語に自動でリンクを貼るwikiの機能