ユーザーコンポーネントに関するポリシー

SCP-JP SB3 » R74のサンドボックスポータル » ユーザーコンポーネントに関するポリシー

このページの批評は終了しました。

クレジット

タイトル: ユーザーコンポーネントに関するポリシー
著者: SCP財団
作成年: 2020

本ページはSCPコミュニティのために作成され、SCP財団に帰属します。本ページの管理はサイトスタッフに委任されています。

このポリシーについて

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

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

------

コンポーネントの定義

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

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

もしあなたが作成したコンポーネントページをサイトに投稿したい場合は、以下の定義に従う必要があります。

------

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

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

user-component:カテゴリに投稿される、または投稿されたページ
SCP-JPの一般メンバーが作成したコンポーネントページ
下記の制限事項を満たすもの

これらの定義に当てはまらないページをuser-component:カテゴリに作成することはできません。

------

制限事項

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

ライセンス

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

許容される条件

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

明確な使用目的を定め、ページの最初に明記する必要があります。
ページを作成するのが妥当であると判断されるのに十分な内容を含んでいる必要があります。
内容はサイトルールや各ガイドラインに違反しない、また違反を助長しないものである必要があります。

許容される要素

あなたは、以下に定める要素以外の、Wikiのすべての部分を変更することができます。但し、現実的な範囲を超えてはいけません。サイトの内容は正しく認識でき、可読である必要があります。

また、ユーザーコンポーネントにサイトルールに違反する内容を含めることはできません。

変更が制限される要素

カスタムテーマに関するポリシー制限事項/許容される変更の変更が制限される要素で定める要素
ユーザーコンポーネントで追加するWikidotシンタックスに対して影響しない要素

互換性の維持

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

コードの質の維持

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

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

また、必要な場合、また他のコンポーネントとの互換性のために使用したほうが良いと判断される場合を除き、CSSでの!importantの使用は避けることを推奨します。

直リンクの禁止

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

但し、SCP-JPファイルストレージ、Google Fonts、BootStrapCDN、cdnjsなどのいくつかのサイトについては、その信頼性やWikiの容量節約を鑑み、特例的に直リンクでの利用が許可されます。ここに挙げられていないサイトについては、個別に審査されます。

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

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

[[iftags]]
[[include :scp-jp:user-component:コードを使用したページ]]
[[/iftags]]

ページ数

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

マニュアルページの提示

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

マニュアルページには、自分の記事にユーザーコンポーネントを適用し、使用するために何をするべきか、どのような見た目になるのかを記述することを意識してください。知っておくべき特別な機能があるのであれば、それも記述してください。

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

他にもマニュアルページでは、そのページ自体に自身のユーザーコンポーネントを適用しなければなりません。マニュアルページ自体がユーザーコンポーネントの見本となります。

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

+ テンプレート

サイトスタッフは、このマニュアルページを含むユーザーコンポーネントページの全体を査読の対象とします。

全てのユーザーコンポーネントページはマニュアルページを以下の方法でBacklinksする必要があります。

+ テンプレート

ユーザーコンポーネントに複数ページ要する場合

深層インクルードを使用する場合、どうやってもページが2つ必要になります。その場合、インクルード元ページには「コンポーネント・バックエンド」タグを付与しuser-component:カテゴリへ、初期値を代入した[[include]]文が含まれるマニュアルページには「フラグメント」タグを付与しfragment:カテゴリに作成してください。

+ テンプレート

ユーザーコンポーネントに[[iftags]]が使われている場合

特殊な例ですが、この場合もユーザーコンポーネントに複数ページ要する場合同様、インクルード元ページに「コンポーネント・バックエンド」を付与しuser-component:カテゴリへ、マニュアルページに「フラグメント」タグを付与しfragment:カテゴリに作成してください。

この時、マニュアルページはマニュアルだけの機能としてください。

+ テンプレート

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

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

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

------

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

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

申請者

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

手順

1. 作成

ユーザーコンポーネントが完成したら、Wikidot上でユーザーコンポーネントページの下書きを作成してください⁵。

2. 査読

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

スタッフは、あなたの作成したユーザーコンポーネントがこのポリシーに適しているかを判断し、問題がなければ投稿を許可します。モデレーター以上のサイトスタッフが許可を出す権利を持ちますが、投稿許可を出すには必ず1人以上のテクニカルスタッフの承認が必要です。

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

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

3. 投稿

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

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

------

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

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

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

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

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

------