README

自动校正中文文案排版（针对文件）

此工具针对“文件”校正中文文案的排版，统一中文文案与排版格式皆参考中文文案排版指南。

此工具是基于NauxLiu/auto-correct开发的“自动中文排版工具”。

** 此工具仅在命令行模式下运行 **

安装要求：

PHP 5.6+

安装：

通过 Composer：

$ composer require wadehuang1993/auto-correct-chinese-typesetting --prefer-stable dev-master

或直接克隆 AutoCorrectChineseTypesetting。

使用说明：

AutoCorrectChineseTypesetting 必须在 PHP-CLI 模式下运行：

将要进行排版的文件放在 AutoCorrectChineseTypesetting 目录下。
使用 PHP-CLI 执行 AutoCorrect.php 校正中文文案排版。
AutoCorrect.php 会自动将校正完成的文件输出到 Outputs 目录内。

步骤：

在命令行模式中：

cd path/to/AutoCorrectChineseTypesetting
php AutoCorrect.php -i InputFile -o OutputFile

如果未定义 OutputFile，则默认输出文件名将与输入文件名相同。

可用参数：

-i  要做排版的檔案名稱。
-o  輸出的檔案名稱（可選）。
-a  新增校正辭彙庫（可選，可多次新增）。
-h  查看使用說明。

添加词典库

-a 参数提供了添加词典库的功能：

将您要添加的词典库（xxx.php）放置于 dictionary 目录下。
执行 AutoCorrect.php 并使用 -a 参数加载词典库。
可多次使用 -a 参数，加载多个词典库。

词典库必须为 *.php 文件，其内容为：

<?php
return [
   # '校正前的字詞' => '校正後的字詞',
   /**
    * ...將您的新詞彙加入於此。
    */
   'docker' => 'Docker',
   'deploy' => 'Deploy',
   'zf1' => 'ZendFramework 1',
   'zf2' => 'ZendFramework 2',
];

示例：使用 -a 参数，加载多个词典库。

cd path/to/AutoCorrectChineseTypesetting
php AutoCorrect.php -i InputFile -a dictionary/AAA.php -a dictionary/BBB.php

注意：

此版本目前只测试过 txt 文件可正常排版。

wadehuang1993 / auto-correct-chinese-typesetting

维护者

详细信息