ReStructuredText:Buku Pengenalan Asas/Pengenalan

Daripada Wikibooks
Pergi ke pandu arah Pergi ke carian
Note Teks di bawah ini tidak terkandung dalam dokumen sumber. Ia dimuatkan di sini sebagai penjelasan am tentang ReSructuredText

Docutils ialah sebuah sistem pemprosesan teks sumber terbuka yang digunakan bagi memproses dokumen-dokumen yang ditulis dengan teks biasa kepada format-format yang berguna, seperti HTML, LaTeX, laman manual, open-document dan XML. Docutils menyedia dan menggunakan ReStructuredText (atau reStructuredText, ReST), bahasa penanda teks biasa yang mudah dibaca, mudah diguna, dan apa-yang-dilihat-itu-yang-dapat (WYSIWYG).

Dengan demikian, penulis tidak perlu membuat banyak salinan dokumen sekiranya beliau ingin menerbitkan dokumen yang sama dalam format berlainan, misalnya dalam format HTML atau PDF – penulis hanya perlu menyiapkan teks induk dengan menggunakan bahasa penanda ReST dan kemudian jelmakan dokumen yang sama dalam format yang dikehendaki dengan memproses dokumen induk menggunakan peralatan yang dibekalkan Docutils. Docutils ditulis dengan bahasa pengaturacaraan Python.

ReST menggunakan binaan ringkas dan intuitif untuk menanda struktur sesuatu dokumen. Binaan-binaan ini mudah dibaca sama ada dalam bentuk mentah ataupun sesudah diproses. Penghurai ReST ialah sebahagian daripada Docutils.

Penanda yang ringkas dan tersurat digunakan untuk menanda binaan khas, seperti pengepala bahagian, senarai titik dan penegasan. Sebanyak mungkin, penanda yang digunakan adalah minimum dan tak menonjol. Binaan yang kurang sering digunakan dan sambungan pada sintaks ReST asas boleh memiliki penanda yang lebih rumit atau lebih tersirat.

ReST dapat digunakan bagi membuat dokumen tanpa mengira panjang dokumen tersebut, dari dokumen amat pendek (seperti cebisan dokumentasi sebaris) sehinggalah dokumen sepanjang buku ini.

Penggunaan Docutils dan ReST memerlukan dua perisian:

  • Python
  • Perisan Docutils yang boleh dimuat turun dari repositori dengan menggunakan Subversion (svn), di laman ini: docutils.svn.sourceforge.net. Sebagai pilihan, Docutils juga dapat dimuat turun dengan menggunakan klon Git: repo.or.cz/docutils.git. Panduan tentang bagaimana mengguna Subversion buat semua platform, Unix/Linux, Mac dan Windows, terdapat di laman berkaitan repositori yang dipautkan di atas.

Panduan cara mengguna ReST dan Docutils.