編集の手引き

Last-modified: 2022-06-27 (月) 05:37:20

このページでは、編集についてのあれこれをまとめてあります。
困ったことがあれば、覗いてみてください。
何かあればご自由に追記してください。

 
 
 

編集系ページのリンクまとめ

 

本Wikiについて

仕様や取説

  • 本Wikiは、クラウドサービスWIKIWIKI.jp*にて作成しています。誰でも会員登録なしで編集できます。
    • WIKIWIKI.jp*はPukiWiki Plus!をベースに開発され、PukiWiki Plus!はPukiWikiの派生版です。
      • 現在はPukiWikiがベースだとしている。
  • 仕様については、WIKIWIKI独自の整形ルール・PukiWikiでのヘルプや、WIKIWIKIの取説を参照。
  • 使えるプラグインについては、プラグインマニュアル一覧やPukiWiki Officialの自作プラグイン一覧1・2などを参照。このページ内でもまとめてあるので活用してください。
    • 前者のリンクは、"本来は"「PukiWikiのver1.4での標準プラグインの一覧」用のページです。
      • ただし最近WIKIWIKI.jp*が自作したプラグインが、このページに追記されてしまいました。
        いよいよもってWIKIWIKIで使えるプラグイン一覧になりつつあります。
      • なお「amazon」の廃止などが更新されていないため、上記の公式お知らせも参照してください。
    • 後者のリンクは「PukiWiki公式に寄せられた自作プラグインのうち、WIKIWIKIで使えるプラグイン一覧(の一部)」です。
      • このうちの「折りたたみMENU」は非推奨になってますが更新されていません。
    • また、プラグインの解説ページはこれらの他にも乱立しているので、取説でページ内検索したり、上記の公式お知らせやTwitterを見るなどして頑張ってください。
    • PukiWiki Plus!やPukiWiki由来の一部仕様が使えることがあります。
      また、上記などのWIKIWIKIからの文章には載っていない機能もありますので、各自WEB検索してください。
      • Sonots' PukiWiki プラグインさんのプラグインが使えたり使えなかったりします。
      • プラグイン解説などについては、PukiWiki公式・PukiWiki開発向けも参照のこと。
        プラグインについてWEB検索した際にこれらのサイトが表示された場合は、一度目を通してみるのもいいかもしれません。
 

編集について

  • 本Wikiは有志Wikiです。小さな情報を積み重ねていくことで内容の充実を目指しています。
    皆さんのご協力をお願いします。
  • ページの編集・作成を自分でするつもりはなくても、こんなページがあれば……・この情報が抜けてる……などがあれば、各種掲示板にてご連絡ください。
    優しい誰かが編集・作成してくれると思います。数値などの情報があるとなお嬉しいです。
  • 連絡には各種掲示板や、各ページコメント欄を適宜ご利用ください。
    • 編集内容の重要度によっては、編集したことを報告したほうがよい場合もあります。
      そのページのコメント欄を使うか、多くのページにまたがっているなどの場合は編集相談所へ。
      • 文末に編集履歴がコメントアウトされているページもあります。
        そのようなページを編集した場合、履歴を追加しておいてください。
        エンピツアイコンから編集した場合は忘れないように特に気を付けること。
  • 編集での質問や相談・提案があれば、編集相談所まで。
    • サンドボックス(練習用ためしがき)ページはSandBoxにあるので、自由に使ってください。
    • WIKIWIKI.jp*は多くの有名どころのWikiが利用しています。最近更新されたWIKIも参照。
      本Wiki内でわからないことがあっても、別のWikiの編集方法が助けになるかもしれません。
  • よく追加されるページのテンプレは、テンプレートにあります。
    • その他のページを追加する場合は、過去の同型のページを参照してください。

掲示板の選択チャート

  • あくまでも筆者の主観です。
  • 解決していない疑問があるとき
  • どんなページ・情報（解決まで時間がかかった疑問・新提案など）がほしいのか考えがあるとき
  • 数値欄などの空白・更新されていない古い箇所を発見したとき
  • 空白に入力する情報を調べてきた・誤植を発見したとき
  • レイアウト変更など大幅な変更案があるとき
    • 編集の規模にもよりますが、他ユーザーからの視点での比較や動作確認のため、SandBoxなどに案を作成して編集相談所へ。
    • 利用中のページをいきなり変更するのはなるべくしないようにしましょう。
 

データ更新時に編集するページ一覧

定期的な更新について

MenuBar内の一覧も活用してください。
目印としてページ内に「yyyy/mm/dd」と更新履歴が記載されていたりいなかったり。

 

プラグイン等の機能一覧

まずは、上記の整形ルールや取説のトップページ・プラグインのマニュアル・自作1・自作2を読んできてください。

とは言っても読まないと思います。実際、軽く編集をするだけなら、あまり読む必要はありません。
最初に「自分で編集したい！」と思うのは既存ページの修正でしょうから、前後の記述を真似るだけで済みます。
更に言うと、様々なページを真似るだけで、ほとんどの機能を一通り使えるようになると思います（個人差あり）。
本Wiki内には様々な機能がどこかで利用されています。そのページの編集画面を開き、その機能周辺の記述を眺めていくのが近道です。

 

