想要使用 Docutils 強大的文檔轉換能力,就必須使用 reST 撰寫你的文檔,reST 是一種輕量級標記語言(lightweighted markup language),同屬於這種語言的還有 Markdown、MultiMarkdown 和 Ruby Document Format 等。輕量級標記語言的好處是可以簡單的標記處理各種文字格式,並轉換成各式文檔;而輕量級標記語言原始檔的共同特色就是易讀性佳,可以讓使用者在未轉檔前也能夠了解該份文件中的內容。
Docutils & reST 的配合大多是使用在程式中的說明文件和網路上的文件(如部落格和 wiki 等),而較少使用在一般文件中,因為除非使用者將 reST 文件轉換成 LaTex 檔,否則 Docutils 所產生的文件並沒有分頁的能力。即便如此,Docutils & reST 依然非常適合快速地撰寫草稿使用,等需要輸出時再進文書處理系統調整格式。
參考文件:
(1) Easy to learn reStructuredText :此篇教學文件教導完全不懂得如何使用 Python 的學習者使用任何純文字編輯器來撰寫 reST 文件。如果熟悉 Python 也能夠做進一步的編寫和轉檔設定。
(2) Docutils TeachingDoc :Docutils是個開放源碼的純文字處理系統,可以將純文字轉為各種好用的格式,包括 HTML、Latex 和 odt 等。Docutils 中包涵了 reStructuredText這個容易閱讀、編寫的純文字標記語言。此份教學文件假設使用者已經知道如何使用終端機,並已經裝好 Python。