Menulis SpongeDocs

Peringatan

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Itu Sponge dokumentasi, juga disebut sebagai " SpongeDocs ", merupakan dokumentasi resmi dari Sponge proyek. Tujuan dari SpongeDocs adalah untuk:

  • Bantu pengguna menyiapkan server mereka sendiri yang didukung oleh penerapan Sponge.
  • Memberikan pengembang dengan informasi tentang bagaimana untuk berkontribusi pada Sponge proyek.
  • Memberikan pengembang dengan informasi tentang bagaimana untuk memulai dengan Plugin pembangunan.

Pelaporan Masalah

Mungkin selalu terjadi bahwa halaman akan usang, kesalahan menyelinap di atau Anda hanya melihat halaman dan berpikir "Nah, ada cara yang lebih baik untuk menjelaskan ini." Jika itu terjadi dan Anda untuk beberapa alasan tidak mampu menyediakan memperbaiki diri sendiri, ada tiga cara untuk membuat kita menyadari masalah:

  1. Membuat sebuah isu di Github SpongeDocs
  2. Buat sebuah postingan dalam kategori SpongeDocs forum
  3. Kunjungi kami pada saluran `#SpongeDocs di irc.esper.net <ircs://irc.esper.net:6697/#spongedocs>`_(anda harus terdaftar lebih dulu)

Menulis Docs

Perubahan dan penambahan untuk SpongeDocd seharusnya diserahkan sebagai suatu tarikan permintaan untuk ' repositori SpongeDocs pada GitHub <https://github.com/SpongePowered/SpongeDocs> '_. Kami tidak membutuhkan menjadi jauh benar sempurna benar seperti umum untuk permintaan tarik menjadi disempurnakan selama proses ulasan. Penjelasan tidak lengkan juga merupakan sambutan, jadi jangan menghindar jika ada beberapa bagian anda tidak mengerti. Akan selalu ada seseorang yang mampu mengisi kekosongan.

Dokumentasi ditulis dalam reStrukturedText (reST), jika kami akrab dengan Markdown (md) langkah untuk reST tidak harus menjadi susah. Jika kamu memiliki masalah dengan itu kami menyarankan bahwa anda bergabung dengan kami ' forum <https://forums.spongepowered.org/> '_ atau ' #SpongeDocs <ircs://irc.esper.net:6697/#spongedocs> '_ pada Esper.net dan meminta bantuan di sana.

Dokumentasi Sponge berlisensi dibawah ' Creative Commons - Share-Alike lisensi <https://creativecommons.org/licenses/by-sa/4.0/> '_. Aset seni diadakan dibawah yang terkait ' Lisensi Creative Commons - Tidak Komersil, Tidak Derivatif <https://creativecommons.org/licenses/by-nc-nd/4.0/> ' _, Kontribusi secara implisit menerima lisensi ini.

Panduan gaya

Untuk memastikan kita memiliki format yang konsisten di semua SpongeDocs halaman, berikut ini adalah panduan kami telah dikembangkan untuk menulis Sponge Dokumentasi. Daftar ini mungkin akan ditambahkan ke (atau membungkuk keluar dari bentuk) sebagai Docs mendapatkan lebih besar.

  1. Judul harus ditulis dalam kotak judul (<-contoh) [kecuali kalau #8 terpasang].
  2. Judul halaman harus bermakna (judul muncul sebagai link).
  3. Kode program harus dicantumkan `dibaris literal <http://docutils.sourceforge.net/docs/ref/rst/roles.html#literal>`_atau kode blok.
  1. Cobalah untuk tidak menempatkan terlalu banyak teks dalam blok kode, karena mereka tidak dapat diterjemahkan. Kontributor yang dianjurkan berkomentar di blok kode sedapat mungkin. Teks sederhana tempat-pemegang mungkin diperlukan dalam beberapa contoh. Idealnya, blok kode contoh akan pendek, dan dilanjutkan dengan penjelasan untuk setiap contoh dalam teks tubuh. Tentu saja, mungkin ada beberapa konsep yang tidak dapat digambarkan dengan contoh singkat.
  1. Menjaga wilayah yang terpisah untuk Pengguna, Plugin Pengembang, dan Sponge Pengembang.
  2. Menghindari pengulangan dengan berbagi halaman di mana mungkin.
  3. Link ke sumber eksternal daripada mereproduksi mereka.
  1. Beberapa pengecualian yang dibuat untuk tujuan penerjemahan.
  1. Membuat perbedaan antara SpongeForge, SpongeVanilla dan SpongeAPI.
  2. Jika terlihat mengerikan dalam bahasa Anda, menciptakan aturan sendiri.
  3. Sponge adalah Judul Proyek dan TIDAK harus diterjemahkan.
  1. Beberapa bahasa mungkin ingin menggunakan terjemahan fonetik juga.
  1. Terjemahan otomatis (mis. Google Translate) Sangat dianjurkan. Ini sering berisi kesalahan yang sangat serius, dan besar kemungkinan akan ditolak.
  2. Halaman Judul dan Bagian Pos harus teks biasa, menghindari blok literal dan format lainnya.
  3. Simbol kode harus dikapitalisasi dalam bentuk aslinya dan tidak memiliki ruang ekstra (misalnya. blockState (nama field) atau BlockState (nama kelas), daripada blok negara). Mereka juga harus diformat sebagai literal menggunakan tanda kutip mundur ganda (misalnya. `` BlockState``) dalam tubuh teks.
  4. Baris harus memiliki panjang maksimal 120 karakter.
  5. Impor harus ditulis dalam blok kode pertama kalinya mereka dirujuk dalam setiap artikel, tapi tidak terulang setelah pertama kali.

Catatan

Karena Sponge masih dalam kondisi fluks, kurangnya dokumentasi pembangunan diharapkan. Sampai resmi rilis Sponge, pasti ada rongga di banyak mata pelajaran. Meski demikian, SpongeDocs adalah dokumen hidup, selalu bisa di edit. Tidak akan pernah sempurna, hanya dipukul menjadi seperti kebutuhan.

Kontribusi, saran dan koreksi selalu diterima.