ここでは編集文章内での機能の一覧（抜粋）を表示しております。
プラグインで#と&が両方あるものは、よく使う方を表示しております。
なお「?plugin=～」「?cmd=～」など「?」で始まるものは、ページ内ではなくアドレスバーに入力する機能です。
取っつきやすさ重視のため、インラインやブロックなどを極力必要としない説明になるようにしています。ご了承ください。
また、引数の指定方法などは記載していないものが多いです。適宜取説を確認してください。

ページ下部の編集の注意点で詳しく解説されている項目もあるので、適宜参照してください。
また、画面上部のボタン各種については、アイコン説明を参照してください。

 


機能一覧目次

 

凡例

機能
解説 / 使用例
 

記号

(半角空白)
半角空白から始まる行は整形済みテキストになる。プラグインは展開されない 
この青い部分が整形済みテキスト
#(半角空白)
「#(半角空白)」の2文字から始まる行は、&プラグインが展開される整形済みテキストになる 
赤色に指定
>
引用文(レベル1)。四角で囲まれて表示される。

この部分が引用文

|テキスト|
表組み。書式指定については省略。 / いろんなことができるので、ぜひ実例を参照
  • 細くするための1桁行幅なら良いが、行幅の数値を一部の行だけ広げると、スマホで見たとき表示が崩れる。
    全ての行で幅を指定するか、全ての行で指定しないかにすること。
  • 表中の背景と文字の色を合わせて文字を隠すのは可能だが、背景色指定なしの白文字だと、スマホでは青背景になるので注意。
  • PukiWiki開発向けでの整形ルール案も参照するといいかも
