跳至内容
Topos Uranos

LaTeX 学术写作:课程计划

摘要

本课是课程的起始单元,介绍课程的完整学习计划。它说明课程的宗旨、面向的学生、所需的少量预备知识以及通向的后续课程;提出课程设定的七项总体学习目标;描述七个单元及其所含各课;估算课程所需的总学习量、各单元的分配、建议的学习节奏以及折合的可转换学分;解释各课的构成方式和学习进展的评估方式;最后就如何学习本课程提出建议。

学习目标

  1. 描述课程各单元的顺序,并解释每个单元为后续单元提供了什么。
  2. 陈述课程的总体学习目标,并识别哪些单元服务于每一项目标。
  3. 根据各单元的估计学时,计算课程或其中一部分所需的学习量,并据此规划个人的学习节奏。
  4. 解释本课程一节课的结构,以及如何恰当使用其中的代码示例、习题、挑战和单元测验。

宗旨

本站所有课程都要求写作:数学和物理中的证明与解答,工程和信息学中的报告,哲学中的论文和文本评注,经济学中带有表格和图表的作业。然而,没有一门课程讲授学术界用来排版这些文本的工具。若是如此,LaTeX 课程就不是某一学科学习之外的附带内容,而是其他课程共同依托的基础,无论在自然科学还是人文学科中都是如此;因此它是跨学科的:它不属于某一个专业,而属于所有专业。

本课程不讲授学术写作的文风,那是其他课程的内容,而是讲授学术文档的排版:如何编写、编译和修改 LaTeX 源文件;如何用多种语言和文字排版正文,连同注释、引文和诗句;如何赋予长文档一个由相互引用的编号部分组成的架构;如何用正确的记号书写数学和逻辑;如何呈现表格、图片和绘图;如何管理参考文献并按各学科的惯例引用;以及如何排版学者用来传播其工作的其他体裁:演示文稿、海报、信函、简历、团队合写的文档,以及投给期刊或存储库的文档。其指导原则就是 LaTeX 本身的原则:把一段文字是什么与它应当如何呈现区分开来,使作者专注于内容,而排版交由程序完成。

整个课程使用 LuaLaTeX,配合 babel 和 fontspec 宏包,它们使人能够直接书写任何语言和任何文字;使用 Texmaker 作为本地编辑器,因为它在所有操作系统上的工作方式相同;并以 Overleaf 作为在线替代方案。示例在学科之间保持中立:同一种做法可以用一份化学报告、一篇哲学论文、一段西塞罗的文字或一条定理来说明,因为不同学科之间变化的是写什么,而不是如何排版。

学习对象与预备知识

本课程面向开始学习本站任何一个学习方案的人,也面向在学习或工作的任何阶段需要排版学术文档的人:准备报告、学年论文或学位论文的学生,编写讲义和文章的教师,以及刚接触 LaTeX 或一直靠模仿使用它、却不知道为什么能用的东西能用的研究者。

本课程几乎从零开始。它不要求用过 LaTeX,不要求会编程,也不要求数学知识;也不要求懂英语,尽管引擎的信息是英文的,因为课程中出现的每一条信息都会得到解释。它只要求能正常使用计算机:建立文件夹,用指定的名字把文件保存在指定的文件夹中,之后再找到它,复制、移动和删除文件,安装程序;或者有一个浏览器和一个 Overleaf 账号。不写数学的人可以在第 4 单元少花些工夫在公式上,但不应跳过它:其中关于逻辑的一课对哲学和信息学同样有用,而用于陈述的环境也用于定义、论点和案例。

通向何处

由上所述,可以确定本课程在网站中的位置。它没有先修要求,属于所有学习方案(物理学、数学、工程学、信息学、哲学和经济学),在每个方案中规划器都把它排在第一位,因为任何其他课程,只要其解答和作业能用它来撰写,学起来都会更好。同时学习 代数与几何 I 或 数理逻辑 I:命题逻辑 的人,会在第 4 单元找到以与思考同样的精确度书写证明、真值表和演绎树的方法。

然而,本课程也是本站日后将开设的一系列写作课程的入口,这些课程都将以它为先修课程:一门科学写作课程和一门人文与哲学写作课程,范围宽泛且不编号,因为它们并不构成先后顺序;以及各学习方案自己的写作课程,例如技术写作、实验报告、研究论文和学位论文开题。本课程教人排版文档;那些课程将教人构建文档所包含的文本。

总体学习目标

