updmap and kanji embedding in TeX Live

Font selection for Japanese TeX users ((e)ptex, (e)uptex) is done at conversion time from dvi to pdf, using dvipdfmx. To this end updmap(-sys) provides ways to select whether Japanese fonts should be embedded or not, which fonts should be embedded, and which style.

The related options supported in updmap and their respective allowed values are:

• kanjiEmbed: selects the general font family or no embedding. Any string allowed, but see below.
• kanjiVariant: selects the variant/style; currently only the styles for JIS1990 (value is the empty string) and JIS2004 (value is the string -04) are supported.
• pxdviUse: specifies if pxdvi (Japanese patched version of xdvi; not shipped by TeX Live proper, see tlptexlive) should be set up to use the same fonts.

For setting these options in a TeX Live installation please see the documentation of updmap. In principle you have to add it to any of the updmap.cfg files that will be read. The best method is to use updmap-sys --setoption, followed by a run with no options to regenerate what's needed:

      updmap-sys --setoption OPTION VALUE
      updmap-sys

Operation of updmap wrt kanji settings

At updmap(-sys) run time, all map file names (not the file contents!) are scanned for the strings @kanjiEmbed@ and @kanjiVariant@. If found, these strings are replaced with the values set for the respective options.

In TeX Live the following Kanji maps are defined and thus included in the updmap.cfg file:

• KanjiMap ptex-@kanjiEmbed@@kanjiVariant@.map: package ptex
• KanjiMap uptex-@kanjiEmbed@@kanjiVariant@.map: package uptex
• KanjiMap otf-@kanjiEmbed@.map: package japanese-otf
• KanjiMap otf-up-@kanjiEmbed@.map: package japanese-otf-uptex
• KanjiMap morisawa.map: package ptex
• KanjiMap otf-cktx.map: package japanese-otf

Thus setting kanjiEmbed and kanjiVariant in a proper way one can select different font maps.

Currently shipped map files

As mentioned above, any string can be used for kanjiEmbed, but since these strings will end up in map file names, it only makes sense to use values that actually result in existing map files.

Currently, the following values for kanjiEmbed work, as the respective map files are shipped in TeX Live:

