MYAO's WEBSITE

2017-05-04

Syntax and Rule of files for Tripitaka

設定ファイル(~/.tripitakarc, project)や、記事の内容を表すファイル(.datファイル)の書き方を説明します。

設定ファイルや、記事の内容を表すファイルの書き方

これらのファイルは、以下のようにコロン(:)から始まるキーワードと、そのキーワードが表す値のペアが並んだものになっています。

projectファイルの例

:site-name SAMPLE WEBSITE  
:site-url sample://eaxample.com  
:author Your name  
:pubyear 2017 

.datファイルの例

:title TITLE-OF-PAGE  
:date YYYY-MM-DD  
:up upper-page  
:prev previous-page  
:next next-page  
:text  
This is a sample text.  
 
Hello Tripitaka!  
 
You can use markdown notation.  
 
* sample list  
* foo  
* bar 

似た記法のものとして、Lispのplistや、CommonLisp製のrosaがあります。

現在(2017-05-04)は、以下の仕様となっていますが、以下のように制限や変更する可能性があります。

.tripitakarcファイルとprojectファイル

これらについては、前ページでも触れたので割愛。

.datファイル

Tripitakaは.datファイルの雛形を生成するtripitaka:make-datという関数を提供している。これは、以下のキーワードが含まれた.datファイルを生成する。

現在(2017-05-04)は、titleを除いて、これらはTripitakaで使われる項目ですが、単純にテンプレートと合わせてHTMLを作るtripitaka:make-html関数を使うのみであれば、キーワードの名称がなんであっても構いません。それはテンプレートの作り方に依存します。しかし、テンプレートを作るやり方が決まっている事が良いと思われる、また日記の自動採番やフィードの自動生成等の機能のためには必須となる項目がために、今後必須項目となる可能性が高いです。

次のページではテンプレートの書き方を説明します。