letter

A simple LaTeX letter template
git clone https://git.ckiri.com/cmk/letter.git
Log | Files | Refs | README | LICENSE

README.md (1560B)


      1 # A simple LaTeX letter template
      2 
      3 ## How To
      4 
      5 Create a `config.tex` inside the projects root directory, specifying your
      6 personal information:
      7 ```tex
      8 \def\authorname{Chris Kiriakou}
      9 \def\authorplace{Musterstadt}
     10 \def\authoraddress{Musterstraße 1, 10115 \authorplace}
     11 \def\authorphone{+49 151 98765432}
     12 \def\authoremail{c@kiri.com}
     13 \def\authorwebsite{https://www.ckiri.com}
     14 ```
     15 
     16 To build the PDF document, run:
     17 ```sh
     18 make doc=<content_name>
     19 ```
     20 
     21 NOTE: The document (`<content_name>`) specified needs to be available inside
     22 the `content` directory.
     23 
     24 If the `doc` cli parameter isn't specified, it defaults to `template` (a simple
     25 showcase document)
     26 
     27 ## Misc
     28 
     29 ### Flatten the document
     30 
     31 If *active* contents are prohibited (due to security concerns), flatten the PDF
     32 after building it:
     33 ```sh
     34 make doc=<document_name> flatten
     35 ```
     36 
     37 ### Options
     38 
     39 Options[1] and configuration of the document are set inside `main.tex`:
     40 
     41 | Option | Description |
     42 |--------|-------------|
     43 | `firstfoot=false` | Disable footer on first page |
     44 | `fromurl=false` | Hide senders url (e.g. website) from header |
     45 | `fromemail=false` | Hide senders email address from header |
     46 | `fromphone=false` | Hide senders phone number from header |
     47 | `fromrule=false` | Hide horizontal ruler dividing sender header from rest |
     48 | `\usepackage[ngerman]{babel}` | Use German locale; comment out to use your default locale |
     49 | `\LoadLetterOption{DIN}` | Use a DIN letter |
     50 
     51 ---
     52 
     53 [1]
     54 :: Kohm, M. (November 2025). _KOMA - Script_ <https://mirrors.ctan.org/macros/latex/contrib/koma-script/doc/scrguide-en.pdf>