| 1 |
\documentclass[a4paper]{ctexart} |
| 2 |
% 20190115 |
| 3 |
% Author: Yuchang Yang < [email protected] > |
| 4 |
\usepackage{metalogo} |
| 5 |
\usepackage{fancyvrb} |
| 6 |
\usepackage{changepage} |
| 7 |
\usepackage{color} |
| 8 |
\definecolor{darkmiku}{RGB}{19, 149, 139} |
| 9 |
\CTEXsetup[format={\Large\bfseries}]{section} |
| 10 |
|
| 11 |
\title{tetragonos宏包\footnote{Github 地址:\texttt{https://github.com/Mikumikunisiteageru/tetragonos}}} |
| 12 |
\author{杨宇昌\footnote{电子邮箱:\texttt{[email protected]}}} |
| 13 |
\date{2019年1月16日\qquad v1} |
| 14 |
|
| 15 |
\begin{document} |
| 16 |
|
| 17 |
\maketitle |
| 18 |
|
| 19 |
\begingroup |
| 20 |
\CJKfontspec{IPAPMincho} |
| 21 |
\large |
| 22 |
\centerline{四角い地球を丸くしてる!} |
| 23 |
\hfill --- 初音ミク、\kern1ex TOKOTOKO(西沢さん\mbox{P})\hbox{}\par |
| 24 |
\vskip1em |
| 25 |
\endgroup |
| 26 |
|
| 27 |
\section{简介} |
| 28 |
tetragonos 是一个用于查询汉字四角号码的\XeLaTeX{}宏包。\par |
| 29 |
宏包名称取自希腊语,tetra者四也,gon者角也。\par |
| 30 |
|
| 31 |
\section{用法} |
| 32 |
tetragonos 宏包定义了宏 \verb|\getTG|。\texttt{\textbackslash getTG\{\textit{<string>}\}} 可展开成汉字字符串 \texttt{\textit{<string>}} 中第一个汉字的带附号的新版四角号码。举个简单的例子,\verb|\getTG{汉}| 与 \verb|\getTG{汉字}| 都会展开成“汉”字的四角号码,即 37140。\par |
| 33 |
|
| 34 |
\section{四角索引范例} |
| 35 |
四角号码常用来为汉字字词编写索引。文件 tetragonos-example.tex 中即示范了 tetragonos 宏包与 glossaries 宏包的联合应用。该文件从《广东新语》中摘录了一段文字,并为其中出现的所有植物名称建立了首字四角号码索引。该文件中的关键内容如下: |
| 36 |
|
| 37 |
\begingroup |
| 38 |
\begin{adjustwidth}{3em}{3em} |
| 39 |
\footnotesize |
| 40 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=1,formatcom=\color{darkmiku}] |
| 41 |
% arara: clean: {files: [tetragonos-example.glsdefs, tetragonos-example.TG-*]} |
| 42 |
% arara: xelatex |
| 43 |
% arara: makeglossaries |
| 44 |
% arara: xelatex |
| 45 |
% arara: xelatex |
| 46 |
\end{Verbatim} |
| 47 |
指示 arara 运行时先清空历史索引条目,之后依次执行 \XeLaTeX{}、makeglossaries 等各程序。编译时直接输入 \verb|arara tetragonos-example| 即可。 |
| 48 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=28,formatcom=\color{darkmiku}] |
| 49 |
\usepackage{tetragonos} |
| 50 |
\usepackage[nopostdot,nomain]{glossaries} |
| 51 |
\newglossary*{TG}{Tegragonos} |
| 52 |
\makeglossaries |
| 53 |
\end{Verbatim} |
| 54 |
引入 tetragonos 与 glossaries 宏包后,新建好索引,准备登记四角号码与汉字条目。 |
| 55 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=32,formatcom=\color{darkmiku}] |
| 56 |
\def\syntaxTG#1#2#3#4#5{\textbf{#1#2#3#4\textsubscript{#5}}} |
| 57 |
\end{Verbatim} |
| 58 |
定义四角号码的格式,使其整体加粗,并令附号(即附角号码)作下标。 |
| 59 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=33,tabsize=4,formatcom=\color{darkmiku}] |
| 60 |
\newcommand{\addTG}[1]{% |
| 61 |
\newglossaryentry{#1}{ |
| 62 |
type=TG, |
| 63 |
name={\syntaxTG#1}, |
| 64 |
description={\nopostdesc} |
| 65 |
}% |
| 66 |
} |
| 67 |
\end{Verbatim} |
| 68 |
定义宏 \verb|\addTG|,建立四角号码条目,在索引中位于第一级。 |
| 69 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=40,tabsize=4,formatcom=\color{darkmiku}] |
| 70 |
\newcommand{\anchorTG}[1]{% |
| 71 |
\edef\theTG{\getTG{#1}}% |
| 72 |
\expandafter\addTG\expandafter{\theTG\expandafter}% |
| 73 |
\newglossaryentry{#1}{ |
| 74 |
type=TG, |
| 75 |
name={\textmd{#1}}, |
| 76 |
parent={\theTG}, |
| 77 |
sort={\theTG}, |
| 78 |
description={\hfill} |
| 79 |
}% |
| 80 |
\glsadd{#1}% |
| 81 |
} |
| 82 |
\end{Verbatim} |
| 83 |
定义宏 \verb|\anchorTG|,建立汉字(词)条目,居于第二级,是其首字四角号码对应的条目的子条目。\verb|\anchorTG| 只插入锚点,登记汉字(词)条目与当前页码,不在正文中产生可视效应。这是照顾一些在正文与索引中有不同字(词)形的条目的需要,毕竟在 \TeX{} 里合总比分容易。glossaries 宏包中的 \verb|\newglossaryentry| 命令会自动忽略登记过的条目,因此不必特意对条目判重。\verb|\expandafter| 强迫 \verb|\theTG| 在送入 \verb|\addTG| 前完全展平成四角号码。 |
| 84 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=52,formatcom=\color{darkmiku}] |
| 85 |
\newcommand{\cc}[1]{#1\anchorTG{#1}} |
| 86 |
\end{Verbatim} |
| 87 |
\verb|\cc| 则定义为显示完汉字(词)后马上把它原样加入索引的命令。 |
| 88 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=68,tabsize=4,formatcom=\color{darkmiku}] |
| 89 |
\begin{multicols}{4} |
| 90 |
\renewcommand{\glossarysection}[2][]{} |
| 91 |
\renewcommand*{\glsgroupskip}{} |
| 92 |
\setlength{\glstreeindent}{7pt} |
| 93 |
\printglossary[type=TG,style=tree,title=] |
| 94 |
\end{multicols} |
| 95 |
\end{Verbatim} |
| 96 |
四角号码索引分成多个纵栏,采用 tree 样式,第一级的四角号码均无缩进,第二级的汉字(词)排于各自所属的四角号码之后,统一缩进值可根据需要自由调整。 |
| 97 |
\end{adjustwidth} |
| 98 |
\endgroup |
| 99 |
|
| 100 |
\section{代码实现} |
| 101 |
|
| 102 |
宏包主文件 tetragonos.sty 的全部内容如下: |
| 103 |
|
| 104 |
\begingroup |
| 105 |
\begin{adjustwidth}{3em}{3em} |
| 106 |
\footnotesize |
| 107 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,formatcom=\color{darkmiku}] |
| 108 |
%% tetragonos.sty |
| 109 |
%% Copyright 2019 Yuchang Yang < [email protected] > |
| 110 |
% |
| 111 |
% This work may be distributed and/or modified under the |
| 112 |
% conditions of the LaTeX Project Public License, either version 1.3 |
| 113 |
% of this license or (at your option) any later version. |
| 114 |
% The latest version of this license is in |
| 115 |
% http://www.latex-project.org/lppl.txt |
| 116 |
% and version 1.3 or later is part of all distributions of LaTeX |
| 117 |
% version 2005/12/01 or later. |
| 118 |
% |
| 119 |
% This work has the LPPL maintenance status `maintained'. |
| 120 |
% |
| 121 |
% The Current Maintainer of this work is Yuchang Yang. |
| 122 |
% |
| 123 |
% This work consists of the files tetragonos.sty and tetragonos-database.def |
| 124 |
% and the associated example file tetragonos-example.tex. |
| 125 |
%% |
| 126 |
\NeedsTeXFormat{LaTeX2e} |
| 127 |
\ProvidesPackage{tetragonos}[2019/01/15 v1 package tetragonos] |
| 128 |
\newcommand{\saveTG}[2]{\expandafter\gdef\csname TG-#1\endcsname{#2}} |
| 129 |
\newcommand{\loadTG}[1]{\csname TG-#1\endcsname} |
| 130 |
\end{Verbatim} |
| 131 |
宏 \verb|\saveTG| 与 \verb|\loadTG| 实际上实现了一个索引为汉字字符的数组的写入与读出。 |
| 132 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=last,formatcom=\color{darkmiku}] |
| 133 |
\makeatletter |
| 134 |
\newcommand{\get@first@char}[1]{\loadTG{#1}\iffalse} |
| 135 |
\newcommand{\getTG}[1]{\get@first@char#1\fi} |
| 136 |
\makeatother |
| 137 |
\end{Verbatim} |
| 138 |
宏 \verb|\getTG| 利用 \TeX{} 的宏机制配合 \verb|\get@first@char|,实现了抓取参数中的第一个字符并查询其四角号码的功能。 |
| 139 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,firstnumber=last,formatcom=\color{darkmiku}] |
| 140 |
\input{tetragonos-database.tex} |
| 141 |
%% |
| 142 |
%% End of file `tetrogonos.sty' |
| 143 |
\end{Verbatim} |
| 144 |
\end{adjustwidth} |
| 145 |
\endgroup |
| 146 |
|
| 147 |
汉字到四角号码的映射储存在另外的文件 tetragonos-example.def 中。其正文开头数行如下: |
| 148 |
|
| 149 |
\begingroup |
| 150 |
\begin{adjustwidth}{3em}{3em} |
| 151 |
\footnotesize |
| 152 |
\begin{Verbatim}[numbers=left,numbersep=1ex,gobble=2,formatcom=\color{darkmiku},firstnumber=22] |
| 153 |
\ProvidesFile{tetragonos-database.def}[2019/01/14 v1 tetragonos database] |
| 154 |
\saveTG{亠}{00000} |
| 155 |
\saveTG{弯}{00027} |
| 156 |
\saveTG{亪}{00037} |
| 157 |
\saveTG{疒}{00100} |
| 158 |
\saveTG{韲}{00101} |
| 159 |
\end{Verbatim} |
| 160 |
\end{adjustwidth} |
| 161 |
\endgroup |
| 162 |
|
| 163 |
\end{document} |