summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/lua-widow-control/lwc-documentation.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/lua-widow-control/lwc-documentation.tex')
-rw-r--r--macros/luatex/generic/lua-widow-control/lwc-documentation.tex37
1 files changed, 33 insertions, 4 deletions
diff --git a/macros/luatex/generic/lua-widow-control/lwc-documentation.tex b/macros/luatex/generic/lua-widow-control/lwc-documentation.tex
index 564f51618a..bbee53cee1 100644
--- a/macros/luatex/generic/lua-widow-control/lwc-documentation.tex
+++ b/macros/luatex/generic/lua-widow-control/lwc-documentation.tex
@@ -3,7 +3,7 @@
% lua-widow-control
% https://github.com/gucci-on-fleek/lua-widow-control
% SPDX-License-Identifier: MPL-2.0+ OR CC-BY-SA-4.0+
-% SPDX-FileCopyrightText: 2021 Max Chernoff
+% SPDX-FileCopyrightText: 2022 Max Chernoff
% Warning: Compiles slowly
@@ -37,12 +37,12 @@
\startdocument[
title=lua-widow-control,
author=Max Chernoff,
- version=1.1.5, %%version
+ version=1.1.6, %%version
github=https://github.com/gucci-on-fleek/lua-widow-control,
ctan=https://www.ctan.org/pkg/lua-widow-control,
]
-\Lwc/ is a Plain~\TeX/\LaTeX/\ConTeXt{} package that removes \waos/ without any user intervention. Using the power of \LuaTeX{}, it does so \emph{without} stretching any glue or shortening any pages or columns. Instead, \lwc/ automatically lengthens a paragraph on a page or column where a \woo/ would otherwise occur.
+\Lwc/ is a Plain~\TeX/\LaTeX/\ConTeXt{}/Op\TeX{} package that removes \waos/ without any user intervention. Using the power of \LuaTeX{}, it does so \emph{without} stretching any glue or shortening any pages or columns. Instead, \lwc/ automatically lengthens a paragraph on a page or column where a \woo/ would otherwise occur.
\section{Quick Start}
Ensure that your \TeX~Live/Mik\TeX{} distribution is up-to-date. Then, \LaTeX{} users just need to place \inlineTEX{\usepackage{lua-widow-control}} in the preamble of your document. For more details, see the \goto{Installation and Usage sections}[sec:install].
@@ -166,6 +166,9 @@ Run \type{tlmgr install lua-widow-control} in a terminal, or install using the \
\subsection{Mik\TeX}
Run \type{mpm --install=lua-widow-control} in a terminal, or install using the \q{Mik\TeX{} Maintenance} \acronym{GUI}.
+\subsection{\ConTeXt{} \acronym{MKIV} Standalone}
+Run \type{first-setup.sh --modules="lua-widow-control"} in a terminal or install manually.
+
\subsection{Manual}
Currently, \ConTeXt{} \acronym{MKXL} (\LuaMetaTeX{}) users must manually install the package. Most other users will be better served by using the \lwc/ supplied by \TeX~Live and Mik\TeX{}; however, all users may manually install the package if desired. The procedure should be fairly similar regardless of your \acronym{OS}, \TeX{} distribution, or format.
@@ -190,7 +193,10 @@ Currently, \ConTeXt{} \acronym{MKXL} (\LuaMetaTeX{}) users must manually install
\Lwc/ requires \LuaTeX{} ($\ge$ 0.85), \LaTeX{} ($\ge$ 2015/01/01), \sans{microtype} (any version), and \sans{etoolbox} (any version). Any version of \TeX~Live $\ge$ 2016 will meet these requirements.
\subsection{\ConTeXt{}}
-\Lwc/ requires \ConTeXt{} \acronym{MKXL} (\LuaMetaTeX{}).
+\Lwc/ supports both \ConTeXt{} \acronym{MKXL} (\LuaMetaTeX{}) and \ConTeXt{} \acronym{MKIV} (\LuaTeX{}).
+
+\subsection{Op\TeX{}}
+\Lwc/ works with any version of Op\TeX{} and has no dependencies.
\section{Loading the Package}
@@ -207,6 +213,10 @@ Currently, \ConTeXt{} \acronym{MKXL} (\LuaMetaTeX{}) users must manually install
\inlineTEX{\usemodule[lua-widow-control]}
+\subsection{Op\TeX{}}
+
+\inlineTEX{\load[lua-widow-control]}
+
\section{Columns}
Since \TeX{} implements column breaking and page breaking through the same internal mechanisms, \lwc/ should remove \waos/ between columns just as well as it does with \waos/ between pages. This has been tested with the standard \LaTeX{} class option \type{twocolumn} and the two-column output routine from Chapter~23 of \cite[title][texbook].\cite[texbook] \Lwc/ should presumably work with any other multi-column implementation; however, due to the diversity and complexity of output~routines, this cannot be guaranteed.
@@ -242,6 +252,14 @@ Since \TeX{} implements column breaking and page breaking through the same inter
\NC \NC \inlineTEX{\prependtoks\lwc@patch@post\to\everyafterfoo} \NC\NR
\stopTABLE
+\subsection{Op\TeX{}}
+\startTABLE
+\NC Enable (default) \NC \inlineTEX{\lwcenable} \NC\NR
+\NC Disable \NC \inlineTEX{\lwcdisable} \NC\NR
+\NC \estretch/ \NC \inlineTEX{\lwcemergencystretch=3em} \NC\NR
+\NC Selectively Disable \NC \emph{Not Implemented} \NC\NR
+\stopTABLE
+
\subsection{\estretch/}
You can configure the \estretch/ used when stretching a paragraph. The default value is 3~em.
@@ -256,6 +274,9 @@ You could just disable then reenable \lwc/ every time that you use the command;
\Lwc/ automatically patches the default \LaTeX{}, \ConTeXt{}, and Plain~\TeX{} section commands, so you shouldn't need to patch these yourself; however, \lwc/ does \bold{not} patch the non-standard section commands provided by \sans{memoir}, \sans{\acronym{KOMA}-script}, \sans{titlesec}, and others. You'll need to patch these yourself.
Under \ConTeXt{}, you need to use a different method to selectively disable \lwc/. Instead of using \tex{lwcdisablecmd}, you should use one of the preexisting \tex{everyfoo} hooks as shown in the table above since patching commands is rarely advisable in \ConTeXt{}
+
+No commands are provided for selectively disabling \lwc/ with Op\TeX{}. Users must implement this functionality themselves.
+
\section[sec:issues]{Known Issues}
\startitemize
\item \Lwc/ will not expand the first paragraph of a document.
@@ -336,6 +357,14 @@ Please note that a compiled document is \bold{not} considered to be an \q{Execut
\typeTEXfile{../source/t-lua-widow-control.mkxl}
+\subsection{t-lua-widow-control.mkiv}
+
+\typeTEXfile{../source/t-lua-widow-control.mkiv}
+
+\subsection{lua-widow-control.opm}
+
+\typeTEXfile{../source/lua-widow-control.opm}
+
\subsection{Demo from \in{Table}[tab:demo]}
\typeTEXfile{lwc-documentation-demo-text.tmp}