Compare revisions

root = true

[*]

trim_trailing_whitespace = true

insert_final_newline = true

charset = utf-8

end_of_line = lf

indent_style = space

[*.{dtx,tex,bib,def}]

indent_size = 2

# 贡献者公约

## 我们的承诺

身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。

我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。

## 我们的准则

有助于促进本社区积极环境的行为包括但不限于：

* 与人为善、推己及人

* 尊重不同的主张、观点和经历

* 积极提出、耐心接受有益批评

* 面对过失，承担责任、认真道歉、从中学习

* 关注社区共同诉求，而非一己私利

不当行为包括但不限于：

* 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引

* 挑衅行为、侮辱或贬损的言论、人身及政治攻击

* 公开或私下骚扰

* 未获明确授权擅自发布他人的资料，如地址、电子邮箱等

* 其他有理由认定为违反职业操守的不当行为

## 落实之义务

社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。

社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。

## 适用范围

此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。

代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。

## 贯彻落实

如遇滥用、骚扰等不当行为，请通过 [git+nju-lug-email-3104-issue-@yaoge123.cn](mailto:git+nju-lug-email-3104-issue-@yaoge123.cn) 向纪律检查委员举报。

纪委将迅速审议并调查全部投诉。

社区全体负责人有义务保密举报者信息。

## 指导方针

社区负责人将依据下列方案判断并处置违纪行为：

### 一、督促

**社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。

**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。

### 二、警告

**社区影响**：一起或多起事件中的违纪行为。

**处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。

### 三、封禁

**社区影响**：严重违纪行为，包括屡教不改。

**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致开除。

### 四、开除

**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。

**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。

## 来源

本行为标准改编自[参与者公约][homepage]2.0版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0]

指导方针借鉴自[Mozilla纪检分级][Mozilla CoC]。

此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][FAQ]。