以下目标描述完成本课程的学生应当能够做到的事。每一项都表述为可观察的表现,以便用具体任务加以检验;每一节内容课又各自说明自己的目标,它们服务于一项或多项总体目标,而结课的一课则展示每项目标在哪些单元和课中得到训练。七项目标都有编号,以便引用。

  1. 目标 1。制作并编译文档,诊断并修正其中的错误:从空文件开始编写源文件,用 LuaLaTeX 编译,阅读日志,区分错误与警告,并从引擎的信息追溯到原因。
  2. 目标 2。以多种语言和字母正确排版文本:段落、空格、引号、破折号和连字符;用 babel 声明的语言和用 fontspec 选择的字体,包括希腊文和拉丁文;表达每段文字功能的格式;以及注释、引文和诗句。
  3. 目标 3。构建带有内部引用的长文档:选择文档类和页面,划分章节并配以目录和附录,引用时绝不手写编号,把学位论文或书分成多个文件,并汇集自己的导言区。
  4. 目标 4。以正确的记号书写数学和逻辑:行内公式和行间公式,带有其所表达约定的符号和字母表,多行公式,作为环境声明的定理和证明,以及联结词、真值表和演绎。
  5. 目标 5。呈现易读的表格和插图:无网格、使用横线并按数字对齐的表格,跨页的表格,相对大小的图片,编号的浮动体,以及在文档内部用 TikZ 绘制的图。
  6. 目标 6。管理参考文献并按各学科的惯例引用:建立文献数据库,用 BibLaTeX 以著者–出版年制和顺序编码制引用,按人文学科的方式以脚注引用,并编制主题索引和术语表。
  7. 目标 7。为每种学术体裁选择合适的文档类:论文、报告、学位论文和书,也包括演示文稿、海报、信函和简历,团队合写的文档,以及按期刊模板调整或为存储库准备的文档。

大体上,每项目标对应一个单元,顺序相同。然而,第一项目标还是贯穿性的:在任何单元中,每编译一个示例、每修正一个错误,都在训练它,而其余各项目标的达成都依赖于它的达成。第七项目标则从第 3 单元开始准备,该单元比较各种文档类,并在第 7 单元完成,该单元把所学用于其余体裁。

内容

本课程分为七个单元,前有本课,后有结课的一课。每个单元以一节导言课开始,介绍该单元的各课、单元要解决的问题以及它所假定的已有知识;以一节总结课结束,重建单元中原理与机制的链条,把它与课程的其余部分联系起来,并提出六个难度高于各课习题的挑战。

第 0 单元 课程介绍

由本课构成,确定课程的宗旨、总体目标、内容、学习量和设计。

第 1 单元 入门

其目标是让从未用过 LaTeX 的人达到能独立编写、编译和修改一份简短文档的程度。

  1. 入门:导言。
  2. 什么是 LaTeX:排版,标记语言与文字处理软件的对比,以及 TeX 和 LaTeX 的由来。
  3. 工作环境:各系统的 TeX 发行版,以 LuaLaTeX 为编译器的 Texmaker,以及 Overleaf。
  4. 文档的结构剖析:导言区与正文,命令及其参数,分组与环境。
  5. 编译与排错:编译的各轮次,latexmk,阅读日志,以及一种排错策略。
  6. 入门:总结与挑战。

第 2 单元 文本

其目标是从一份能编译的文档走向一份以学术写作所要求的细致排版的文本,无论使用哪种语言和文字。

  1. 文本:导言。
  2. 段落、空格与符号:段落与换行,空格,引号,各种横线,以及保留字符。
  3. 语言与字体:babel 及其语言切换,多调符希腊文与拉丁文,以及用 fontspec 选择字体。
  4. 有意义的格式:逻辑标记与视觉标记的对比,强调,字体的族、系列、形状和字号。
  5. 注释、引文与诗句:脚注,短引文和长引文,以及诗句的排版。
  6. 文本:总结与挑战。

第 3 单元 文档结构

其目标是赋予长文档自己的架构,其各部分有编号、列于目录、相互引用并分布在多个文件中。

  1. 文档结构:导言。
  2. 文档类与页面:标准文档类和 KOMA-Script 的文档类,以及版面设计。
  3. 章节、目录与附录:标题,摘要,各级划分,目录,图表目录,以及附录。
  4. 交叉引用:标签,标签的正确位置,以及对章节、图和公式的自动引用。
  5. 长文档:用 \input 和 \include 把学位论文或书分成多个文件。
  6. 宏与自己的导言区:自定义命令和环境,以及可重复使用的导言区。
  7. 文档结构:总结与挑战。

