summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/typog/README.md
blob: fb55ccb1e1210017dcfe2ca848634f6d6faf1c6c (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
#  TypoG – Typographic Fine-Tuning for LaTeX

LaTeX package `typog` provides macros for (micro-)typographic enhancements;
it covers a variety of topics:

* Precise hyphenation control
* Disable/break ligatures
* Manual italic correction
* Extra kerning for slash and hyphen
* Raising selected characters (e.g. hyphen, en-dash, and em-dash)
* Aligning of the last line of a paragraph
* Filling of the last line last line of a paragraph
* Word spacing control
* [Microtype](https://github.com/schlcht/microtype) front-end
* Slightly sloppy paragraphs
* Vertically partially-tied paragraphs
* Breakable displayed equations
* Setspace front-end
* Smooth ragged-right paragraphs

Moreover `typog` provides an environment to flag interesting parts of
the information deluge typically accumulating in a LaTeX *log*-file
and an associated tool, **typog-grep**, that selectively retrieves
these parts.


##  Installation

The minimally necessary files to install typog are *typog.ins* and *typog.dtx*.  Running LaTeX
on *typog.ins* in particular produces *typog.sty*:

        latex typog.ins

After extraction from *typog.dtx* place *typog.sty* in a directory mentioned in your TEXINPUTS
paths or copy it into one of the directories for your LaTeX installation's *sty*-files and run
**mktexlsr** or equivalent.

To build the documentation it is easier to use the GNU *Makefile*:

        make

To construct the manual *typog.pdf* or the usage example *typog-example.pdf* a working
[MetaPost](https://tug.org/metapost.html) installation and some
[POD](https://perldoc.perl.org/perlpod) utilities of a [Perl](https://www.perl.org/)
distribution are required.  Cautious users can run

        make tool-check

ahead to verify that the required utilities are installed and working.
For an overview over the most important *Makefile* targets use

        make help


##  Usage

Load the package with the usual incantation

        \usepackage{typog}

See Section 2 of the package documentation for available options.


##  Documentation

The package documentation can be found
[online](https://cspiel.github.io/typog/).


##  Credits

Typog is written by Ch. L. Spiel <cspiel@users.sourceforge.org>.


##  License

Released under the
[LaTeX Project Public License v1.3c](https://www.latex-project.org/lppl.txt)
or later.