Documentation

Difference between revisions of "Using the kulemt package"

(Windows)
Line 10: Line 10:
 
logokul{,eng}.eps to the same directory as your LaTeX file.
 
logokul{,eng}.eps to the same directory as your LaTeX file.
  
== System-wide installation ==
+
== User-wide installation ==
 
If you need to use the kulemt package more than a few times, copying these
 
If you need to use the kulemt package more than a few times, copying these
 
five files can become a little bit of a hassle. It is also possible to install
 
five files can become a little bit of a hassle. It is also possible to install
this package system-wide. When using TeXLive, as we recommend, this involves a
+
this package in a central place for your user. When using TeXLive, as we
bit more work and use of a command-line.
+
recommend, this involves a bit more work and use of a command-line.
  
 
=== Windows ===
 
=== Windows ===
 
First, you should find where to install the packages for your user. By default,
 
First, you should find where to install the packages for your user. By default,
 
this will be in the folder "texmf" in your %USERPROFILE%
 
this will be in the folder "texmf" in your %USERPROFILE%
(C:\Users\YourUsername). It is possible that this folder needs to be created
+
(C:\Users\YourUsername). From the extracted kulemt-tds.zip, copy the entire
first. From the extracted kulemt-tds.zip, copy the entire directory "tex" to
+
directory "tex" to this location. It is possible that this folder needs to be
this location (note: the directory itself, not its contents).
+
created first.
  
 
In case this does not work, this folder might be different for you for some
 
In case this does not work, this folder might be different for you for some
Line 40: Line 40:
  
 
=== UNIX-like OSes ===
 
=== UNIX-like OSes ===
You can follow the general guidelines provided by the department:
+
On UNIX-like OSes, such as Linux or macOS, the steps are similar to Windows.
ftp://ftp.esat.kuleuven.be/latex/kulemt/README.
+
First, find your TEXMFHOME. This is the folder in which you can install LaTeX
 +
packages for your user. By default, this is "~/texmf". You can check this with
 +
the following command:
 +
  kpsewhich -expand-var='$TEXMFHOME'
 +
An example output would be:
 +
  /home/ulyssis/texmf
 +
Copy the entire "tex" directory (the folder itself, not its contents) from the
 +
extracted kulemt-tds.zip to this directory. It is possible that you need to
 +
create this folder first.
 +
 
 +
For a more detailed overview, you can follow the general guidelines provided by
 +
the department: ftp://ftp.esat.kuleuven.be/latex/kulemt/README.
  
 
== Using the kulemt package ==
 
== Using the kulemt package ==

Revision as of 14:44, 26 October 2016

We often get the question at our LaTeX workshop on how to properly install the kulemt package. For this reason, we have decided to provide a proper guideline. You can acquire the kulemt package by downloading "kulemt-tds.zip" from ftp://ftp.esat.kuleuven.be/latex/kulemt/.

One-time use

Most people will only use this package once, for their master thesis. The easiest way is to unzip the downloaded file and go to the directory "tex/latex/kulemt". Here, copy the files kulemt{.cfg,.cls,x.sty} and logokul{,eng}.eps to the same directory as your LaTeX file.

User-wide installation

If you need to use the kulemt package more than a few times, copying these five files can become a little bit of a hassle. It is also possible to install this package in a central place for your user. When using TeXLive, as we recommend, this involves a bit more work and use of a command-line.

Windows

First, you should find where to install the packages for your user. By default, this will be in the folder "texmf" in your %USERPROFILE% (C:\Users\YourUsername). From the extracted kulemt-tds.zip, copy the entire directory "tex" to this location. It is possible that this folder needs to be created first.

In case this does not work, this folder might be different for you for some reason. It is possible to retrieve the correct location through the Windows command-line.

Open the Windows command-line by searching for "cmd" in your start menu. The app has a black, square logo.

To find out the central location of installed packages, run the following command:

 kpsewhich -var-value=TEXMFHOME

An example output would be:

 C:/Users/ULYSSIS/texmf

If you have found this folder, copy the entire "tex" directory from the extracted kulemt-tds.zip to this location, as stated before. Create the folder if needed.

UNIX-like OSes

On UNIX-like OSes, such as Linux or macOS, the steps are similar to Windows. First, find your TEXMFHOME. This is the folder in which you can install LaTeX packages for your user. By default, this is "~/texmf". You can check this with the following command:

 kpsewhich -expand-var='$TEXMFHOME'

An example output would be:

 /home/ulyssis/texmf

Copy the entire "tex" directory (the folder itself, not its contents) from the extracted kulemt-tds.zip to this directory. It is possible that you need to create this folder first.

For a more detailed overview, you can follow the general guidelines provided by the department: ftp://ftp.esat.kuleuven.be/latex/kulemt/README.

Using the kulemt package

A complete reference for using the kulemt package can be found at ftp://ftp.esat.kuleuven.be/latex/kulemt/kulemt.pdf. A minimal working example is provided below (inspired by the above manual).

\documentclass[master=eelt,masteroption=ei]{kulemt}
\setup{title={The best master thesis ever},
  author={First Author\and Second Author},
  promotor={Prof.\,dr.\,ir.\ Knows Better},
  assessor={Ir.\,Kn. Owsmuch\and K. Nowsrest},
  assistant={Ir.\ An~Assistent \and A.~Friend}}

\begin{document}
\mainmatter
Test
\end{document}

Please note that for some other masters, some other options might be necessary, such as:

\setup{
  translatedtitle={My title in English (in case of a Dutch master)},
  udc=621.3, % This is the udc number for the faculty of engineering science
  shortabstract={A short summary of the thesis},
}