LaTeX: To use kanji glyph data registered at GlyphWiki
Switch branches/tags
Nothing to show
Clone or download
Latest commit f618bba May 7, 2017
Permalink
Failed to load latest commit information.
.gitignore First commit Oct 17, 2013
LICENSE First commit Oct 17, 2013
README.md Documentation (v0.4a) May 7, 2017
bxglyphwiki.lua LuaTeX-ja vertical writing May 5, 2016
bxglyphwiki.sty Documentation (v0.4a) May 7, 2017

README.md

BXglyphwiki パッケージバンドル

LaTeX: 「グリフウィキ」に登録された文字を利用する

フリーな「漢字字形共有サイト」である グリフウィキ で登録された漢字字形 を LaTeX 文書で簡単に利用できるようにする。

前提環境

  • TeX 処理系: pLaTeX、upLaTeX、XeLaTeX、LuaLaTeX
  • DVI ウェア(DVI 出力時): dvips、dvipdfmx
  • LuaTeX エンジンを Lua インタプリタとして使用するのでインストール されている必要がある。
  • 前提パッケージ:
    • pdftexcmds、ifluatex、ifxetex
  • インターネットへのアクセス ;-)

インストール

bxglyphwiki.sty$TEXMF/tex/latex/BXglyphwiki に移動する。

bxglyphwiki.lua については、それが bxglyphwiki というコマンド名で 実行可能であるようにする。具体的な手順は環境により異なる。 ($TEXMFBIN は TeX 関連の実行ファイルの場所を表す。)

  • Unix 系 OS の場合:

    • ファイル名を bxglyphwiki に改名する。
    • 先頭の shebang を有効にし、実行可能権限を付与する。
    • 実行パスの通ったディレクトリに置く。
  • Windows 版 TeX Live の場合:

    • $TEXMFBIN/runscript.exebxglyphwiki.exe という名前で コピーする。
    • それを実行パスの通ったディレクトリに置く。
    • bxglyphwiki.lua$TEXMF/scripts/BXglyphwiki に移動する。
  • W32TeX の場合:

    • $TEXMFBIN/runscr.exebxglyphwiki.exe の名前でコピーする。
    • それを $TEXMFBIN (または、それと同階層にある、実行パスの 通ったディレクトリ)に置く。
    • bxglyphwiki.lua$TEXMF/scripts/BXglyphwiki に移動する。 (bxglyphwiki.exe と同じディレクトリでもよい。)

上述の説明が実行できない場合は、回避策として、bxglyphwiki.lua を カレントディレクトリ(文書ファイルがある場所)に置いても動作する。

bxglyphwiki パッケージ

パッケージの読込

\usepackage[<オプション>]{bxglyphwiki}

パッケージオプション:

  • ドライバ指定: dvipsdvipdfmxpdftexxetexluatex の何れか。(graphicx のドライバと同じにする。)
  • download (既定): 「グリフウィキ」サイトからのダウンロードを 行う。
  • nodownload : ダウンロードを一切行わない。(既にダウンロードされた キャッシュファイルのみを使用する。)
  • internallua : “internallua”モード(後述)を有効にする。
  • nointernallua : “internallua”モードを無効にする。
    • LuaLaTeX では internallua が、それ以外では nointernallua が 既定値である。
  • dir=<ディレクトリ名> : キャッシュファイルを置くディレクトリ。 既定値は .(カレントディレクトリ)。
  • cache=<数値> : キャッシュファイルの有効期限(分単位)。既定値は 10080 (一週間)。値を forever とすると無期限になる。

本パッケージは graphicx パッケージの読込を必要とする。graphicx が未読込の 場合でドライバ指定がある場合はそのドライバで自動的に graphicx を読み込む。 逆に、graphicx が既に読み込まれている場合は、ドライバ指定が省略可能で、 その場合は graphicx のドライバ指定を引き継ぐ。

