Skip to content

hausanlp/BUK-Thesis-Template

Repository files navigation

Bayero University Kano PhD/MSc Thesis Template

This is a LaTeX template for PhD and MSc theses in Computer Science at Bayero University Kano (BUK). It has been adapted from the University of Lincoln Computer Science Thesis Template.

Version Information

  • Template Version: 2.0.0 (BUK Template Version)
  • Last Updated: December 2025
  • Original Template: University of Lincoln CS Thesis Template by Benjamin Williams
  • Adapted by: Idris Abdulmumin abumafrim@gmail.com

Features

  • Centralized Settings: Edit all personal information in ONE file (preamble/thesis-details.tex)
  • Auto-Uppercase Conversion: Type in normal case - template converts to uppercase automatically
  • Pre-configured for Bayero University Kano formatting requirements
  • Includes all required preliminary pages (declaration, certification, approval, etc.)
  • Support for both APA7 and numeric citation styles
  • Built-in glossary and acronym management
  • Well-organized chapter structure with comprehensive templates
  • Professional formatting with proper spacing and margins
  • Properly configured list environments (enumerate, itemize, description)
  • Professional table formatting with booktabs package

Directory Structure

.
├── main.tex                    # Main thesis file
├── buk.cls                     # BUK thesis document class
├── preamble/
│   ├── thesis-details.tex      # ⭐ YOUR PERSONAL INFORMATION (edit this!)
│   ├── packages.tex            # LaTeX packages and configurations
│   ├── bib-setup.tex           # Bibliography configuration
│   ├── abbreviations.tex       # Acronyms and abbreviations
│   └── concepts.tex            # Glossary terms
├── chapters/
│   ├── declaration.tex         # Declaration page (auto-filled)
│   ├── certification.tex       # Certification page (auto-filled)
│   ├── approval.tex            # Approval page (auto-filled)
│   ├── acknowledgements.tex    # Acknowledgements
│   ├── dedication.tex          # Dedication
│   ├── abstract.tex            # Abstract
│   ├── introduction.tex        # Introduction chapter
│   ├── literature-review.tex   # Literature review chapter
│   ├── method.tex              # Methodology chapter
│   ├── results.tex             # Results and discussion chapter
│   └── conclusions.tex         # Conclusions chapter
├── appendices/
│   └── appendices.tex          # Appendices
├── bib/                        # Bibliography files (.bib)
└── figures/                    # Figures and images

Getting Started

Prerequisites

You need a LaTeX distribution installed on your system:

  • Windows: MiKTeX or TeX Live
  • macOS: MacTeX
  • Linux: TeX Live (usually available through package managers)

Quick Start Guide

  1. Clone or download this template to your local machine

  2. Edit your personal information in preamble/thesis-details.tex:

    This is the ONLY file you need to edit for all your personal details. It contains:

    • Your name and registration number
    • Thesis title and degree type
    • Supervisor and examiner names
    • Department and university information
    • Submission dates

    Simply replace the placeholder text:

    \newcommand{\studentName}{Your Full Name}
    \newcommand{\studentRegNumber}{YOUR/REGISTRATION/NUMBER}
    \newcommand{\thesisTitle}{Your Thesis Title Here}
    \newcommand{\degreeType}{Doctor of Philosophy}  % Or "Master of Science"
    \newcommand{\supervisorName}{Professor/Dr. Supervisor Name}

    ✨ Note: Type in normal case - the template automatically converts to uppercase where needed!

    These variables are automatically used throughout your thesis (declaration, certification, approval pages, etc.)

  3. Update content pages:

    • chapters/acknowledgements.tex - Write your acknowledgements
    • chapters/dedication.tex - Add your dedication
    • chapters/abstract.tex - Write your abstract
  4. Add your bibliography:

    • Update the bibliography file path in preamble/bib-setup.tex
    • Add your references to your .bib file
  5. Customize acronyms and glossary:

    • Edit preamble/abbreviations.tex for acronyms
    • Edit preamble/concepts.tex for glossary terms
  6. Write your chapters:

    • Fill in the template content in each chapter file
    • Add additional research chapters as needed in main.tex
  7. Compile the document:

    pdflatex main.tex
    biber main  # or bibtex main for numeric citations
    makeglossaries main
    pdflatex main.tex
    pdflatex main.tex

Writing Your Thesis

Chapter Structure

