reStructuredTextAuthor: Lloyd HuangDate: 2010-09-18, 2012-12-06

.

reStructuredText - 羽量級技術文件撰寫系統

reStructuredText

• Tim: 要寫文件啊，那就用 sphinx 或 python-docutils 吧.• lloyd: 哦...

▪ (一周後)..▪ 啊....▪ 啊....啊....▪ 啊....啊....啊....▪ 啊.... reStructuredText 真是個好物.

• 報告完畢報告完畢

真情推薦真情推薦

• 一種語言 - reStructuredText• 兩個工具 - python-docutils, sphinx• 中文支援 - html pdf text s5 odp

• 多說無益，等一下多說無益，等一下 Demo 吧吧

今日焦點今日焦點

• 進程一: 單一行程，埋頭爆肝• 進程二: 雜工，同時多個案子，舊案又陰魂不散• 進程三: 案子太多了，到了用嘴寫 code• 進程四: 寫文件，面對客戶

師程工進化史師程工進化史

• 用嘴吧寫 code ，聽過了就忘• 畫白版抄筆記，不是重點抄一堆，重點都沒抄到• 錄音機，吵架利器，不好記錄。• 便利貼，久了跟天書沒兩樣• 發 mail 不好改版，久了跟天書一樣• ChangeLog 天書進階版• 老師說沒在聽，還是乖乖寫文件吧• 最後你還是要寫文件的。

師程工文件進化史師程工文件進化史

• text 最好是純文字檔• diff 要可以比對差異• wiki 要可以多人共筆• coder 符合 coder 的習慣• version 我要 version control (cvs, svn, git)• editor 慣用編輯器 editor ，我要 emacs，我要 vim

需求需求 coder 的願望的願望

• 多說無益多說無益 Demo 吧吧Demo

Concept

• Linux-sgml & Linuxdoc• CJK-LaTex ChiLaTex• Docbook• OO.o & CJK-LaTex• reStructuredText

我的文件進化史我的文件進化史

• LDP & CLDP• SGMLtools & Big5-SGMLtools

向前輩致敬向前輩致敬

Docbook

Docbook

是的 Trac ，Redmind 及某些 wiki 也支援 RST的語法

• 那那 Demo 吧吧

Trac - reStructuredText

• install rst2odp• plain : rst2odp slides.rst output.odp• template : rst2odp slides.rst --template-filetemplate/darkGradient.otp output.odp

Creating slides

.

.

.

Any questions?

.

.

E-Mail: lloyd.tw at gmail.com

謝謝謝謝 Thanks