5/06/2007

coderay

事情很簡單,就是每次我貼程式碼都覺得有很大的困擾,因為不只排版很麻煩,highlight 的問題更是折騰。我之前曾經改寫過一個用 ruby 寫成的 nopaste, 他是呼叫外部 highlight 的程式,查了一下,是這個:http://www.andre-simon.de/. 關於那個 nopaste 我就不多提了,寫得很爛,沒什麼營養。(這也是我想改寫的原因)

後來你也知道,我三分鐘熱度很嚴重,所以只改到一半就沒繼續做下去了。

過了一段時間,我看到了 Lighty RoR 上的〈Syntax Highlight 套件〉,讓我重新想起這件事,希望以後能有個好 highlight 方式。於是我灌了 syntax gem, coderay gem, 還有 highlight gem. 結果那次到底發生了什麼事,其實我也忘了。只記得好像是稍微試過之後就放到一邊去了吧。

今天我又想起這件事,所以又重新找起套件來了。看來看去,syntax 和 highlight 好像都不怎麼好用。最後我終於又試到了 coderay. 這次發現 coderay 相當好用,應該不用繼續找下去了。

gem install coderay
coderay -ruby -span < input.rb > output.rb.txt
這樣可以產生適合直接貼到支援 HTML/CSS 文章中的 HTML+CSS code.
coderay -ruby -page < input.rb > output.rb.html
這樣會直接產生一個完整的 XHTML 1.0 的頁面,相當方便。
coderay -ruby -html < input.rb > output.rb.html
如此產生出來的 CSS 會是用 class 的形式,適合原本就有 CSS 檔的地方。

(補充:另外除了 page 以外,span 和 html 視情況需要在前後加上 pre tag, 也許這部份可以再稍微 hack 一下使之不用加 pre tag, 省得事情變得更麻煩。)

沒錯,最大的好處就是直接用 command line 就好了,不用寫 ruby 程式。其他所支援的語法,在 lib/coderay/scanners 中可以找到,就我現在手上的 0.7.4.215 版中有:

c, delphi, html, nitro_xhtml, plaintext, rhtml, ruby, xml

擴充容易,自己去寫 you_want.rb 丟到 scanners 中就可以使用了。至於輸出格式,在 lib/coderay/encoders 中可以找到,同版本中有:

count, div, html, null, page, span, statistic, text, tokens, xml, yaml

別問我是什麼意思,沒試過我也不知道。不過 statistic 是產生報表,這不小心試過 XD 還有這也和上面一樣,擴充容易,自己寫 encoders 就可以用自己要的輸出格式。至於在 ruby 程式中呼叫 coderay, 這當然沒問題了,用法自己找,我懶得試了。唯一可惜的是 license 是 GPL 吧,我不確定我可不可以把他拉到 ludy 而不用讓 ludy 用 GPL 釋出。不過沒差,這程式內容還滿多的,我應該沒時間好好去改他。乖乖地用
就好了。

除此之外,還找到 rhighlight, 是上面提到的那個 highlight 程式的 binding. 我想這也應該滿值得一試的,但既然先發現 coderay 堪用了,也懶得繼續試,就先 note 起來就好。除此之外,還有 sourcecode2html, 不過這個看來還在開發中。

2007.05.06 godfat 真常

1 則留言:

winson 提到...

直接貼到Pastie (http://pastie.textmate.org/)省頁面空間又有效率,如果你用TextMate,還可按快速鍵呢。