第 4 单元 数学与逻辑

其目标是用与思考同样精确地排版的公式、方程、陈述和演绎来充实这一架构。

  1. 数学与逻辑:导言。
  2. 行内公式与行间公式:数学模式,其中有何变化,以及公式何时放在段落内、何时放在段落外。
  3. 符号与记号:上下标,分式,根式,希腊字母,数学字母表,运算符和定界符。
  4. 多行公式:amsmath 和 mathtools 的环境,它们的对齐与编号。
  5. 定理与证明:用 amsthm 声明的陈述,它们的编号与样式。
  6. 逻辑与演绎:联结词与量词,真值表,自然演绎树,Fitch 框,以及标准形式的论证。
  7. 数学与逻辑:总结与挑战。

第 5 单元 表格与插图

其目标是排版数据、图片和绘图,使其读起来如正文一样清楚,像章节一样编号和引用,并且无须作者手动固定就能在页面上找到自己的位置。

  1. 表格与插图:导言。
  2. 易读的表格:tabular 环境,用 booktabs 的横线代替网格,以及数字的对齐。
  3. 复杂表格与长表格:横向和纵向合并的单元格,固定宽度的表格,以及跨页的表格。
  4. 文档中的图片:graphicx,相对大小,旋转,裁剪,以及文件格式。
  5. 浮动图表:浮动环境,位置参数,题注,以及对它们的引用。
  6. 用 TikZ 绘图:坐标,路径,节点与样式,示意图,树,以及函数图像。
  7. 表格与插图:总结与挑战。

第 6 单元 参考文献与索引

其目标是从文献数据库中引用来源,使引文和参考文献表按各学科的格式自动排出,并用索引和术语表使文档便于查阅。

  1. 参考文献与索引:导言。
  2. 文献数据库:.bib 文件,其条目与字段,以及它与 Zotero 等文献管理软件的关系。
  3. 用 BibLaTeX 引用文献:与 Biber 的配合流程,引用命令,著者–出版年制和顺序编码制样式。
  4. 人文学科中的引用:脚注引用,其拉丁文缩写,以及使其自动化的样式。
  5. 索引与术语表:带有子条目和参见的主题索引,同时编制多个索引,以及术语表。
  6. 参考文献与索引:总结与挑战。

第 7 单元 其他文档与协作

其目标是把所学用于其他学术体裁,用于多位作者同时撰写的文档,以及提交给期刊或存储库的文档。

  1. 其他文档与协作:导言。
  2. 用 Beamer 制作演示文稿:帧,主题,逐步显示,以及学术报告。
  3. 海报、信函与简历:用 tcolorbox 制作的海报,正式信函,以及附有论著目录的学术简历。
  4. 团队协作写作:共享的 Overleaf,最简的 Git 工作流程,团队约定,以及 latexdiff。
  5. 模板与发表:期刊的文档类,向 arXiv 投稿,长期存档,以及许可协议。
  6. 其他文档与协作:总结与挑战,其最后一个挑战把整门课程汇集为一篇完整的学术论文。

课程总结

由 LaTeX 学术写作:最终回顾 一课构成,它重温七项总体目标,展示每项目标在哪些单元和课中得到训练,按目标汇总各结业测验的首次作答,并指出学习接下来的方向。

学习量与学分

一门课程的学习量不以讲授学时来衡量,异步课程中并没有讲授学时,而以学生的全部工作来衡量:阅读、重现示例、解题和复习。估算在本站所有课程中采用同一方法:按每分钟一百词计算每节课正文(包括示例代码)的阅读时间,每道例题二十分钟,每道练习题三十五分钟,每个挑战四十五分钟,每次入门测验或结业测验十二分钟,再加上十分之一的复习余量。

结果

本课程各课共含 9393 道例题、9393 道练习题和 4242 个挑战,另有十四次单元测验。各单元估计的学习量,取整到小时,如下:

  • 第 0 单元,课程介绍:不到 11 小时。
  • 第 1 单元,入门:2020 小时。
  • 第 2 单元,文本:2121 小时。
  • 第 3 单元,文档结构:2424 小时。
  • 第 4 单元,数学与逻辑:2525 小时。
  • 第 5 单元,表格与插图:2626 小时。
  • 第 6 单元,参考文献与索引:2121 小时。
  • 第 7 单元,其他文档与协作:2222 小时。
  • 课程总结:不到 11 小时。

