Documentation

Difference between revisions of "Using the kulemt package"

(UNIX-like OSes)
Line 1: Line 1:
We often get the question at our LaTeX workshop on how to properly install the
+
We often get the question at our LaTeX workshop how to properly install the
 
kulemt package. For this reason, we have decided to provide a proper guideline.
 
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
 
You can acquire the kulemt package by downloading "kulemt-tds.zip" from
Line 5: Line 5:
  
 
== One-time use ==
 
== One-time use ==
Most people will only use this package once, for their master thesis. The
+
Most people will only use this package once, for their master thesis. In this
easiest way is to unzip the downloaded file and go to the directory
+
case, you can just put the necessary files in the same folder as your LaTeX
"tex/latex/kulemt". Here, copy the files kulemt{.cfg,.cls,x.sty} and
+
project.  The easiest way to accomplish this, is to unzip the downloaded file
logokul{,eng}.eps to the same directory as your LaTeX file.
+
and in the unzipped folder, navigate to the directory "tex/latex/kulemt". Here,
 +
copy the following files to the same directory as your LaTeX project:
 +
kulemt.cfg, kulemt.cls, kulemtx.sty, logokul.eps and logokuleng.eps.
  
 
== User-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 in a central place for your user. When using TeXLive, as we
+
this package in a central location where LaTeX can find it autonomously. When
recommend, this involves a bit more work and use of a command-line.
+
using TeXLive, as we recommend, this involves a bit more work.
  
 
=== 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. This is
this will be in the folder "texmf" in your %USERPROFILE%
+
called the TEXMFHOME. By default, this will be in the folder "texmf" in your
(C:\Users\YourUsername). From the extracted kulemt-tds.zip, copy the entire
+
%USERPROFILE% (C:\Users\YourUsername). It is possible that this folder needs to
directory "tex" to this location (note: the directory itself, not its
+
%be created first. From the extracted kulemt-tds.zip, copy the entire directory
contents). It is possible that this folder needs to be created first.
+
%"tex" to this location (note: the directory itself, not only its contents).
  
In case this does not work, this folder might be different for you for some
+
If this does not work, or if you want to check first, please refer to the
reason. It is possible to retrieve the correct location through the Windows
+
"Finding the TEXMFHOME" section of this document.
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 ===
 
=== UNIX-like OSes ===
 
On UNIX-like OSes, such as Linux or macOS, the steps are similar to Windows.
 
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
 
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
+
packages for your user. By default, this is "~/texmf".
the following command:
+
 
kpsewhich -var-value=TEXMFHOME
+
If this does not work, or if you want to check first, please refer to the
An example output would be:
+
"Finding the TEXMFHOME" section of this document.
/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
 
For a more detailed overview, you can follow the general guidelines provided by
Line 81: Line 66:
 
   shortabstract={A short summary of the thesis},
 
   shortabstract={A short summary of the thesis},
 
}</nowiki>
 
}</nowiki>
 +
 +
== Finding the TEXMFHOME ==
 +
In case the default location for the TEXMFHOME as stated above does not work,
 +
you can find the correct directory through command-line. In Linux and macOS,
 +
look for an app called "Terminal". In Windows, search for "cmd" using the start
 +
menu. The program 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.

Revision as of 16:47, 26 October 2016

We often get the question at our LaTeX workshop 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. In this case, you can just put the necessary files in the same folder as your LaTeX project. The easiest way to accomplish this, is to unzip the downloaded file and in the unzipped folder, navigate to the directory "tex/latex/kulemt". Here, copy the following files to the same directory as your LaTeX project: kulemt.cfg, kulemt.cls, kulemtx.sty, logokul.eps and logokuleng.eps.

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 location where LaTeX can find it autonomously. When using TeXLive, as we recommend, this involves a bit more work.

Windows

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

If this does not work, or if you want to check first, please refer to the "Finding the TEXMFHOME" section of this document.

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".

If this does not work, or if you want to check first, please refer to the "Finding the TEXMFHOME" section of this document.

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},
}

Finding the TEXMFHOME

In case the default location for the TEXMFHOME as stated above does not work, you can find the correct directory through command-line. In Linux and macOS, look for an app called "Terminal". In Windows, search for "cmd" using the start menu. The program 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.