• noEmbed: the default, nothing will be embedded and the viewer (evince, okular, Acrobat, ...) will decide how to display the fonts.
• ms: embed MS Mincho and MS Gothic, which are coming with Windows.
• ipa: embed the IPA fonts (by Information-technology Promotion Agency).
• ipaex: embed the IPAex fonts, an extension of the IPA fonts.
• hiragino: embed the Hiragino Pro fonts (by Dainippon Screen Mfg. Co., Ltd.): these fonts have to be obtained separately (bundled with Mac OS X).
• hiragino-pron: embed the Hiragino ProN fonts (by Dainippon Screen Mfg. Co., Ltd.): these fonts have to be obtained separately (bundled with Mac OS X 10.5 or later, or Japanese word processor Ichitaro 2012 Premium/Super-premium editions).
• morisawa: embed the Morisawa Pro fonts (by Morisawa Inc.): these fonts have to be obtained separately.
• morisawa-pr6n: embed the Morisawa Pr6N fonts (by Morisawa Inc.): these fonts have to be obtained separately.
• kozuka: embed the Kozuka Pro fonts (by Adobe Systems): these fonts have to be obtained separately (bundled with Adobe's software).
• kozuka-pr6: embed the Kozuka Pr6 fonts (by Adobe Systems): these fonts have to be obtained separately (bundled with Adobe's software).
• kozuka-pr6n: embed the Kozuka Pr6N fonts (by Adobe Systems): these fonts have to be obtained separately (bundled with Adobe's software).

To support these settings, the following map files are shipped with TeX Live in the jfontmaps package:

Remarks

• In the case that the MS or IPA[ex] fonts are used, there are no separate map files for JIS1990/JIS2004 as these fonts don't provide the latter or former style, respectively.
• when using the otf package (japanese-otf), JIS2004 style can be selected as a package option:
  \usepackage[jis2004]{otf}
• In the case that using MS or IPA[ex] fonts, bold series of Japanese font families provided by the otf package won't display correctly, since these fonts don't have bold fonts.
• when using the otf package with uplatex, it is necessary to specify the uplatex option, but these two options (uplatex and jis2004) are mutually exclusive (extension under discussion).

Example of running updmap-sys

Let's suppose we want to use the Kozuka family of fonts in JIS2004 style. We thus set the respective options:

     updmap-sys --setoption kanjiEmbed kozuka
     updmap-sys --setoption kanjiVariant -04

Given the above map lines, this will effectively result in including the following map files:

  ptex-kozuka-04.map
  otf-kozuka.map
  uptex-kozuka-04.map
  otf-up-kozuka.map

Automatic setup of Kanji font embedding: kanji-config-updmap

updmap-otf was originally written by Kobayashi Taizo to automatically set up embedding of fonts with dvipdfmx according to the available fonts. Norbert Preining rewrote it in Perl, adapted it to work with the current settings of updmap.cfg, and also to avoid hard-coded paths. He is the current maintainer. The new script was called updmap-setup-kanji in TeX Live 2012, and due to Windows treating programs with 'setup' in the name specifically, is now called kanji-config-updmap. It is included in the package jfontmaps.

Usage is

 kanji-config-updmap  Set up embedding of Japanese fonts via updmap.cfg.

                This script searches for some of the most common fonts
                for embedding into pdfs by dvipdfmx.

                In addition it allows to set up arbitrary font families
                to be embedded into the generated pdf files, as long
                as at least the map file otf-<family>.map is present.
                Other map files that will be used if available are
                   
                  ptex-<family>.map
                  uptex-<family>.map
                  otf-up-<family>.map

 Please see the documentation of updmap for details (updmap --help).
 
 Usage:  kanji-config-updmap {<fontname>|auto|nofont|status}
 
    <family>    embed an arbitrary font family <family>, at least the
                map file otf-<family>.map has to be available.
    auto:       embed one of the following supported font families
                automatically:
                  hiragino, hiragino-pron, morisawa, morisawa-pr6n, 
                  kozuka, kozuka-pr6, kozuka-pr6n, ipaex, ipa, ms
                and fall back to not embedding any font if none of them
                is available
    nofont:     embed no fonts (and rely on system fonts when displaying pdfs)
                If your system does not have any of the supported font 
                families as specified above, this target is selected 
                automatically.
    status:     get information about current environment and usable font map
 
 Options:
    -n, --dry-run  do not actually run updmap
    -h, --help     show this message and exit
    -jis2004       use JIS2004 variants for default fonts of (u)pTeX
    --version      show version information and exit

The following lists values for kanjiEmbed which can be selected by kanji-config-updmap auto, in order of precedence:

1. OpenType fonts which supports Adobe-Japan1-6
   1. morisawa-pr6n
   2. kozuka-pr6n
   3. kozuka-pr6
2. OpenType fonts which supports Adobe-Japan1-5
   1. hiragino-pron
   2. hiragino
3. OpenType fonts which supports Adobe-Japan1-4
   1. morisawa
   2. kozuka
4. TrueType fonts
   1. ipaex
   2. ipa
   3. ms

The development is done in a git repository: https://git.gitorious.org/tlptexlive/jfontmaps.git.

Map file for pxdvi

updmap

Current updmap generates a file xdvi-ptex.map (in TEXMF(SYS)VAR like the other generated map files) if one sets the updmap.cfg option pxdviUse to true (see above on how to set options). In this case, xdvi-ptex.map is just a copy of kanjix.map (a map file for Japanese fonts used by dvipdfmx). Otherwise, you have to write your own xdvi-ptex.map. To summarize:

• pxdviUse true: the display in pxdvi and the PDF output by dvipdfmx look similar. So, if one considers the PDF to be the final output and uses pxdvi only for previewing, this is the best option.
• pxdviUse false: the display in pxdvi may differ with the PDF output. The typical use of this option is: one want to embed IPA[ex] fonts, but he also wants to see (fake) bold fonts at the display in pxdvi.

No files are removed by setting pxdviUse; so if one change pxdviUse, he has to remove the unwanted xdvi-ptex.map by hand. A copy of the original xdvi-ptex.map (included in the package pxdvi) is in texmf-dist/xdvi/xdvi-ptex.map.sample.

Syntax of xdvi-ptex.map

A map entry in xdvi-ptex.map has the following form:

<Japanese tfm> <enc> <font>[,<variant>] [<option>]

• Strictly speaking, <enc> should be one of the folowing:

  	JIS	Unicode	Ordering in a font	Adobe-Japan1
  Horizontal	JIS-H	Unicode-H	Identity-H	AJ16-H
  Vertical	JIS-V	Unicode-V	Identity-V	AJ16-V

  However, we can specify a CID as in kanjix.map, because of the following replace entries in pxdvi.cfg:

  replace H                   JIS-H
  replace V                   JIS-V
  replace UniJIS-UTF16-H      Unicode-H
  replace UniJIS-UTF16-V      Unicode-V
  replace UniJIS-UCS2-H       Unicode-H
  replace UniJIS-UCS2-V       Unicode-V
  replace UniJIS2004-UTF16-H  Unicode-H
  replace UniJIS2004-UTF16-V  Unicode-V
  ...

• If <enc> is Identity-{H,V} and the fontname <font> ends with /AJ16 (this setting is needed to use Adobe-Japan1 CID with TrueType fonts in dvipdfmx), the encoding part is automatically replaced with AJ16-{H,V}. Other CSI specifications, such as /AK??, are not supported.
• Supported values for <variant> are Bold, Italic, and BoldItalic. When one of these values is specified, the corresponding fake bold, italic, or bolditalic font from freetype is used.

• There are also replace entries for <font> in pxdvi.cfg:

  replace Ryumin-Light            ipam.ttf/AJ16
  replace GothicBBB-Medium        ipag.ttf/AJ16

  Because of these entries, one can use the following entry in xdvi-ptex.map (this line is in the kanjix.map generated with kanjiEmbed=noEmbed):

  otf-cjgb-h Identity-H !GothicBBB-Medium,Bold

Thanks and acknowledgements