Guidelines (日本語)

登録を済ませた全ての利用者は Wiki を編集できますが、一貫性を維持するために、これらのガイドラインに従ってください。ガイドラインの変更、または追加情報を入れるべきであると気付いた場合は、ためらわずに Rude までご連絡ください。

目的

Wiki の主な 目的は以下の通りです。

  1. LÖVE API の文章化、および教本を提供する。
  2. LÖVE を使用したゲームおよびライブラリに関する情報を提供する。

言っておきますが、これらの分類を破壊する外部的な情報を追加することが十分可能であると言うことです。

大きな変更を Wiki で行いたい場合、例えば、組み込み型の新規構造体を展開したい。それは行わないで下さい。事前に Rude と必ず相談して許可を得てください。そうしなければ、あなたによる変更は高い確率で破棄されます。

名前衝突

括弧で括られた URL を無効にするため、接頭辞または接尾辞のない平易な題名があります。例えば、 Image 型は外部から http://love2d.org/wiki/Image_(日本語) として参照できます。

これは偶に名前衝突を生じる場合があり、この場合は常にドキュメンテーションのページが優先されます。Awesome (オーサム) と呼ばれるゲームを作成する場合には、その後 LÖVE は Awesome (完全に存在するとは限らない) という型を公開する決定して、そしてゲームを別のタイトルへ移動します。

様式

LÖVE の組み込み型に関して話題にする場合は、それらへリンクをしてください。例えば、 Image は画面上へ画像を表示することができるオブジェクトです。

一般的な文の内部にある変数およびコードを参照する場合は、可読性を改善するために <code> タグを使用してください。例えば: foo および bar を追加した場合は、結果は foobar です。

ドキュメンテーション

ドキュメンテーションが利用可能な場合は、ドキュメンテーションのページは必ず同一構造に従います。

ドキュメンテーションのページには関連項目に親ページへの意味的なリンクが必ずあります。これがありませんと、項目は Wiki 全体に渡る自動生成リストへ出現しません。love.audio においての意味的なリンクは関数、型または列挙型はこのように追加されます: 

[[parent::love.audio (日本語)]]

全てのドキュメンテーションのページには意味的に、'リストと友好的な'解説が必ずあります。これはページの下部に以下を追加することで処理されます: 

{{#set:Description=画面に [[Image (日本語)|Image]] を描画します。}}

モジュール

以下の '二階層' のヘッダは許可されていますが、なにか内容がある場合に限り使用すべきです。

  • 型
  • 関数
  • 列挙型
  • 注釈
  • 用例
  • 関連

必ず全てのモジュールは Category:Modules と関連付けてください。

型

以下の '二階層' のヘッダは許可されていますが、空行にしたまま使用しないでください。

  • 関数
  • 列挙型
  • 上位型
  • 下位型
  • 注釈
  • 用例
  • 関連

必ず全ての型は Category:Types と関連付けてください。

関数

関数に関しては、注釈、用例および関連以外の全てのヘッダが要求されます。これは関数が返値を返さない場合、それが何も返さないことを明示的に述べるべきであることを意味します。同じことは引数にも当てはまります。

同様に、特定の種類 (例えば Contact) に対するコンストラクタが存在しない場合は、これは明示的に言及すべきです。

以下のリストにある外部項目は '二階層' ヘッダであり、内部項目は '三階層' です。

  • コンストラクタ
  • 関数
    • 概要
    • 引数
    • 返値
  • 注釈
  • 用例
  • 関連

関数にオーバーロードがある場合、オーバーロードごとに '関数' ヘッダを反復してください。これはオプションの引数を追跡するためには必携ではありません。単に括弧内の省略値を代わりに表示してください。

引数と返値は Template:param を使用して定義一覧として表記してください。

必ず全ての関数は Category:Functions と関連づけてください。

列挙型

列挙型に対しては、これらのヘッダが許可されています:

  • コンストラクタ
  • 注釈
  • 関連

定数は定数一覧表として一覧化すべきです。

必ず全ての列挙型は Category:Enums と関連づけてください。

ゲーム

ゲームに関しては、あなたが構成を選択することができますが、ゲームの一覧へ正しく掲載させるためにページへいくつかの意味的な特性を必ず追加すべきです: 

{{#set:Name=NoGame}} (ページのタイトルと同じにしてください)
{{#set:Author=User:Rude}}
{{#set:Genre=ゲームの種類}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=ゲームの簡潔な説明。}}
{{#set:Screenshot=File:ScreenshotURL.png}}

画面撮影物は 161x100 ピクセルの枠内に収まるようにするために自動的に大きさが変更されます。

ゲームを Category:Games へ加えることで自動的にゲームページに出現します。正しい分類へゲームを加えるには、この行をページの終端に追加してください。 

[[Category:Games]]

さらにゲーム画面の撮影物を用意することを推奨します。

ライブラリ

厳密な規約はありませんが、ライブラリに関しては、これら意味的な特性を追加すべきです: 

{{#set:LOVE Version=0.6.1}}
{{#set:Description=ライブラリの簡潔な説明。}}

ライブラリを Category:Libraries へ加えることで自動的にライブラリページに出現します。正しい分類へライブラリを加えるには、この行をページの終端に追加してください。 

[[Category:Libraries]]

そのほかの言語

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=Guidelines_(日本語)&oldid=16610"