root/lang/perl/misc/ebicoma/README

ebicoma : Simple Content Manager

./ebicoma.pl -o html -t template source/*.html

prog [-o OUTPUT_DIR] [-t TEMPLATE_DIR] ORIGINAL_FILES

====

ebicoma はブログっぽいサイトを簡単に管理できるコンテンツマネ
ジメントシステム(CMS)です。

■概要

ebicoma の実態は静的ファイルを生成するコンバーターです。
ユーザは、ヘッダやフッタをのぞいたコンテンツ部分だけからなる
複数のHTMLファイル（元記事ファイルと呼びます）を
オリジナルデータとして管理します。
ウェブサイトで公開するときには、
これらの元記事ファイルを入力として ebicoma に渡します。
ebicoma は、ヘッダ、フッタの付与して個別記事ページを作成し、
さらにインデックスページ、RSSファイルの作成を行います。

コメント機能、トラックバック機能はありません。
そういうのが必須な用途には向きません。

月別、日付別、カテゴリ別などのアーカイブ機能（月別HTMLページ
の生成）はありません。HTMLは、インデックスページと
個別記事ページを生成するのみです。

大量のファイル（例えば１００万記事）を扱うには向きません。
数十〜百くらいの記事数が想定範囲内です。

■テンプレートのカスタマイズ

カスタマイズはテンプレートファイルを編集することで行います。
テンプレートファイルには以下の三つがあります。
- index.html : インデックスページのテンプレート。
- index.rss : RSSファイルのテンプレート。
- item.html : 個別記事ページのテンプレート。
基本は HTML で、変数部分は perl の HTML::Template に準じています。
サンプルがありますので見ていじりながら試すとよいと思います。

■元記事ファイル

編集対象となる元記事ファイルは、
ヘッダとフッタ部分をのぞいた HTML ファイルです。
ヘッダ、フッタはテンプレートのものがくっつきます。
特殊な記法としてファイルのトップに下記の情報を付与できます。
これらの情報はテンプレートで使用されます。

- 「#title:」 タイトル。
- 「#since:」　最初に記事を作成した日付。
- 「#update:」　最後に記事を更新した日付。
- 「#description:」 meta description に入れる文字列。
- 「#keyword:」　meta keyword に入れる文字列。

以下、記述例です：
>>
#title:毎月一日は休みます
#since:2002-03-01
#update:2002-07-04
#description:毎月一日は休むと前々から宣言し有給休暇消化を容易にします。
#keyword:休暇,仕事,有給休暇,有給消化,ライフハック
<<

■使い方

Usage: prog [-o OUTPUT_DIR] [-t TEMPLATE_DIR] ORIGINAL_FILES

使用例： ./ebicoma.pl -o html -t template source/*.html

「-o」は、生成したHTMLファイル、RSSファイルを書き出す
ディレクトリを指定します。
「-t」は、テンプレートファイル(index.html,index.rss,item.html)
を格納しているディレクトリを指定します。
残りで、元記事ファイル（複数）を指定します。