| 1 |
<!-- lua-widow-control |
| 2 |
https://github.com/gucci-on-fleek/lua-widow-control |
| 3 |
SPDX-License-Identifier: MPL-2.0+ OR CC-BY-SA-4.0+ |
| 4 |
SPDX-FileCopyrightText: 2022 Max Chernoff |
| 5 |
--> |
| 6 |
|
| 7 |
lua-widow-control |
| 8 |
================= |
| 9 |
|
| 10 |
Lua-widow-control is a Plain TeX/LaTeX/ConTeXt/OpTeX package that removes widows and orphans without any user intervention. Using the power of LuaTeX, it does so _without_ stretching any glue or shortening any pages or columns. Instead, lua-widow-control automatically lengthens a paragraph on a page or column where a widow or orphan would otherwise occur. |
| 11 |
|
| 12 |
Please see the [**package manual**](https://github.com/gucci-on-fleek/lua-widow-control/releases/latest/download/lua-widow-control.pdf) for usage details or the [***TUGboat***](https://github.com/gucci-on-fleek/lua-widow-control/releases/latest/download/tb133chernoff-widows.pdf) or [***Zpravodaj* articles**](https://github.com/gucci-on-fleek/lua-widow-control/releases/latest/download/lwc-zpravodaj.pdf) for background information and discussion. |
| 13 |
|
| 14 |
Usage |
| 15 |
----- |
| 16 |
### Installation |
| 17 |
Lua-widow-control is included in TeX Live and MikTeX. Provided that you have an up-to-date installation, you should not need to explicitly install the package. |
| 18 |
|
| 19 |
If you are using ConTeXt or want to manually install the package, you may download it from one of the below links: |
| 20 |
|
| 21 |
|Latest Release|Other Releases| |
| 22 |
|--------------|--------------| |
| 23 |
|[GitHub](https://github.com/gucci-on-fleek/lua-widow-control/releases/latest/)|[GitHub](https://github.com/gucci-on-fleek/lua-widow-control/releases)| |
| 24 |
|[CTAN](https://www.ctan.org/pkg/lua-widow-control)|| |
| 25 |
|[ConTeXt Garden](https://modules.contextgarden.net/cgi-bin/module.cgi/action=view/id=127)|| |
| 26 |
|
| 27 |
### Usage |
| 28 |
To load the package, add the relevant line to your preamble: |
| 29 |
|
| 30 |
|Macro Package|Code | |
| 31 |
|-------------|--------------------------------| |
| 32 |
|LaTeX |`\usepackage{lua-widow-control}`| |
| 33 |
|ConTeXt |`\usemodule[lua-widow-control]` | |
| 34 |
|Plain TeX |`\input lua-widow-control` | |
| 35 |
|OpTeX |`\load[lua-widow-control]` | |
| 36 |
|
| 37 |
|
| 38 |
Contributing |
| 39 |
------------ |
| 40 |
|
| 41 |
Please see [`CONTRIBUTING.md`](https://github.com/gucci-on-fleek/lua-widow-control/blob/master/CONTRIBUTING.md). |
| 42 |
|
| 43 |
Licence |
| 44 |
------- |
| 45 |
|
| 46 |
Lua-widow-control is licensed under the [_Mozilla Public License_, version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) or greater. The documentation is additionally licensed under [CC-BY-SA, version 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode) or greater. |
| 47 |
|
| 48 |
Please note that a compiled document is absolutely **not** considered to be an "Executable Form" as defined by the MPL. The use of lua-widow-control in a document does not place **any** obligations on the document's author or distributors. The MPL and CC-BY-SA licenses **only** apply to you if you distribute the lua-widow-control source code or documentation. |
| 49 |
|
| 50 |
--- |
| 51 |
_v3.0.1 (2024-03-11)_ <!--%%version %%dashdate--> |