Skip to content

Latest commit

 

History

History
143 lines (110 loc) · 7.79 KB

README_CN.md

File metadata and controls

143 lines (110 loc) · 7.79 KB

语言:

开放文档

Texlive Version License LaTeX Template Version

介绍

一个记录我个人博客的博文的开放文档仓库。

注:博客中一些重要的博文(例如软件手册或者系列文章汇总)会有对应的 PDF 及 LaTeX 源码。

目录

本仓库的文件结构

单个文档项目本身由一个含有 PDF 电子文档及其 LaTeX 源码的文件夹组成,均有其父分类。文件夹的名称就是该项目的名称,主文件名一般与文档项目名一致,即 PDF 电子文档和 LaTeX 源码主文件的文件名与文件夹名称相同。

例如名为 ToggleLanguage 文件夹所对应的项目名称就是 ToggleLanguage,位于名为 Manuals 的父文件夹下。其 PDF 电子文档和 LaTeX 源码的主文件名均为 ToggleLanuage。目录结构如下:

.
└── OpenDocs
    └── manuals
        └── toggle_language
            ├── resources
            │   ├── images
            │   │   ├── default_hint.png
            │   │   ├── developer_hint.png
            │   │   ├── enable_addon.png
            │   │   ├── installation.png
            │   │   ├── settings_for_loading_my_settings.png
            │   │   ├── translate_name_option_addon.png
            │   │   ├── translate_name_option_effect.png
            │   │   ├── translate_name_option_pref.png
            │   │   ├── ui.png
            │   │   ├── video_progress_bar_child_strip.png
            │   │   └── video_progress_bar_meta_strip.png
            │   └── reference.bib
            ├── toggle_language.pdf
            └── toggle_language.tex

用法

本仓库只提供文章源码(LaTeX)。

注:为缩减仓库大小,本仓库自 2021/6/28 起,不再提供电子格式文件(PDF)。PDF 文件将改由百度云网盘同步分享。

获取 PDF 电子文档

PDF 电子文档由百度云网盘同步分享。PDF 和文件夹同名,直接下载即可。

百度云(提取码:docs)

由 LaTeX 源代码编译生成电子文档

不熟悉 LaTeX 语法的话,不推荐使用此方法

从仓库获取文档项目所需的 LaTeX 源码后,利用编译程序编译生成 PDF 等电子格式。本人的工作流是 VS Code + LaTeXWorkshop + TeX Live

编译前的准备工作:

  • 安装编译程序,例如 TeX Live
  • 安装 Adode 思源字体(思源西文字体均采用 OTF 格式,思源中文字体采用 Language-specific OTFs 中的 SC 版本)。
    • Source Sans 3 (v3.052)
    • Source Serif 4 (v4.005)
    • Source Code Pro (v2.042/v1.062)
    • 思源黑体 (v2.004)
    • 思源宋体 (v2.003)
  • 安装 SIL 字体(当前 LaTeX 源码的文类使用的是 Doulos SIL 字体)
    • Doulos SIL (v6.200)

编译流程:

  1. 下载文档项目所需的 LaTeX 源码。
  2. 下载公共资源文件夹「PublicResources」。
  3. 基于文档目录结构的路径正确存放好文件(若是克隆整个仓库,则无需此步操作)
  4. 使用 Tex 引擎编译源码:xelatex -> biber -> xelatex -> xelatex。

P.S. 安装浏览器插件 GitZip,可下载仓库中单个文件夹或者单个文件,而无需下载或克隆整个仓库。

GitZip 火狐版:跳转安装页面

几点介绍

新文类的发布介绍

  • 使用文类替代导言区设置:通过编写 CLS 文件完成 LaTeX 的文类。
  • 取消子文件编译方式:对于新文类,我暂没想到好的方案解决 Tex 底层命令的条件语句,故抛弃了旧模板的子文件编译功能。
  • 使用编译命令参数替代 synonly 宏包:使用编译命令参数实现快速编译以检查语法的功能,删除 synonly 宏包的设置和命令。
  • 进一步精简:新文类沿袭旧模板中的思路,使用相对路径,将其应用于所有重复性文件,做到最大程序移除仓库的冗余文件(旧模板只是部分精简)。

工作流的多文件编译功能

在当前 VS Code + LaTeXWorkshop + TeX Live 的工作流上,进行多文件编译时,LaTeXWorkshop 可在任一文件上执行编译命令。换而言之,指定主文件执行编译命令并非是必要条件,因为 LaTeXWorkshop 会自动寻找主文件。

跳转 LaTeXWorshop Wiki 页面 以查看更多资料。

使用 Pandoc 转换格式的问题

本仓库的 LaTeX 源码有不少复杂的底层代码,因此使用 Pandoc 转换成其他格式(如 md,docx)的效果可能与原排版效果有出入。同时,因复杂的代码和使用自定义文类的缘故,可能会导致 Pandoc 转换失败。

为何不用 Markdown 宏包

Markdown 宏包貌似不支持 TeX 命令拓展,因此暂不予考虑。并且,在使用新文类进行文档结构优化之后,编写文档的工作流也很简便。

作者

开放文档 © Mr. Kin,所有文件,除个人设计创作的图像(如 logo 等)和相关的视频创作及其他特别声明外,均采用 知识共享 署名—非商业性使用—相同方式共享 4.0 许可协议进行发布。

由 Mr. Kin 著作并维护。

注:若想对本作品进行转载、引用亦或是进行二次创作时,请详细阅读上述相关协议内容(若不理解,请点击链接跳转阅读)。为保障本人权利,对于违反者,本人将依法予以处理!望周知! —— Mr. Kin

搜索关注微信公众号:MisterKin

博客 · GitHub · 微博 · 知乎 · AcFun · 哔哩哔哩 · 优酷 · 头条 · 油管