This repository has been archived on 2024-04-22. You can view files and clone it, but cannot push or open issues or pull requests.
tuos-latex/tuos-letter/README.md

49 lines
1.6 KiB
Markdown
Raw Normal View History

2016-07-28 12:53:37 +00:00
# tuos-letter
2016-07-28 12:53:37 +00:00
A LaTeX class (based on the letter class of the
[KOMA-Script bundle](https://www.ctan.org/pkg/koma-script) that
approximates the
[letter layout](https://www.shef.ac.uk/polopoly_fs/1.167026!/file/Letter_layout.pdf)
of The University of Sheffield.
## Disclaimer
2016-07-28 12:53:37 +00:00
Please not that this LaTeX setup is neither endorsed nor officially
supported by the University of Sheffield.
## Prerequisites
2016-07-28 12:53:37 +00:00
* The `tuos-logo` style.
* The `tuos-fonts` style (optional).
## Installation
2016-07-28 12:53:37 +00:00
* Copy the `tuos-letter.cls` and `tuos.lco` into your `texmf` tree.
* Edit your personal contact and departmental information in the
`personal.lco` file.
* Run LaTeX on the `example.tex` to create a personalised example
letter.
## Usage
2016-07-28 12:53:37 +00:00
The `tuos-letter` class is a customised setup of the letter class of the
[KOMA-Script bundle](https://www.ctan.org/pkg/koma-script). Thus,
please see the KOMA-Script bundle documentation for its detailed
use. In addition, the class provides an option `plainfonts` that used
the standard LaTeX fonts instead of the cooperate fonts of The
University of Sheffield. There are mainly two reasons why you want to
use this option:
* The cooperate fonts do not provide mathematical symbols. Thus, if
you want to write mathematical content in your letter, the LaTeX
fonts might be the better choice (or add a suitable LaTeX package
providing mathematical symbols.
* You do not want to fiddle with your font installation.
## License
2016-08-01 18:53:39 +00:00
This project is dual-licensed under a 2-clause BSD-style license and/or
the LPPL version 1.3c or (at your opinion) any later version.
SPDX-License-Identifier: LPPL-1.3c+ OR BSD-2-Clause