# wengan-li/ncku-thesis-template-latex architecture

> Architecture diagram of the GitHub repository wengan-li/ncku-thesis-template-latex, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wengan-li/ncku-thesis-template-latex
- Repository: https://github.com/wengan-li/ncku-thesis-template-latex

## Overview

##### Project type and purpose
- This repo is not an application or service but an open‐source LaTeX “template project.”
- Its purpose is to provide a complete National Cheng Kung University thesis/dissertation template (with commands, styles, examples, and how-to guides) that students can clone, customize, and compile into a PDF matching NCKU requirements.

##### File structure
- Top level
- reference/     ← sample IEEEtran.tex and orientation examples
- thesis/        ← the heart of the template: configuration, contexts, examples, and the core template
- .gitignore, README.md, LICENSE, CHANGELOG.md, CONTRIBUTE  ← project metadata
- Inside thesis/
- conf/          ← high‐level configuration for cover, margins, fonts
- context/       ← skeleton directories for abstract, acknowledgments, introduction, conclusion, related work, nomenclature, references, oral materials
- example/       ← living “how-to” demos: sample abstracts, acknowledgments, appendices, content tests, writing guidelines, build instructions
- template/      ← low‐level command definitions (cmd-*.tex), style files (ncku.tex), cover templates, fonts, libs, oral templates
- thesis.tex     ← the master file that ties everything together
- Presence of “how-to” and “Customization.md” shows an extensible design pattern: separation of core template vs. consumer examples and customization layer.

##### README for additional insights
- Describes features: bilingual support via XeLaTeX, auto-generated metadata (TOC, cover, certificate), built-in user manual, simple syntax for advanced LaTeX features
- Mentions external dependencies: XeLaTeX, bibtex, TeXLive or MiKTeX, PDF generation
- Highlights “Customization.md” for adapting to other universities

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Modules and Components
    Config["Configuration Module"]:::core
    Core["Core Template Engine"]:::core
    User["User Content Module"]:::user
    Customization["Customization Extension"]:::user
    Example["Example & Documentation Module"]:::example
    RefOri(("Reference Module\norientation examples")):::ref
    RefBib(("Reference Module\nbibliography inputs")):::ref
    Build[/Build System/]:::build
    XeLaTeX[/XeLaTeX & BibTeX/ external tools/]:::external
    Output["Output & Delivery\nGenerated PDF → ETDS"]:::external

    %% Relationships
    Config -->|"inject parameters"| Core
    User -->|"provide .tex files"| Core
    RefBib -->|"provide .bib inputs"| Core
    Core -->|"defines style & macros"| Build
    User -->|"content inputs"| Build
    RefBib -->|"bibliography inputs"| Build
    Config -->|"configuration inputs"| Build

    Build -->|"invoke"| XeLaTeX
    XeLaTeX -->|"produce PDF"| Output

    Example -.->|"demonstrates"| Core
    Example -.->|"samples"| User
    RefOri -.->|"samples orientation"| Example
    Customization -->|"extends"| Core

    %% Click Events
    click User "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/thesis/context"
    click Core "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/thesis/template"
    click Config "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/thesis/conf"
    click Example "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/thesis/example"
    click RefOri "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/reference"
    click RefBib "https://github.com/wengan-li/ncku-thesis-template-latex/tree/main/thesis/context/references"

    %% Styling
    classDef core fill:#cee,stroke:#069,stroke-width:2px;
    classDef user fill:#e6ffe6,stroke:#0a0,stroke-width:2px;
    classDef example fill:#ffe6cc,stroke:#f60,stroke-width:2px;
    classDef ref fill:#f0f0f0,stroke:#888,stroke-width:1px;
    classDef build fill:#fff5cc,stroke:#fa0,stroke-width:2px;
    classDef external fill:#f5f5f5,stroke:#999,stroke-width:1px;
```
