summaryrefslogtreecommitdiff
path: root/macros/jptex/latex/pxjahyper/README-ja.md
blob: 43134f41eb1671ef108e201160efd865fd67a396 (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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
PXjahyper パッケージバンドル
============================

LaTeX: pLaTeX 上での hyperref のサポート

(u)pLaTeX 上で hyperref を用いて日本語の文書情報を含む PDF 文書を作成する
場合に必要となる以下の機能を提供する。

  * PDF 文字列内の和文文字のサポート
  * mag 指定に対するサポート

### 前提環境

  * フォーマット: LaTeX
  * エンジン:
      - pTeX 3.0版以降
      - upTeX 0.10版以降
      - pTeX-ng (試験的)
    ※一部の機能では e-TeX 拡張が必要。
  * DVIウェア: dvipdfmx
  * 依存パッケージ:
      - atbegshi
      - hyperref
  * 一部の機能で必要なパッケージ:
      - japanese-otf
      - etoolbox
      - bxjatoucs

### インストール

  - `*.sty`, `*.def` → $TEXMF/tex/platex/PXjahyper

### ライセンス

本パッケージは MIT ライセンスの下で配布される。


pxjahyper パッケージ ー 本体
----------------------------

詳細についてはマニュアル `pxjahyper.pdf` を参照されたい。


pxjahyper-enc パッケージ ー 文字コード設定
------------------------------------------

他のパッケージの内部で読み込むために pxjahyper から機能を抜粋して作った
パッケージであり、DVI ファイル中の PDF 文字列の漢字コードを指定するため
の「tounicode special」を出力する機能のみをもつ。

※文書作成者は pxjahyper を読み込むことが推奨される。

### パッケージオプション

※オプション無しでの読込が望ましいが、一応グローバルのドライバオプション
に反応するようにしている。

  * ドライバオプション:`dvipdfmx`/`dvips`/`nodvidriver` があり、
    `dvipdfmx` 以外を指定した場合はパッケージの機能を無効化する。

### 機能

パッケージを読み込むと、既定動作として、エンジンの内部漢字コードに基づき
適切な「tounicode special」を出力する。

  * `\suppressbigcode`:内部漢字コードが Unicode のときに、`UTF8-UTF16`
    ではなく `UTF8-UCS2` の CMap を指定する。
  * `\suppressdefaulttounicode`:既定動作を無効にする。
  * `\pxjahyperToUnicodeSpecial{<名前>}`:引数の CMap 名を指定して
    「tounicode special」を出力する。


更新履歴
--------

  * Version 1.5  〈2024/08/25〉
      - アンカー文字列での動作を修正。

  * Version 1.4  〈2024/08/14〉
      - 設定キー `fallback-warn` を追加。
      - 設定キー `fallback-cidm` を追加。
      - `force-unicode` オプションを非推奨とし、警告を出す。
      - 開発者用命令 `\pxjahyperBadCharacter` を追加。
      - オプション `autodvidriver`、`fallback-geta`、`fallback-delete`
        を非推奨にする。

  * Version 1.3  〈2023/03/01〉
      - “pTeX + hyperref unicode モード”を正式にサポートする。これに
        伴い、unicode モードに関する警告を削除。

  * Version 1.2a 〈2022/10/19〉
      - バグ修正。(thanks: @h20y6m さん)

  * Version 1.2  〈2022/05/27〉
      - LaTeX カーネル 2022/06/01 版への対応。
      - `\pxjahypersetup` を追加。
      - 設定キー `fallback` を追加。
      - `\pxDeclarePdfTextCommand/Composite` の不具合を修正。
      - (試験的) 設定キー `extjis` を追加。
      - (試験的) 設定キー `ajhankaku-chars` を追加。

  * Version 1.1  〈2022/05/10〉
      - オプション `fallback-geta`/`fallback-delete` を追加。
      - `\Uchar` を利用したUnicode文字出力をサポート。
      - オプション `(no)charcmds` を追加。
      - hyperref のドライバ指定が非サポートの場合に警告する。
      - `otfmacros` オプション指定の条件を撤廃する。
      - `autodvidriver` を `resetdvidriver` に変える。

  * Version 1.0a 〈2022/04/15〉
      - バグ修正。

  * Version 1.0  〈2022/04/01〉
      - オプション `auto` を `autodvidriver` に改名(旧名は非推奨)。
      - オプション `nodvidriver` の非推奨の旧名 `none`を廃止した。
      - `disablecmds` の対象に jsclasses 独自の命令を追加した。
      - (試験的)“pTeX + hyperref unicode モード”に対するサポート。

  * Version 0.9d 〈2022/03/15〉
      - LaTeX カーネル 2021/11/15 版への対応。(thanks: @wtsnjp さん)

  * Version 0.9c 〈2021/06/06〉
      - pxjahyper-uni モジュールを実際に使用する。

  * Version 0.9b 〈2021/05/29〉
      - PDF 文字列中で pxbabel の `\UTFJ` をサポート。
      - モジュール pxjahyper-uni.def を追加。

  * Version 0.9a 〈2021/05/11〉
      - バグ修正。

  * Version 0.9  〈2021/05/10〉
      - パッケージオプションの整理:`(no)papersize`、`convbkmk`、
        `(no)otfutf` を追加。
      - out2uni のエスケープ出力で UTF-16 を正しく扱う。
      - pLaTeX で tounicode 前提の動作をするときに、`\Ux` 等の Unicode
        符号入力についてフォールバック(ゲタ文字出力)を行う。

  * Version 0.8  〈2021/05/05〉
      - japanese-otf パッケージに対する実行のタイミングをパッケージ読込
        の直後に変更した。
      - (試験的) `(no)papersize` オプション。

  * Version 0.7b 〈2021/02/26〉
      - バグ修正。

  * Version 0.7a 〈2021/02/23〉
      - バグ修正。

  * Version 0.7  〈2021/02/13〉
      - 「upLaTeX での hyperref の `unicode` 指定への対応」を正式サポート
        の扱いとする。一部の正常動作しなかった機能についても対応させる。

  * Version 0.6a 〈2020/10/10〉
      - pxjahyper-enc:`dvips` 指定時はエラーでなく警告を出す。

  * Version 0.6  〈2020/10/05〉
      - pxjahyper-enc パッケージを追加した。
      - `otfmacros` オプションを既定で有効にする。

  * Version 0.5b 〈2020/10/04〉
      - バグ修正。

  * Version 0.5a 〈2020/09/27〉
      - LaTeX カーネル 2020/10/01 版への対応。

  * Version 0.5  〈2020/06/13〉
      - `otfmacros` オプションを正式にサポート。
      - `disablecmds` オプションを追加。
      - `none`(`nodvidriver` の別名)を非推奨とする。

  * Version 0.4b 〈2020/04/24〉
      - `\copyright` の再定義をやめる。

  * Version 0.4a 〈2019/11/23〉
      - (試験的) PDF 文字列中で japanese-otf の文字入力マクロをサポート
        (`otfmacros` オプション)

  * Version 0.4  〈2019/10/25〉
      - PDF 文字列中で `\CID` をサポート(`otfcid` オプション)

  * Version 0.3e 〈2019/06/20〉
      - hyperref の `unicode` 指定が後から変更された場合はエラーを出す。

  * Version 0.3d 〈2018/07/15〉
      - バグ修正。

  * Version 0.3c 〈2018/01/25〉
      - バグ修正。

  * Version 0.3b 〈2018/01/13〉
      - パッケージ定義の PDF 文字列の文字定義を拡充した。
      - (試験的) 自動判別の誤判定を防ぐため、アウトラインファイルに
        日本語文字のコメントを含ませておく。
      - (試験的) `(no)jacommentline` オプション。

  * Version 0.3a 〈2017/10/17〉
      - `bigcode` を既定に変更。
      - (試験的) upLaTeX で hyperref の `unicode` 指定を可能にする。

  * Version 0.3  〈2012/05/28〉
      - papersize special の調整機能を追加。
      - `\Ux` を追加。

  * Version 0.2  〈2012/05/27〉
      - 最初の公開版。

--------------------
Takayuki YATO (aka. "ZR")  
https://github.com/zr-tex8r