summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/titlesec/README.md
blob: 4bdf80bc073302f4aa41d634503494c9a02d54f7 (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
## Titlesec, Titletoc, Titleps

This directory holds 3 packages for sectioning titles -- when used as
such (titlesec), in headers and footers (titleps) and in tables of
contents (titletoc).  They can be used separately, but you will get
most of them when used together.

### Titlesec

Sectioning titles, including margin and `wrap` titles, different
format in odd and even pages, rules above and below the title, 
adding new sectioning levels, measuring the width of the title, etc.

### Titletoc

TOC entries, with the possibility of changing the format in the middle
of a document, grouping the entries in a single paragraph, pretty
free-forms entries, partial tocs, etc. It's described in
`titlesec.pdf`.

### Titleps

Page styles with working top marks, access to top, first and bot marks
in a single header/footer, rules, headers/footers for specific floats
(kinda `\thispagestyle`), multiple sets of marks, etc.  An one-stage
mechanims is used, without intermediate `\leftmark`s or `\rightmark`s.

### Latest changes

```
2.14  2021-07-05
      A couple of minor changes (for issues #17, #39).

2.13  2019-10-16
      - \markboth (which has been redefined in the LaTeX kernel) works
        again.

2.12  2019-09-09
      - Fix - Partial TOCs were severely broken.
      - Fix - An undefined section doesn't raise an error any more.

2.11  2019-07-16
      - New license: MIT.
      - Option nostruts, to remove struts inserted by titlesec.
      - Reorganized code: only sty files, removed def and tss ones
        (although the mechanism for tss still works).
      - Fix - Wrong hyperlinks in table of contents with the starred
        versions, because of a change of behavior of hyperref (it
        patches the behaviour of an internal macro in hyperref).
      - Fix - Wrong spacing with titleps and displayed text after a
        section.
      - Fix - Newly defined floats raised an error with titletoc.
```

### Installation

No .ins/.dtx preinstalation is required.  Move the files to a place 
where LaTeX can find them and typeset titlesec.tex.  All of files in 
this directory are necessary for titlesec.sty to work, except the 
manual titlesec.tex (and this 'readme' file). The manual requires
titlesec.sty and titletoc.sty.

Further details are available on

   http://www.texnia.com/titlesec.html

### Contact

Please, for suggestions, bug reports, etc., go to

   https://github.com/jbezos/titlesec/issues