Each chapter file contains:

  • Commented guidance on what to include
  • Placeholder text in square brackets [PLACEHOLDER TEXT]
  • Section and subsection templates
  • Example structures for tables, figures, and lists

Simply replace the placeholder text with your actual content.

Adding New Chapters

To add additional research chapters (beyond the template's Introduction, Literature Review, Methodology, and Conclusions):

  1. Create a new file in the chapters/ directory (e.g., chapters/my-chapter.tex)
  2. Add the chapter to main.tex:
    \chapter{My Chapter Title}
    \label{chapter-my-chapter}
    \input{chapters/my-chapter.tex}

Citation Styles

The template supports two citation styles:

  • APA7 Style (default): Keep \documentclass[apa7]{buk} in main.tex
  • Numeric Style: Use \documentclass{buk} (without the apa7 option)

Using Acronyms

Define acronyms in preamble/abbreviations.tex:

\newacronym{nmt}{NMT}{Neural Machine Translation}

Use in text:

\acrfull{nmt}   % First use: Neural Machine Translation (NMT)
\acrshort{nmt}  % Subsequent use: NMT
\acrlong{nmt}   % Full form: Neural Machine Translation

Using Glossary Terms

Define terms in preamble/concepts.tex:

\newglossaryentry{machine learning}{
    name=machine learning,
    description={A type of artificial intelligence...}
}

Use in text:

\gls{machine learning}

Adding Figures

\begin{figure}[htbp]
\centering
\includegraphics[width=0.8\textwidth]{figures/my-figure.pdf}
\caption{Caption for my figure}
\label{fig:my-figure}
\end{figure}

Reference with: \Cref{fig:my-figure} or Figure~\ref{fig:my-figure}

Adding Tables

\begin{table}[htbp]
\centering
\caption{Caption for my table}
\label{tab:my-table}
\begin{tabular}{lcc}
\toprule
Header 1 & Header 2 & Header 3 \\
\midrule
Row 1 & Data & Data \\
Row 2 & Data & Data \\
\bottomrule
\end{tabular}
\end{table}

Compilation

Using Command Line

# Full compilation sequence
pdflatex main.tex
biber main  # or bibtex main
makeglossaries main
pdflatex main.tex
pdflatex main.tex

Using LaTeX Editors

  • Overleaf: Upload all files and compile (change compiler to XeLaTeX or pdfLaTeX)
  • TeXstudio: Open main.tex and press F5
  • TeXShop: Open main.tex and click "Typeset"
  • VS Code with LaTeX Workshop: Open main.tex and use the extension's build commands

BUK-Specific Requirements

This template is pre-configured for BUK requirements:

  • Proper page margins and spacing
  • Correct preliminary page order:
    1. Title page
    2. Declaration
    3. Certification
    4. Approval
    5. Acknowledgements
    6. Dedication
    7. Table of Contents
    8. List of Tables
    9. List of Figures
    10. Acronyms
    11. Abstract

Ensure you verify these match current BUK requirements, as they may change over time.

Tips for Success

  1. Start early - Don't wait until the last minute
  2. Backup regularly - Use Git, Dropbox, or similar version control
  3. Compile often - Catch errors early by compiling frequently
  4. Read the comments - The template files contain helpful guidance
  5. Ask for help - Consult your supervisor and department guidelines
  6. Proofread - Always proofread your final document carefully

Common Issues and Solutions

Problem: Bibliography not showing

Solution: Make sure you:

  • Have references in your .bib file
  • Have cited them in your text using \cite{} or \citep{}
  • Ran biber main (or bibtex main)
  • Compiled at least twice after running biber

Problem: Acronyms not showing

Solution: Run makeglossaries main after the first compilation

Problem: References showing as ??

Solution: Compile the document multiple times (usually 2-3 times)

Problem: Figures not appearing

Solution:

  • Check the file path is correct
  • Ensure the image file exists in the figures/ directory
  • Supported formats: PDF, PNG, JPG

Support and Contribution

For issues specific to Bayero University Kano formatting:

For general LaTeX issues:

License

This template is provided as-is for use by Bayero University Kano students. The original Lincoln CS Thesis Template was created by Benjamin Williams.

Acknowledgements

  • Original template by Benjamin Williams, University of Lincoln
  • Adapted for Bayero University Kano by Idris Abdulmumin

Good luck with your thesis!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages