README

px2-dec は、Pickles 2 に DEC 拡張機能を追加します。

Usage - 使い方

1. Pickles2 をセットアップ

2. composer.json に追記

{
    "require": {
        "pickles2/px2-dec": "^2.0.0"
    }
}

3. composer を更新

$ composer update

4. px-files/config.php に追加

$conf->funcs->processor->html にAPI設定を追加します。

tomk79\pickles2\dec\main::trim_dec() は、埋め込まれたDECを削除します。
tomk79\pickles2\dec\main::add_auto_dec() は、URIパラメータ showDEC をつけると自動的にDECを表示するスクリプトを追加します。
tomk79\pickles2\dec\main::exec() は、$px->is_publishtool() の値を参照し、自動的に振り分け処理を行います。

それぞれ、必要な機能を選択して設定してください。

<?php

$conf->funcs->processor->html = [
    // DEC変換処理の実行
    //   Pickles2の状態を参照し、自動的に処理を振り分けます。
    //   パブリッシュする場合、DECコメントを削除します。
    //   プレビューの場合、DECライブラリを埋め込み、
    //   URIパラメータからDECの表示・非表示を切り替えられるようにします。
    'tomk79\pickles2\dec\main::exec()' ,

    // DECを削除する
    'tomk79\pickles2\dec\main::trim_dec()' ,

    // 自動DEC表示機能を追加する
    'tomk79\pickles2\dec\main::add_auto_dec()' ,
];

DECモジュールを利用する場合、$conf->plugins->px2dt->paths_module_template に ./vendor/pickles2/px2-dec/modules/ を追加。

<?php
// config for Pickles2 Desktop Tool.
@$conf->plugins->px2dt->paths_module_template["DEC"] = "./vendor/pickles2/px2-dec/modules/";

開発者向け情報 - for Developer

テスト - Test

$ cd {$documentRoot}
$ composer test

更新履歴 - Change log

pickles2/px2-dec v2.1.0 (2022年1月8日)

サポートするPHPのバージョンを >=7.3.0 に変更。
PHP 8.1 に対応した。

pickles2/px2-dec v2.0.2 (2019年9月10日)

PHP 7.3系で起きるエラーを修正した。

pickles2/px2-dec v2.0.1 (2018年3月16日)

0バイトのコンテンツがある場合に Fatal Error が起きる不具合を修正した。

pickles2/px2-dec v2.0.0 (2016年8月30日)

initial release.

ライセンス - License

Copyright (c)2001-2022 Tomoya Koyanagi, and Pickles 2 Project
MIT License https://opensource.org/licenses/mit-license.php

作者 - Author

Tomoya Koyanagi tomk79@gmail.com
website: https://www.pxt.jp/
Twitter: @tomk79 https://twitter.com/tomk79/

pickles2 / px2-dec

Maintainers

Details