new lualatex package lua-check-hyphen (20jun12)

git-svn-id: svn://tug.org/texlive/trunk@27227 c570f23f-e606-0410-a88d-b1316a301751

5 files changed, 129 insertions, 0 deletions

diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md
new file mode 100644
index 00000000000..20d8244dc83
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md
@@ -0,0 +1,26 @@
+# lua-check-hyphen
+
+## Usage
+
+    \usepackage{lua-check-hyphen}
+    ...
+    \LuaCheckHyphen{mark,whitelist={filea.txt,fileb.txt}}
+
+## What it does
+
+It lists all hyphenated words in the log file as well as in the file with the extension `.uhy`
+
+## How to use
+
+A typical workflow is:
+
+* run final document
+* put the correctly hyphenated words into a text file (format: each word separated with space or on a single line, only whitespace matters as a separator)
+* add that file to the whitelist (as given above)
+* optionally use the option `mark` to make the unknown hyphenated words visible in the PDF file
+
+
+Copyright 2012 Patrick Gundlach (patrick@gundla.ch)  
+Package version: 0.1
+Public repository: https://github.com/pgundlach/lua-check-hyphen  
+Licensed under the MIT license.
diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.pdf b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.pdf
new file mode 100644
index 00000000000..aa837960627
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.pdf
diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex
new file mode 100644
index 00000000000..deab3895410
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex
@@ -0,0 +1,93 @@
+\documentclass{ltxdockit}
+\usepackage{dtklogos}
+\newcommand\pkgversion{0.1}
+
+\titlepage{%
+  title={The lua-check-hyphen package},
+  subtitle={Checking your hyphenated words},
+  url={https://github.com/pgundlach/lua-check-hyphen},
+  author={Patrick Gundlach},
+  email={patrick@gundla.ch},
+  revision={\pkgversion},
+  date={\today}}
+
+\hypersetup{%
+  pdftitle={The lua-check-hyphen package},
+  pdfsubject={Checking your hyphenated words},
+  pdfauthor={Patrick Gundlach},
+  pdfkeywords={tex, latex, hyphenation}}
+
+
+
+
+\begin{document}
+\printtitlepage
+\tableofcontents
+
+\section{Introduction}
+
+\TeX\ is pretty good at hyphenating words. But a computer algorithm is not perfect, sometimes we wish to manually check all used hyphenations in a document. This package helps you on this task.
+
+\section{Usage}
+
+This package only works with \LuaTeX. To activate it a
+
+\begin{verbatim}
+	\usepackage{lua-check-hyphen}
+\end{verbatim}
+is enough.
+
+When you process your document with \LuaLaTeX, a file with the suffix \verb|.uhy| is created with that contains every hyphenated word. You can check that file for hyphenation errors.
+
+\section{Advanced usage}
+\label{sec:advanced_usage}
+
+With longer documents it becomes tedious checking for the same hyphenated words over and over. Therefore this package allows you to create a whitelist of \emph{accepted hyphenation}. This whitelist is a simple textfile where the words are separated by whitespace and the allowed hyphenation is marked with a dash (-). You can use the output file \texttt{.uhy} as an input for the whitelist file. You load the file in your document with
+
+\begin{verbatim}
+	\LuaCheckHyphen{whitelist=myfile.txt}
+\end{verbatim}
+
+and a sample file looks like this:
+
+\begin{verbatim}
+seren-ity
+morn-ings
+posses-sion
+\end{verbatim}
+
+or
+
+\begin{verbatim}
+seren-ity morn-ings posses-sion
+\end{verbatim}
+
+The format is not important, the entries must be separated by whitespace.
+
+Words in this whitelist won't be reported. \sty{lua-check-hyphen} assumes that these are valid break points.
+
+You can have more than one whitelist file by giving the filenames separated by comma:
+
+\begin{verbatim}
+	\LuaCheckHyphen{whitelist={file1.txt,file2.txt,file3.txt}}
+\end{verbatim}
+
+\section{Visual marker}
+
+You might want to use the PDF viewer to check for incorrectly hyphenated words. To enable visual feedback, just pass the \texttt{mark} option to the \cmd{usepackage} or to the \cmd{LuaCheckHyphen} command:
+
+\begin{verbatim}
+\usepackage{lua-check-hyphen}
+% or:
+\LuaCheckHyphen{mark}
+\end{verbatim}
+
+This marks all non-whitelisted used hyphenation points in the document with a black square (not to be confused with overfull boxes): 
+
+\includegraphics{sample-crop}
+
+\section{Final document}
+
+When you pass the Option \opt{final} to the \cmd{documentclass}, the \cmd{usepackage} or the \cmd{LuaCheckHyphen} command, all processing is disabled.
+
+\end{document}
\ No newline at end of file
diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf
new file mode 100644
index 00000000000..406be84ddca
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf
diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.tex b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.tex
new file mode 100644
index 00000000000..618fbf7f174
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.tex
@@ -0,0 +1,10 @@
+\documentclass{article}
+\usepackage{fontspec,nopageno}
+\usepackage[mark]{lua-check-hyphen}
+\begin{document}
+\parindent0.9em
+\hsize 1.3in
+A wonderful serenity has taken possession of my entire soul, like these sweet
+mornings of spring which I enjoy with my whole heart.
+
+\end{document}
\ No newline at end of file