Guidelines (Indonesia)

Semua user yang terdaftar dapat mengubah isi wiki ini. Oleh karena itu, agar wiki teratur dengan baik dan konsisten, silahkan mengikuti ketentuan-ketentuan berikut ini. Jika anda merasa panduan ini perlu diperbaiki atau ditambah, jangan ragu, silahkan hubungi Rude. ^__^

Tujuan Wiki

Tujuan utama wiki ini adalah sbb:

1. untuk mendokumentasikan LÖVE API dan menyediakan panduan pembelajaran (tutorial);
2. untuk menyediakan informasi mengenai permainan komputer yang menggunakan LÖVE dan library pendukung yang tersedia:

oleh karena itu, penambahan informasi yang berkaitan dengan kategori-kategori tersebut sangat diperbolehkan.

Jika anda ingin mengadakan perubahan signifikan dalam wiki, seperti menerapkan struktur baru untuk tipe-tipe yang telah tersedia, anda harus menghubungi Rude terlebih dahulu. Jika tidak, perubahan tersebut akan dikembalikan seperti sedia kala.

Konflik Penamaan Halaman

Untuk mengurangi penggunaan URL yang terlalu panjang, halaman dokumentasi menggunakan judul sederhana tanpa awalan atau akhiran. Sebagai contoh, halaman yang berisi dokumentasi mengenai tipe data Image, dapat dirujuk dari situs lain dengan menggunakan link http://love2d.org/wiki/Image.

Jika terjadi konflik penamaan, nama halaman dokumentasi framework LÖVE akan dipertahankan dan halaman yang bertentangan akan dipindahkan ke alamat lain. Contohnya, jika anda mendaftarkan halaman dokumentasi permainan komputer dengan nama Awesome, dan LÖVE di kemudian hari memiliki tipe-data Awesome (bukan mustahil :P), maka halaman permainan anda akan dipindahkan ke alamat lain.

Cara Penulisan

Jika dalam tulisan anda terdapat tipe-data yang ada dalam LÖVE, berilah link ke halaman yang bersangkutan dengan menggunakan sintaks kurung-siku ganda [[ judul halaman ]]. Contoh:

• "[[File]] adalah sebuah objek yang merepresentasikan sebuah file dalam sistem."
• File adalah sebuah objek yang merepresentasikan sebuah file dalam sistem.

Untuk menampilkan variabel dan rutin program dalam kalimat biasa, gunakanlah tag <code> kode </code> untuk mempermudah pembaca. Contoh:

• "Untuk menggabungkan <code>string1</code> dan <code>string2</code>, dapat digunakan sintax <code>string1 .. string2</code>."
• Untuk menggabungkan string1 dan string2, dapat digunakan sintax string1 .. string2.

Dokumentasi Otomatis

Beberapa halaman yang ada dalam dokumentasi ini diproduksi secara otomatis dengan memanfaatkan semantik tertentu. Oleh karena itu, halaman dokumentasi harus mengikuti struktur tertentu agar dapat berfungsi dengan baik.

Setiap halaman dokumentasi harus memiliki link-semantik ke halaman parent mereka pada bagian See Also. Tanpa link ini, halaman tersebut tidak akan ditampilkan dalam daftar otomatis di dalam wiki ini. Contoh: setiap halaman dokumentasi function, type atau enum yang memiliki parent love.audio memiliki kode link-semantik sbb:

• [[parent::love.audio]]

Setiap halaman dokumentasi juga harus memiliki deskripsi-semantik di akhir halaman sehingga deskripsi tersebut dapat ditampilkan dalam daftar yang terdapat di halaman parent. Contoh kode deskripsi-semantik pada halaman Image:

• {{#set:Description=Draws an [[Image]] on screen.}}

Struktur Dokumentasi LÖVE

Modul

Dalam dokumentasi sebuah modul, header 'level 2' berikut ini dapat digunakan jika ada informasi yang dapat dikategorikan kedalamnya.

• Tipe Data
• Fungsi
• Enumerasi
• Catatan
• Contoh
• Kaitan

Semua dokumentasi modul harus diasosiasikan dengan menggunakan semantik:

• [[:Category:Modules]]

Tipe Data

Dokumentasi tipe data dapat menggunakan header 'level 2' berikut, jika ada informasi yang dapat diberikan.

• Fungsi
• Enumerasi
• Supertipe
• Subtipe
• Catatan
• Contoh
• Kaitan

Semua dokumentasi tipe data harus diasosiasikan dengan menggunakan semantik:

• [[:Category:Types]]

Fungsi

Berikut ini adalah daftar header 'level 3' (yang terindentasi) dan 'level 2' untuk dokumentasi suatu fungsi.

• Konstruktor
• Fungsi
  • Sinopsis
  • Argumen
  • Keluaran
• Catatan
• Contoh
• Kaitan

Semua header kecuali Catatan, Contoh and Kaitan harus digunakan. Jika sebuah fungsi tidak mengembalikan suatu nilai, secara eksplisit harus dituliskan bahwa fungsi tersebut tidak mengembalikan apa-apa. Demikian juga halnya dengan Konstruktor dan Argumen.

Jika sebuah fungsi memiliki parameter yang berbeda, header 'Fungsi' dapat diulang untuk setiap bentukan. Jika argumen memiliki argumen yang bersifat optional, nilai cadangannya (default) dapat diberikan di dalam tanda kurung.

Argumen and Keluaran harus ditampilkan dalam bentuk daftar definisi menggunakan:

• [[:Template:param]]

Semua dokumentasi fungsi harus diasosiasikan dengan menggunakan semantik:

• [[:Category:Functions]]

Enumerasi

Header berikut boleh digunakan dalam dokumentasi enumerasi

• Konstanta
• Catatan
• Kaitan

Konstanta harus ditampilkan dalam bentuk daftar definisi dengan menggunakan:

• [[:Template:param]]

Semua dokumentasi enumerasi harus diasosiasikan dengan menggunakan semantik:

• [[:Category:Enums]]

Struktur Halaman Permainan

Untuk membuat sebuah dokumentasi permainan, anda dapat menggunakan struktur buatan sendiri, tetapi ada beberapa semantik yang perlu ditambahkan ke halaman tersebut agar dapat ditampilkan dengan benar dalam daftar list of games:

• {{#set:Name=NoGame}} (Harus sama dengan judul halaman.)
• {{#set:Author=User:Rude}}
• {{#set:LOVE Version=0.6.2}}
• {{#set:Genre=Genre dari game anda}}
• {{#set:Description=Deskripsi singkat mengenai game anda}}
• {{#set:Screenshot=File:ScreenshotURL.png}}

Sangat dianjurkan untuk menampilkan gambar tampilan permainan dalam dokumentasi anda. Screenshot akan secara otomatis disesuaikan ke dalam kotak sebesar 161x100 pixel.

Supaya dokumentasi permainan akan ditampilkan secara otomatis dalam halaman Games, daftarkan permainan anda dalam Category:Games dengan menambahkan baris berikut di akhir halaman:

• [[Category:Games]]

Struktur Halaman Library

Tidak ada aturan yang mengikat, seperti pada dokumentasi permainan, anda harus menambahkan beberapa semantik sbb:

• {{#set:LOVE Version=0.6.2}}
• {{#set:Description=Gambaran singkat mengenai library buatan anda.}}

Tambahkan semantik berikut di akhir halaman untuk mendaftarkan dokumentasi library anda:

• [[Category:Libraries]]