summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/xecjk/README
blob: 6145bc6f7b7435e0b84a09faf85ebb07dd2ca3e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

xeCJK is a package written for XeLaTeX which allows users to typeset
CJK scripts easily.

 - different default fonts for CJK and other characters;
 - spaces automatically ignored between CJK characters;
 - special effects on full-width CJK punctuation; and
 - automatic adjustment of the space between CJK and other characters.

This package is licensed in LPPL.

This package consists of the file  xeCJK.dtx,
                                   full-stop.map,
                                   fullwidth-stop.map,
                                   han-simp.map,
                                   han-trad.map,
             and the derived files xeCJK.pdf,
                                   xeCJK.sty,
                                   xeCJK.cfg,
                                   xeCJK.ins,
                                   xeCJKfntef.sty,
                                   xeCJK-listings.sty,
                                   xunicode-addon.sty,
                                   xunicode-extra.def,
                                   xeCJK-example-autofake.tex,
                                   xeCJK-example-fallback.tex,
                                   xeCJK-example-subCJKblock.tex,
                                   xeCJK-example-CJKecglue.tex,
                                   xeCJK-example-checksingle.tex,
                                   xeCJK-example-CJKfntef.tex,
                                   xeCJK-example-punctstyle.tex,
                                   xeCJK-example-verbatim.tex,
                                   xeCJK-example-CM.tex,
                                   xeCJK-example-listings.tex,
                                   xunicode-symbols.tex,
                                   xunicode-commands.tex,
                                   xunicode-combine-marks.tex,
                                   xunicode-symbols.pdf,
                                   full-stop.tec,
                                   fullwidth-stop.tec,
                                   han-simp.tec,
                                   han-trad.tec, and
                                   README.txt (this file).

If you are interested in the process of development you may observe

    https://github.com/CTeX-org/ctex-kit

    Author:
            Wenchang Sun    <sunwch@nankai.edu.cn>
    Current Maintainers:
            Leo Liu         <leoliu.pku@gmail.com>
            Qing Lee        <sobenlee@gmail.com>

Installation
------------
The package is supplied in dtx format and as a pre-extracted zip file,
xecjk.tds.zip. The later is most convenient for most users: simply
unzip this in your local texmf directory and run texhash to update the
database of file locations. If you want to unpack the dtx yourself,
running "xetex xeCJK.dtx" will extract the package whereas
"xelatex xeCJK.dtx" will typeset the documentation.

The package requires LaTeX3 support as provided in the l3kernel and
l3packages bundles and the fontspec package. All of these are available
on CTAN as ready-to-install zip files. Suitable versions are available
in the latest version of MiKTeX and TeX Live (updating the relevant
packages online may be necessary).

To compile the documentation without error, you will need some specific
CJK scripts fonts (TrueType or OpenType).