总计约 160160 小时的学生学习量。这个数字应按其本来面目理解:它是对一位重现全部示例、解答全部习题和挑战的学生的估计。已经用过 LaTeX 的人,或只做练习题而不做挑战的人,所需时间会少得多;从未安装过程序、也从未读过错误信息的人可能需要更多,尤其是在第一单元。

然而,这个数字是名义上的:它决定课程的学分,并假定以恒定速度阅读、每个挑战用四分之三小时。在用真实学生测量之前,最好给它配上一个现实的区间。如果阅读速度只有假定的一半,就像在自己的编辑器中逐个输入并编译每个示例时那样,而每个挑战需要七十五分钟而非四十五分钟,同一方法会得出约 211211 小时。因此,可预期的学习量介于约 160160 小时与约 210210 小时之间。上限是一个审慎的界限,而不是测量结果;待了解学习者实际所用的时间后,区间将予以修正,在此之前学分按名义数字计算。

建议节奏

为了给各种节奏命名,本计划采用与本站其他计划相同的标准:全日制学习相当于一个 6060 学分的学年,约 16501650 小时,分布在约四十周内,即每周约 4040 小时;半日制为其一半,即每周约 2020 小时。由此得出建议的节奏:一个十六周的学期,每周学习约 1010 小时,即全日制的四分之一;按现实区间计算,每周 1010 至 1313 小时。由于规划器在所有学习方案中都把本课程排在第一位,这个学期通常就是第一学期,本课程与该学科的第一批课程同时进行,并从第一周起就为它们服务:学完第 1 和第 2 单元,约 4141 小时,学生就已经能用 LaTeX 排版自己的解答和作业。

强化节奏为每周约 2020 小时,即半日制,八周即可完成本课程,适合希望在开始学习方案中其他课程之前掌握它的人。较宽松的节奏为每周约 55 小时,需要两个学期;在这种情况下,最好不要推迟第 1 至第 3 单元,它们在开始时最为需要,而把第 5 至第 7 单元留到第二学期,可以随着其他课程对表格、插图、参考文献或演示文稿的需要而学习。

折合可转换学分

可转换学分体系以课程要求学生完成的全部工作来衡量课程,而不是以课堂面授学时来衡量,目的是使在一所院校完成的学业能在另一所院校得到承认。欧洲学分转换与累积体系由欧洲各大学在博洛尼亚宣言之后采用,规定全日制学年为 6060 学分,每学分对应 2525 至 3030 小时的学习量。智利可转换学分体系由智利各大学按类似的设计采用,同样规定学年为 6060 学分,每学分对应 2424 至 3131 小时的学习量。

然而,把估计的 160160 小时分别除以各区间的两端,本课程大约相当于 55 至 66 个欧洲学分(5.3 至 6.4),以及 55 至 77 个智利可转换学分(5.2 至 6.7)。以两个区间的中间值,即每学分 27.5 小时为参照,两种体系得到同一个数字 5.8,取整为 6。对欧洲学分而言,学分数 CC 的范围如下:

(16030)≤C≤(16025)\left( \frac{160}{30} \right) \leq C \leq \left( \frac{160}{25} \right)

因此,建议为本课程分配 66 个欧洲学分和 66 个智利可转换学分,即全日制学年的十分之一,相当于一门普通的一学期课程。

课程设计

学习形式

本课程是异步的、在线的、自定进度的:没有日期、直播课和截止期限,每个学生按照自己的基础和时间所允许的速度前进。课程以本站的十四种语言提供;在每个语言版本中,示例的文字都用该版本的语言书写,因为排好每一种语言正是本课程所教内容的一部分。各课都说明最好先学哪些其他课,因此推荐的顺序是明确的。

一节课的结构

所有内容课都采用相同的结构。它们以摘要和一份本课学习目标的列表开始,这些目标表述为可观察的表现。接下来是讲解,其核心是代码示例:每个示例都显示源代码,带有行号和复制按钮,旁边是在白纸上编译出的结果,使人一眼看出每条命令产生什么。另一些代码块只显示源代码,用于错误示例或辅助文件、终端命令,或编译日志的真实摘录,其中的错误行会被突出显示。每课最后是三道附有解答的例题和三道练习题,每道练习题都有一个折叠的提示,之后是答案,以便学生核对自己的结果而不被提前揭示解题路径。

