ユーザーコンポーネントのガイドライン
評価: +4+x
blank.png

このポリシーについて

このポリシーは、ページの一部要素の追加や外観の変更を目的とするWikidotシンタックスやCSS、JavaScriptなどの技術的要素を内包し、簡易に利用することができる「ユーザーコンポーネント」を運用するためのものです。

このポリシーは、以下に定める「ユーザーコンポーネント」を対象に制定されたものです。あなたが個々のページに複雑なWikidotシンタックスを追加、適用しようと考えている場合、このポリシーに書かれていることを意識することは、あなたと、あなたの記事を読む読者、そして同じWikidotシンタックスを追加しようと考える人を助けることにつながります。

------

コンポーネントとは

コンポーネントとは、ページの見た目、もしくはページ内に記述されているWikidotシンタックスを変更することを目的とするCSSコードを含み、[[include]]構文を用いて他のページに導入できるものを指します。これにはテーマは含まれません。これらのページには「コンポーネント1」タグもしくは「コンポーネント・バックエンド2」タグが付与されています。

原則、コンポーネントは The Backrooms JP Wiki サイトスタッフのみが作成できます。The Backrooms JP Wiki 外部サイトに投稿されたコンポーネントページを移植したい場合、サイトスタッフまで連絡し内容を確認した上で代理投稿を行います。その際、サイトスタッフによって内容の追加・変更が行われることがあります。

もしあなたが作成したコンポーネントページをサイトに投稿したい場合は、ユーザーコンポーネントとして投稿する必要があります。その際、以下のルールに従う必要があります。

------

ユーザーコンポーネントとは

このポリシーが適用されるページを「ユーザーコンポーネント」と呼称します。ユーザーコンポーネントとは、以下の定義に全て当てはまるものを指します。

  • 前述したコンポーネントの定義に当てはまるページ
  • user-component:カテゴリに投稿されているページ
  • The Backrooms JP Wiki 一般メンバーの作品として投稿された(サイトスタッフとしての政策の一環で投稿されたものではない) ページ
  • そのユーザーコンポーネントの利用方法を示すユーティリティ(後述)が、ユーザーコンポーネントの作成者と同一ユーザーによって投稿されているページ
  • そのうち、以下の規定(ルール)をすべて満たすもの

これらの定義に当てはまらないページを ユーザーコンポーネントとして作成することは認められません。また、 user-component:カテゴリにユーザーコンポーネントではないページを投稿することは認められません。

サイトスタッフは、ユーティリティを含むユーザーコンポーネントページの全体を査読の対象とします。査読されていないページをユーザーコンポーネントとして作成することは認められません。

------

ユーザーコンポーネントの規定

サイトに投稿されるユーザーコンポーネントは、以下の規定を満たす必要があります。

CC BY-SA 3.0 ライセンスで提供する

ユーザーコンポーネントはWikiの他のコンテンツと同様に、CC BY-SA 3.0で公開されている必要があります。CC BY-SA 4.0 のコンテンツを含めることは認められません。

また、既存のコードを参考にしたり、一部を引用した場合は、当該のコードとライセンスをすべて然るべき場所に明記してください。

使用目的を明示する

ユーザーコンポーネントは、以下に定める条件を満たす必要があります。

  1. 明確な使用目的を定め、ページの最初に明記している
  2. ページを作成するのが妥当であると判断されるのに十分な内容を含んでいる


当サイトの方針に違反する変更内容を含まない

ユーザーコンポーネントは、以下に定める要素を変更してはなりません。

ユーザーコンポーネントでは、それ以外のWikiのすべての部分を変更することができます。ただし、現実的な範囲を超えてはいけません。ユーザーコンポーネントはサイトのコンテンツを正しく認識でき、問題なく読める状態に保つ必要があります。

互換性を維持する

ユーザーコンポーネントは、主要なブラウザ(Google Chrome, Firefox, Safari)、主要なOS(Windows, macOS)、及びモバイル端末(画面幅320px以上)の全てで正常に機能しなければなりません。

コードの質を維持する

ユーザーコンポーネントは不必要なWikidotシンタックス/CSSを大量に含むことはできません。既存のコンポーネントを参考にすることは構いませんが、必要でないコードは参照性の悪化、読み込み速度の低下を引き起こすため削除してください。

また、Wikidotシンタックス/CSSの知識を持つ人がコードを読んだ時、それが何を意図して書かれたものかが十分に理解できるように書かれている必要があります。最低限、あなたはあなたの書いたコードの全ての行に対して、それが何をしているか説明できなければなりません。

