reportisel

Template for bachelor report written in LaTex

Demo: click here

Instructions

This document will serve as a template for the preparation of a report for the Programming curricular unit. To create a report of a higher grade you can see https://github.com/matpato/thesisisel.

\documentclass[
	rpt,		% (*)rpt, preprpt - Technical Report or PrepTechnical Report
	pt,			% (*)pt, en - languages 
	twoside,	% (*)twoside, oneside - single or double sided printing
	12pt,		% (*)12pt, 11pt, 10pt - use font size
	a4paper,	% paper size/format
	utf8,		% (*)utf8, latin1 - Text encoding: Linux, Mac or Windows
	onscreen, 	% (*)onscreen, onpaper - Page layout: screen versus paper print	
	hyperref = true,  % (*)true, false - Hyperlinks in citations
	listof = totoc
]{reportisel} 

How to run (terminal or console)

1. Single document w/o nomenclature or references
   $ pdflatex template

2. With nomenclature:
   $ pdflatex template
   $ makeindex template.nlo -s nomencl.ist -o template.nls
   $ pdflatex template (twice)
   

3. With Bibliography:
   $ pdflatex template
   $ bibtex template
   $ pdflatex template (twice)
   

Description

reportisel: This is the main directory and includes:

1. Appendixes: Directory with tex files with a section or table of subsidiary matter at the end of a book or document;

2. Logo: Directory with Faculty logos;

3. Chapters: Directory where to put user files (text and figures);

   1. chapter# - tex files for each chapter (#: 1, 2, ...);
   2. scripts: Directory with useful bash scripts, e.g., for cleaning all temporary files;
   3. img: Directory with all images to use in the chapters, e.g. \texttt{ra-raster.png}.

4. alpha-pt.bst: A file with bibliography names in portuguese, e.g., 'Relatório Técnico' e 'Tese de Mestrado' instead of 'Technical Report' and 'Master Thesis'. This file is used automatically if Portuguese is selected as the main language (see below);

5. defaults.tex: A file with the main default values for the package (institution name, faculty's logo, degree name and similars - TO CHANGE BY THE USER);

6. personaldataofthesis.tex: A file with the identification of report as well as the author and juries names - TO CHANGE BY THE USER;

7. template.tex: The main file. Please refrain from changing the file content outside of the well defined area;

8. bibliography.bib: The bib file. An easy way to find to import citation into bibtex is select option "Show links to import citation into BibTex" in \href{http://scholar.google.pt/scholar_settings?hl=en&as_sdt=0,5}{Scholar google settings};

9. reportisel.cls: The LaTeX class file for the thesis{} style. Currently, some of the defaults are stored here instead of \verb!defaults.tex!. This file should not be changed, unless you're ready to play with fire! :) - DO NOT CHANGE).

10. relationalAlgebra.sty: Contains adapted Relational algebra symbols from ftp://reports.stanford.edu/www/dbgroup_only/latex-macros.html. This is used, only, for Sistemas de Informação course. This file should not be changed, unless you're ready to play with fire! :) - DO NOT CHANGE).

All of these files should be in the same folder. The outputs will be a .pdf file called template.pdf with the manuscript. After that, this should be renamed.

In addition, latex generates extra files which are .aux, .log, .out, .bbl and .synctex.gz. Theses files provide important info:

.log - about the compiler that you are running (warning and errors);
.aux, .sync, .toc and others - are needed for things to actually work when you compile your document multiple times.

Deleting them can break things, then it's not really a great idea to (automatically) remove them. However, if you desire to have a cleaner working directory, there are a few ways to accomplish that. For example, you can compile your document with the output-directory parameter. Read more ...

Some informations

The template will first automatically place the abstract in the language of the main text and then the abstract in the other language. For example, if the dissertation is written in Portuguese, the abstract will appear first in Portuguese, then in English, followed by the main text in Portuguese.

How to write using LaTex

The template presents some instructions how to write a report, or the major concepts how to write a good report: title, abstract, keywords and chapters. I recommend to you to read carefully. Moreover, you will find some instructions how to write in #LaTex, for instance how to insert a figure, table, some text formats and others. In addition, the list below you can see some webpages that may be useful

https://www.latex-project.org
https://www.overleaf.com/learn/latex/Learn_LaTeX_in_30_minutes
http://www4.di.uminho.pt/~jcr/AULAS/didac/manuais/manual-latex.pdf

tikZ and PGF: http://www.texample.net/tikz/

Available Software

1. Overleaf is an online LaTeX and Rich Text collaborative writing and publishing tool that makes the whole process of writing, editing and publishing scientific documents much quicker and easier. (source: https://www.overleaf.com). In this case, you need to create an account. After logging in, create a new project in "New Project" and select "Upload Zipped Project". Place the zip of this content in the window that was opened.

2. Texmaker is a free, modern and cross-platform LaTeX editor for linux, macosx and windows systems that integrates many tools needed to develop documents with LaTeX, in just one application. (source: http://www.xm1math.net/texmaker/)

3. MiKTeX (pronounced mick-tech) is an up-to-date implementation of TeX/LaTeX and related programs. TeX is a typesetting system written by Donald Ervin Knuth who says that it is intended for the creation of beautiful books - and especially for books that contain a lot of mathematics. (source: https://miktex.org)

Author

Matilde Pós-de-Mina Pato

Last update: June, 14th 2023

this package and template are not official for ISEL/IPL

License

MIT