Using the kulemt package: Difference between revisions

(Created page with "We often get the question at our LaTeX workshop on how to properly install the kulemt package on Windows. For this reason, we have decided to provide a proper guideline. You c...")
 
No edit summary
(26 intermediate revisions by 3 users not shown)
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 on Windows. For this reason, we have decided to provide a
kulemt package. For this reason, we have decided to provide a proper guideline.
proper guideline. You can acquire the kulemt package by downloading
You can acquire the kulemt package by downloading "kulemt-tds.zip" from
kulemt-tds.zip from ftp://ftp.esat.kuleuven.be/latex/kulemt/.
ftp://ftp.esat.kuleuven.be/latex/kulemt/.


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


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


Open the Windows command-line by searching for "cmd" in your start menu. The
First, you should find where to install the packages for your user. This is
app has a black, square logo.
called the TEXMFHOME. The default location of this folder is:
* For Windows: the folder "texmf" in your %USERPROFILE% (C:\Users\YourUsername for Windows Vista and up).
* For Linux: "~/texmf"
* For OS X/macOS: "~/Library/texmf"
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).


To find out the central location of installed packages, run the following
If this does not work, or if you want to check the directory first, please
command:
refer to the section [[#Finding the TEXMFHOME]] at the bottom of this document.
  kpsewhich -var-value=TEXMFHOME
 
An example output would be:
For a more technical overview, you can follow the general guidelines provided
  C:/Users/ULYSSIS/texmf
by the department: ftp://ftp.esat.kuleuven.be/latex/kulemt/README.html.
From the extracted kulemt-tds.zip, copy the entire directory tex to the
location given in the previous step. It is possible this folder needs to be
created first.


== Using the kulemt package ==
== Using the kulemt package ==
Line 51: Line 56:
  <nowiki>
  <nowiki>
\setup{
\setup{
   translatedtitle={My title in English (in case of a Dutch master)},
   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
   udc=621.3, % This is the udc number for the faculty of engineering science
   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.
== Troubleshooting ==
The kulemt package requires the memoir package. Make sure you have this package. We recommend installing the texlive-full package on Ubuntu. When you use the installer from [ftp://ftp.ulyssis.org/LaTeX-Workshop/installers/ our FTP server] for Windows or OS X/macOS, you will automatically have the entire LaTeX suite.

Revision as of 13:42, 8 October 2017

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.

First, you should find where to install the packages for your user. This is called the TEXMFHOME. The default location of this folder is:

  • For Windows: the folder "texmf" in your %USERPROFILE% (C:\Users\YourUsername for Windows Vista and up).
  • For Linux: "~/texmf"
  • For OS X/macOS: "~/Library/texmf"

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 the directory first, please refer to the section #Finding the TEXMFHOME at the bottom of this document.

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

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.

Troubleshooting

The kulemt package requires the memoir package. Make sure you have this package. We recommend installing the texlive-full package on Ubuntu. When you use the installer from our FTP server for Windows or OS X/macOS, you will automatically have the entire LaTeX suite.