summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/scrlayer-fancyhdr/README.md
blob: 909e88aaabc55addd3e9be84c4dc70c585e9f153 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# `scrlayer-fancyhdr` — combining [`fancyhdr`](https://www.ctan.org/pkg/fancyhdr) with [KOMA-Script](https://www.ctan.org/pkg/koma-script)'s [`scrlayer`](https://www.ctan.org/pkg/scrlayer)

------------------------------------------------------------------------------

LaTeX package `scrlayer-fancyhdr`  
Copyright (c) 2008—2021 Markus Kohm  
Release: 2021-03-30 v0.2.1  
License: LPPL 1.3c (see LICENSE.md)  
CTAN Location: https://ctan.org/pkg/scrlayer-fancyhdr

------------------------------------------------------------------------------

## Summary

`scrlayer-fancyhdr` is a LaTeX package, that uses
[KOMA-Script](https://www.ctan.org/pkg/koma-script)'s
[`scrlayer`](https://www.ctan.org/pkg/scrlayer) to redefine the page styles of
package [`fancyhdr`](https://www.ctan.org/pkg/fancyhdr).  This allows the
combination of features of `fancyhdr` with features of `scrlayer`.

Before KOMA-Script v3.33 `scrlayer-fancyhdr` was part of KOMA-Script itself.
It still depends on KOMA-Script package
[`scrlayer`](https://www.ctan.org/pkg/scrlayer) at least version 3.33.  It
also depends on [`fancyhdr`](https://www.ctan.org/pkg/fancyhdr). Currently
version 3 and 4 up to 4.0.1 are supported and tested.

## Status

This is an early release of an experimental package.

## Installation

We recommend to use the package manager of your TeX distribution to install
packages. However, if you need to install `scrlayer-fancyhdr` manually, you
can either use a semi-manual installation or a completely manual installation.

### Semi-manual Installation

For a semi-manual installation you can first create a local clone
of the repository:

```bash
git clone https://github.com/komascript/scrlayer-fancyhdr.git
```

Then enter the directory created while cloning the repository:

```bash
cd scrlayer-fancyhdr
```

Last, but not least use `l3build` to install it locally with manual and
sources:

```bash
l3build install --full
```

or without manual and sources:

```bash
l3build install
```

### Completely Manual Installation

To do a completely manual installation, download `scrlayer-fancyhdr.dtx`.
Then extract it using:

```bash
tex scrlayer-fancyhdr.dtx
```

To create the manual use:

```bash
pdflatex scrlayer-fancyhdr.dtx
mkindex scrlayer-fancyhdr
biber scrlayer-fancyhdr
pdflatex scrlayer-fancyhdr.dtx
pdflatex scrlayer-fancyhdr.dtx
```

Now, you can either install it in the proper directory (see the
documentation of your TeX distribution) or copy `scrlayer-fancyhdr.sty`
to your document directory.

------------------------------------------------------------------------------