ユーザ用ツール

サイト用ツール


Language:

サイドバー

バーチャルキャスト公式Wiki

メニュー

配信

その他

リリース情報

デベロッパー向け


開発環境

VRM

VCI

GLB

wiki:rule

Wikiの編集ルール

Wikiを編集する人は一読お願いします。

参考リンク

1.方針

ページ分類 意味
単項目ページ 1つの内容ついて説明したページ
ガイドページ いくつかの単項目ページを組み合わせて作成したページ

基本的には単項目ページガイドページの2種類のページによって構成します。
「知りたいページが見つからない」のを防ぐためにサイドメニューにリンクを作成します。


例えば「VRMの作り方」を説明しようとした場合…
Unityの準備、VRMの仕様や設定方法、MToonの設定、SEEDへのアップロード、VirtualCastの作業…
といった感じで、多くのツールや物事についてまたいだ形で説明する必要があります。

この時に作業手順を全て書き出してページを作成してしまうと、
別の作業手順の説明をした際に似たような内容を再掲載してしまったり、作業全体ではなく特定の事だけ知りたいのに作業全体を順番になぞって探す必要がある等の問題が発生します。

具体的な内容単項目ページに記載し、
作業手順のページや全体を俯瞰したページを書きたい場合ガイドページとして作成しましょう。


上図のように、ガイドページはいくつかの単項目ページへのリンクで構成します。
そうする事で、重複した作業内容を繰り返し書く必要がなくなり、保守するページも最小限になります。
ページを作りすぎてもwikiの構造が複雑になり保守コストが上がり検索性が落ちるので、不足なく必要なページのみを作成するように心がけます。

2.編集ルール

  1. 新規に作成するページは 単項目ページ か ガイドページ のどちらかを作成する
  2. 単項目ページは1つの内容について書く
  3. ガイドページには詳細な内容は書かず、単項目ページへのリンクを掲載する形で説明を行う
  4. 文章の区切りは余白で表現する(hr 禁止)
  5. 見出しの前後にbr 禁止
  6. スマートフォンなどの端末で表示した際に破錠する恐れがあるため画像の右揃え、左揃えを禁止。

Questページ

3.Wiki構成について

カテゴリー一覧

ネームスペース


ネームスペースとは、ページを作成したときに割り振られるURLのことです。
ネームスペースには階層があり、「/」(スラッシュ)で区切られます。

  • 1番上のネームスペースは サービスの種類・ツール・扱うデータの種類 で分けます
  • その下のカテゴリーは比較的柔軟に決めてOKです(既存ページの命名など参考にしながら)
  • 既存のネームスペースに分類できそうなものは既存のネームスペースに分類してください

ネームスペースの方針の基準として 何がどこにあるのか分かりやすくする・分類しやすくする を第一とします。ネームスペース通りに単項目ページを並べると目次になるような状態が理想です。

ネームスペース一覧

画像ファイルのネームスペース

画像はアップロードした際の名前がそのままネームスペースになります。
可能であれば下記ルールでアップロードしましょう。

  • 画像を掲載するページと同じネームスペースにする
  • カテゴリー名事に大文字やアンダーバーで区切る(item_make , ItemPointer 等)
  • 複数枚にまたがる場合は末尾に数字を付ければOK


ネームスペースは半角英数字のみ

全角文字(2byte)を使用してしまうとリンクが長くなり、改行の際に変な切れ方をする事があります。
サービスによってはリンクが文字数制限に引っかかったり、リンクが切れる事があります。
wikiのリンクを外部に貼りやすくするためにも、ネームスペースは半角英数字で区切るようにしましょう。

4.用語に関するルール

正しい用語・表記を使用するように心がけましょう。

正しい用語・表記 ルール 誤った表記の例
バーチャルキャスト Virtual Cast, VirtualCast
キャラクター 用途にもよるがTSO仕様はキャラクター アバター、VRM、モデル
アイテム 用途にもよるがTSO仕様はアイテム 小道具、VCI
ロケーション 用途にもよるがTSO仕様はロケーション 背景、GLB、ワールド
関数 VCIスクリプト等を説明する際に、メソッドという言葉を使わずに関数で統一してください。
VSCode wikiでVisual Studio Codeを指す場合はVSCodeで統一してください(Cは大文字)。 VScode
コピー&ペースト コピペという略語は使わずに、コピー&ペーストで統一してください。
THE SEED ONLINE 略さずに全て大文字で統一してください。 THE SEED, SEED, The Seed Online
VCIスクリプト VCIScript
Lua lua
部屋主スタジオの表現は部屋主ですが、ルームの表現はオーナーになります。 Owner, オーナー
スタジオID 凸ID

5.ページテンプレート

ページ分類 テンプレート
単項目ページ 単項目ページ(テンプレート)
ガイドページ ガイドページ (テンプレート)
VCIサンプルページ VCIサンプルページ(テンプレート)
リファレンスページ リファレンスページ(テンプレート)
アップデートログ アップデートログ(テンプレート)

6.記法のコツ

リンクについて

Wikiの編集ルールのようなリンクは、次のように記載します。

[[wiki:rule]]

このようにネームスペースをかっこで括り、「/」(スラッシュ)を「:」(コロン)で置き換えると、
リンク先のページの最初の見出しが、リンク文字列として表示されます。

[[wiki:rule | リンク文字列]]

上記のように | で区切ることで、右側に任意のリンク文字列を書く事ができます。

折り畳み

ガイドページやTOPページが長くなる場合、折り畳み機能を使用して見やすくします。
折り畳みのタイトルには (クリックで展開) を含めてください。(展開できると思われない場合があります)

〇〇一覧 (クリックで展開)
  • 1
  • 2
  • 3


--> 〇〇一覧 (クリックで展開) #

  * 1
  * 2
  * 3

<--

書き方を統一するため、次のような場合は例文のように記載して下さい。

メニューや、キーを記述する場合

[]を使用します。
例: [表示 > 隠しファイル]にチェックを入れてください。
例: Windowsなら[Ctrl + Shift + X]を押して拡張機能のウィンドウが開けます。

フォルダのパスを記述する場合

フルパスの場合はcodeタグを使ってください。

C:/Users/_USER_/AppData/LocalLow/infiniteloop Co,Ltd/VirtualCast
<code@>C:/Users/_USER_/AppData/LocalLow/infiniteloop Co,Ltd/VirtualCast</code@>

※@マークを抜いてください。

本文中にコードを挿入する場合

文章中にコード を挿入。

文章中に''コード'' を挿入。

強調したい場合

1つ目の強調2つ目の強調。

''1つ目の強調''、**2つ目の強調。**

目次オフ

右上に表示される目次を消したいときに、ページの一番上に記載します。

~~NOTOC~~

参考リンク

参考リンクがあるとき、青色がバーチャルキャストっぽいのでこちらを使います。
Wikiの編集ルール

<wrap notice right>⇒ [[wiki:rule]]</wrap>\\

その他

  • 図表のフォントは、NotoSansJP-Regular等の見やすいフォントを使ってください。
wiki/rule.txt · 最終更新: 2022/07/01 20:32 by pastatto

ページ用ツール