tomk79/px2-peraichize

dev-main 2024-04-07 16:53 UTC

Requires

• php: >=7.3.0
• teamtnt/tntsearch: ~4.2.1
• tomk79/filesystem: ~1.0
• tomk79/request: ~1.0

Requires (Dev)

• phpunit/phpunit: ~9.5
• pickles2/px-fw-2.x: ~2.0
• pickles2/px2-clover: ~0.3
• pickles2/px2-multitheme: ~2.0
• pickles2/px2-paprika: ~0.5
• pickles2/px2-path-resolver: ~2.0
• pickles2/px2-publish-ex: ~2.0
• pickles2/px2-px2dthelper: ~2.0
• pickles2/px2-remove-attr: ~2.0
• pickles2/px2-sitemapexcel: ~2.0
• pickles2/px2style: ~3.0
• vlucas/phpdotenv: ~5.4.0

MIT

• Tomoya Koyanagi

• pickles2

README

Pickles 2で構築されたウェブサイトのページを、1枚のHTMLページに統合します。

Setup - セットアップ手順

Pickles 2 プロジェクト をセットアップ

1. composer.json に、パッケージ情報を追加

$ composer require tomk79/px2-peraichize

2. px-files/config.php を開き、プラグインを設定

$conf->funcs->before_content = array(
    // PX=peraichize
    tomk79\pickles2\peraichize\register::before_content(array(
        // 検索エンジンの種類
        // - 'client' = ブラウザ上で静的に動作する検索インデックス
        // - 'paprika' = Paprikaフレームワークを用いてサーバー上で動作する検索インデックス
        // 省略時: 'client'
        'engine_type' => 'client',

        // クライアント用アセットを書き出す先のディレクトリ
        // 省略時: '/common/peraichize/'
        'path_client_assets_dir' => '/common/peraichize/',

        // 非公開データの書き出し先ディレクトリ
        // 省略時: '/_sys/peraichize/'
        'path_private_data_dir' => '/_sys/peraichize/',

        // インデックスから除外するパス
        // 複数のパス(完全一致)、または正規表現で定義します。
        // 省略時: 除外しない
        'ignored_path' => array(
            '/perfect_match_ignored/ignored.html', // 完全一致 による設定例
            '/^\/ignored\/.*$/i', // 正規表現による設定例
        ),

        // コンテンツエリアを抽出するセレクタ
        // 省略時: 'body'
        'contents_area_selector' => '.contents',

        // コンテンツから除外する要素のセレクタ
        // 省略時: 除外しない
        'ignored_contents_selector' => array(
            '.contents-ignored',
        ),
    )),
);

4. 統合されたHTMLファイルを生成する

$ php ./src_px2/.px_execute.php "/?PX=peraichize.create"

管理画面拡張

config.php に次のような設定を追加します。

$conf->plugins->px2dt->custom_console_extensions = array(
    'px2-peraichize' => array(
        'class_name' => 'tomk79\pickles2\peraichize\cce\main()',
    ),
);

PXコマンド - PX Commands

PX=peraichize.create

インデックスファイルを生成する。

変更履歴 - Change Log

tomk79/px2-peraichize v0.1.0 (リリース日未定)

• Initial Release.

ライセンス - License

MIT License

作者 - Author

• (C)Tomoya Koyanagi [e-mail]
• website: https://www.pxt.jp/
• Twitter: @tomk79 https://twitter.com/tomk79/