Debian Codegraph @

texmf-dist/doc/lualatex/lua-typo/README.md

raw
1 Lua-typo
2 ========
3
4 Description
5 -----------
6 This package tracks common typographic flaws in LuaLaTeX documents,
7 specially widows, orphans, hyphenated words split over two pages,
8 consecutive lines ending with hyphens, paragraphs ending on
9 too short lines, etc.
10
11 Documentation
12 -------------
13
14 For the impatient: have a look at files demo.tex and demo.pdf to see
15 a short example of how some flaws are highlighted.
16
17 Then read the documentation in English (file lua-typo.pdf) or in French
18 (file lua-typo-fr.pdf).
19
20 License
21 -------
22
23 Released under the LaTeX Project Public License v1.3c or later
24 See http://www.latex-project.org/lppl.txt
25 for the details of that license.
26
27 Installation
28 ------------
29
30 This bundle is meant to be included in most TeX distributions,
31 but if you really need to install it by yourself
32 1. run "luatex lua-typo.dtx" to strip the comments and create
33 lua-typo.sty, lua-typo.cfg, lua-typo.ltx and lua-typo-fr.ltx;
34 2. run "lualatex lua-typo.ltx" to get the full documentation
35 (lua-typo.pdf) in English;
36 3. run "lualatex lua-typo-fr.ltx" to get the French documentation
37 (lua-typo-fr.pdf, without documented code).
38
39 Recommended locations for installation:
40 - TDS:tex/lualatex/lua-typo/lua-typo.sty
41 - TDS:tex/lualatex/lua-typo/lua-typo.cfg
42 - TDS:doc/lualatex/lua-typo/lua-typo.pdf
43 - TDS:doc/lualatex/lua-typo/demo.pdf
44 - TDS:doc/lualatex/lua-typo/demo.tex
45 - TDS:doc/lualatex/lua-typo/README.md
46 - TDS:source/lualatex/lua-typo/lua-typo.dtx
47
48 On Debian based systems, the "TDS:" prefix can be replaced by "$HOME/texmf/"
49 for a single user installation.
50
51 Changes
52 -------
53
54 * First release version: 0.30, March 2021.
55
56 * v.0.32: bug fixes
57 - better protection against nil nodes,
58 - new page detection corrected,
59 - homeoarchy detection improved.
60
61 * v.0.40 (not released): bug fixes
62 - in some cases parlines count was wrong, fixed;
63 - partial improvement of short pages detection.
64
65 * v.0.50: new implementation, May 2021
66 - callback change: `pre_shipout_filter` instead of `pre_output_filter`
67 this change requires latex release 2021-06-01;
68 - rollback enabled in case `pre_shipout_filter` is missing;
69 - footnotes are scanned now;
70 - overfull box detection fixed (works for equations and tt fonts now);
71 - short pages detection fixed;
72 - coloration of faulty lines improved;
73 - all flaws found are now recorded into file "`\jobname`.typo".
74
75 * v.0.51 (not released): bug fix
76 - in some cases orphans were not detected.
77
78 * v.0.60: new implementation, Feb. 2023
79 - this version should do a better job on two columns documents;
80 - debugging stuff added.
81
82 * v.0.61:
83 - bug fixes and documentation enhanced;
84 - colours `mygrey` and `myred` renamed as `LTgrey` and `LTred`.
85
86 * v.0.65:
87 - new option `ShortFinalWord` to detect short end-of-sentence word
88 on top of next page;
89 - code cleaning.
90
91 * v.0.70:
92 - options handled via `ltkeys` instead of `kvoptions`;
93 - Code cleaning, bug fixes.
94
95 * v.0.80:
96 - config file `lua-typo.cfg` changed (new colours added, all colour
97 numbers are shifted by 1);
98 - colours no longer override each other, a special colour has been
99 added for lines affected by multiple flaws (f.i. widow+overfull);
100 - bug fix (file `.typo`): in footnotes, line numbers for homeoarchy
101 were not reset.
102
103 * v.0.85:
104 - a warning is issued if some pages fail to be checked properly;
105 - margin notes checking added (over/underfull lines, position);
106 - code cleaning, bug fixes.
107
108 * v.0.86:
109 - corrected typo in the `signature` function;
110 - compatibility with package `stfloats` added.
111
112 * v.0.87:
113 - improved page body detection.
114 - warning about incompability with the `reledmac` package added.
115
116 * v.0.88:
117 - Overfull/Undefull lines inside vboxes (minpage, parbox) are now
118 checked, see https://tex.stackexchange.com/questions/757764/.
119
120 --
121 Copyright 2020--2026 Daniel Flipo
122 E-mail: daniel (dot) flipo (at) free (dot) fr