diff options
author | Karl Berry <karl@freefriends.org> | 2014-08-03 16:53:27 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-08-03 16:53:27 +0000 |
commit | 6493ff809c01bf214a27f16adf993ca101b7b8c3 (patch) | |
tree | c30ba8cdbee32f847f72dbd9538840aa92a81b06 /Master/texmf-dist/doc | |
parent | 685b5dc94ea5ebab0435f4f24c7a77183aac27b5 (diff) |
lua-check-hyphen
git-svn-id: svn://tug.org/texlive/trunk@34810 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md | 9 | ||||
-rw-r--r-- | Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.pdf | bin | 76927 -> 110703 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex | 73 | ||||
-rw-r--r-- | Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf | bin | 5316 -> 5327 bytes |
4 files changed, 73 insertions, 9 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 index 20d8244dc83..f6fe0bee1d8 100644 --- a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md +++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md @@ -20,7 +20,8 @@ A typical workflow is: * 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. +Copyright 2012–2014 Patrick Gundlach (patrick@gundla.ch)<br> +Package version: 0.3 +Public repository: https://github.com/pgundlach/lua-check-hyphen<br> +Licensed under the MIT license. See the file 'mit-license.txt' for exact terms.<br> +Status: works fine, slightly unmaintained.<br> 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 Binary files differindex aa837960627..97d054ffb7d 100644 --- a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.pdf +++ 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 index deab3895410..aafa334d210 100644 --- a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex +++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/luacheckhyphenmanual.tex @@ -1,6 +1,6 @@ \documentclass{ltxdockit} -\usepackage{dtklogos} -\newcommand\pkgversion{0.1} +\usepackage{dtklogos,csquotes} +\newcommand\pkgversion{0.3} \titlepage{% title={The lua-check-hyphen package}, @@ -37,7 +37,7 @@ This package only works with \LuaTeX. To activate it a \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. +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. With the package option \texttt{nofile}, you can tell the package not to write the external file. In any case the list is written to the log file. \section{Advanced usage} \label{sec:advanced_usage} @@ -69,7 +69,7 @@ Words in this whitelist won't be reported. \sty{lua-check-hyphen} assumes that t 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}} +\LuaCheckHyphen{whitelist={file1.txt,file2.txt,file3.txt}} \end{verbatim} \section{Visual marker} @@ -77,7 +77,7 @@ You can have more than one whitelist file by giving the filenames separated by c 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} +\usepackage[mark]{lua-check-hyphen} % or: \LuaCheckHyphen{mark} \end{verbatim} @@ -86,8 +86,71 @@ This marks all non-whitelisted used hyphenation points in the document with a bl \includegraphics{sample-crop} +\section{Options to \cmd{LuaCheckHyphen}} + +For the true/false options you don't need to write the \texttt{=true} part. All options except for the \texttt{whitelist} can be passed directly to the package: + +\begin{verbatim} +\usepackage[mark,nofile]{lua-check-hyphen} +\end{verbatim} + +\noindent All options can be set in \cmd{LuaCheckHyphen}. + +\begin{verbatim} +\LuaCheckHyphen{mark,nofile,whitelist=myfile.txt} +\end{verbatim} + + +\begin{optionlist} + \boolitem[false]{mark}{Create visual markers when an unknown hyphenation encountered.} + \boolitem[false]{nofile}{Don't write to an external file (\texttt{.uhy}).} + \boolitem[false]{file}{Don't do anything. This is for the last document run, no marks will be generated.} + \valitem{whitelist}{files}{List of files, separated by \enquote{\texttt{,}}. You need to wrap the filenames in braces \texttt{\textbraceleft...\textbraceright} so that the comma won't be seen as a option separator.} +\end{optionlist} + \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. +\section{Changes} +\begin{changelog} + \begin{release}{0.2}{2012-06-22} + \item Fix ligature counting error (github issue \#1) + \item Add nofile option + \item No hyphenation list in the terminal output (log only) + \item License details added + \end{release} +\end{changelog} + +\section{Bugs} + +\begin{itemize} + \item Paragraphs that end with \verb+\end{document}+ are ignored. Inserting an empty line or + \cmd{par} helps. +\end{itemize} + +\section{License} + +This file (documentation and the package) is released under the terms of the MIT License. See the file \texttt{mit-license.txt} in the distribution. + +% Copyright (c) 2012 Patrick Gundlach + +% Permission is hereby granted, free of charge, to any person obtaining a copy +% of this software and associated documentation files (the \enquote{Software}), to deal +% in the Software without restriction, including without limitation the rights +% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +% copies of the Software, and to permit persons to whom the Software is +% furnished to do so, subject to the following conditions: + +% The above copyright notice and this permission notice shall be included in all +% copies or substantial portions of the Software. + +% THE SOFTWARE IS PROVIDED \enquote{AS IS}, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +% SOFTWARE. + \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 Binary files differindex 406be84ddca..3c9409bf05a 100644 --- a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf +++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/sample.pdf |