編集ガイド

「編集ガイド」の編集履歴(バックアップ)一覧に戻る

編集ガイド - (2019/08/15 (木) 23:30:40) のソース

当wikiを編集する際のノウハウを伝授します。
atwikiの編集プラグインについては''[[atwikiご利用ガイド>>https://www1.atwiki.jp/guide/]]''で調べてください。

#contents(,fromhere=true,level=3)
----
**wikiの登録・ログイン
''現在、一時的にwikiに編集制限を設定しています。''
編集を希望する方は、右上の''「このウィキに参加」''からメンバー登録を行ってください。
現在、登録は自動承認制です。登録にはメールアドレスが必要になります。

wikiメンバーの権限は以下の通りです。
-編集制限がかかっているときにも、wikiページの編集権限を持つ。
-編集制限がかかっていないとき、編集実行時の文字入力承認が不要になる。
-閲覧制限のあるページにもアクセスできる。&footnote(現在、恒久的に閲覧制限をかけているページはありませんが…)

また、wiki管理者は
-個別ページに対する閲覧・編集権限の設定
-編集モードの変更
-アップロードファイルの削除
をwikiメンバーに付与することができます。
これらの機能が必要な方は管理人まで連絡ください。

高度な設定(ページ削除、CSSスタイル設定など)は''管理者のみ可能''です。


**掲載ページに迷ったら
&u(){ページ:''[[小ネタ]]''に載せてください。}
数行で収まるような内容ならば、これらのページに見出しを一つ追加して掲載してください。

検証wikiの項目にない良い記事を見つけたときや、自身のブログなどに検証内容をまとめた場合は、
ページ:[[小ネタ]]に項目を追加するか、メニューの「その他」にリンクを作成してください。

「**」クラスの見出しが2つ以上作れるときや、独立したページを作る価値があるネタについては新規ページを作成してください。
ページ:[[小ネタ]]の内容が膨れ上がった場合は、新規ページを作って内容を移動しましょう。

「ギリギリで独立ページになったネタ」として、for検証wikiの次のページを判断基準にするとよいと思います。
-[[for_ベクトル合成>>https://www30.atwiki.jp/ssb4_kensyou/pages/122.html]]:内容の量のボーダーライン。
-[[for_ポート>>https://www30.atwiki.jp/ssb4_kensyou/pages/130.html]]:量としては若干足りないが、関連する項目が無いため独立して作るべきだと判断。


**ページ作成
複数のページ編集モードがありますが、''基本的にatwikiモードを推奨''します。
ページ作成後は、「メニューの編集」で''メニューにページを追加''してください。


**ページレイアウト・一行の文字数
2019/6/9現在、PC版のページレイアウトを
-本文:14 px
-最小本文幅:840 px
-最小全体ページ幅:1280 px
に設定しています。
この設定の下では、''本文1行につき60文字''までであれば、PCブラウザのウィンドウサイズによらず折り返しが発生しません。&footnote(全角の場合)
このため、''一文をなるべく60文字以下に収め、一文ごとに改行する''ことを推奨します。
60文字を超える文は、区切りの良い所で改行して2行にすると良いでしょう。

''左メニューは1行につき10文字''までならば一行に収まります。&footnote(全角の場合。箇条書き記号を含む)
ページ名が10文字を超える場合、「&nowiki(){[[ページ略称>>リンクするページ名]]}」の書式でメニューに登録してください。

スマホ版は、おおむね''本文1行あたり20文字''で表示されます。
ただし端末に大きく依存するため、編集時にはあまり気にしなくて良いです。


**編集プラグインの用例
管理人のプラグインの使い方を紹介します。
これに従う必要は全くありませんが、参考になれば幸いです。

***目次・コメント
ページの一番上には基本的に目次を作る。
「***」までの見出しを表示するには、
 #contents(,fromhere=true,level=3)
 ----

ページの一番下にはコメントボックスを置く。

 ----
 **コメント
 #comment() あるいは #pcomment(reply)
上の例のように、本文と目次・コメントの間には仕切り線「&nowiki(){----}」を入れる。
-「&nowiki(){#comment()}」タイプは、投稿コメントが本文テキスト扱いとなり、ページ編集で編集可能となる。
-「&nowiki(){#pcomment(reply)}」タイプは、ツリー形式のコメントが別ページ扱いで展開される。

***見出し
見出しの規模は次のように使い分けるとよい。
 **(h2):ページ内で数回出てくるような規模の見出し
 *** (h3):小見出し
 ****(h4), *****(h5):極小見出し、強調
「**」の前には空行を2行、「***」の前には1~2行挿入するのが目安。
「****」,「*****」は見出しだけでなく強調としても使える。
「*」(h1) も使用できるが、atwikiでは利用を推奨していない。

***文字装飾
****太字
 書式: &b(){太字} または ''太字''
単語や短いフレーズ、強調したい文に使用する。
強調には、基本的に太字を使えばよい。
シングルクォート2つ('')で囲う形式は、中身にスペースが入っていると上手く機能しない。

****下線
 書式:&u(){下線}
少し強調したい文・フレーズに使用する。太字と組み合わせるのもよい。

****色文字
 書式:&color(red){文字} もしくは &color(red,blue){文字}
性質の違うものとして注意を惹きたい箇所に使う(変更点など)。太字と組み合わせるのもよい。

色を1つ指定すると文字色が変わる。2つ指定すると、1つめが文字色・2つめが背景色になる。
( )内に使える色は、[[atwikiで使える英語色名の一覧>>https://www65.atwiki.jp/atwikicolor/]]にまとめられている。
例:&color(red){red}, &color(blue){blue}, &color(yellow){yellow}, &color(orange){orange}, &color(green){green}, &color(purple){purple}

***箇条書き
 書式: -(番号無) もしくは +(番号付)

箇条書きの領域は、上下の本文との境界に
-この程度の余白が
生まれることに留意。

入れ子構造の箇条書きでは、標準と番号付の箇条書きを組み合わせることも可能である。
+大乱闘スマッシュブラザーズSPECIAL
+大乱闘スマッシュブラザーズfor
+-大乱闘スマッシュブラザーズfor3DS
+-大乱闘スマッシュブラザーズforWiiU
+大乱闘スマッシュブラザーズX

***整形済みテキスト
 書式: 行頭に半角スペース
計算式や解析データのスクリプトなどを載せるときに使う。
整形済みテキスト内では、文字装飾や箇条書きなどのプラグインが無効になる。

****数値強調(等幅プラグイン)
 書式:&tt(){テキスト}
&tt(){12%}のように、文章中で数値を目立たせたいときに使用する。
この等幅プラグインの装飾は当wiki独自のものである。


***引用
 書式:行頭に ">"
公式情報や他サイトからの引用に使う。

***divclass
 書式:#divclass(class名){テキスト}
当wikiのCSS設定で定義したclassの書式をテキストに適用する。
当wikiが現在定義しているclassは、
-&bold(){bggray}
-&bold(){caution}
-&bold(){box1}
-&bold(){box2}
である。

#divclass(bggray){
bggray
}

#divclass(caution){
caution
}

#divclass(box1){
box1
#divclass(box_title){box1_title1}
#divclass(box_title2){box1_title2}
#divclass(box_title3){box1_title3}
}

#divclass(box2){
box2
#divclass(box_title){box2_title1}
#divclass(box_title2){box2_title2}
}


***数式
検証wikiではTexlikeモードをONにしている。
Tex形式の記述を「$$」で挟むと画像として数式を表示できる。
ただし行幅が固定なので分数表記には向かない。
他サイトへのコピー&ペーストも考えて、''数式は整形済みテキストで打ち込む''ことを推奨しておく。

***表
例えば、
-先頭行をヘッダーに指定
-並び替え可能
-縞模様
-10項目ごとにヘッダー繰り返し
の表は、以下のように作成する。
 |A|B|C|h
 |a|b|c|
 |a|b|c|
 |a|b|c|
 #table_sorter(){head=#d6f,odd=#f0f0f0,even=#ffffff,repeathead=10}

表の作成には、Excelの表をwiki形式に変換するツールを使うと便利である。
-[[WikiサポートExcelアドイン>>https://www.ideamans.com/software/wiki-support-addin/]]
-[[Excelの表をWiki形式に変換するjsフォーム>>https://tools.racing-lagoon.info/excel2wiki]]

***画像
まず、ページに使いたい画像を「このページにファイルをアップロード」からアップロードする。

画像表示にはimageコマンドを使う。
 書式:#image(sample.jpg, width=480, https://img.atwikiimg.com/www65.atwiki.jp/smashsp_kensyou/attach/15/651/sample.jpg)
#image(sample.jpg, width=480, https://img.atwikiimg.com/www65.atwiki.jp/smashsp_kensyou/attach/15/651/sample.jpg)

widthまたはheightで大きさを一辺だけ指定すると、もう一辺は縦横比を保存したままリサイズされる。
スマホ版ページは横幅を自動調整して表示してくれるので、PC版でのレイアウトだけを考えて表示サイズを決めればよい。
&bold(){横幅 = 480px, 640px}あたりが目安となる。

画像クリックで拡大表示させるには、画像のURLをimageコマンド内に追加する。
「このページにファイルをアップロード」>アップロードされたファイル一覧
から、画像ファイルのリンクアドレスをコピーするのが一番手軽。


****キャラクターアイコン
atwikiでは、wiki内の他のページにアップロードしてある画像を参照できる。
例えば複数のファイターを挙げるとき、ページ:[[アイコン]]にあるストックアイコンを利用すると綺麗にまとまるだろう。
アイコンを横に並べる場合、"inline"オプションを使って下のように記述するとよい。
 &image(inline, page=アイコン, mario.png)&image(inline, page=アイコン, luigi.png)

上の表示例:&image(inline, page=アイコン, mario.png)&image(inline, page=アイコン, luigi.png)


***リンク
wiki内ページであれば、シンプルに以下の形で書くのが良い。
 [[リンクするページ名]] または [[ページ略称>>リンクするページ名]]

新しいタブで外部ページを開くリンクは以下のように作成する。">"が1つだと直接そのページに移動する。
「あるページのある見出し」に飛ばすには、そのページの目次にある見出しリンクURLをコピー&ペーストし、↓のURLとして入力する。
 [[表示するテキスト>>URL]]

----
**コメント
#comment()