Menulis SpongeDocs

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.

The Docs are written in reStructuredText (reST), if you're familiar with Markdown (md) the step to reST shouldn't be too hard. If you're having issues with it we suggest that you join our forums or #spongedocs on irc.esper.net and ask for help there.

The Sponge Documentation is licensed under the Creative Commons - Share-Alike license. Art assets are held under the related Creative Commons - Non Commercial, No Derivatives license. Contributors implicitly accept this licensing.

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.
  2. Use the following code block types for particular code blocks:
  • Groovy/Gradle-Files -> groovy
  • Hocon-Config -> guess (hocon highlighting is not yet supported)
  • In-Game/Server Console Command -> none
  • Java-Code -> java
  • Json-Config -> json
  • Linux-Terminal -> bash
  • Logs -> none
  • Text -> text
  • Windows-Console -> bat
  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. Automated translations (e.g. Google Translate) are strongly discouraged. These often contain serious errors, and are very likely to be rejected.
  2. Halaman Judul dan Bagian Pos harus teks biasa, menghindari blok literal dan format lainnya.
  3. Code symbols should be capitalized in their original form and have no extra spaces (e.g. blockState (a field name) or BlockState (a class name), rather than block state). They should also be formatted as a literal using double backticks (e.g. blockState) in body text.
  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.