另有诸译本：[https://www.contributor-covenant.org/translations][translations]。

[homepage]:https://www.contributor-covenant.org

[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html

[Mozilla CoC]: https://github.com/mozilla/diversity

[FAQ]: https://www.contributor-covenant.org/faq

[translations]: https://www.contributor-covenant.org/translations

name: 报告问题

description: 描述需要修复的问题

title: "[Bug]: "

labels: ["bug"]

body:

  - type: markdown

    attributes:

      value: |

        请使用此模板来报告*模板运行问题*，并尽可能多地提供信息。

  - type: checkboxes

    id: prerequisites

    attributes:

      label: 先决条件

      options:

        - label: |-

            我已尝试更新[模板版本](https://github.com/nju-lug/NJUThesis/blob/master/CHANGELOG.md)

          required: true

        - label: |-

            我已检索[模板手册](http://mirrors.ctan.org/macros/unicodetex/latex/njuthesis/njuthesis.pdf)

          required: true

        - label: |-

            我已检索[项目 wiki](https://github.com/nju-lug/NJUThesis/wiki)

          required: true

        - label: |-

            我已确认这个问题没有在[其他 issues](https://github.com/nju-lug/NJUThesis/issues) 中提出过。

          required: true

  - type: textarea

    id: expected_behavior

    attributes:

      label: 期望的现象

      placeholder: 本来应该是什么效果

    validations:

      required: true

  - type: textarea

    id: what_happened

    attributes:

      label: 发生了什么

      placeholder: 实际发生了什么偏差，此处不妨拖拽上传截图

    validations:

      required: true

  - type: textarea

    id: minimal_working_example

    attributes:

      label: 最小工作示例

      description: |

        一段*完整的可供编译*的 LaTeX 代码，用来复现上述问题。这段代码应当从 `\documentclass` 开始，到 `\end{document}` 结束。请删除*所有不会引起该问题的内容*。譬如，对于正文格式出现的问题，不必添加 `\njusetup` `\tableofcontents` 等命令。删除无关内容是一个 debug 的过程，能帮助你我更准确地问题的根源 : D

      placeholder: |

        \documentclass[]{njuthesis}

        ...

        \end{document}

      render: TeX

    validations:

      required: true

  - type: input

    id: njuthesis_version

    attributes:

      label: njuthesis 模板版本

      placeholder: v1.0.0

      description: 模板版本可以在 `.log` 文件中搜索 `njuthesis` 得到。

    validations:

      required: true

  - type: dropdown

    id: source

    attributes:

      label: 模板获取途径

      options:

        - <https://tex.nju.edu.cn>

        - 使用包管理器从 CTAN 安装

        - 通过 GitHub Releases 或镜像站下载

        - 从 Git 仓库下载

  - type: dropdown

    id: operating_system

    attributes:

      label: 操作系统

      options:

        - Windows

        - macOS

        - Linux

  - type: input

    id: tex_distribution

    attributes:

      label: TeX 发行版

      placeholder: TeX Live 2022 / MiKTeX 22.1

  - type: dropdown

    id: compiler

    attributes:

      label: 编译程序

      options:

        - XeLaTeX

        - LuaLaTeX

  - type: textarea

    id: more_info

    attributes:

      label: 额外信息

      placeholder: 任何你认为有帮助的信息

  - type: markdown

    attributes:

      value: |

        -----

        在提交这篇 issue 时，您将默认服从我们的[行为准则](https://github.com/nju-lug/NJUThesis/blob/master/.github/CODE_OF_CONDUCT.md)。

name: 请求新功能

description: 提出可以改进的要点

title: "[Feature]: "

labels: ["enhancement"]

body:

  - type: checkboxes

    id: prerequisites

    attributes:

      label: 先决条件

      options:

        - label: |-

            我已尝试更新模板版本

          required: true

        - label: |-

            我已检索[模板手册](http://mirrors.ctan.org/macros/unicodetex/latex/njuthesis/njuthesis.pdf)

          required: true

        - label: |-

            我已检索[项目 wiki](https://github.com/nju-lug/NJUThesis/wiki)

          required: true

        - label: |-

            我已确认这个请求没有在[其他 issues](https://github.com/tuna/issues/issues)中提出过。

          required: true

  - type: textarea

    id: inconvenience

    attributes:

      label: 现有模板的不便之处

      placeholder: 你的请求是否来自于使用上有不好的体验？请简要进行描述。

  - type: textarea

    id: possible_solution

    attributes:

      label: 提出可能的解决方案

      placeholder: 你认为需要采取什么措施，或者你希望改进后将呈现出什么效果。

    validations:

      required: true

  - type: textarea

    id: considerations

    attributes:

      label: 提出考虑过的方案

      placeholder: 请描述你进行过的相关尝试。

  - type: textarea

    id: more_info

    attributes:

      label: 额外信息

      placeholder: 任何你认为有帮助的信息

  - type: markdown

    attributes:

      value: |

        在提交这篇 issue 时，我们默认您服从我们的[行为准则](https://github.com/nju-lug/NJUThesis/blob/master/.github/CODE_OF_CONDUCT.md)。

blank_issues_enabled: true

contact_links:

  - name: 讨论

    url: https://github.com/nju-lug/NJUThesis/discussions/new

    about: 使用上的疑惑可以发在论坛哦

name: Build LaTeX document using LuaLaTeX

on: [push, pull_request]

jobs:

  build_latex:

    runs-on: ubuntu-latest

    steps:

      - name: Set up Git repository

        uses: actions/checkout@v2

      - name: Compile to PDF

        uses: HermitSun/latex-action@v3

        with:

          root_file: njuthesis.tex

          latexmk_use_lualatex: true

          args: '-bibtex'

      - name: Upload PDF

        uses: actions/upload-artifact@v2

        with:

          name: PDF

          path: njuthesis.pdf

name: Build LaTeX document

on: [push, pull_request]

jobs:

  build_latex:

    runs-on: ubuntu-latest

    steps:

      - name: Set up Git repository

        uses: actions/checkout@v2

      - name: Compile to PDF

        uses: HermitSun/latex-action@v3

        with:

          root_file: njuthesis.tex

          latexmk_use_xelatex: true

          args: '-bibtex'

      - name: Upload PDF

        uses: actions/upload-artifact@v2

        with:

          name: PDF

          path: njuthesis.pdf

name: Build

on:

  push:

    branches:

      - master

  pull_request:

    branches:

      - master

env:

  CTAN_URL: https://mirrors.rit.edu/CTAN

  PACKAGES: latexmk cleveref enumitem footmisc tex-gyre xits biblatex-gb7714-2015 biber

jobs:

  build-on-ubuntu:

    runs-on: ubuntu-latest

    if: "!startsWith(github.ref, 'refs/tags/v')"

    env:

      SET_PATH: |

        export PATH=/tmp/texlive/bin/x86_64-linux:$PATH

    steps:

      - name: Set up Git repository

        uses: actions/checkout@v4

      - name: Install TeX Live

        run: |

          ${{ env.SET_PATH }}

          wget ${{ env.CTAN_URL }}/systems/texlive/tlnet/install-tl-unx.tar.gz

          tar -xzf install-tl-unx.tar.gz

          cd install-tl-20* && ./install-tl --profile ../.github/workflows/texlive.profile

      - name: Install latest njuthesis

        run: |

          ${{ env.SET_PATH }}

          tlmgr option repository ${{ env.CTAN_URL }}/systems/texlive/tlnet/

          tlmgr install xetex l3build

          l3build install

          cd scripts

          bash download.sh ${{ env.CTAN_URL }}

          cd data

          wget https://raw.githubusercontent.com/stone-zeng/tl-depend-analysis/data/data/tl-depend.json

          cd ..

          python3 main.py --pkg "${{ env.PACKAGES }}" --exclude "njuthesis-doc.cls"

          tlmgr update --self --all --no-auto-install

      - name: Compile test file

        run: |

          ${{ env.SET_PATH }}

          cd test

          latexmk -xelatex  -halt-on-error test-xetex-undergraduate

          xelatex           -halt-on-error test-xetex-graduate

          xelatex           -halt-on-error test-xetex-graduate-nlcover

          # latexmk -lualatex -halt-on-error test-luatex

      - name: Upload CLS Files

        uses: actions/upload-artifact@v4

        with:

          name: "njuthesis-cls-${{ github.sha }}"

          path: |

            build/unpacked/njuthesis.cls

            build/unpacked/*.def

name: Release

on:

  push:

    branches:

      - master

    tags:

      - v*

env:

  CTAN_URL: https://mirrors.rit.edu/CTAN

  PACKAGES: cm-unicode tex-gyre tex-gyre-math lexend xits natbib makeindex

jobs:

  release:

    runs-on: ubuntu-latest

    if: startsWith(github.ref, 'refs/tags/v')

    env:

      SET_PATH: |

        export PATH=/tmp/texlive/bin/x86_64-linux:$PATH

    steps:

      - name: Set up Git repository

        uses: actions/checkout@v4

      - name: Set Version

        run: echo "VERSION=${GITHUB_REF##*/}" >> $GITHUB_ENV

      - name: Install TeX Live

        run: |

          ${{ env.SET_PATH }}

          wget ${{ env.CTAN_URL }}/systems/texlive/tlnet/install-tl-unx.tar.gz

          tar -xzf install-tl-unx.tar.gz

          cd install-tl-20* && ./install-tl --profile ../.github/workflows/texlive.profile

      - name: Install latest njuthesis

        run: |

          ${{ env.SET_PATH }}

          tlmgr option repository ${{ env.CTAN_URL }}/systems/texlive/tlnet/

          tlmgr install xetex l3build

          l3build install

          cd scripts

          bash download.sh ${{ env.CTAN_URL }}

          cd data

          wget https://raw.githubusercontent.com/stone-zeng/tl-depend-analysis/data/data/tl-depend.json

          cd ..

          python3 main.py --pkg "${{ env.PACKAGES }}" --exclude "njuthesis.cls"

          tlmgr update --self --all --no-auto-install

      - name: Install latest ctex

        run: |

          ${{ env.SET_PATH }}

          git clone https://github.com/CTeX-org/ctex-kit.git

          cd ctex-kit/ctex

          l3build install

      - name: Install fonts

        run: |

          mkdir fonts

          wget https://github.com/adobe-fonts/source-han-serif/raw/release/OTF/SimplifiedChinese/SourceHanSerifSC-SemiBold.otf

          wget https://github.com/adobe-fonts/source-han-serif/raw/release/OTF/SimplifiedChinese/SourceHanSerifSC-Bold.otf

          wget https://github.com/adobe-fonts/source-han-serif/raw/release/OTF/SimplifiedChinese/SourceHanSerifSC-Heavy.otf

          wget https://github.com/be5invis/Iosevka/releases/download/v15.6.3/ttf-iosevka-15.6.3.zip

          unzip ttf-iosevka-15.6.3.zip

          cp *.otf                   /usr/share/fonts/

          cp iosevka-lightitalic.ttf /usr/share/fonts/

          cp iosevka-light.ttf       /usr/share/fonts/

          cp iosevka-semibold.ttf    /usr/share/fonts/

          chmod -x /usr/share/fonts/*.otf

          chmod -x /usr/share/fonts/*.ttf

          fc-cache -fv

      - name: Zip CTAN package

        run: |

          ${{ env.SET_PATH }}

          l3build ctan

          mv njuthesis-ctan.zip njuthesis-ctan-$VERSION.zip

          mv njuthesis.pdf njuthesis-$VERSION.pdf

      - name: Zip USER package

        run: |

          ${{ env.SET_PATH }}

          mv docs/* .

          mv build/unpacked/* .

          zip -r njuthesis-user-$VERSION.zip *.def njuthesis-sample* njuthesis.cls nju-*.pdf LICENSE CHANGELOG.md README.md

      - uses: "marvinpinto/action-automatic-releases@latest"

        with:

          repo_token: "${{ secrets.GITHUB_TOKEN }}"

          prerelease: true

          files: |

            njuthesis-v*.pdf

            njuthesis-user-v*.zip

            njuthesis-ctan-v*.zip

# From latex3

# https://github.com/latex3/latex3/blob/main/support/texlive.profile

selected_scheme     scheme-infraonly

TEXDIR              /tmp/texlive

TEXMFSYSCONFIG      /tmp/texlive/texmf-config

TEXMFSYSVAR         /tmp/texlive/texmf-var

TEXMFLOCAL          /tmp/texlive/texmf-local

TEXMFHOME           ~/texmf

TEXMFCONFIG         ~/.texlive/texmf-config

TEXMFVAR            ~/.texlive/texmf-var

option_doc          0

option_src          0

tlpdbopt_autobackup 0

*.cb2

.*.lb

## DocStrip generated file

*.cls

*.def

*.ins

*.sty

!docs/njuthesis-setup.def

## Zip file

*.zip

## Fonts

*.ttf

*.otf

## Intermediate documents:

*.hd

*.dvi

*.xdv

*-converted-to.*

# these rules might exclude image files for figures etc.

# *.ps

# *.eps

# *.pdf

## Generated if empty string is given at "Please type another file name for output:"

njuthesis.pdf

njuthesis*.pdf

test*.pdf

# Folders

build/

release/

support/

scripts/data

TDS/

temp/

mythesis/

__pycache__/

## Bibliography auxiliary files (bibtex/biblatex/biber):

*.bbl

{

    "latex-workshop.latex.autoBuild.run": "never", // 禁止自动编译

    "latex-workshop.latex.recipe.default": "lastUsed", // 使用前一次的编译方法

    "latex-workshop.latex.tools": [

        {

            "name": "xelatex",

            "command": "xelatex",

            "args": [

                "-synctex=1",

                "-shell-escape",

                "-interaction=nonstopmode",

                "-file-line-error",

                "%DOCFILE%"

            ]

        },

        {

            "name": "latexmk",

            "name": "latexmk-xe",

            "command": "latexmk",

            "args": [

                "-xelatex"

                "-xelatex",

                "-time",

                "-interaction=nonstopmode",

                "%DOCFILE%"

            ]

        },

        {

            "name": "latexmk-lua",

            "command": "latexmk",

            "args": [

                "-lualatex",

                "-time",

                "-interaction=nonstopmode",

                "%DOCFILE%"

            ]

        },

        {

            "name": "lualatex",

            "command": "lualatex",

            "args": [

                "-interaction=nonstopmode",

                "-file-line-error",

                "%DOCFILE%"

            ]

        }

        },

    ],

    "latex-workshop.latex.recipes": [

        {

            "name": "latexmk 🔃",

            "name": "latexmk(xe)",

            "tools": [

                "latexmk"

                "latexmk-xe"

            ]

        },

        {

                "xelatex"

            ]

        },

        {

            "name": "xe->bib->xe->xe",

            "tools": [

                "xelatex",

                "biber",

                "xelatex",

                "xelatex"

            ]

        },

        {

            "name": "latexmk(lua)",

            "tools": [

                "latexmk-lua"

            ]

        },

        {

            "name": "lualatex",

            "tools": [

            ]

        },

        {

            "name": "xe->bib->xe->xe",

            "name": "lua->bib->lua->lua",

            "tools": [

                "xelatex",

                "lualatex",

                "biber",

                "xelatex",

                "xelatex"

                "lualatex",

                "lualatex"

            ]

        }

        },

    ]

}

The `njuthesis` class

=====================

The `njuthesis` class is intended for typesetting Nanjing University

dissertations with LaTeX, providing support for bachelor, master,

doctoral thesis and postdoctoral report. Compilation of this class

requires either `xelatex` or `lualatex` engine.

Usage

-----

A minimal example of this document class should look like

```LaTeX

\documentclass{njuthesis}

\njusetup{}

\begin{document}

\maketitle

\tableofcontents

\mainmatter

\chapter{Welcome}

Hello \LaTeX{}！

\printbibliography

\end{document}

```

Contributing

------------

[Issues](https://github.com/nju-lug/NJUThesis/issues) and

[pull requests](https://github.com/nju-lug/NJUThesis/pulls)