导言课和总结课有自己的结构。导言介绍单元、其中各课和贯穿它们的线索,它所假定的已有知识和要解决的问题,并包含入门测验。总结重建单元中原理与机制的链条,标明每一环在哪一课中确立以及各自用到什么,把它与前后单元联系起来,包含结业测验,并提出六个挑战,每个挑战都有提示、答案和一份折叠的详细解答,它们综合多节课,比练习题要求更多的创造性。

语音朗读

每一课都可以通过本站的朗读器听读,它使用设备自带的语音:正文按原样朗读,其中引用的命令按其含义读出,代码块只作提示,不逐字符朗读。这样可以离开屏幕复习讲解内容;示例则始终需要编辑器。

评估

本课程不评分:其评估是形成性的,以自我评估为基础。练习题用来检验各课目标的达成情况,挑战用来检验各单元目标的达成情况;在所有这些题目中,最终的裁判都是引擎本身,因为一份没有错误和警告地编译、并产生所要求内容的文档,是一种无可争辩的证明。

此外还有单元测验。入门测验位于导言中,是一份由八到十二道题组成的简短自我测评,用于衡量起点;结业测验位于总结中、挑战之前,用于衡量所达到的水平,并与入门测验比较。两者都在浏览器中直接批改:每个答案都会得到解释,每个典型错误都会得到指明它的评语,每道题都会指向值得复习的那一课。它们都不评分、不发证书,结果只保存在学生的浏览器中;对所获技能的认证将来会在另一个平台上进行。七个单元都包含这两种测验,最终回顾把每次结业测验的首次作答汇总为按总体目标划分的概况。各课还包含由网站即时检查的简短练习,同样只起反馈作用。

对于各项总体目标,建议采用以下达成证据:

  • 目标 1:拿到一份含有若干错误的源文件,编译它,并仅凭日志的指引加以修正,直到它没有错误和警告地编译通过。
  • 目标 2:排版一篇文本,其中有一段希腊文或拉丁文、若干脚注、一段长引文和一首诗,并使用中文的引号、破折号和标点规范。
  • 目标 3:把一篇简短的学位论文分为一个主文件和若干章,配有目录、附录以及经得起任何重新排序的交叉引用。
  • 目标 4:誊写一页带有对齐公式、一条定理及其证明以及一个树形或框形演绎的笔记。
  • 目标 5:用一个带横线、数字对齐的表格呈现一些数据,并用 TikZ 画一幅示意图,两者都是浮动体,有编号并在正文中被引用。
  • 目标 6:只改动导言区,就把同一组著作分别以著者–出版年制和脚注方式引用,并加上人名索引。
  • 目标 7:从同一个基础出发,用各自合适的文档类,排出一篇完整的论文、讲解它的演示文稿和概括它的海报。

如何学习本课程

本课程设计为按顺序学习。每个单元都以前面的单元为前提,许多示例沿用先前各课的导言区和约定;跳过一课,迟早都得回头补上。

主要的规则只有一条:编译每一个示例。LaTeX 不是读会的,而是写会、编译会的,因此学生要在自己的 Texmaker 中重现每个示例,工作环境 一课讲解如何安装和配置它;无法安装 TeX 发行版的人可以使用 Overleaf,它用免费账号在浏览器中编译。网站不编译学生的代码:它展示预期的结果,由学生在自己的编辑器中得到它。在最初几个单元中,最好手动输入示例而不是复制,因为手能记住眼睛忽略的东西;示例编译成功后,最好故意改动它(删掉一个花括号,改一个选项,把一条命令移到正文中),再读一读日志说了什么,因为每一个故意引发的错误,都是日后能认出来的错误。

每个单元有两个检查点。入门测验位于导言中,是起点:最好在学习单元之前作答,不查阅任何资料,并记下错误所指向的各课。结业测验位于总结中、挑战之前,用作对照:学完各课后作答,同样不查阅资料,并与入门测验比较。两者都以首次作答为准,比较的是它,最终回顾的概况汇总的也是它。由此可知,自认为已经掌握某个单元的人,不应凭一次测试就下结论:如果结业测验成绩扎实,并能在自己的编辑器中解出总结中的挑战,就可以进入下一单元;否则,最好把测验和挑战所指出的各课再学一遍。

在练习题和挑战中,最好在自己的尝试用尽之后再打开提示,到最后再看答案,用来核对。在编译出自己的答案之前就看过答案的题目,不是解出来的,而是读过的。最后,最好从第一天起就在课程之外运用所学:用 LaTeX 撰写其他课程的笔记、解答和作业,是把本课程所教变成习惯的练习,也是本课程设计的初衷。