本パッケージでは外部 Lua スクリプトの実行を利用するので、シェル呼出機能を 有効にする(コマンドラインで -shell-escape オプションを指定する)必要が ある。シェル呼出機能が無効である場合は自動的に nodownload オプション 指定時の動作にフォールバックする。

ただし、エンジンが LuaLaTeX の場合は、“internallua”モードが利用できる。 このモードでは Lua スクリプトを LuaTeX エンジンの内部の Lua 処理系により 実行する。新たに LuaTeX を実行しないので、無制限シェル呼出は不要となる が、スクリプト中で repstopdf コマンドを呼び出しているため、これの実行が 許可されている必要がある。TeX Live の既定の設定では、-shell-escape は 不要となるはずである。

機能

グリフ出力

  • \GWI[*][<バージョン指定>]{<グリフ名>} : 指定のグリフ名の文字(グリフ)を出力する。

バージョン指定のオプションは以下の通り。既定値は + であるが、* 付き の場合は * となる(\GWI*{...}\GWI[*]{...} と同じ)。

  • <数字> : 指定のバージョンのみを使用する。
    • 指定のバージョンのキャッシュが有効(期限内)ならそれを使用。
    • そうでないならダウンロードを行う。
    • それが失敗した場合はフォールバック表示。
  • + : 最新のバージョンを使用する。
    • 何れかのバージョンの キャッシュが有効なら、 全ての バージョン の中で最新のものを使用する。
    • そうでないなら最新のバージョンをダウンロードする。
    • それが失敗した場合はフォールバック表示。
  • * : キャッシュの中で最新のバージョンを使用する。
    • 何れかのバージョンの キャッシュが有効なら、 全ての バージョン の中で最新のものを使用する。
    • そうでないならキャッシュに存在する全てのバージョンの中で最新の ものをダウンロードする。
    • それが失敗した場合はフォールバック表示。
  • <数字>++ と同様だが、指定した値以降のバージョンのみを使用 する。
  • <数字>** と同様だが、指定した値以降のバージョンのみを使用 する。

パラメタ設定

  • \setgwscale{<実数>} : グリフ出力のスケールの倍率を指定する。既定値は 1.05。 ※この値が 1 の場合は 1zw 四方の正方形に合わせて画像データが出力 される。値が 1 以外の場合も、文字の外見の横幅は 1zw のままである。

  • \setgwyvertadjust{<実数>} : 横組時のグリフの出力位置の上方向の補正値。既定値は 0。

  • \setgwtvertadjust{<実数>} : 縦組時のグリフの出力位置の“上方向”(実際は右方向)の補正値。 既定値は 0。

更新履歴

  • Version 0.4a 〈2017/05/07〉
    • XeTeX/LuaTeX ではドライバを自動推定する。
    • 縦組時の処理を改良。
  • Version 0.4 〈2016/05/05〉
    • LuaTeX v0.85 以降への対応。
    • “internallua”モードを追加。
    • LuaTeX-ja の縦組みモードに対応。
  • Version 0.3b 〈2015/07/20〉
    • 出力する文字の高さ・深さについて、\cht\cdp が利用可能なら それに合わせるようにした。
    • README を更新。
  • Version 0.3a 〈2015/05/06〉
    • 「グリフウィキ」の一部のグリフにおいて、v0.3 で決め打ちした形式 (単一の path 要素)とは異なる形式(polygon 要素を含む)の SVG 画像が使用されていたので、それに対応した。
  • Version 0.3 〈2015/02/26〉
    • 「グリフウィキ」の EPS 画像出力機能が廃止になったので、SVG 画像 をダウンロードしてそれを(一旦)EPS に変換する方式に変更した。 SVG→EPS の変換ロジックはグリフウィキの出力するファイルに特化 したものとなっている。
    • \setgwscale\setgwyvertadjustsetgwtvertadjust を新設。
  • Version 0.2 〈2013/10/16〉
    • 最初の公開版

Takayuki YATO (aka. "ZR")
http://zrbabbler.sp.land.to/