HatStaticEngine マニュアル

静的HTMLジェネレーター（管理画面：静的HTMLジェネレーター メニュー配下）の使い方をまとめたものです。

このプラグインは、baserCMS で作ったサイトを静的なHTMLファイルとして書き出し、公開用のサーバーへ配信するものです。公開されるサイトからPHPとデータベースが無くなるため、表示が速くなり、CMS本体を外部に晒さずに済みます。

はじめて使う場合は、このプラグインの仕組み → はじめての設定 の順に読んでください。この2ページを読めば、あとは必要になったところだけ拾い読みできます。

まず読む

静的HTMLジェネレーターが何をするものかと、最初の設定手順です。

このプラグインの仕組み

CMSから公開先までの流れと、生成がいつ実行されるか。

はじめての設定

設定 → cron → 試し生成 → 全ページ再生成 → 公開の順に進めます。

URLとファイルの対応

どのページがどのファイル名で書き出されるか。

管理画面の使い方

左メニュー「静的HTMLジェネレーター」配下の各画面です。

生成できたページの一覧。検索・再生成・削除。

差分生成の詳細

「内容」と「条件」の2つで、保存時の自動再生成を組み立てます。

差分生成する内容

どのページを作るかの登録（カテゴリ別一覧・RSS など）。

差分生成する条件

いつ作り直すかの登録。推奨条件の一括作成つき。

ログ

管理画面のログとサーバー上のログファイルの使い分け。

バックアップ

生成したHTMLを一定期間とっておき、ZIPでダウンロードします。

設定画面

左メニュー「静的HTMLジェネレーター」＞「設定」の各セクションです。

基本・実行・全生成

公開先パス、1回あたりの処理件数、夜間の全ページ再生成。

URL収集

対象ページの集め方、除外、URLの読み替え、クロール。

静的ファイル同期

画像・CSS・JSの同期、手動同期パターン、公開期間限定ファイル。

公開設定

公開方式、余分なファイルの削除と削除除外パターン。

困ったとき

よくあるつまずき

生成されない・公開されない・404になる・毎回全部転送される。

サーバーの準備（導入担当者向け）

サイトを構築する担当者が最初に一度だけ行う作業です。

インストールと配置

プラグインの導入、書き出し先と公開先の決め方。

cronの設定

3本のcronの役割と、実行間隔の決め方。

別サーバーへの配信

rsync over SSH の設定と、使えない環境の見分け方。

制作者向け

テーマや独自プラグインを作る人向けです。

テーマ制作の注意点

静的化と相性の悪い書き方と、その直し方。

独自プラグインとの連携

再生成の依頼、URL一覧の提供、ページ数の算出。

付録

コマンド一覧

bin/cake hat_static_engine の全アクション。

用語集

このマニュアルに出てくる言葉の意味。