Skip to content

yuhao-kuo/NKUST-thesis-template

Repository files navigation

NKUST Thesis LaTeX

yuhao-kuo - NKUST-thesis-template License forks - NKUST-thesis-template stars - NKUST-thesis-template

本專案為國立高雄科技大學研究所論文 LaTeX 模板,以開源工具為基礎的 LaTeX 編輯環境,內文依照國立高雄科技大學教務處學位論文撰寫體例參考(中華民國111年3月修訂版)及建工校區電子工程系網路計算實驗室(WNDCLabNCLabAIoRLab)之論文格式標準進行編排。其內容排列順序依序為:

  1. 封面
  2. 書名頁
  3. 論文指導教授推薦書 (自行置入)
  4. 論文口試委員會審訂書 (自行置換)
  5. 學位論文著作權歸屬協議書 (自行置換)
  6. 中文摘要
  7. 英文摘要
  8. 誌謝或序言
  9. 目錄
  10. 表目錄
  11. 圖目錄
  12. 符號說明 (未提供)
  13. 論文本文
  14. 參考文獻
  15. 附錄
  16. 自傳或簡歷 (未提供)
  17. 空白頁

開發環境

OS - Ubuntu OS - Arch Linux OS - Debian OS - Windows OS - MacOS Container - Docker

此模板開發初期使用 Linux 系作業系統進行開發,主體仍相依於 Linux 環境上,目前已知此模板能在 UbuntuArch LinuxDebian 等多個 Linux 發行版中使用。如果您是 Windows 使用者或不想佈署環境的用戶可使用 docker 方案進行使用。

後續文件內容依序為安裝工具取得使用等三大部份。

安裝工具

專案推薦使用編輯器 Visual Studio Code,使用 maketexlive 套件包進行文件的編譯移除等相關操作,另外我們推薦使用 Git 管理版本,預防資料遺失及損毀等災難,詳細的工具安裝說明請見 Docs/environment.md

取得

請直接下載穩定版本/開發版本,或是使用 git 獲取專案。

建議使用 Git 獲取專案

開發版本為 master 分支中的最新版本,穩定版本是架構或內容經過大變動後的版本。目前論文架構已經趨近穩定,已經少有劇烈的變動,因此直接下載開發版本即可。

使用時發現任何問題,歡迎向我們發出 Issues 並描述您碰見的問題。

使用

本章節著重說明版型架構以及 make 相關的操作指令。

架構說明

  • Chapters : 主文
  • Configurations : 本文格式定義與引入設定
  • Docs : 說明文件
  • Docker : Docker 相關指令與設定
  • Exteranls : 外部匯入的PDF檔案
  • Fonts: 字體檔案
  • Figures : 文中的所有圖片
  • Instance : 封面/書名頁/封面/摘要/誌謝
  • Packages : LaTeX 套件
  • References : 參考文獻 bib 檔案
  • Templates : 文件版型
  • Tables : 外部插入的表格
  • build : 編譯結果
  • .vscode : 編輯器設定檔
  • config.tex : 論文內容載入設定
  • main.tex : 論文主架構
  • thesisinfo.tex : 論文作者訊息
  • titlepage.tex : 置中的論文封面

字體問題經常導致編譯時出現錯誤,基於易用原則在 Release v2.0 重新將 Fonts 加回專案中,Fonts 內提供的字體皆為開源 or 免費的,字體的 License 一併被附加到 Fonts 目錄中。

產生論文

編輯完成後,透過 all 指令來產生論文。

$ make all

資料清除

清除暫存資料請使用 clean,該指令將會保留編譯時產生的 PDF 文件,如需完整清除編譯結果請使用 distclean

$ make clean
$ make distclean

檔案防拷處理

考量到論文 PDF 有加入防拷處理的需求,故新增指令 pdfprocessing,此功能依賴外部工具 ghostscript。 該命令僅對 main.pdf 進行防拷處理,因此執行命令時 main.pdf 必須存在。

$ make pdfprocessing

安全性

如使用 GitHubGitLabBitbucket 等公開的程式碼代管服務管理論文,請注意遠端儲存庫 (Remote Repository) 的存取權限,知識內容請設為私密,以避免防資料外洩等安全性問題。

鳴謝

感謝參與這個專案的貢獻者以及製作版型內容的前輩們!

如果這個專案有幫助到您,請給專案一個 Star,Thanks!

授權與免責聲明

創用 CC 授權條款
本著作係採用創用 CC 姓名標示-相同方式分享 3.0 台灣 授權條款授權.

因專案的貢獻者大多已畢業,使用前請務必檢視版型是否符合現行規範。若引用此專案造成一切損失,本專案之貢獻者不承擔任何責任。

如有發現格式問題錯誤,歡迎提交 Issue 告知。