パブリッシュ

パブリッシュは、Pickles Framework上に構築されたウェブサイトを静的なHTMLファイル群に書き出すための手順です。この手順により生成されたHTMLは、PHPやフレームワークの環境を必要とせず、一般的なウェブサーバーがあれば公開できる状態です。

パブリッシュ実行手順

次の手順でパブリッシュを実行します。

  1. Pickles Frameworkの任意のパスに、URLパラメータ ?PX=publish を付加してアクセスする。
  2. 「パブリッシュを実行する」ボタンを押す。
  3. パブリッシュを実行する画面が表示されるので、終了するまで待つ。
  4. パブリッシュが終了すると、./_PX/_sys/publish/htdocs/ に書き出されたファイルが設置されています。

設定

必要に応じて、パブリッシュの動作を設定することができます。
これらの設定は、メインコンフィグに記述します。

publish.path_publish_dir - 出力先のディレクトリを指定する
このパスを設定すると、パブリッシュ完了時に、設定したパスにコピーを作成する。公開サイトのドキュメントルートパスを指定する、などの利用方法が考えられる。
publish.paths_ignore – 対象外のパスを指定する
恒久的にパブリッシュの対象外とするパスを設定します。パスはインストールパスを起点とするディレクトリパスの形式で設定します。改行、カンマ、またはセミコロンで区切り、複数のパスを設定することができます。アスタリスク記号(*)を、ワイルドカードとして使用することができます。

仕様

パブリッシュの仕様について説明します。

パブリッシュ対象ファイルの一覧をどう生成するか

Pickles Frameworkのインストールディレクトリをスキャンし、一覧を生成します。

静的書き出しファイルと動的書き出しファイル

拡張子 *.html は動的に生成され、それ以外の拡張子は全て静的にコピーされます。

動的に生成するファイルは、HTTPでPickles Frameworkにアクセスし、ブラウザがページを閲覧するのと同じ方法でHTMLを取得して保存します。

X-PXFW-RELATEDLINK

Pickles Frameworkが、HTTP拡張レスポンスヘッダーX-PXFW-RELATEDLINKを出力した場合、このヘッダーが示すリンク先がパブリッシュ対象として動的に追加されます。

動的なコンテンツプログラムによってコンテンツを自動生成している場合は、このヘッダーを出力して、パブリッシュツールに仮想URLを知らせる必要があります。

このヘッダーを出力することをPickles Framework に通知するインターフェイスは下記のメソッドとして用意されています。

$px->add_relatedlink( '/a/b/c.html' );

<前へ | 次へ>

次期バージョン Pickles 2 を公開しました。もっと詳しく