Giter Site home page Giter Site logo

lucid-a / tongji-undergrad-thesis Goto Github PK

View Code? Open in Web Editor NEW

This project forked from tj-csccg/tongji-undergrad-thesis

0.0 0.0 0.0 3.53 MB

:page_facing_up: 同济大学本科生毕业设计论文模板 | Tongji University Undergraduate Thesis Template | Overleaf / Mac / Linux / Windows / Workshop / Docker

License: Other

Perl 1.06% TeX 82.07% Makefile 6.49% Batchfile 10.38%

tongji-undergrad-thesis's Introduction

📄 同济大学本科生毕业设计论文模板(理工类)

中文 | English

  • 注意:使用该模板你会获得 pdf 文件作为输出。但在毕业设计过程中可能存在需要提交 docx 等格式文件的场合,这时你可以使用一些 pdf 转 docx 工具,比如:pdf2go.pdf-to-word)。
  • 不需要担心 “抛弃 1 系统的 docx 模板而选用本 LaTeX 模板是否会受到影响”,毕竟使用该模板的我们(2017-ganler, 2018-skyleaworlder)都没有因格式问题而被勒令重新排版论文。

样例展示

完整样例可见 模板输出样例展示(完整版)Release 页 中 "Assets" 下的 pdf 下载链接。

以下依次展示 “封面”、“中文摘要”、“目录”、“主要内容”、“参考文献” 与 “谢辞”。

使用方法

1. 直接在 Overleaf 上使用(Overleaf 模板)

点这里跳转至 Overleaf 👉 svg of overleaf-tongjithesis

但请注意!上方的 Overleaf 模板并未及时更新。因此建议想要使用最新模板的同学们在 Overleaf 上创建自己的项目,具体操作请看该小节

注意! 请检查 Overleaf 项目中对 编译器主入口 的配置:

  • main.tex 设为主入口,而非项目中的其他 .tex 文件(尤其是 tongjithesis.clstongjithesis.sty);
  • 推荐将 XeLaTeX 设置为编译器,本项目不支持某些编译器(如 pdfLaTeX)。

2. 在 Overleaf 上使用最新版本

  • 通过本仓库主页项目文件列表上方的 “Code | Download ZIP” 下载本仓库;
  • 打开 Overleaf
  • 通过拖拽下载的 zip 文件上传至 Overleaf。

3. 在 Mac / Linux 上使用

i. 使用 tlmgr

下载 TeXLive,并使用 tlmgr 下载宏包:

# The following commands aims at installing packages upon TeXLive without any packages.
# You can also install BasicTex: https://mirrors.chevalier.io/CTAN/systems/mac/mactex/mactex-basictex-20210325.pkg
sudo tlmgr update --self

sudo tlmgr install adjustbox algorithm \
    cases caption chngcntr collectbox ctex enumerate enumitem environ extarrows fancybox fancyhdr \
    lastpage latexmk longtable mathptmx minted multirow needspace rsfs setspace subfigure \
    tcolorbox texcount texliveonfly tikz titling \
    tocloft trimspaces ucs verbatim xcolor xecjk zhnumber

sudo tlmgr update --self --all

ii. 通过 Makefile 构建项目

感谢 SJTUThesis 项目的 Makefile 文件。

你可以通过下列指令完成对应操作:

make all                      # compile main.pdf
make ENGINE=$ENGINE all       # use $ENGINE(where $ENGINE=-xelatex or -lualatex) to compile main.pdf
make clean                    # rm intermediate files
make cleanall                 # rm all intermediate files (including .pdf)
make wordcount                # wordcount

4. 在 Windows 上使用

i. 安装 TeXLive

通过 此处 下载 install-tl-windows.exe

ii. 通过 Batchfile 构建项目

感谢 SJTUThesis 项目的 Compile.bat 文件。

你可以通过下列指令完成对应操作:

.\make.bat                      # the same to "make.bat thesis"
.\make.bat thesis               # compile main.pdf
.\make.bat thesis $ENGINE       # use $ENGINE(where $ENGINE=-xelatex or -lualatex) to compile main.pdf
.\make.bat clean                # clean all work files by latexmk -c
.\make.bat cleanall             # clean all work files and main.pdf by latexmk -C
.\make.bat wordcount            # wordcount
.\make.bat help                 # read the manual

5. 在 VSCode 上使用

i. 配置 VSCode

在插件市场中安装 LaTeX Workshop 插件,此后下载该项目,并在该项目根目录打开。(LaTeX Workshop 只是一个插件,仍需要下载对应平台下的 TeXLive

注意:下列配置已被项目中 .vscode/settings.json 包含。正常情况下,启动 LaTeX Workshop 插件时会自动装载配置。(.vscode/settings.json 中的配置会覆盖全局配置文件 settings.json 中对应选项,因此不必修改全局配置文件)

"latex-workshop.latex.recipe.default": "latexmk (xelatex)",
"latex-workshop.latex.tools": [
    {
        "name": "xelatexmk",
        "command": "latexmk",
        "args": [
            "-xelatex",
            "-synctex=1",
            "-quiet",
            "-interaction=nonstopmode",
            "-file-line-error",
            "-halt-on-error",
            "-shell-escape",
            "%DOC%"
        ]
    }
],
"latex-workshop.latex.recipes": [
    {
        "name": "latexmk (xelatex)",
        "tools": [
            "xelatexmk"
        ]
    }
]

ii. 通过 Workshop 提供的功能编译项目

  • 点击左侧边栏中带有 TEX 图标的 LaTeX 按钮;
  • 点击 Build LaTeX project 列表中的 Recipe: latexmk (xelatex) 编译 .pdf 文件。

6. 在 GitHub Actions 中编译

项目以 .github/workflows/*.yaml 配置了 GitHub Actions,push 代码到 fork 仓库或 template-generated 仓库均可触发测试。可通过 commit 对应的 workflow run 中的 Summary | Artifacts 获得多平台构建产物。

(通过勾选 Settings | Actions | General | Allow all actions and reusable workflows 打开 GitHub Actions)

7. 在 Docker 中使用

详细使用方法见 tongji-undergrad-thesis-env

如何为该项目贡献代码?

还请查看 How to pull request

开源协议

该项目使用 “你想干啥就干啥” 协议(WTFPLv3.1)。

              DO WHAT THE FUCK YOU WANT TO PUBLIC LICENCE
                         Version 3.1, July 2019
                     https://ph.dtf.wtf/u/wtfplv31

by Sam Hocevar <[email protected]>
   theiostream <[email protected]>
   dtf         <[email protected]>

              DO WHAT THE FUCK YOU WANT TO PUBLIC LICENCE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

有关突出贡献的说明

  • 该项目起源于 YukuanHU 的本科毕业设计论文,论文于 2019.05.24 上传;
  • 2021.05.09 起,ganler 以上述项目为基础,增强其功能(项目结构与平台适配)并开始维护新项目。

致谢

我们从顶尖高校的优秀开源项目中学到了很多:

联系方式

# Python
[
    f'jiawei#@$.edu'.replace('#', '6').replace('$', 'illinois'),
    'jgli22@$.edu.cn'.replace('$', 'm.fudan')
]

tongji-undergrad-thesis's People

Contributors

skyleaworlder avatar ganler avatar cookiepieww avatar strear avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.