summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xcjk2uni/README
blob: 91a55c7db3d8f2a2245f158bc3c8f8fc916e1574 (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
72
73
74
75
76
77
78
Introduction
------------
The `xCJK2uni` package provides commands to convert CJK character to Unicode in
non-UTF-8 encoding. It provides hooks for `hyperref` to get the correct bookmarks.
It also provides some /ToUnicode mapping file for CJK subfont. They can be used
with `cmap` package and make CJK character searchable and copyable in PDF files
generated by pdfLaTeX.

It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this license or
(at your option) any later version. The latest version of this license is in

   http://www.latex-project.org/lppl.txt

and version 1.3 or later is part of all distributions of LaTeX version
2005/12/01 or later.

This work has the LPPL maintenance status "maintained".
The Current Maintainer of this work is Qing Lee.

This work consists of the file  xCJK2uni.dtx,
          and the derived files xCJK2uni.pdf,
                                xCJK2uni.sty,
                                xCJK2uni.ins,
                                xCJK2uni-make.ltx,
                                xCJK2uni-UBg5plus.def,
                                xCJK2uni-UBig5.def,
                                xCJK2uni-UGB.def,
                                xCJK2uni-UGBK.def,
                                xCJK2uni-UJIS.def,
                                xCJK2uni-UKS.def,
                                c****.cmap, and
                                README (this file).

Basic Usage
-----------
The package provides the following macros:

  \useCJKencmap{<encoding>}
    Set the current encoding. The default encoding is GBK.

  \CJKchartouni{<character>}
    Convert a single CJK character to its Unicode.
    It requires two steps of expansion.

  \CJKsfdtouni{<plane>}{<slot>}
    Convert the .sfd coordinate to its Unicode.
    It requires two steps of expansion.

You can read the package manual (in Chinese) for more detailed explanations.

Author
------
Qing Lee
Email: sobenlee@gmail.com

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

    http://code.google.com/p/ctex-kit/

Installation
------------
The package is supplied in dtx format and as a pre-extracted zip file,
xCJK2uni.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 xCJK2uni.dtx" will extract the package whereas
"xelatex xCJK2uni.dtx" will typeset the documentation.
Then run "lualatex --shell-escape xCJK2uni-make.ltx" to generate some
definition files and /ToUnicode mapping files.

The package requires LaTeX3 support as provided in the l3kernel.
It is 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 the xeCJK package
and some specific Chinese Simplified fonts.