:テキスト|テキスト
定義リスト。辞書のような表示 / この項目
*
見出し(レベル1)。アンカーとして[#英数]が自動生成され、見出しごとに編集できるエンピツアイコンが表示される
-
番号無しリスト(レベル1)。箇条書きで表示される。
+
番号付きリスト(レベル1)。1.～、2.～として表示される。
----
水平線。4つ以上の-で生成。画面いっぱいの長さで表示。 / 目次の次の行
(​(テキスト))
注釈。ページ一番下に*1として表示される文章を入力
&#数値;
数値参照文字。特殊な記号のときや、編集書式の記号だと認識されたくないときに使う / 「①」など・この項で多用
//
コメント行。表示に反映されなくなる。行中コメントはnullにて
(改行)
表の利用中などの、編集画面上で1行にまとめて書かないといけない箇所では、行の区切りなどを表す。
その他の箇所では、文中で普通に改行するだけで改行される。
ただし編集画面上の空行は、空行として表示されず、記述ブロックの区切りとなる。
 
 

リンク系

[[リンク先]]
リンク。文中にはリンク先の名前がそのまま表示される。Wiki内ページ名・URLともに使用できる。
  • 多くの場合、文字のURLエンコードは必要ない。URLそのままのリンクだと括弧を使わずに、そのままURLを書くのでもよい。
  • Wiki内リンクではアンカーが使用でき「ページ名#アンカー名」とするとページ内のその位置へのリンクになる。現在のページ内へのリンクの場合は「#アンカー名」と省略できる。アンカーの設置場所が折りたたまれている場合は、ページ内外リンクともにうまく機能しないので注意。
  • ページ名の省略に関わらず、アンカー名も文中にそのまま表示される。
    ただし「SandBox#アンカー名」の場合は「SandBox」のみの表示となる。
  • PCでの閲覧時、Wiki内へのリンクであれば、マウスオーバー時にページ名が表示される。
[[リンクテキスト>リンク先]]
文中に表示されるテキストを変更してのリンク。Wiki内ページ名・URLともに使用できる。
  • URLに:を含む場合は、この記述方法が必須となる。
  • アンカーが指定できる以下同上。
[[リンクテキスト:リンク先]]
文中に表示されるテキストを変更してのリンク。URLのみ使用できる。
  • 「>」との違いは、InterWikiNameページにURLを登録しておくと、URLの前半が省略できる機能が使えること。
    あまり使われていない。
  • InterWikiNameに、[そのサイトのURLの共通部分 キーワード]と登録すると、
    別のページで[[キーワード:URLの続き]]と入力するだけで、
    [[キーワード:URLの続き > 合体したURL]]と記述したときのようなリンクとなり、他サイト内の様々なページにリンクを貼るのが容易になる。
    • ちなみにこの機能を利用した場合、このWiki内へのリンクであっても外部リンクアイコンが表示される。
    • [[リンクテキスト>キーワード:URLの続き]]と記述することで、更にテキストを変更することもできる。 / 使用例:MenuBarの一番下の「MenuBarの編集」
  • InterWikiテクニカル・InterWikiName・InterWikiSandBoxを参照。
 
 

文字装飾系

'​'テキスト''
強調。シングルクォート2つで挟む。Shift+2ではなく、Shift+7を2回。
'​'​'テキスト'''
斜体。シングルクォート3つで挟む。
ただしWindowsから見ると日本語は斜体にならない。(WIKIWIKI.jp* - よくあるご質問参照)
強制的に斜体にするプラグイン(こちら)もあるが、将来使えなくなる可能性があり非推奨とのこと。
%​%テキスト%%
取り消し線。パーセント2つで挟む
%​%​%テキスト%%%
下線。パーセント3つで挟む
 
 

A-D

#accordion
折りたたみ付きの見出し
&aname
アンカーの設置
foldプラグインを設置する際に設定するタイトル末尾に付記しても機能しないため、注意の事。
上の行に置くか、foldプラグイン格納内部の1行目に付記すれば機能する。
#areaedit
指定した範囲のみ編集するボタンを設置 / プラグイン等の機能紹介(ここ)
見出しをまたいでの編集も可能(編集点が見出しで切れない)
&attachref
その場に画像添付窓口を設置し、添付が完了次第その場に画像を表示する。
画像をリンクとして使う場合は、添付が出来ていない間もリンクとして機能し、添付窓口としては扱えないため注意
&button{ };
ボタン生成。丸カッコ( )ではなく波カッコ{ }を使用
&br;
改行。表の行中などで改行するとき
#br
行間開け。表などの外で行間を開けるとき
&color
文章中の文字色・背景色(網掛け)の変更。指定方法はこちらも参照。
表組内の背景色指定(BGCOLOR)は独立しているため、下記用例の様に「表組内背景色・文字網掛け色・文字色」3種をバラバラに指定する事が可能だが、色の組合せによっては著しく見難くなるため、注意の事。
　文字色用例　
 
  • テキストを読みにくいように隠すとき
    • silverを利用
    • grayでも可
    • whiteはiPhone・iPad環境では読めないので本気で隠すとき用
CENTER:
センタリングされる
#contents
目次。ページ中の見出しの一覧を表示
&countdown
指定時刻までの残り時間を表示する
(YYYY-MM-DD[ hh:mm:ss][,(day|hour|full)])[{メッセージ}];
例: &countdown(2038-01-19 12:14:07,day){カウントダウン完了};
&counter
ページの参照回数の表示 / MenuBarの一番下
?cmd=diff_log
編集差分の一覧。差分ボタン(cmd=diff)と違って、画像添付なども表示される。
ちなみに最終更新ページのソートでも画像添付などを含む。 / 最終更新や差分ページにリンクあり
 
 

E-G

#ecache
ページを部分的にキャッシュして軽くしようとする機能。
  • Wikiのソース形式(|表内テキスト|表内テキスト| など)から、
    ブラウザで表示されるHTML形式(<table></table> など)へ変換したものを、Wiki内に予め保存しておく機能。
  • ページ内のHTML変換が重い部分(include・表・画像の表示など)や、複雑な処理の部分(人気30など)に対して使う。
    • もちろんページ全体でも可(ただしコメント欄は除く)
  • 基本的にページの編集更新時(new)にキャッシュを更新すればよい。ただし、コメントや最新のx件など他のページから影響を受ける部分に使う際は、編集時以外にも定期的にキャッシュの更新が必要。
    • MenuBarで使用するとページ用のデザイン(見出し末尾で▲▼、外部リンクで&ref(): File not found: "ext.png" at page "FrontPage";など)になるらしいので、適用範囲に注意
    • プレビューをしただけでキャッシュが保存されるらしい？編集を取り止める場合は編集前のソースでプレビューし直す必要がある？
#flex_box
flex_containerで並べるコンテンツの作成
#flex_container
flex_boxを並べて表示する
#fold
折りたたみ / ＋もっと見る
設置の際の意図にもよるが、格納内部の1行目にはタイトルと同文を置くと開いた際の見栄えがよい。
#footer
個人で使える機能としては、ページ終端へのアンカーとして利用可能
 
 

H-K

#header
個人で使える機能としては、ページ先頭へのアンカーとして利用可能
#hr
水平線。その箇所の形式に合わせた長さで表示
#include
他ページの内容を丸ごと挿入するプラグイン
#includex
上記の拡張プラグインであり、他ページの内容の一部を(例：ある特定の見出しとその内容を丸ごと)ピックアップしての挿入が可能。lsxプラグインが本プラグインを内包するため、そちらのオプションから複数ページの挿入も可能であるが多用は禁物(気を付けないとページ内にincludeした内容毎includeしてしまったりするため)。
#jumplist
セレクトメニュー。listboxで選択してページ移動ができる。
存在しないページ名はスキップされ、有効なページ名が1つもない場合は、リスト自体表示されない。
 
 

L-N

LEFT:
左寄せされる
#ls2_1
指定した条件に合致するページの一覧を表示(移行前)。「検索結果を表示する別ページ」へのリンクとして挿入できる。
#lsx
指定した条件に合致するページの一覧を表示(最新版)。詳細は高度な編集を参照。
#memox
入力欄の表示。コメントのように、ページの閲覧状態でも編集ページと同様に文章を変更できる記入欄を作成する。
何も変更せずに更新ボタンを押すと真っ白な画面に飛ばされるので注意。
#menu
記入したページのみ、画面左のメニューバーの参照先を変更する
&new(日付)
入力された日付を表示する。また、最近の日付ならば日付の後にNew!と表示する / コメントの入力時に自動的に付与
#nobr
表組みなどの自動サイズ調整や自動改行を抑制する
ntbr
表や記事を丸ごと隠したり、コメントのみをピンポイントに隠したり出来る。いわゆるネタバレ防止用のマスキング機能。

現在の所、一度展開したものを元に戻す事は出来ないようです(ページのリロードが必要)。

#null
複数行コメント。表示に反映されなくなる
&null
行中コメント。表示に反映されなくなる
 
 

O-R

&online
現在アクセス中のユーザー数を表示。
ユーザー数は、5分以内にアクセスのあったIPアドレスの数 / MenuBarの一番下
#pcomment
別ページとしてコメントの履歴用ページを作成(実際の生成は1回目のコメント時)し、コメントの履歴を表示し、コメントの入力欄を作成。
入力された文章はコメントの形式(日付や枝)に整えられ、コメントページに加筆される。その後にコメントの履歴表示機能により、現在のページからコメントページの内容を把握できる
#pre
整形済みテキスト。
(半角空白)や#(半角空白)と違って、整形済みテキスト内の見出しのアンカーが自動生成される場合があったり、リンクがyetlistに表示されたりする。青枠のデザインも少し異なる / 個別テンプレート各種
#popular
参照回数の多いページの一覧を表示 / MenuBarの一番下のリンク
#recent
最近更新されたページの一覧を表示 / MenuBarの一番下のリンク
#recentdetail
最近更新されたページの一覧を、経過時間ごとにまとめて表示 / MenuBarの一番下の「最新の5件」
&ref
既にどこかのページで添付されている画像を表示。ここも参照
RIGHT:
右寄せされる。
&ruby
ルビをふる。
 
 

S-U

#shadowheader
目次に表示されない見出し
#side( ページ名 )
ページの右側に右メニュー用のページ(SideBar)を表示する
本wiki内で使用中のページはないが、本プラグイン用にSideMenuページ自体は用意されている。
「Menubar｜メインページ｜追加のSideMenu」と3カラム式になるため、メインのページが狭くなる欠点。
&size
文字の大きさを指定
#skin( スタイル )
ページのスキンを変更できる。スタイルの種類はこちらを参照
#tablesort
並べ替え付きの表。使用時には見出し行に▲▼が表示される。
詳細は高度な編集参照。
TITLE:
見かけ上のページタイトルの変更。ページ名(URL)は変更されない。
なお編集時のプレビュー内には反映されないため注意
&tooltip
マウスカーソルを合わせている間、テキストが表示される。
使用箇所が存在するページ名だった場合は、そのページへのリンクになる。
  • マウスオーバーでのテキスト表示については、PCでの閲覧時限定なので多用には注意
  • リンクでのツールチップテキストはページ名だが、tooltipを同時に使うことでツールチップテキストを変更できる 
    [[&tooltip(表示テキスト){ツールチップテキスト};>ページ名]]
#twitter_timeline
Twitterのタイムラインの埋め込み / トップページ
#twitter_tweet
Twitterのツイートの埋め込み
 
 

V-Z

#vote2
投票フォームを表示
?word=文字列
指定した文字列のハイライト表示
実際にはコメントのお名前が多く表示されるため使いにくい。また、現状:RenameLogも表示されますが読み飛ばしてください
#youtube
YouTube動画の埋め込み
  • 横幅のみや、横幅と高さの指定ができる。
    • 横幅と高さを指定すると、スマホだとサムネが見切れることがあるので、横幅のみに留めたほうが良い。
  • 列幅が大きい表中で使う場合は、横幅と高さを指定しないとCENTERが機能しない。
    • 表の列幅と同じ横幅を指定するか、横幅を指定しなかった際の横幅(540？)よりも表の列幅を小さくすると良い。
  • 横幅と高さともに指定しないのが端末差の面で無難。列幅の大きな表内での使用も控えると配置の面で無難。
 
 
 

高度な編集

この項では、あまり情報がない機能に関して経験的にわかっていること等を書き溜めています。
情報がない=仕様変更されても気づきにくい部分でもあるので注意！

lsx

基本的な使用方法はこちらを参照

 

使い方の補足

ブロック型およびコマンド型で使用可。用途に応じて使い分けられる。

  • ブロック型：上記のページ参照
    その場にリストを展開する
  • コマンド型：URLにhttps://wikiwiki.jp/shinycolors/?cmd=lsx&...と記述
    コマンド型のURLへのリンクを使用することで、別ページにリスト展開するような使い方がメイン
    • 「?cmd」の部分は「?plugin」としてもOK
    • オプションの区切りはlsxの後ろは「&」、それ以外は「&」でも「,」でも基本的にOKっぽい。
  • includeでページの内容を表示することもできる。このとき、検索したい文字を含む行のみ抜粋して表示できるので、コメントアウトを含めない検索として活用できる。
     

よく使う正規表現の例

  • AND：◯◯および××および△△ 
    ^(?=.*◯◯)(?=.*××)(?=.*△△).*$
  • OR：◯◯または××または△△ 
    ◯◯|××|△△
  • NOT：◯◯を含まない/◯◯で始まらない/◯◯で終わらない 
    ◯◯を含まない　：^(?!.*◯◯).*$
◯◯で始まらない：^(?!◯◯).*$
◯◯で終わらない：^.*(?<!◯◯)$
    「except=^(?!.*◯◯).*$」は「filer=◯◯」と同義になるっぽい
  • 応用例

    応用例
    ◯◯および××を含まない

    ^(?!.*◯◯)(?!.*××).*$

    ◯◯または××を含まない

    ^(?!.*(◯◯|××)).*$

    ◯◯を含むかつ××を含まない

    ^(?=.*◯◯)(?!.*××).*$
  • 特殊文字の検索
    下記の記号は正規表現で特殊文字として扱われる 
    $  (  )  *  +  .  ?  [  ]  \  ^  {  }  |
    この記号自体を検索したい場合は、直前に「\」をつけると他の文字と同様に扱える 
    \$  \(  \)  \*  \+  \.  \?  \[  \]  \\  \^  \{  \}  \|
 

URLリンクの注意点

lsxに限らないが、リンク先に記号(一部を除く)が含まれたURLを使用すると、「有効なInterWikiNameではありません」と表示され、意図した表示ができない場合がある。そのため、当該の記号はUTF-8形式に変換する必要がある。

  • そのまま使用できる記号の例
    ( ) : * & / = . ? !
 

ref

  • 「"」(ダブルクォーテーション)で囲うとshadowheaderやfoldの子要素にできる
  • attachrefも同様
  • accordionの子要素にはできない。らしい
     

tablesort

使い方の補足

下記はWindowsの場合の内容です。他の環境は未確認。

  • Shiftを押しながらヘッダー行を押すと、基準とする列を複数選択できます。(先に押した列の方が優先度が高くなる)
  • Ctrlを押しながらヘッダー行を押すと初期の並び順に戻ります。
     

表の幅について

  • 並べ替えのない普通の表を行幅値通りに描画した後に、▲▼付きの表に再描画される。
  • 行幅が無指定・%指定であれば変化しないが、数値指定の場合は▲▼の挿入により行幅が伸びる。
    • 行幅の変化により表内の改行位置がずれることがある。
    • 折り畳みの外でtablesortを使う場合は、行幅が伸びる前の描画時から改行が変化しないように、余裕を持った行幅指定にすると良い。
       

ソートの順番

下記の内容は推測によるものです。(詳しい方の編集求む)

  • 数字、文字、記号がそれぞれ連続する部分でブロックを分け、左のブロックから順番に比較
    (例) 12ABC(345)→「12」、「ABC」、「(」、「345」、「)」に分ける
  • 数字のブロックは1文字ずつの比較ではなく、値の大きさで比較
    (例) 「11」、「101」、「05」 を昇順にすると 「05」、「11」、「101」の順になる
  • 「.」は数字の間にある場合小数点になる？
  • 編集用の文字列(&br;など)は比較時には無視される？
  • 見出し行が結合されている場合、該当見出し下の1列目はソートされるが、2列目以降は昇順で固定されるっぽい
    実例

    実例

    No.文字列B1B2B3
    1283SC412283SC412
    2283IMSC412283IMSC412
    3283SC283283SC283
    4412SC283412SC283
    541.2SC28341.2SC283
    641.2SC41.2SC
    74040
    84242
     

編集の注意点

この項では、ページの編集について特に気をつけて欲しい点を記載しています。
実際にあったミスなど、各自が気になった点を自由に加筆してください。

大まかに重要度順/参照頻度順に並べています。

 

新規ページ作成について

  • 新規ページ名のガイドラインについては、テンプレートを確認してください。
 
  • マニュアルには新規ページの作成方法として、以下が解説されている。
  1. 「新規」ボタン
  2. [[新規ページ名]]でのリンク
  • 後者について、本Wikiでページを作成する際の手順としてまず最初に、ページがまだ作られていない段階ではあるが、そのページのURLを開く必要がある。未作成のページだからと言ってNewなどの単語は必要なく、既存ページと同じく「wikiwiki.jp/playavengers/新規ページ名」とするだけである。
    このページに辿りつけたら、内容記入後にページの更新ボタンを押したタイミングで、その内容での新規ページが作成される。
  • このように、「/新規ページ名」のページに辿りつく方法の1つなのである。
    よって、既存ページのすみっこで[[ ]]を記述する必要性は必ずしもなく、アドレスバーに手打ちでもよい。もちろんページ上部の新規ボタンでもよい。
  • ただし、ページ名として利用可能かどうかを判断する場合や、「私はこのタイトルのページを作成中です」との宣伝目的などがある場合はその限りではない。
 

ページの容量オーバーについて

1ページ当たりの容量には上限があります。ある程度大きくなったら、ページを分ける・余分な個所を削るなどの対策が必要になります。

  • 1ページの最大行数は1600行です。
  • 1ページの最大文字数はおそらく25万～25.5万byteです。
    • 半角文字=1byte、全角文字=2byte？
    • たいてい行数の方が先にオーバーするので、文字数の方は普段はあまり気にする必要はありません。
      例外として質問掲示板のコメント格納ページは文字数が先にオーバーすることがあるので、1ページ当たり1000行程度を目安としています。
       

表記揺れ・誤字

記述時間の短縮や読みやすさなど、考えた上で砕けた表記にするのは構いません。
情報量を増やすことを優先してください。
時間があるときには、公式と異なる表記を多用しないようにしましょう。

  • 日付の0埋め
    • 「2000/01/01」のようにスラッシュを利用して日付を記入する際には、月や日が1桁の場合は0をつけてほしいです。
  • 「ヒーロー」
    • キャラクターではなく「ヒーロー」で統一しています。
  • 過剰な略語の使用
    • 「ダメバフ」、「クリダメ」、「ボイチャ」などは避けたほうが無難です。
  • 用語集を参照
    • 上記の他に自信のない単語などあれば、用語集を参照してみてください。
      基本的には正しい表現が使われていると思います。
 

コピペ用の記号一覧

各デバイスでの入力方法は各自検索してください。

  • 三点リーダ「……」
    • 各ブラウザのフォントによっては、中央（―）ではなく下（_）に表示されます
  • 波線「～」（全角チルダ）：下に備考あり
  • 丸「◯」(大)・「○」(中)：好みで使い分けてください
    • ボタン表記では「○」(中)を使用してください
    • 「〇」(漢数字のゼロ)：数字が伏字の凡例用
      • ブラウザ内検索では0と区別されないことがあるので注意
  • 二重丸「◎」：丸印(中)と対です
  • バツ「×」：丸印(中)と対です
  • ハート：白のほうがよく使われます
    • 「♡」(白:♡)
    • 「♥」(黒や赤:♥ / ♥)
  • ダッシュ：
    • 「──」（罫線の横細線:U+2500）：推奨
      • フォントに依らず2本が繋がって見えやすい横棒。
      • 公式中のほとんどではおそらくこちらが使われている。サンプル
      • 「けいせん」で変換連打するとあるかも
    • 「――」（水平棒:U+2015）
      • ダッシュ的なもの(ダッシュではない)。フォントによっては2本が離れて見える。
      • 本Wikiではこちらも使われている
      • 「だっしゅ」で変換連打するとあるかも
    • 「ーー」（全角の長音:U+30FC）：文中と混同するため禁止！
  • 各種テンプレート用置換記号：省略
 

文字コード関連

  • フォントの更新により、使えるようになった記号があります
    • 「♡」など
  • ページ編集の更新をすると、「♡」などの記号は数値参照文字に自動で変換される
    • 逆に、自動で変換されない文字を数値参照文字で入力しても、普通の文字には変換されない
  • ページ編集の更新をすると、波ダッシュU+301C→全角チルダU+FF5Eに変換される
    • 逆にいうと、区別せずどちらを入力してもよい
    • PukiWiki-devのBugTrack/246の最下部のソース書き換え一覧のうち、1番上以外の6つは同様に変換される
  • Wikipediaでの文字コード・符号位置表を確認してJISで定義されてる記号がメジャー
    ほとんど同じ見た目のときはこれらを使う
 

画像添付

  • 本Wikiで表示される各画像は、どのページに対して添付（アップロード）されているか紐づいています。
    ただし、保存場所なだけで、どのページからでも表示させることはできます。
  • ちなみに1画像につき512KBまでなので、相応の画質のものしか使用できません。
    なお超過すると自動的に調整/変換されます。お知らせはこちら。
 

Macユーザーの画像添付について

  • Macを使って濁点・半濁点のついたファイル名の画像をアップロードすると、
    内部では「か゛」のように半ば2文字として認識されているため、文字化けが起こります。
    • Macに保存されているファイルの名前は、画像かを問わず全てこのようになっています。
      Windowsからアップロードするか、その画像のアップロードを諦めましょう。
    • アップロードに気をつける必要があるだけで、ページ内で文字編集をするのは問題ないです。
  • 詳しい人の解説求む。
 

空行の使い方

  • 編集画面上の空行は、空行として表示されるのではなく、記述ブロックの区切りとなる。
  • 動作例は以下の通り。ブロック要素の例として箇条書きを使用している。
 
  • 下のように空行によって箇条書きのかたまりが2つになり、若干のすきまが空く。
    1行分の空白(#br)ではない。 
    -箇条書きA-1
-箇条書きA-2
(空行)
-箇条書きB-1
-箇条書きB-2
    • 箇条書きA-1
    • 箇条書きA-2
    • 箇条書きB-1
    • 箇条書きB-2
  • 下のように箇条書きから抜け出ることもできる。 
    -箇条書きA-1
箇条書きA-1の2行目
(空行)
平文
    • 箇条書きA-1
      箇条書きA-1の2行目

    平文

  • なお、#brにはこの機能はないため、下のように箇条書きから抜け出ることはできない。
     
    -箇条書きA-1
箇条書きA-1の2行目
#br
箇条書きA-1の3行目
    • 箇条書きA-1
      箇条書きA-1の2行目
       
      箇条書きA-1の3行目
 

「更新の衝突」が起きてしまいました！？

  • まずは深呼吸して落ち着いてください。
  • 次に胸に手を当てて思い返してみてください。
    「ページの更新」ボタンを連打しませんでしたか？
    • 連打していた場合の更新の衝突相手は、誰も競合相手がいない時間帯ならばほとんど自分自身なので、そのまま下にスクロールして「ページの更新」を押し直してください。今度は1回しか押さないように気をつけてくださいね。
      • とはいえ、1回目のクリックで編集が確定しているので、ここでキャンセルを押しても編集が反映されてたりする。
    • どう考えても1回しか押していなかった場合、衝突を解決する必要があります。
      以下をご覧ください。
 
  • 「更新の衝突」とは
    • 「あなたがページの編集を始めてから、今あなたがページの更新ボタンを押すまでの間に、
      他の誰かがそのページの更新を完了してしまっていた」ということです。
    • 他の誰かさんの更新は、すでに完了しています。
    • あなたの更新は、まだ完了していません。
      これから「ページの更新」をもう一度押すことで、あなたの編集がようやく反映されます。
    • そのページの上半分には、他の誰かの更新とあなたの更新をいい感じに合成したデータが表示されています。
      お互いに別の部分を更新していたらいいのですが、2人の更新した部分が被っている場合があります。
      その画面の中であなたが編集した部分を確認して、自分の納得のいく文章になっているか確認してください。
    • 納得がいかなかったら、そのページの下半分の編集欄でいつも通りに編集をしてみてください。
      折衷案へと変更次第更新を確定させましょう。
    • 納得がいったなら、一番下までスクロールして「ページの更新」を押してください。これであなたの更新は反映されました。
    • お疲れさまでした。
       

見出しとアンカータグについて

見出しをアンカータグごとコピーしない

  • 見出しアンカーとは、見出しへのリンクの作成や、見出しごとに編集できるようになる「エンピツアイコンparaedit.png」に必要なもの。
  • 既に作成されている見出しは、見出しの段階に応じて、 
    * 見出し名 [#abcd1234]
** 見出し名 [#efgh5678]
*** 見出し名 [#ijkl9012]
    などと記述されている。この[[#英数]]がアンカーである。
    アンカーは自動生成されるため、編集時に記述するのは、 
    * 見出し名
** 見出し名
*** 見出し名
    だけで良い。「ページの更新」で一度編集を完了させた時点で生成される。
    • コメントアウト内では生成されない。
      整形済みテキスト内では、半角空白・#半角空白だと生成されないが#preだと生成される場合もある。
  • 1つのページ内で、同じアンカー名を複数箇所で使用すると、正しく機能しないので注意。他のページと被るのは可。
    • 手動で命名しても良い。その際は、先頭を英字とする2～40文字の英数や一部記号(#を含めずカウント)で記述すること。
  • ちなみに上記以外の機能として、見出し以外の場所でアンカーを作成する&anameがあります。
 

見出しにアンカータグをつけない方法

  • 「見出し」ではアンカータグが自動でつくため、つけない状態にすることはできない。
    目次に載せたくないなどの場合は、見出しのデザインをした別の機能「目次に表示されない見出し」を活用すべし。
    記述は、段階に応じて以下の通り。 
    #shadowheader(1,見出し名)
#shadowheader(2,見出し名)
#shadowheader(3,見出し名)
    • この#shadowheaderと&anameを組み合わせることで、#contentsを使わない擬似的な目次が作成でき、目次に載せる見出しの取捨選択が可能です。編集や管理が大変ですが。
      このページの「機能一覧」で使ってみてます。
どうしてもアンカータグをつけずに「機能：見出し」を使いたい人

どうしてもアンカータグをつけずに「機能：見出し」を使いたい人

  • 仕様外の用例だが、目次に載せたい&目次のリンクは効かなくていい(≒アンカータグがいらない)&エンピツアイコンがいらない のときは、以下の記述で出来た。 
    LEFT:*見出し
    • このときは、アンカータグをつけずに「見出し」を利用できる。
    • 自動でつかないだけで、自分でアンカータグを記入すれば、目次のリンクは効くなど通常仕様になる。
 

見出しごとの編集中にプレビューで}}が見える

  • エンピツアイコンを利用して見出しごとの編集を開始した場合、次のエンピツアイコンまでかページの最後までのみを編集することができます。
  • その編集中のプレビューでは、編集中の文章のみを参照して表示するので、見出し以前に「{{」を記述していたプラグインは「}}」のみが表示されます。
    ページ全体として必要な記述なので、安易に消してしまわないように気をつけましょう。
  • プレビューでは見えてしまっている「}}」ですが、編集を完了させるとプラグインとして機能するようになるためご安心ください。
 
  • 実例は以下の通り。エンピツアイコンをクリックし、プレビューを確認してみてください。
 

実例：折りたたみの括弧の対応について

まだ折りたたみが始まっておらず、括弧の外です。

もっと見る

前の行から折りたたみの括弧が始まりました。

(解説用見出し)

次の行で括弧を終了します。

既に折りたたみが終了して、括弧の外です。

 

折りたたみプラグイン region/accordion の仕様変更について

  • 2020/02/20のWIKIWIKI.jp*の更新にて、折りたたみの仕様が変更されました。
    内部的に新プラグインに置き換えられるため旧プラグインも使用可能ですが、新プラグインの方が処理が軽いので非推奨とのこと。
    • とはいえ、折りたたみは存在するだけでそのページが重くなるので、多用するのは避けましょう。
  • 折りたたみ旧記述:region 
    #region(見出し)
テキスト
#endregion
  • 折りたたみ新記述:fold 
    #fold(見出し){{
テキスト
}}
    • (見出し,open)とすると、読み込み時にひらいた状態になります。
    • (見出し)、(見出し,close)とすると、読み込み時にとじた状態になります。
    • 動作例：
      見出し

      テキスト

  • 折りたたみmenu旧記述:accordion 
    #accordion_start(見出し,*,close)
テキスト
#accordion_end
  • 折りたたみmenu新記述:accordion 
    #accordion(見出し,*,close){{
テキスト
}}
    • (見出し,*)、(見出し,*,open)とすると、読み込み時にひらいた状態になります。
    • (見出し,*,close)とすると、読み込み時にとじた状態になります。
    • 動作例：

      見出し

      テキスト

 