また、具体的に以下のような記述は避けてください。それぞれの記述が適切であるかどうかは査読を担当するサイトスタッフ・サポーターが一件ずつ判断します。

  • CSSでの!importantの使用(基幹テーマやコンポーネントとの互換性のために使用しなければ目的を実現できないと判断される場合をのぞく)
  • 同じコード、同ページのコードブロック間での不揃いなインデント・コーディングルール


直リンクを含まない

外部サイトにアップロードされたファイルを@importurl:()などの方法を用いて直接使用することは、原則として禁止されます。ユーザーコンポーネントに使用される画像ファイルなどは、すべてThe Backrooms JP Wiki ストレージにアップロードし、それを参照しなければなりません。

ただし、サイトルール > 第3章 義務と禁止事項 > 第1条 投稿 > 第6項 【外部サイトからの参照の禁止】 で個別に列挙されたサイト群については、その信頼性やWikiの容量節約を鑑み、特例的に直リンクでの利用が許可されます。ここに挙げられていないサイトへの直リンクについては、個別にサイトルールの改訂を待つ必要があります。

また、サンドボックスを含むメインWiki以外の場所にあるコードブロックを参照してはいけません。上記の特例を除き、ユーザーコンポーネントは他のユーザーコンポーネント以外に依存せず、他のコンテンツの変更や削除の影響を極力受けないようにする必要があります。

もし、他のユーザーコンポーネントのコードを使用する場合以下のコードを最下部に挿入する必要があります。

[[iftags]]
[[include :japan-backrooms-wiki:user-component:コードを使用したページ]]
[[/iftags]]


可能な限りページ数を削減する

ユーザーコンポーネントは特にページ数に制限は設けていませんが、可能な限り少ないページで済むようにする必要があります。適切なページ数かどうかは査読時にスタッフによって判断されます。

ユーザーコンポーネントが使用されている

使われていない、また使われる予定のないユーザーコンポーネントの投稿は認められません。ユーザーコンポーネントを投稿するためには、以下の条件を1つ以上満たす必要があります3

  • Wikiに既に存在しているページ4に使われているWikidotシンタックスとほぼ同じ機能を果たし、ユーザーコンポーネント投稿後にその記事のWikidotシンタックスを投稿したユーザーコンポーネントに差し替える5予定があること
  • ユーザーコンポーネントを使用するページとほぼ同時に投稿する予定であること
  • ユーザーコンポーネントを使用するページが、ユーザーコンポーネント投稿から1週間以内に投稿される予定があること


ユーティリティへのバックリンクを掲載している

全てのユーザーコンポーネントページは以下の方法でユーティリティへのバックリンクを含める必要があり、如何なる評価モジュールも設置してはなりません。ユーティリティページにはクレジット付き評価モジュールを設置する必要があります。




ユーティリティとは

ユーザーコンポーネントを説明するページを「ユーティリティ」と呼称します。ユーザーコンポーネントには、他のメンバーがそのユーザーコンポーネントを使用したい時のためのユーティリティを用意されなければなりません。

ユーティリティの規定

サイトに投稿されるユーティリティは、以下の規定を満たす必要があります。

機能を明示する

ユーティリティには、他の記事でユーザーコンポーネントを使用するために何をしなければならないか、どのような機能を持ちどのような見た目で出力されるのかを記述することを意識してください。知っておくべき特別な機能があるのであれば、それも記述してください。

正しい使い方を明示する

ユーティリティでは、[[include]]メソッドでユーザーコンポーネントを参照することで、ユーザーコンポーネントをページに適用するようにユーザーに指示しなければなりません。これは、バックリンク機能を利用して、そのユーザーコンポーネントを利用しているページを正確に把握するためのものです。

クレジット付き評価モジュールを設置する

ユーティリティページにはクレジット付き評価モジュールを設置する必要があります。




以下にユーティリティのテンプレートを示します。必ずしもこの通りに作る必要はありませんが、[[iftags]]メソッドの使用方法など、このテンプレートを参考にすると良いでしょう。

------

ユーザーコンポーネントの作成

ユーザーコンポーネントを作成、投稿したい場合以下のルールと手順に従う必要があります。

申請者

ユーザーコンポーネントの査読、投稿を申請できるのは、原則としてそのユーザーコンポーネントの作成者に限ります。自分以外が作成したユーザーコンポーネントを許可なく投稿することはできません。
あなたを含む複数人によって作成されたユーザーコンポーネントである場合は、その全員の許可のもとでのみ申請することができます。

手順

1. 作成

ユーザーコンポーネントが完成したら、Wikidot上でユーザーコンポーネントページとユーティリティの下書きを作成してください6。ユーザーコンポーネントページには如何なる評価モジュールも設置してはならず、ユーティリティページにはクレジット付き評価モジュールを設置する必要があります。

