読者です 読者をやめる 読者になる 読者になる

uehaj's blog

Grな日々 - GroovyとかGrailsとかElmとかRustとかHaskellとかFregeとかJavaとか -

HowToPublisher

grails groovy

Grailsのハウツー文書を、Peter Ledbrookさんがまとめております。これはかなり参考になります。

今回の本題は、このHOWTOの内容ではなくて、このHOWTOがどのようにHTMLとして作られているかです。調べると、github上のプロジェクトとして管理されています。

これを見ると面白いのですが、元はgdoc形式で、しかしGrailsのdocコマンドではなく、gradleのビルドスクリプトで、Grailsのgdocエンジン(grails-gdoc-engine)を使って*1生成しています。そういう意味ではGrailsのリファレンスと同様ですが、HOWTOに特化しているというかシンプルでより一般性が高いです。例えば「クイックリファレンス」とかは無く、右上にはページの目次が表示されていたり、他のHOWTOへのリンクが表示されます。

このHowTo文書のWikiエンジンというかHTMLレンダラに正式名称があるかわかりませんが、コード中にHowToPublisher.groovy」というクラスが入っているので、この記事ではHowToPublisherと呼んでみます。

Pythonコミュニティのsphinxがドキュメントエンジンとして秀逸*2でうらやましいのですが、ちょっとしたものならこのHowToPublisherで良いと思いました*3。スタイルというかHTMLテンプレートを簡単に変更できますし、ロジックも書けます。Gentのテンプレートが欲しいところです。


プログラミングGROOVY
プログラミングGROOVY
posted with amazlet at 12.11.09
関谷 和愛 上原 潤二 須江 信洋 中野 靖治
技術評論社
売り上げランキング: 58657

*1:つまりRadeoxベース。

*2:ちなみにプログラミングGroovyはSphinxで書きました。

*3:テーブルの要素に2つ以上のリンクを入れるとバグる、とかいう問題もありますが。

広告を非表示にする