処理が重い機能

  • 過剰な多用は避けた方が良いものについて
  • 特にMenuBarでは使わないようにしましょう。
  • 折りたたみ(#fold,#accordion)
    • 可読性とトレードオフです。気をつけて使いましょう。
  • #include
    • 編集のしやすさや可読性とトレードオフです。リンクを貼るだけに変更するなど対策してください。
    • ecacheプラグインの使用も検討しましょう。
  • Glossary
    • 誰からも忘れられてる機能です。使わないようにしましょう。
    • Glossaryページに単語を登録することで、他のページでその単語を使ったときにマウスオーバー(2秒くらい待つ)で解説が出てくる。
      （PC閲覧専用の機能）
    • Glossaryを使わなくても、このように手動でできるので、解説がほしい箇所ごとに記述しましょう。 
      &tooltip(表示テキスト){解説テキスト};
 

無編集でのページ更新の完了時

  • 編集画面にてどこにも手を加えずに「ページの更新」を押しても編集は実行されず、日付の更新もされない。
  • ソースの自動修正が起こった場合はその限りでない。ただしコメントアウト内では自動修正されないため注意。主に以下の場合がある。
    • #プラグインの末尾のセミコロンの消去
    • 括弧の数や対応の修正
    • ページ末尾の余計な空白・空行の消去
       
  • #プラグインの末尾のセミコロンの消去
    • プラグインには様々なものがあるが、ページ内への記述方法は以下の2種類である。 
      #hogehoge(引数)
&hogehoge(引数);
    • 上記のように#から始まるものでは、末尾のセミコロン「;」を必要としない。
      • ページの更新時に自動的に消去されるようにアップデートされた（いつ？これか？）
      • 本アップデート前に作成されたページにはセミコロンが残っている場合があるが、ページの編集更新時に消去される。
  • 括弧の数や対応の修正
    • プラグインの括弧の数が修正される。 
      #hogehoge(内側+1つ){{{
#hogehoge(一番内は2つ){{
}}
}}}
      • ペアで数が揃ってさえいれば、多すぎ少なすぎともに修正される？
  • ページ末尾の余計な空白・空行の消去
    • おそらく最近(2020/12)追加されたようです。
  • また、ecacheプラグインを利用しているページでのキャッシュの更新には、無編集更新でも判定される？
 

