MYAO's WEBSITE

2017-05-04

Functions provided by Tripitaka

Tripitakaの提供する関数の簡単な説明です。

ready

(tripitaka:ready) 

後述のread-rcとset-projectを合わせたような関数。.tripitakarcファイルを読み。その一番最初の行で指定されたプロジェクトを現在のプロジェクトに設定する。

read-rc

(tripitaka:read-rc) 

.tripitakarcファイルを読みこんで、内部でプロジェクト名とそのディレクトリのリストを保持する。.tripitakarcファイルの先頭で指定されたプロジェクト名を返す。

set-project

(tripitaka:set-project project) 

引数のprojectは、projectを表す文字列。指定されたプロジェクトを現在のプロジェクトに設定する。

make-project

(tripitaka:set-project &key name dir) 

キーワード引数dirが指定されなかった場合には、nameで指定された文字列に対応するプロジェクトのディレクトリ以下に、プロジェクトのために必要なディレクトリとprojectファイルを作る。dirはディレクトリを表すパスネームか文字列で、指定された場合にはそのディレクトリを作成して、プロジェクトのために必要なディレクトリとprojectファイルを作る。

make-dat

(tripitaka:make-dat name  
                    &key (title "")  
                         (date (tripitaka::get-date-string "-"))  
                         (up "")  
                         (next "")  
                         (prev "")  
                         (id "")  
                         (text "")  
                         overwrite) 

それぞれの項目を指定して、nameに指定した名前の.datファイルを作る。例えば、以下のように呼ぶ。

(tripitaka:make-dat "hoge") 

この時は、hoge.datというファイルが、日付はYYYY-MM-DDの形式で入力された状態で、その他は空文字が入力された状態で現在のプロジェクトのdatディレクトリ直下に作られる。

make-html

(tripitaka:make-html name &optional (tripitaka::template-name "template")) 

この関数は、引数nameで指定した文字列の.datファイルを使ってHTMLファイルを現在のプロジェクトのhomeディレクトリ直下に作る。オプションで使用するテンプレートファイルを選択できる。デフォルトでは現在のプロジェクトのthemeディレクトリ直下のtemplateファイル。(つまりこちらは拡張子込みでファイル名を指定する。)

(tripitaka:make-html "hoge") 

上の例のように呼べば、hoge.datファイルから、templateファイルを使って、hoge.htmファイルを作る。

update-page

(tripitaka:update-page name &optional (tripitaka::template-name "template")) 

上述のmake-htmlとほぼ同じだが、こちらはもしIDが指定されていないファイルを引数に与えたら、IDを付与する。そのため、いずれの場合でも.datファイルが保存されるので注意が必要。

make-new-diary

(tripitaka:make-new-diary) 

日記用に名前が作成する日付でYYYYMMDD(N)?形式の.datファイルを作る。Nの部分は連番を生成する。また、diaryという名前のファイルを日記用に使うため、:UPにdiaryを指定する。

update-diary

(tripitaka:update-diary &optional (tripitaka::template-name "template")) 

tripitaka:make-new-diaryで作られた.datファイルをHTML化する。この時に、以下のことを行う。

この関数でも、テンプレートを指定できる。

update-diary-with-feed

(tripitaka:update-diary-with-feed comment) 

commnetで指定した文字列をAtomフィードのsummary要素として日記を更新する際にAtomフィードを生成する。この時現在のプロジェクトのhomeディレクトリ直下にAtomフィードファイルfeed.xmlが生成される。また、フィードを管理するためのfeedファイルが現在のプロジェクトのディレクトリの直下に生成される。

Atomフィードの生成のためにはprojectファイルのsite-url, site-name, authorの項目が必要です。

update-default-feed

(tripitaka:update-default-feed name comment) 

nameで指定した記事の内容で、commnetで指定した文字列をAtomフィードのsummary要素として日記を更新する際にAtomフィードを生成する。この時現在のプロジェクトのhomeディレクトリ直下にAtomフィードファイルfeed.xmlが生成される。また、フィードを管理するためのfeedファイルが現在のプロジェクトのディレクトリの直下に生成される。

Atomフィードの生成のためにはprojectファイルのsite-url, site-name, authorの項目が必要です。

update-atom

(tripitaka:update-atom dat file  
                       &key (title "")  
                            (link "")  
                            (id "")  
                            (updated (iso8601-time))  
                            (summary "")) 

datはフィードを管理する為のリストが書かれたファイル fileは吐き出すAtomフィード(xmlファイル)のパスをそれぞれ指定する。id title link update summaryの各項目を指定して、指定したAtomフィードを更新する。同じidのエントリがすでに存在した場合にはそのエントリを更新する。同じidのエントリがない場合には、エントリを追加する。updateはデフォルトではiso8601の形で現在時刻を設定する。