summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/babel-contrib/japanese/README.md
blob: 7e52f31134f4a47a7f4b4fd7eedd0167b3594e5b (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
79
80
81
82
83
84
85
# babel-japanese

The package "babel-japanese" (or shortly, "japanese" package) provides
`japanese` option for Babel package. It defines all the language
definition macros in Japanese.

Currently this package works on pLaTeX, upLaTeX, XeLaTeX and LuaLaTeX.


## Limitations

Note that this package is not perfect: the word order in Japanese is
different from that in most Western languages including English, so
the words like "Part" or "Chapter" cannot be replaced with Japanese
counterpart. This limitation is due to the design of classes.dtx
(article.cls etc), which has \chaptername in front of the numbering
but no sequence behind the number.

The common Japanese classes including (u)jclasses in (u)pLaTeX,
jsclasses, ltj(s)classes in LuaTeX-ja are well-supported.


## Installation

1) Process japanese.ins with some tex engine. For example, using lualatex:

        lualatex japanese.ins

When you use platex, give -kanji=utf8 option.

        platex -kanji=utf8 japanese.ins

You will get japanese.ldf (the main code) and japanese-sample.tex (sample
document for pLaTeX).

2) Process documentation, japanese.dtx and japanese-sample.tex, as you wish.
japanese.dtx can be processed with pLaTeX, upLaTeX or LuaLaTeX.
japanese-sample.tex is written for pLaTeX or LuaLaTeX.

If you use lualatex:

        lualatex japanese.dtx
        lualatex japanese-sample.tex

If you use platex:

        platex -kanji=utf8 japanese.dtx
        dvipdfmx japanese.dvi
        platex -kanji=utf8 japanese-sample.tex
        dvipdfmx japanese-sample.dvi

3) Deploy the directory or files in an appropriate place under the TEXMF tree.

        * japanese.ldf
               => $TEXMF/tex/latex/japanese
        * japanese.dtx
               => $TEXMF/source/latex/japanese
        * japanese.pdf, japanese-sample.tex, japanese-sample.pdf
               => $TEXMF/doc/latex/japanese

4) Execute mktexlsr.


## Repository

The bundle is maintained on GitHub:
  https://github.com/texjporg/babel-japanese

If you have issues, please let us know from the above page.


## License

Copyright (C) 1999-2007 by ING (Toru Inagaki)
Copyright (C) 2016-     by Japanese TeX Development Community

This package is free software that can be redistributed and/or
modified under the terms of the LaTeX Project Public License 1.3.


## Release Date

2019-04-03

Japanese TeX Development Community