MenuBarでのデザイン

PCでは画面左に表示されているMenuBarのデザインは、通常ページのそれとは異なります。
MenuBarのページ本体を開いた場合には、通常のデザインで閲覧できます。

見出しについて

  • デザインが変わる(四角の枠になる)
  • 自動生成のアンカーが消失する
  • 「paraedit.png」がなくなる
  • 見出し末尾に「▲▼」がない
「アンカーの消失」について

「アンカーの消失」について

  • 見出しに自動付加されるアンカーが使えなくなるだけで、&anameで手動指定したアンカーは機能します。
  • ここで指定したアンカーは、各ページ上のMenuBarのアンカーとしても機能します。
    例えば、MenuBarに「anc」という名前のアンカーがある状態で、任意のページに[[#anc]]と記述すると、そのページのMenuBar上の「anc」へのリンクとなります。
    [[別のページA#anc]]と記述すれば、別のページAが開いたうえで、そこのMenuBarの「anc」へのリンクとなります。
  • ページ本文とMenuBarの両方を検索した上で移動するリンクなので、アンカー名は、Wiki内全てのページで使われているアンカーと被らないようにしてください
    • (MenuBar内のアンカー名を「menubar_hogehoge」などとするのが無難か)
    • なお、被っている場合はおそらくページ本文側のアンカーへの移動が優先される。
 

表組みについて

  • MenuBarでも表組みを使用できる
  • MenuBarの幅はPCでは2列の表合計145px、3列の表なら合計138px分
    • 携帯端末ではページ左の「MenuBar」ではなくページ下端の「メニュー」として表示され、幅は端末によって異なる
  • 表を使用する際は、携帯端末で標準文字サイズが大きく(PC:12pt、携帯:14ptくらい)なって折り返されてしまうことがあるので注意
 

その他のデザインについて

  • #ecacheをMenuBar内で利用すると、画面付加表示でもページ用のデザインになってしまうらしいので、適用範囲に注意
  • 外部リンクで​も「&ref(): File not found: "ext.png" at page "FrontPage";」がつかない
     

Excelを用いた編集

Excelに文字列を貼り付ける際の注意事項と対策例です。Excel使用方法の詳細は検索すれば大体出てくるので割愛

  • 行先頭の文字が +, -, @ などになっているとエラーになる
    • 対策例：貼り付ける前にセルの表示形式を文字列にする
    • 対策例：構文ハイライトのブロック選択で文頭に適当な文字を入れてからコピペ、追加した1文字は最後に消す
  • 行先頭の ’ が消える
    • 対策例：消えた ' を自分で打ち直す(またはエクセルのIF関数で判定&追加処理)
    • 対策例：構文ハイライトのブロック選択で文頭に適当な文字を入れてからコピペ、追加した1文字は最後に消す
  • 張り付けた際に、一部だけ複数列に分けて張り付けられる
    • 対策例：貼り付ける前に「区切り位置」の「区切り文字」のチェックをすべて外しておく

その他

  • TwitterやYouTubeへリンクするときは、URL末尾のパラメータに気を配ること。
    • Twitterでの「?s=21」は必要ないので削除すること。
    • YouTubeでの「&t=1s」はページ表示時の再生時間です。場合に応じて削除してください。
 

コメント