Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuxtech/cnlogo
A package designed to produce logos of Chinese colleges.
https://github.com/yuxtech/cnlogo
Last synced: 3 months ago
JSON representation
A package designed to produce logos of Chinese colleges.
- Host: GitHub
- URL: https://github.com/yuxtech/cnlogo
- Owner: yuxtech
- License: other
- Created: 2019-07-10T14:05:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T17:41:55.000Z (6 months ago)
- Last Synced: 2024-05-28T02:56:00.427Z (6 months ago)
- Language: TeX
- Homepage:
- Size: 9.37 MB
- Stars: 30
- Watchers: 0
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-latex - cnlogo
README
# cnlogo
[](https://results.pre-commit.ci/latest/github/yuxtech/cnlogo/main)
[](https://github.com/yuxtech/cnlogo/actions)
[](https://github.com/yuxtech/cnlogo/releases)
[](https://github.com/yuxtech/cnlogo/releases/latest)
[](https://github.com/yuxtech/cnlogo/issues)
[](https://github.com/yuxtech/cnlogo/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/yuxtech/cnlogo/pulls)
[](https://github.com/yuxtech/cnlogo/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/yuxtech/cnlogo/discussions)
[](https://github.com/yuxtech/cnlogo/milestones)
[](https://github.com/yuxtech/cnlogo/network/members)
[](https://github.com/yuxtech/cnlogo/stargazers)
[](https://github.com/yuxtech/cnlogo/watchers)
[](https://github.com/yuxtech/cnlogo/graphs/contributors)
[](https://github.com/yuxtech/cnlogo/graphs/commit-activity)
[](https://github.com/yuxtech/cnlogo/commits)
[](https://github.com/yuxtech/cnlogo/releases/latest)
[](https://github.com/yuxtech/cnlogo/blob/main/LICENSE)
[](https://github.com/yuxtech/cnlogo)
[](https://github.com/yuxtech/cnlogo)
[](https://github.com/yuxtech/cnlogo)
[](https://github.com/yuxtech/cnlogo)
[](https://github.com/yuxtech/cnlogo)
[](https://github.com/yuxtech/cnlogo)
本宏包利用 tikz 绘制国内高校的校徽，借助学校本身提供的 pdf 高清矢量图通过
inkscape 转化为 tikz 代码。
目前支持：安徽大学 (ahu), 北京航空航天大学 (bhu), 北京交通大学 (bjtu), 北京邮电大学 (bjydu), 北京师范大学 (bnu), 长安大学 (chu), 中国矿业大学 (ckyu), 中南大学 (csu), 中国地质大学 (cug), 中国政法大学 (cupsl), 东北财经大学 (dbcju), 大连理工大学 (dllgu), 复旦大学 (fdu), 贵阳师范大学 (gnu), 广东外语外贸大学 (gufs), 湖北大学 (hbu), 华东师范大学 (hdsfu), 华东政法大学 (hdzfu), 合肥工业大学 (hgyu), 河海大学 (hhu), 哈尔滨工业大学 (hit), 华南理工大学 (hnlgu), 湖南师范大学 (hnnu), 湖南大学 (hnu), 华中科技大学 (hustc), 华中师范大学 (hznu), 吉林大学 (jlu), 暨南大学 (jnu), 江南大学 (ju), 兰州大学 (lzu), 中央民族大学 (muc), 南昌大学 (ncu), 东北大学 (neu), 南京大学 (nju), 南京理工大学 (njust), 南开大学 (nku), 北京大学 (pku), 中国人民大学 (ruc), 四川大学 (scu), 山东财经大学 (sdcju), 山东大学 (sdu), 上海大学 (shu), 上海交通大学 (stju), 南方科技大学 (sustc), 西南农业大学 (swau), 西南师范大学 (swcnu), 中山大学 (sysu), 深圳大学 (szu), 清华大学 (thu), 同济大学 (tju), 天津大学 (tjuu), 北京科技大学 (ustb), 中国科学技术大学 (ustc), 武汉理工大学 (whlgu), 武汉大学 (whu), 温州大学 (wzu), 西北农林科技大学 (xbnlkju), 西安电子科技大学 (xdu), 西安交通大学 (xjtu), 厦门大学 (xmu), 扬州大学 (yzu), 中国传媒大学 (zcmu), 中国海洋大学 (zhyu), 浙江大学 (zju), 中国科学院大学 (zky), 中国农业大学 (znyu), 郑州大学 (zzu)。
## :package: 安装
### :truck: 用包管理器
```sh
tlmgr install cnlogo
```
### :hammer: 手动下载源代码编译并安装
```sh
git clone --depth=1 https://github.com/yuxtech/cnlogo
cd cnlogo
l3build install
```
注意，编译包括编译宏包 `cnlogo.sty` 和文档 `cnlogo.pdf`
。后者因为含有所有学校的校徽图片编译极慢，在我的电脑上共需要编译 7 分钟。
建议从包管理器安装或手动下载编译好的安装包。如果你一定要从源代码编译，你可以只编译
`cnlogo.sty` 并参照下一节手动安装。
```sh
lualatex cnlogo.ins # 编译宏包 `cnlogo.sty`
lualatex cnlogo.dtx # 编译文档 `cnlogo.pdf`
```
### :arrow_down: 手动下载编译好的安装包安装
从
[Release](https://github.com/yuxtech/cnlogo/releases/latest)
下载 `cnlogo.tds.zip` 。通过 `unzip` 解压缩到正确的路径并用`texhash` 刷新。
```sh
$ gh release list -Ryuxtech/cnlogo
0.0.1 Latest (0.0.1) about 24 minutes ago
...
$ gh release download 0.0.1 -Ryuxtech/cnlogo
$ ls
cnlogo-ctan.zip cnlogo.tds.zip
$ mkdir -p $(kpsewhich --var-value TEXMFHOME)
$ mv cnlogo.tds.zip $(kpsewhich --var-value TEXMFHOME)
$ unzip cnlogo.tds.zip
Archive: cnlogo.tds.zip
inflating: doc/latex/cnlogo/README.md
inflating: doc/latex/cnlogo/cnlogo.pdf
inflating: tex/latex/cnlogo/cnlogo.sty
inflating: source/latex/cnlogo/cnlogo.ins
inflating: source/latex/cnlogo/cnlogo.dtx
$ texhash
texhash: /etc/texmf: directory not writable. Skipping...
texhash: /usr/local/share/texmf: directory not writable. Skipping...
texhash: /usr/share/texmf: directory not writable. Skipping...
texhash: /usr/share/texmf-dist: directory not writable. Skipping...
texhash: /var/lib/texmf: directory not writable. Skipping...
texhash: Done.
```
### :white_check_mark: 确保你已经安装成功
```sh
$ kpsewhere cnlogo.sty
/home/your_name/texmf/tex/latex/cnlogo/cnlogo.sty
```
## :art: 用法
```sh
texdoc cnlogo
```
[帮助文档](https://mirrors.cnlogo.org/language/chinese/cnlogo/cnlogo.pdf)
## :wrench: 开发
### :rocket: 构建
```sh
git clone --depth=1 https://github.com/yuxtech/cnlogo # 下载源代码
cd cnlogo
vi cnlogo/学校的缩写.tex # 新建文件，可以参考别的学校
cat cnlogo/学校的缩写.tex # 显示文件内容
```
```tex
% 学校的缩写
% 学校的网址
% 你的姓名 <你的邮箱> % 方便 logo 有问题的时候你的学弟学妹可以联系到你
% 其他注意事项
% 例如 logo 的原始 pdf 文件来源，以便确认没有版权问题或者出现争议时方便查找
% 定义颜色
\definecolor{学校的缩写}{RGB}{0,0,0}
% 定义命令，命令参考上一节的帮助文档
\NewDocumentCommand\学校的缩写logo{O{学校的缩写}O{1}}{
... % 生成学校 logo 的 tikz 代码，参见下一节
}
...
```
```sh
l3build tag # 自动更新文档和源代码，不要手动编辑它们！
l3build doc # 确认能否成功构建帮助文档
xdg-open *.pdf # 浏览帮助文档检查图标是否正确
git commit -m ':sparkles: Support 学校的名字'
gh pr create # 发送代码合并请求
```
### :sparkles: 从 logo 的 `pdf` 文件得到生成 logo 的 `tikz` 代码
`pdf` 文件难以修改颜色，所以该项目使用 `tikz` 代码存储 logo 。
安装任意一个 `svg` 转 `tikz` 的插件：
- [svg2tikz](https://github.com/xyz2tex/svg2tikz)
- [inkscape2tikz](https://github.com/halamalala/inkscape2tikz)
1. 使用 [Inkscape](https://github.com/inkscape/inkscape) 打开 `pdf` 后另存为
`svg`
2. `Extensions > Export > Export to tikz`
3. 编辑生成的代码得到 `cnlogo/学校的缩写.tex`
## :construction: TODO
1. 为所有学校都添加一个指向学校网址的超链接
2. 将学校的 logo 统一修改为相同尺寸，目前定为能使以下代码中校徽的圆能与侧边栏正切的尺寸
```tex
\documentclass{beamer}
\usepackage[ustc]{cnlogo}
\logo{\ustclogo[ustc][0.1]}
\usetheme{Berkeley}
\usecolortheme{spruce}
\begin{document}
\maketitle
\end{document}
```