# Magicat - A LaTeX Template

**Repository Path**: daohengdao/magicat

## Basic Information

- **Project Name**: Magicat - A LaTeX Template
- **Description**: Magicat  is a LaTeX template based on XeTeX, which can be used in multiple editors such as Overleaf (in the form of document class file).
- **Primary Language**: TeX/LaTeX
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-05-13
- **Last Updated**: 2023-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 简介

**魔法猫猫**（英：Magicat）是一个基于XeLaTeX的LaTeX模板，本作品采用知识共享署名4.0国际许可协议，您可以在不违反此协议的基础上随意使用本模板，包括但不限于：
1. 本体文件，即`.cls`文件，您可以将文件放在目录中来使用本模板；
2. 源代码，本模板中的任意代码在不违反此协议的基础上都可以随意参考取用；
3. 指南书，包括`.pdf`文件与其相应的源代码在不违反此协议的基础上都可以随意参考取用；

本文旨在对本模板的安装，使用与配置等具体情况进行说明。

#### 使用方式

若您使用 _Overleaf_ ，则您需要使用 _XeTeX_ 来编译文件（不可使用除此以外的其他方式，例如 _pdfTeX_ 与 _LuaTeX_ 等），调用的方式与一般的文档类相同。

若您使用 _TeXLive_ ，则您可能需要检查宏包的运行情况与字体的加载情况等问题，当存在宏包丢失等类似问题时，您可以按照以下方式利用命令行进行排查：

1. 运行 `tlmgr update --all` ；
2. 运行 `tlmgr update --self` ；
3. 运行 `tlmgr update --self --all --reinstall -forcibly -removed`；

若您使用其他平台，则您可在此处对具体遇到的问题进行反馈。

#### 版本分类

这个仓库存储的内容是各个版本的魔法猫猫，具体分类如下：

1. 在v1.5版本之前，版本号的格式为`Magicat version`，对应的指南书位于`guidebook[v1.0-v.1.5]`；
2. 在v1.6版本及之后版本，魔法猫猫分为`classic`与`extended`两个分支版本，版本号的格式不变，但使用`Magicat-version-type`来对文件等作区别，对应的指南书位于`guidebook[v1.6+]`文件夹中；


#### 注意事项

在使用本模板时，请务必注意以下问题：

1. 对于`classic`分支，在文档类选项`mode=math`时不可使用`unicode-math`宏包，否则会因为字体问题导致自定义符号失效；
2. 不建议修改`extended`分支的源代码，因为这可能造成许多问题，本模板的维护重心也是`classic`分支而非`extended`分支；
3. 对于指南书的更新一般跟随维护，在存在大变动的版本进行相关更新。