diff options
author | Karl Berry <karl@freefriends.org> | 2013-09-28 22:28:12 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-09-28 22:28:12 +0000 |
commit | 19b318173dcad91687fbea247b2824c3430e6271 (patch) | |
tree | 0568d2987756e2fd6ba8e9077e8a2809b0f7008b /Master/texmf-dist/doc | |
parent | 2466b9b1303df3fffaad52e2ccb3242d05d24bc2 (diff) |
bxcjkjatype (28sep13)
git-svn-id: svn://tug.org/texlive/trunk@31788 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/LICENSE | 27 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/README | 232 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.pdf | bin | 0 -> 157803 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.tex | 76 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.pdf | bin | 0 -> 101778 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.tex | 48 |
6 files changed, 383 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/LICENSE b/Master/texmf-dist/doc/latex/bxcjkjatype/LICENSE new file mode 100644 index 00000000000..4acbc245013 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/LICENSE @@ -0,0 +1,27 @@ +$BK\%=%U%H%&%'%"$O(B MIT $B%i%$%;%s%9$N2<$GG[I[$5$l$^$9!#(B +$BCx:n8"$O:n<T$G$"$k!VH,EP(B $B?rG7!JJLL>(B ZR$B!K!W$KB0$7$^$9!#(B +$B$^$?K\%=%U%H%&%'%"$OL5J]>Z$G$9!#(B + +This software is distributed under the MIT License. + +The MIT License + +Copyright (c) 2013 Takayuki YATO (aka. "ZR") + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/README b/Master/texmf-dist/doc/latex/bxcjkjatype/README new file mode 100644 index 00000000000..82c4a3088dc --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/README @@ -0,0 +1,232 @@ +BXcjkjatype Package +=================== + +LaTeX: Support for Japanese typesetting with pdfLaTeX and CJK package + +This package provides working configuration of the CJK package suitable +for Japanese typesetting of moderate quality. Moreover, it facilirates +use of the CJK package for pLaTeX users, by providing commands that +are similar to those used by the pLaTeX kernel and some other packages +used with it. + +Note that while the CJK package supports many input encodings, this +package supports only UTF-8. + +### System requirement + + * TeX format: LaTeX. + * TeX engine: pdfTeX (DVI or PDF mode). + * DVI driver: Anything. + - Non-default font settings require dvipdfmx or pdfTeX. + * Dependent packages: + - CJK, CJKutf8, CJKspace, CJKpunct, etoolnoc; + - ipaex-type1 (when using default font mapping); + - zhmetrics (when using non-default font mapping). + +### Installation + + - `*.sty` → $TEXMF/tex/latex/BXcjkjatype + +The bxcjkjatype Package +----------------------- + +### Package Loading + + \usepackage[<option>,...]{bxcjkjatype} + +The available options are described hereafter. + +#### Options for auto-wrapping + +These options enable one to wrap the document body with a `CJK(*)` +environemnt automatically and safely. They are suitable when a document +contains much amount of CJK text, or some “moving arguemnts” hold +CJK text. + + * `whole`, `wholeCJK*`: Wraps the whole document body with a `CJK*` + environment (precisely speaking, with + `\begin{uCJK*}` ... `\end{uCJK*}` ). + * `wholeCJK`: Wraps the whole document body with a `CJK` environment + (precisely speaking, with + `\begin{uCJK}` ... `\end{uCJK}` ). + * `nowhole` (default): Negation of `wholeCJK*` or `wholeCJK`. + +#### Options for “auto-tilde” + +The option `autotilde` triggers automatic invocation of `\CJKtilde`, +which makes a tilde character (`~`) insert “shibuaki” (a thin space +between alphabetic and ideographic letters) rather than a no-break +space (standard). No-break spaces can still be inserted by the command +`\nbs`, and `\standardtilde` cancels the effect of `\CJKtilde`. (The +commands mentioned here belong to CJK package.) + + * `autotilde`: Makes `\CJKtilde` invoked at the beginning of every + `CJK(*)` environemnt. + * `noautotilde` (default): Negation of `autotilde`. + +#### Options for font-mapping + +One can use preset font mappings in the same way as in the [pxchfon +package]. Please refer to the manual of that package for detailed +explanation of this feature. + + * `oneweight`, `nooneweight`: The same as in pxchfon. + * One can use font preset options (such as `ms`) which are available + in pxchfon (except obsolete ones). + * `ipaex-type1`: Disables the font management of this package and + directly uses the families provided by the ipaex-type1 package, + namely `ipxm` and `ipxg`. In this setting the value of `\mcdefault` + is `ipxm` and the value of `\gtdefault` and `\mgdefault` is `ipxg`, + so that the higher level commands (such as `\sffamily` and + `\gtfamily`) can work correctly. + +[pxchfon package]: http://www.ctan.org/pkg/pxchfon + +#### Other options + + * `everypage`: Outputs the font mapping information on every page of + the resulted DVI document. Available only with `dvipdfmx` driver. + * `noeverypage` (default): Negation of `everypage`. + * driver options: + `pdftex`, `dvipdfmx`, `dvips` and `none` are available. The driver + setting is relevant only when using font mappings other than the + default one (ipaex-type1 fonts), so one need not care of drivers + in using default fonts. Moreover, non-default font mappings are + supported only by `pdftex` and `dvipdfmx`, and these two values are + auto-detected (`pdftex` is default in PDF mode and `dvipdfmx` in + DVI mode). Thus one will never need to specify the driver. + +### Usage + +#### Selecting CJK fonts + +The present package provides three “generic” CJK families in the same +way as pLaTeX plus the [japanese-otf package]: Mincho family +(`\mcfamily`), Gothic family (`\gtfamily`), and Maru-gothic family +(`\mgfamily`). In default setting, the font set from the ipaex-type1 +package are allocated; Mincho family uses IPA Mincho font, and Gothic +and Maru-gothic families use IPA Gothic font. This allocation can be +altered by users. + + * `\mcfamily`: Changes the CJK family to Mincho family. Equivalent + to `\CJKfamily{\mcdefault}`. + * `\gtfamily`: Changes the CJK family to Gothic family. Equivalent + to `\CJKfamily{\gtdefault}`. + * `\mgfamily`: Changes the CJK family to Maru-gothic family. + Equivalent to `\CJKfamily{\mgdefault}`. + +More advanced commands: + + * `\mcdefault`/`\gtdefault`/`\mgdefault`: The names of CJK families + corresponding to the three generic families. In the standard + allocation their values are `mc`/`gt`/`mg` respectively and the + allocation is used as default. + + * `\setCJKfamilydefault{<CJK-family>}`: Declares the default CJK + family. This default value is used when family names are missing + in some commands, such as `\CJKfamily{}` and `\begin{CJK}{UTF8}{}`. + The (redefined) `\normalfont` also switches the CJK family to the + family specified by this command. + + The default value of this default family is the “counterpart” of + the alphabetic font family which is in effect at the beginning of + the document body. (See the next subsection.) + +[japanese-otf package]: http://www.ctan.org/pkg/japanese-otf + +#### Synchronization of CJK and non-CJK families + +The CJK pakcage (and pTeX engine) manages separate “current families” +for CJK and alphabetic (non-CJK) families. While this treatment has its +merit, synchronization of the two “current families” is convenient in +many cases. Accordingly, tHe present package redefines some of the +LaTeX commands that switches current alphabetic font families so that +the CJK family will be switched to the counterpart of the current +alphabetic family, where the “counterpart” is defined as follows: + + * `\rmfamily` (Serif) → `\mcfamily` (Mincho) + * `\sffamily` (Sans-serif) → `\gtfamily` (Gothic) + * `\ttfamily` (Monospae) → `\gtfamily` (Gothic) + * The counterpart of the other families is `\mcfamily`. + +Redefined commands: + + * `\rmfamily`/`\sffamily`/`\ttfamily`: Changes the CJK family to + the counterpart of the alphabetic font family after the original + function. + * `\normalfont`: Changes the CJK family to the default CJK family + specified by `\setCJKfamilydefault` comamnd. + +There are shorthand forms of `CJK`/`CJK*` environemnts: + + * `\begin{uCJK*}...\end{uCJK*}`: Equivalent to: + + \begin{CJK*}{UTF8}{counterpart}...\end{CJK*} + + where `counterpart` means the counterpart of the current alphabetic + font family. + + Note that this is *not* equivalent to + + \begin{CJK*}{UTF8}{}...\end{CJK*} + + structure, which uses the default CJK family. + + * `\begin{uCJK}...\end{uCJK}`: Equivalent to: + + \begin{CJK}{UTF8}{counterpart}...\end{CJK} + +#### Font mapping + +The usage of these commands are the same as in the pxchfon package. +Please refer to the manual of that package for detail. + + * `\setminchofont[<id>]{<font-file>}` + * `\setgothicfont[<id>]{<font-file>}` + * `\setmarugothicfont[<id>]{<font-file>}` + * `\setlightminchofont[<id>]{<font-file>}` + * `\setmediumminchofont[<id>]{<font-file>}` + * `\setboldminchofont[<id>]{<font-file>}` + * `\setmediumgothicfont[<id>]{<font-file>}` + * `\setboldgothicfont[<id>]{<font-file>}` + * `\setxboldgothicfont[<id>]{<font-file>}` + +However there is a major limitation as to the use of font mapping with +the pdfTeX engine. One can use only TrueType fonts and moreover +TTC format is not allowed. (One can use any flavor of OpenType fonts +when using dvipdfmx.) + +#### Other commands + + * `\UTF{<hexadecimal-number>}`: Inputs a CJK character through Unicode + codepoint value. `\UTF{5B57}` is equivalent to `\Unicode{"5B}{"57}`. + * `\CJKecglue`: Insers a “shibuaki” space. This will be invoked by + `~` when `\CJKtilde` is in effect. This command can be redefined by + users to adjust the value of shibuaki space, just like `\CJKglue`. + For example: + + \renewcommand{\CJKecglue}{\hspace{0.125em minus 0.125em}} + +### Remarks + + * The standard font families provided by this package does *not* + support vertical writing, even when using default ipaex-type1 font + set. However, the families provided by ipaex-type1 (`ipxm` and + `ipxg`) do support vertical writing, and one can utilize these + families directly by specifying `ipaex-type1` option. + +Revision History +---------------- + + * Version 0.2b <2013/09/28> + - Added `\UTF`, `\CJKecglue`. + + * Version 0.2a <2013/08/08> + - Added `autotilde` option. + + * Version 0.2 <2013/08/08> + - The first public version. + +-------------------- +Takayuki YATO (aka. "ZR") +http://zrbabbler.sp.land.to/ diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.pdf b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.pdf Binary files differnew file mode 100644 index 00000000000..cdc9b97afa6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.pdf diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.tex b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.tex new file mode 100644 index 00000000000..79fec7f0353 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype-beamer.tex @@ -0,0 +1,76 @@ +% This file is encoded in UTF-8. +% To be typeset with pdflatex or latex + dvipdfmx. +\documentclass[12pt]{beamer} % for pdfTeX +%\documentclass[12pt,dvipdfmx]{beamer} % for dvipdfmx +\hypersetup{unicode}%← needed to make bookmark text right +\usepackage[whole]{bxcjkjatype}% needed 'whole' +%% That'all! You can do 日本語 right now! +\usetheme{Warsaw} +%--------------------------------------- +\title{How to do 日本語 with pdf{\TeX}} +\author{ZR 某} +\date{某日 of August, 2013} +%--------------------------------------- +\begin{document} + +\begin{frame} + \titlepage +\end{frame} + +%--------------------------------------- +\section{日本語 with bxcjkjatype package} + +\begin{frame}[fragile]{First} + Load the \alert{bxcjkjatype} package in preamble.\par + Use of \structure{\texttt{whole}} option is often suitable.\par + \begin{exampleblock}{とある Example} +\begin{verbatim} +\documentclass[a4paper]{article} +\usepackage[whole]{bxcjkjatype} +\end{verbatim} + \end{exampleblock} +\end{frame} + +\begin{frame}[fragile]{Second} + Write whatever 日本語 text you like in the document body.\par + You can use ひらがな, カタカナ, 漢字, and/or + any character available in the standard fonts + (\structure{IPAex明朝/ゴシック}).\par + \begin{exampleblock}{とある Example} +\begin{verbatim} +\documentclass[a4paper]{article} +\usepackage[whole]{bxcjkjatype} +\begin{document} +私のホバークラフトは鰻でいっぱいです。 +\end{document} +\end{verbatim} + \end{exampleblock} + \structure{※} Must use UTF-8.\par +\end{frame} + +\begin{frame}[fragile]{Third} + Compile the document as usual.\par + +\begin{verbatim} +pdflatex sample.tex +\end{verbatim} +\end{frame} + +\begin{frame}{Last}\relax + {\LARGE\alert{完成!}\par} + \begin{block}{とある Output} + \rmfamily + 私のホバークラフトは鰻でいっぱいです。 + \end{block} +\end{frame} + +%--------------------------------------- +\section{Conclusion (Not!)} + +\begin{frame}{おしまい} + \transdissolve[duration=0.5] + \centering\Large + \structure{Happy 日本語 {\TeX}ing!} +\end{frame} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.pdf b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.pdf Binary files differnew file mode 100644 index 00000000000..960978c5355 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.pdf diff --git a/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.tex b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.tex new file mode 100644 index 00000000000..1a9e117b2f2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxcjkjatype/sample-bxcjkjatype.tex @@ -0,0 +1,48 @@ +% This file is encoded in UTF-8. +% (bxcjkjatype supports only UTF-8.) +% To be typeset with pdflatex, latex + dvipdfmx, or latex + dvips +\documentclass[a4paper]{article} +% hyperref may require an explicit driver option +% (bxcjkjatype does not.) +%\documentclass[a4paper,dvipdfmx]{article} + +% The 'whole' option makes the whole document body wraped with an +% CJK* environment. +\usepackage[whole]{bxcjkjatype} + +% After loading the package, you can write 日本語 text, even in the +% preamble. You can define a macro which includes 日本語. +\newcommand\Nihongo{日本語} + +% You can make PDF files which holds correct CJK text as document +% information, such as boookmarks. +\usepackage[unicode,% ←needed to make bookmark text right + bookmarks=true,colorlinks=true]{hyperref} + +% Here I use Standard fonts (IPAex fonts) for Mincho and Gothic +% families. For Maru-gothic family, I use "Rounded M+ 1c Regular" +% (available at http://d.hatena.ne.jp/itouhiro/20120226). +\setmarugothicfont{rounded-mplus-1c-regular.ttf} + +\begin{document} +% (Now already in a CJK* environment.) + +% You can safely put a section heading containing 日本語! +\section{Preparing 文書 in \Nihongo\ using pdf\TeX} +The 文書 contains 日本語 and English. + +\section{Font selection} +\begin{itemize} +% \rmfamily designates Mincho family. +\item \rmfamily Mincho (明朝) family. + % If you have specified a bold Mincho font with + % \setboldminchofont, then you will see it working. + % \textbf{And bold (太字) version.} +% \sffamily designates Gothic family. +\item \sffamily Gothic (ゴシック) family. +% \mgfamily changes only CJK family, so alphabetic font family +% remains unchanged (i.e. \sffamily). +\item \mgfamily Maru-gothic (丸ゴシック) family. +\end{itemize} + +\end{document} |