summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/hanzibox/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/latex/hanzibox/README.md')
-rw-r--r--macros/xetex/latex/hanzibox/README.md45
1 files changed, 33 insertions, 12 deletions
diff --git a/macros/xetex/latex/hanzibox/README.md b/macros/xetex/latex/hanzibox/README.md
index 68fd73ec82..07e27823da 100644
--- a/macros/xetex/latex/hanzibox/README.md
+++ b/macros/xetex/latex/hanzibox/README.md
@@ -1,28 +1,49 @@
hanzibox
-LaTeX3 Chinese Character package, v1.1.0
+LaTeX3-based Chinese Character package, v2.0.0
=======
-`hanzibox` is a LaTeX package written to simplify the input of Chinese
-with Hanyu Pinyin and translation. Hanyu Pinyin was placed above Chinese with
-xpinyin package and the translation was placed below the Chinese.
+`hanzibox` is a LaTeX package developed in LaTeX3, which provides `\hanzibox` and `\hanzidialog` macros. These two macros are used for typesetting Chinese character with or without a background grid such as a cross grid or star grid for Chinese character writting learning.
-`hanzibox` is a utility for creating practise sheets, dialogs, character explanations and more.
-There are PDFs included which may be useful to regular users.
+And you can display the Hanyu Pinyin above the Chinese character and the translation below them as needed.
-It was inspired by hanzibox.sty from https://github.com/janvorisek/chinese-latex-utilities.
+The `\hanzibox` macro can automatically invoke the `\xpinyin*` command of the `xpinyin` package to achieve Hanyu Pinyin according to the Chinese characters. And the `\hanzibox` command provides an asterisk version of `\hanzibox*`, whose function is achieved by automatically invoking the `xpinyin` package's `\pinyin` macro to achieve this. The `\hanzidialog` macro is implemented by manually inserting the `\pinyin` macro of the `xpinyin` package in it's pinyin option.
-In this new package, the commands were kept, but redesign its options and mandatories.
+`hanzibox` is a utility for learning to write and pronounce Chinese characters, and can be used for Chinese character learning plans, presentations, exercise booklets and other documentation work.
-At present, hanzibox.sty only supports XeTeX engines and only allows UTF-8 encoding tex source file.
+The development of this package was inspired by [Jan Vorisek's hanzibox package](https://github.com/janvorisek/chinese-latex-utilities).
-You can read the package manual (in Chinese) for more detailed explanations.
+However, the new package redesigned the `\hanzibox` and `\hanzidialog` macros and the background grid is redesigned with the `l3draw` package with reference to [zitie package](https://www.ctan.org/pkg/zitie). Also, the new macro package provides more options and arguments in order to get better typesetting results.
+
+Due to the limitations of the `xpinyin` package, the `hanzibox.sty` package currently only supports the XeTeX engine and only supports UTF-8 encoded LaTeX source files.
+
+You can read the manual (in Chinese) for more details and examples.
Contributing
------------
-Gitee repository: https://gitee.com/nwafu_nan/hanzibox-l3.
+1. Gitee repository: [hanzibox-l3](https://gitee.com/nwafu_nan/hanzibox-l3)
+2. Issues and pull requests are welcome. [issue](https://gitee.com/nwafu_nan/hanzibox-l3/issues) or [pull request](https://gitee.com/nwafu_nan/hanzibox- l3/pulls).
+
+hanzibox
+基于LaTeX3的汉字练习宏包, v2.0.0
+=======
+
+`hanzibox`是一个用LaTeX3开发的LaTeX宏包,它提供了`\hanzibox`和`\hanzidialog` 两个命令。这两个命令用于排版汉字学习中带有或不带田字格、米字格等背景格子的汉字,并可以根据需要在汉字正上方显示拼音,在正下方显示译文。其中,`\hanzibox`命令能够根据汉字自动调用`xpinyin`宏包的`\xpinyin*`命令实现汉字注音。并且`\hanzibox`命令提供了`\hanzibox*`星号版本,其注音功能是通过自动调用`xpinyin`宏包的`\pinyin`命令实现的。`\hanzidialog`命令的注音功能通过在拼音选项中手动插入`xpinyin`宏包的`\pinyin`命令实现。
-Issues and pull requests are welcome.
+`hanzibox` 是一个用于学习汉字书写与发音的工具,可以用于汉字学习教案、演示文稿、习题册等文档工作。
+
+开发该宏的灵感来自于[Jan Vorisek的hanzibox宏包](https://github.com/janvorisek/chinese-latex-utilities)。但该宏包对`\hanzibox`和`\hanzidialog`命令进行了重新设计,并参考[zitie字贴宏包](https://www.ctan.org/pkg/zitie)重新用`l3draw`宏包设计了背景格子。同时,新的宏包也提供了更多命令选项和参数,以期更好地控制排版结果。
+
+受`xpinyin`基础宏包所限,目前`hanzibox.sty`宏包仅支持XeTeX编译引擎,并且只支持UTF-8编码的LaTeX源文件。
+
+可以通过阅读宏包手册(中文)以也解该宏包更多的使用细节和使用样例。
+
+### 参与贡献
+---------------------
+1. 本项目由西北农林科技大学信息工程学院耿楠创建和维护
+2. 如果您愿意一同参与工作(不计报酬,免费自由),请及时与作者联系
+3. 项目的gitee仓库地址:[hanzibox-l3](https://gitee.com/nwafu_nan/hanzibox-l3)
+4. 如果您有任何改进意见或者功能需求,欢迎提交 [issue](https://gitee.com/nwafu_nan/hanzibox-l3/issues) 或 [pull request](https://gitee.com/nwafu_nan/hanzibox-l3/pulls)。
Copyright and Licence
---------------------