fyp-latex-template's Introduction

FYP-LaTeX-Template

Template for writing Final Year Project (FYP) and Undergraduate Research Opportunities Programme (UROP) projects in LaTeX for School of Computing, NUS.

Adapted from Prof Ooi's Template

What's inside

socreport.cls: LaTeX style file for FYP/ UROP
socreport.bst: BibTeX style file
socreport.bib: BibTeX biblography file -- this is where you put your biblographies
socreport.tex: LaTeX file -- this is where you write your LaTeX code
Makefile: Makefile to compile the example

Document Class

For FYP, use the document class FYP:

\documentclass[fyp]{socreport}

For UROP, use the document class UROP:

\documentclass[urop]{socreport}

Compiling

Replace socreport of the first line of Makefile with your file name

FILE=your-report-name

Replace socreport of the second line of Makefile with your biblography file name

BIBFILE=your-biblography-name

make

You should get a socreport.pdf as your output for submission :)

You don't have to make files that are included with \include{}

Cleaning up Auxilary and Extra Files

Because LaTeX can be very messy

make clean

Compiling with LaTeX IDE

Compile 'main.tex' using latex or pdflatex => this step will generate main.aux file
Compile 'main.aux' (NOT 'ref.bib') using bibtex
Compile twice 'main.tex' using latex or pdflatex

TAR GZip the files

make tar

Further Resources from School of Computing

Some Errors

bibtex/ pdflatex: No such file or directory for OSX Might be due to directory paths. Refer to this stack overflow answer

Some other LaTeX Template Sources

fyp-latex-template's People

Contributors

Stargazers

Watchers

fyp-latex-template's Issues

Compatibility issues with overleaf and new compliers in general

Hi,

I used this template(a modified version) for a while, compiling fine on local and sharelatex. However, it fails to compile on overleaf. After communicating with their support, we narrowed down the problem to the APA style files embedded in socreport.cls.

The part is

% from apa.sty.

...
% END

These lines have compatibility issues with .bib files with underscore as citation keys, like mitkov_computer-aided_2003. This is the auto-generated format when exporting bibliography as BibTex format in Zotero.

A better approach recommend from overleaf is to

comment out the embedded part above in socreport.cls
add following lines in main latex file which uses the actual apacite package

\usepackage{apacite}
\usepackage{url}
\let\outcite\citeA
\let\abbrevincite\citeA

Replace \bibliographystyle{socreport} with \bibliographystyle{apacite}

Let me know if you want to update the documentation to reflect this.

I can send you a copy of the email from the overleaf support if you want, contact me at [email protected].

quarbby / fyp-latex-template Goto Github PK