一个基于XeTeX和xeCJK的TeX模板

与"Hello World"作为编程入门时迈出的第一步相似,"Hello TeX"也只是学习博大精深的TeX的一块儿敲门砖,离真正的实用还差的远。

两周前开始体验TeX,直到今天才东拼西凑地倒腾出一个够自己使用的且相对实用的基于XeTeX和xeCJK的小模板。这里分享一下,希望能给大家带来一些帮助,同时对自己也算作是一个备忘。关于TeX网上资料很多,这个模板里的东西也都是参考和融会各种资料并试验后总结而成的。如果你是TeX方面的高手,大可不必理会下面内容^_^。

模板分三个部分:文档声明、序言(Preamble)区和正文(Body)区,下面逐个说:

一、文档声明
\documentclass[a4paper,11pt,titlepage]{book} 
每个TeX文档必须包含的一个命令,用来指定该文档的类型,这里类型是Book,属性:A4纸张,五号字,标题后新启一页。

二、序言(Preamble)区

\usepackage{fontspec}
\usepackage{xunicode}
\usepackage{xltxtra} 

以上是XeTeX的三个主要宏包,类似于C语言的stdio.h, stdlib.h和string.h似的,一般只要使用XeTeX,就都要包含。

\XeTeXinputencoding "GBK"
采用GBK字符编码集,如果你的.tex文件的编码格式是GBK,那么必须包含这行命令,否则xelatex将无法识别.tex文件中的中文字符。另外值得注意的是如果你采用include或input指令来包含其他章节.tex,那么单独章节的.tex文件中也要包含这个命令,否则也会导致xelatex编译出错。

\XeTeXlinebreaklocale "zh"
\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
上面两个命令主要是为了使xelatex在进行中文断行时处理的更美观些。

\usepackage[colorlinks,
            linkcolor=black,
            citecolor=black]{hyperref}
控制文本中的超链接内容的格式。

\usepackage[top=1.2in,bottom=1.2in,left=1.2in,right=1in]{geometry}
页边距设置,这里无须多说了。