運用上、ユーティリティを除くすべてのユーザーコンポーネントに関するページはuser-component:カテゴリに投稿されます。必要なユーザーコンポーネントページはすべて「コンポーネント」タグもしくは「コンポーネント・バックエンド」タグのうち適切な方を付与してください。この時、「コンポーネント」タグもしくは「コンポーネント・バックエンド」タグの付与を決定する基準としてユーザーコンポーネントを使用する際に[[include]]を行うページは「コンポーネント」タグであり「コンポーネント」タグが付くページが[[include]]を行うページは「コンポーネント・バックエンド」タグが付与されます。

ユーティリティには「ユーティリティ」タグが必要です。また、utility-で始まっており、ユーザーコンポーネントとの関係性が分かりやすいページネームで作成される必要があります。

ユーザーコンポーネント,ユーティリティのページネームには以下の制限があります。

  • ユーザーコンポーネント
    • user-component:[固定名]-[自由名]
  • コンポーネント・バックエンド」タグが付与されているユーザーコンポーネント
    • 参照先のページネームに-baseを付与する
  • ユーティリティ
    • utility-[固定名]


2. 査読

上記の下書きページのリンクと、投稿を予定しているページのURLを付記し、サイトスタッフに査読を依頼してください。The Backrooms JP Wiki 管理運営サーバーやスタッフへのPMで連絡できます。

スタッフは、あなたの作成したユーザーコンポーネントがこのポリシーに適しているかを判断し、問題がなければ投稿を許可します。モデレーター以上のサイトスタッフは投稿許可を出す権利を持ちます。この判断基準には技術サポーターの助力が加えられることがあります。

スタッフが査読した後、修正すべき点があればそれを、なければ投稿を許可する旨をご連絡します。

査読中もしくは査読後、下書きに大規模な編集を加えることは避けてください。必要な場合は、編集後に再度査読を依頼してください。

3. 投稿

査読が完了し、投稿が許可されたら、あなたはuser-component:カテゴリにページを投稿することができます。
任意のタイミングでサイトにユーザーコンポーネントを投稿しましょう。その際、必ずuser-component:カテゴリに投稿し、「コンポーネント」もしくは「コンポーネント・バックエンド」のいずれかの適切なタグを付与してください。その際、ユーティリティに親記事登録を忘れないようにしてください。

ページを投稿したら、投稿報告を行ってください。

------

ユーザーコンポーネントの編集と削除

ユーザーコンポーネントは通常の記事と同様に扱われ、原著者でないメンバーによる大規模編集は制限されます。誤字やコードの文法的誤りなどは小規模編集として他のユーザーが行っても構いません。

ユーザーコンポーネントの作成者や、作成者の許可を得たユーザーは、ユーザーコンポーネントの大規模編集を行うことができます。これには機能の追加や削除・編集などが含まれます。大規模編集の際にスタッフの査読は必要ありませんが、編集後の内容に問題があるとサイトスタッフが判断した場合は編集前の内容に差し戻しを行う可能性があります。

ユーザーコンポーネントページはVoteが可能ですが、低評価削除の対象とはなりません。

また、ユーザーコンポーネントページの使用されていない状態が1週間以上続いていた場合、予告の後に削除されることがあります。この際、予告から削除の実行までは12時間以上の時間が設けられます。

------

問題が確認されたユーザーコンポーネントの扱いについて

ユーザーコンポーネントは必要だと判断された場合に限り、サイトスタッフによる大規模編集が行われる可能性があります。この大規模編集には、サイトの仕様変更やルールやガイドラインの改定・新設に伴う内容の変更を含みます。

また、ユーザーコンポーネントページは、その内容に問題があると判断された場合、またはサイトスタッフによって内容や使用状況などを鑑みて存在する意義が薄いと判断された場合は、予告の後に削除されることがあります。その際、予告から削除の実行までは12時間以上の時間が設けられます。

但し、その問題が極めて重大であると判断される場合、削除のガイドラインに基づいて即時削除が行われます。

------

他サイトのコンポーネントの翻訳について

他サイトにて CC BY-SA 3.0 相当のライセンスで作成・投稿されたコンポ―ネントページを翻訳・投稿したい場合、翻訳が終了したらサイトスタッフに査読を依頼してください。査読を受けずに投稿することはできません。

サイトスタッフは、そのコンポ―ネントがThe Backrooms JP Wiki独自の仕様に対応しているか、翻訳は十全であるかなどを確認し、問題がなければ翻訳ページの投稿をスタッフが代理投稿します。

査読中もしくは査読後、下書きに大規模な編集を加えることは避けてください。必要な場合は、編集後に再度査読を依頼してください。

投稿時の査読を除いては、通常の他サイト翻訳記事と同様の扱いがなされます。

特に明記しない限り、このページのコンテンツは次のライセンスの下にあります: Creative Commons Attribution-ShareAlike 3.0 License