\title{\XeTeX\ 日常使用模板\\(基于GBK编码)}
\author{著:Tony Bai\\
        译:Tony Bai\footnote{\url{http://bigwhite.blogbus.com}}}
\date{October, 2010}
以上是封面内容,其中\XeTeX命令定义在xlxtra包中,如果不包含xlxtra,那么xelatex将编译失败。

\usepackage{fancyhdr}
\pagestyle{fancy}
\fancyhf{}                                                 
\fancyhead[LE,RO]{\thepage}                               
\fancyhead[RE]{\leftmark}                                
\fancyhead[LO]{\rightmark}                              
\fancypagestyle{plain}{
\fancyhf{}                                             
\renewcommand{\headrulewidth}{0pt}
}
\renewcommand\chaptermark[1]{\markboth{\chaptername~ #1}{}}
\renewcommand\sectionmark[1]{\markright{\thesection~ #1}}
以上是关于页眉页脚设置,基本上是从latex notes中摘录过来,只是最后两行稍作了修改。

\renewcommand{\baselinestretch}{1.25}
设置正文行距。

\usepackage{titlesec}
\titleformat{\chapter}{\centering\huge}{第\thechapter{}章}{1em}{\textbf}
章节格式设置。

% xeCJK设置
\usepackage[slantfont, boldfont, CJKaddspaces]{xeCJK}
\setmainfont{Times New Roman}                              
\setCJKmainfont{SimSun}                                   
\setCJKfamilyfont{song}{SimSun}
\setsansfont{AR PL UKai CN}
目前用到的唯一与xeCJK相关的地方,也没什么可说的。

\renewcommand{\chaptername}{第{\thechapter}章}
\renewcommand{\contentsname}{目~录}
默认情况下,章节的描述是英文的,比如Chapter 1 xx,这里对\chapter作了重定义,将Chapter n改为中文描述”第n章“。

\usepackage[fleqn]{amsmath}
引用数学公式包,默认公式居左。

三、正文(Body)区
考虑到长文档很大,编译一遍消耗时间较长,这里采用\include命令加载其他子模块的tex文件。
\begin{document}

\maketitle                       % 生成title
\include{preface}                % 序言
\tableofcontents                 % 生成目录
\setcounter{tocdepth}{3}         % 设置目录深度
\include{introduction}           % 第一章 导 言

\end{document}

被include的preface.tex和introduction.tex的结构都很简单,以introduction.tex为例:
\XeTeXinputencoding "GBK"                                   % 本文件采用GBK编码

\chapter{导~言}
在这一章节中,…

\section{XX}
在xx

\subsection{XX-1}
在xx-1
\subsection{XX-2}
在xx-2

\section{YY}
在yy
\subsection{YY-1}
在yy-1

再强调一下,如果采用GBK作为.tex文件的内码,那么\XeTeXinputencoding "GBK"这句是必须的,当初被这个问题折磨了半个小时才终于through它。

另外说一下在正文编辑时经常用到的命令:
* 强制对齐
\begin{flushleft}
致谢\\
\end{flushleft}

* 原文照搬
\begin{verbatim}
xxx
\end{verbatim}
如果是内容较短,可以用\verb|xx|。

* 列表
\begin{itemize} or \begin{enumerate}
\item xx
\item yy
\end{itemize}  or \end{enumerate}

这个模板还很简单,诸如索引和附录等都还未考虑。另外由于对XeTeX/LaTeX了解仍不是很透彻,所以模板中不免还有诸多问题,这里就事先打个预防针吧^_^。

完整的模板源文件放置在我的Google code svn库里,可选择下载使用。

lcut增加对mock的支持

记得恰好是在一个月前的今天,我发布了lcut(轻量级C语言单元测试框架)0.1.0版本
。由于发布仓促,文档没能及时跟上。在stackoverflow的一个关于单元测试的帖子
上,一位叫Craig McQueen的朋友也给出了建议:"Some documentation would be helpful. Project background and goals, a features list, advantages over existing alternatives, etc would be helpful for people who are checking it out for the first time." 看完这个建议后心里那个汗啊!不过一想到用E文编写文档心里就有些打怵。就这样在这一个月里文档依旧没有改观:(。不过,lcut本身还是有一些进步的,这两天一直规划着为lcut增加mock的支持,今天终于将这个功能加进了lcut,并发布了lcut-0.2.0-beta版,欢迎大家试用,并提出意见和建议。

之前在单元测试过程中使用cmockery中提供的mock功能,cmockery也是lcut的mock功能的直接灵感来源。与cmockery不同的是lcut将对输出参数的mock和对函数返回值的mock区分开来,这样用起来更加直观。

这里用一个简单的例子(完整代码在lcut包product_database_test.c文件中)来说明一下lcut的mock功能如何使用:

/* product_database.c */
int get_total_count_of_employee() {
    database_conn *conn = NULL;
    int retv = -1;
    int total_count = -1;

    conn = connect_to_database("tonybai", "tonybai", "mysql");
    if (!conn)
        return -1;

    retv = table_row_count(conn, "EMPLOYEE_TABLE", &total_count);
    if (retv < 0)
        return -1;
    return total_count;
}

/* product_database_test.c */
database_conn *connect_to_database(const char *user,
                                   const char *passwd,
                                   const char *serviceid) {
    return (database_conn*)LCUT_MOCK_RETV();
}

int table_row_count(const database_conn *conn,
                    const char *table_name,
                    int *total_count) {
    (*total_count) = (int)LCUT_MOCK_ARG();
    return (int)LCUT_MOCK_RETV();
}

void tc_get_total_count_of_employee_ok(lcut_tc_t *tc, void *data) {
    LCUT_RETV_RETURN(connect_to_database, 0×1234);
    LCUT_ARG_RETURN(table_row_count, 5);
    LCUT_RETV_RETURN(table_row_count, 0);

    LCUT_INT_EQUAL(tc, 5, get_total_count_of_employee());
}

被mock的函数多为系统API或执行代价较高的第三方库函数,我们在业务代码更关心的是这些函数的接口行为,而C语言中函数的接口行为表现为:返回值和输出参数。我们需要通过控制被mock函数的接口行为来达到测试我们业务代码的目的,所以我们需要mock这些函数的返回值和输出参数。上面例子中connect_to_database和table_row_count就是两个被mock了的库函数。我们通过LCUT_MOCK_RETV来mock函数的返回值,通过LCUT_MOCK_ARG来mock函数的输出参数。在测试代码tc_get_total_count_of_employee_ok中,我们分别通过LCUT_RETV_RETURN和LCUT_ARG_RETURN来控制前面两个被mock的函数中mock obj的返回值和输出参数: LCUT_RETV_RETURN(connect_to_database, 0×1234)告诉connect_to_database返回(int)0×1234,相应的,LCUT_ARG_RETURN(table_row_count, 5)则告诉table_row_count执行后其输出参数*total_count的值为5。有了这些设定的mock obj我们就可以专注于我们业务层代码的白盒逻辑单元测试了,一旦connect_to_database和table_row_count的外部行为被控制后,业务层的代码get_total_count_of_employee的行为也就是可预期的了,我们用断言测试即可。

由于实现原理限制,如果你的函数输出参数类型或返回值类型为double*/float*,那么这个函数还不能使用lcut的mock功能,否则会编译出错。但绝大多数软件开发领域都很少使用浮点计算,所以lcut的mock还是可以满足大多数需要的。

题外话:
在公司使用代理上网,svn无法直接访问google code,这个问题一直困扰着我,直到今天才知道可以为svn客户端设置代理,设置步骤如下:
-> vi ~/.subversion/servers
-> 增加如下设置:
   [global]
   http-proxy-host = 你的代理主机域名或ip
   http-proxy-port = 端口
   http-proxy-username = 你的用户名
   http-proxy-password = 你的密码
设置后,svn立马就可以连上google code的svn server了。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats