summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/spelling
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-05-24 00:18:09 +0000
committerKarl Berry <karl@freefriends.org>2013-05-24 00:18:09 +0000
commitfed22753adeb474e7470dbe7c96326fd6bcfbc27 (patch)
tree51a481e1b11ee6aad48949a36db9df820a459bac /Master/texmf-dist/doc/luatex/spelling
parent9c422e89d41cc8126f2379412df4a7ab8cb30f0f (diff)
spelling (23may13)
git-svn-id: svn://tug.org/texlive/trunk@30665 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex/spelling')
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/CHANGES51
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/README19
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/spelling-doc-lst-lua.tex84
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/spelling-doc.bad4
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/spelling-doc.pdfbin106933 -> 127173 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/spelling/spelling-doc.tex465
6 files changed, 442 insertions, 181 deletions
diff --git a/Master/texmf-dist/doc/luatex/spelling/CHANGES b/Master/texmf-dist/doc/luatex/spelling/CHANGES
index 24dd549ca4b..383a64dcb0f 100644
--- a/Master/texmf-dist/doc/luatex/spelling/CHANGES
+++ b/Master/texmf-dist/doc/luatex/spelling/CHANGES
@@ -2,21 +2,56 @@ This material is subject to the LaTeX Project Public License. See
<http://www.latex-project.org/lppl/> for the details of that license.
+### v0.4 (2013-05-23)
+
+New features:
+
+* In addition to lists of bad and good spellings, words can be checked
+ against user-defined match rules to determine highlighting status.
+
+Changes:
+
+* Removed means to configure EOL character of text output file.
+ Standard Lua EOL character is always used, which is platform
+ dependent.
+
+* Improved compatibility with recent LuaTeX versions (v0.74 and newer).
+
+* File `<jobname>.spell.xml` is loaded before file `<jobname>.spell.bad`
+ (if both files exist).
+
+Fixes:
+
+* Bad words with surrounding punctuation haven't been highlighted.
+ Determining whether a word needs to be highlighted is now done by
+ checking against the lists of bad and good spellings words as they
+ appear in the document with possible punctuation as well as with all
+ surrounding punctuation stripped ([GitHub issue 8][ghi#8]).
+
+* Macro `\spellingoutputlinelength` was broken.
+
+* Raising an error when a file cannot be opened for reading causes
+ problems when compiling a document for the first time. Now, only a
+ warning is written to the console and log file in that case.
+
+[ghi#8]: https://github.com/sh2d/spelling/issues/8
+
+
### v0.3 (2013-02-12)
New:
- * [LanguageTool][lt] support: LanguageTool error reports in the XML
- format can be parsed for spelling errors (with the help of the
- [LuaXML][luaxml] package). LanguageTool is a cross-platform style
- and grammar checker.
+* [LanguageTool][lt] support: LanguageTool error reports in the XML
+ format can be parsed for spelling errors (with the help of the
+ [LuaXML][luaxml] package). LanguageTool is a cross-platform style and
+ grammar checker.
[lt]: http://www.languagetool.org/
[luaxml]: http://www.ctan.org/pkg/luaxml
Changes:
- * Default file names used by the package have been changed:
+* Default file names used by the package have been changed:
<jobname>.spb => <jobname>.spell.bad
<jobname>.spg => <jobname>.spell.good
@@ -27,10 +62,10 @@ Changes:
Fixes:
- * File `spelling.lua` could not be found by LaTeX style file
- ([GitHub issue 14][#14]).
+* File `spelling.lua` could not be found by LaTeX style file
+ ([GitHub issue 14][ghi#14]).
-[#14]: https://github.com/sh2d/spelling/issues/14
+[ghi#14]: https://github.com/sh2d/spelling/issues/14
### v0.1 (2012-11-30)
diff --git a/Master/texmf-dist/doc/luatex/spelling/README b/Master/texmf-dist/doc/luatex/spelling/README
index 6489095d30c..fa268331678 100644
--- a/Master/texmf-dist/doc/luatex/spelling/README
+++ b/Master/texmf-dist/doc/luatex/spelling/README
@@ -6,9 +6,9 @@ This material is subject to the LaTeX Project Public License. See
### Package information
Package name: spelling
-Summary description: Aid spell-checking LuaTeX documents.
-Version: v0.3
-Date: 2013-02-12
+Summary description: support for spell-checking of LuaTeX documents
+Version: v0.4
+Date: 2013-05-23
License: [LPPL v1.3c](http://www.latex-project.org/lppl/lppl-1-3c.html)
Maintenance status: maintained
Current maintainer: Stephan Hennig, <sh2d@arcor.de>
@@ -17,11 +17,11 @@ Current maintainer: Stephan Hennig, <sh2d@arcor.de>
### Description
-This package aids spell-checking of TeX documents compiled with the
+This package supports spell-checking of TeX documents compiled with the
LuaTeX engine. It can give visual feedback in PDF output similar to
WYSIWYG word processors. The package relies on an external
-spell-checker application to check spelling of a text file and to output
-a list of bad spellings. The package should work with most
+spell-checker application that can check a plain text file and output a
+list of bad spellings. The package should work with most
spell-checkers, even dumb, TeX-unaware ones.
@@ -36,8 +36,8 @@ generated via
luadoc -d API *.lua
Bugs and a wish list can be found in the
-[issue tracker](https://github.com/sh2d/spelling/issues/).
-Contributions of any kind are warmly welcome!
+[issue tracker](https://github.com/sh2d/spelling/issues/). Patches
+welcome!
_Happy TeXing!_
@@ -49,10 +49,11 @@ _Happy TeXing!_
CHANGES
LICENSE
README
- spelling.lua
spelling.sty
spelling-doc.bad
spelling-doc.tex
+ spelling-doc-lst-lua.tex
+ spelling-main.lua
spelling-recurse.lua
spelling-stage-1.lua
spelling-stage-2.lua
diff --git a/Master/texmf-dist/doc/luatex/spelling/spelling-doc-lst-lua.tex b/Master/texmf-dist/doc/luatex/spelling/spelling-doc-lst-lua.tex
new file mode 100644
index 00000000000..4fee01d300a
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/spelling/spelling-doc-lst-lua.tex
@@ -0,0 +1,84 @@
+%%% spelling-doc-lst-lua.tex
+%%% Copyright 2013 Stephan Hennig
+%%
+%% This work may be distributed and/or modified under the conditions of
+%% the LaTeX Project Public License, either version 1.3 of this license
+%% or (at your option) any later version. The latest version of this
+%% license is in http://www.latex-project.org/lppl.txt
+%% and version 1.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+\lstdefinelanguage[5.2]{Lua}{%
+ alsoletter={.},%
+ % language keywords
+ morekeywords=[1]{%
+ and,break,do,else,elseif,end,%
+ false,for,function,goto,if,in,%
+ local,nil,not,or,repeat,return,%
+ then,true,until,while,%
+ },%
+ % standard library identifiers
+ morekeywords=[2]{%
+ % basic library
+ assert,collectgarbage,dofile,error,_G,getmetatable,ipairs,%
+ load,loadfile,next,pairs,pcall,print,rawequal,rawget,rawlen,rawset,%
+ select,setmetatable,tonumber,tostring,type,_VERSION,xpcall,%
+ % coroutine library
+ coroutine.create,coroutine.resume,coroutine.running,%
+ coroutine.status,coroutine.wrap,coroutine.yield,%
+ % package library
+ require,package.config,package.cpath,package.loaded,%
+ package.loadlib,package.path,package.preload,package.searchers,%
+ package.searchpath,%
+ % string library
+ string.byte,string.char,string.dump,string.find,string.format,%
+ string.gmatch,string.gsub,string.len,string.lower,string.match,%
+ string.rep,string.reverse,string.sub,string.upper,%
+ % table library
+ table.concat,table.insert,table.pack,table.remove,table.sort,%
+ table.unpack,%
+ % mathematical library
+ math.abs,math.acos,math.asin,math.atan,math.atan2,math.ceil,%
+ math.cos,math.cosh,math.deg,math.exp,math.floor,math.fmod,%
+ math.frexp,math.huge,math.ldexp,math.log,math.max,math.min,%
+ math.modf,math.pi,math.pow,math.rad,math.random,math.randomseed,%
+ math.sin,math.sinh,math.sqrt,math.tan,math.tanh,%
+ % bit library
+ bit32.arshift,bit32.band,bit32.bnot,bit32.bor,bit32.btest,%
+ bit32.bxor,bit32.extract,bit32.replace,bit32.lrotate,bit32.lshift,%
+ bit32.rrotate,bit32.rshift,%
+ % io library
+ io.close,io.flush,io.input,io.lines,io.open,io.output,io.popen,%
+ io.read,io.stderr,io.stdin,io.stdout,io.tmpfile,io.type,io.write,%
+ % os library
+ os.clock,os.date,os.difftime,os.execute,os.exit,os.getenv,%
+ os.remove,os.rename,os.setlocale,os.time,os.tmpname,%
+ % debug library
+ debug.debug,debug.gethook,debug.getinfo,debug.getlocal,%
+ debug.getmetatable,debug.getregistry,debug.getupvalue,%
+ debug.getuservalue,debug.sethook,debug.setlocal,debug.setmetatable,%
+ debug.setupvalue,debug.setuservalue,debug.traceback,%
+ debug.upvalueid,debug.upvaluejoin,%
+ },%
+ % add environment
+ morekeywords=[2]{_ENV},%
+ %
+ sensitive=true,%
+ % single line comments
+ morecomment=[l]{--},%
+ % multi line comments
+ morecomment=[s]{--[[}{]]},%
+ morecomment=[s]{--[=[}{]=]},%
+ morecomment=[s]{--[==[}{]==]},%
+ morecomment=[s]{--[===[}{]===]},%
+ % backslash escaped strings
+ morestring=[b]",%
+ morestring=[b]',%
+ % multi line strings
+ morestring=[s]{[[}{]]},%
+ morestring=[s]{[=[}{]=]},%
+ morestring=[s]{[==[}{]==]},%
+ morestring=[s]{[===[}{]===]},%
+ % labels
+ moredelim=[s][keywordstyle3]{::}{::},%
+}[keywords,comments,strings]%
diff --git a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.bad b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.bad
index c5cc1638119..9e344863074 100644
--- a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.bad
+++ b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.bad
@@ -1,6 +1,4 @@
Ther
-fotenoot
-misspelllings
+mispellings
spellling
foo’s
-incorect
diff --git a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.pdf b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.pdf
index c1cacbf3c7f..442195e87a6 100644
--- a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.pdf
+++ b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.tex b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.tex
index 7a0c1bf3af6..88b9a74c5c7 100644
--- a/Master/texmf-dist/doc/luatex/spelling/spelling-doc.tex
+++ b/Master/texmf-dist/doc/luatex/spelling/spelling-doc.tex
@@ -1,4 +1,4 @@
-%%% spelling-doc.sty
+%%% spelling-doc.tex
%%% Copyright 2012, 2013 Stephan Hennig
%%
%% This work may be distributed and/or modified under the conditions of
@@ -14,7 +14,9 @@
\usepackage{fontspec}
\defaultfontfeatures{Ligatures=TeX}
\usepackage{multicol}
+\usepackage[rgb, x11names]{xcolor}
\usepackage{listings}
+\input{\jobname-lst-lua.tex}
\lstset{
basicstyle=\ttfamily,
columns=spaceflexible,
@@ -26,11 +28,18 @@
language={[LaTeX]TeX},
basicstyle=\ttfamily,
+\lstdefinestyle{Lua}{
+ language=[5.2]Lua,
+ keywordstyle=\bfseries\color{Blue4},
+ keywordstyle=[2]\bfseries\color{RoyalBlue3},
+ keywordstyle=[3]\bfseries\color{Purple3},
+ stringstyle=\bfseries\color{Coral4},
+ commentstyle=\itshape\color{Green4},
+}
\usepackage{xspace}
\usepackage{array}
\usepackage{booktabs}
\usepackage[latin, UKenglish]{babel}
-\usepackage[rgb, x11names]{xcolor}
\usepackage{hyperref}
\hypersetup{
pdftitle={spelling},
@@ -59,17 +68,17 @@ basicstyle=\ttfamily,
\newcommand*{\lpie}{\latinphrase{i.\,e.}\xspace}
\begin{document}
\author{Stephan Hennig\thanks{sh2d@arcor.de}}
-\title{\pkg\thanks{This document describes the \pkg\ package v0.3.}}
+\title{\pkg\thanks{This document describes the \pkg\ package v0.4.}}
\maketitle
\begin{abstract}
- This package aids spell-checking of \TeX\ documents compiled with the
- Lua\TeX\ engine. It can give visual feedback in \acr{pdf} output
+ This package supports spell-checking of \TeX\ documents compiled with
+ the Lua\TeX\ engine. It can give visual feedback in \acr{pdf} output
similar to \acr{wysiwyg} word processors. The package relies on an
- external spell-checker application to check spelling of a text file
- and to output a list of bad spellings. The package should work with
- most spell-checkers, even dumb, \TeX-unaware ones.
+ external spell-checker application that can check a plain text file
+ and output a list of bad spellings. The package should work with most
+ spell-checkers, even dumb, \TeX-unaware ones.
\emph{Warning! This package is in a very early state. Everything may
change!}
@@ -89,9 +98,7 @@ basicstyle=\ttfamily,
\label{sec:intro}
Ther%
-\footnote{A fotenoot containing misspelllings. But note how
- `misspelllings' currently slips through due to punctuation. Some
- annoying bugs are listed in \autoref{sec:bugs}.}
+\footnote{A footnote containing mispellings.}
%
are three main approaches to spell-checking \TeX\ documents:
@@ -113,9 +120,9 @@ package follows the third approach, providing some unique features:
\item In traditional solutions, text is extracted from typeset
\acr{dvi}, \acr{ps} or \acr{pdf} files, including hyphenated words.
- Therefore, to avoid lots of false positives being reported by the
- spell-checker, hyphenation has to be switched off during the \TeX\
- run. So, one doesn't work on the original document any more.
+ To avoid (lots of) false positives being reported by the
+ spell-checker, hyphenation needs to be switched off during the \TeX\
+ run. That is, one doesn't work on the original document any more.
In contrast to that, the \pkg\ package works transparently on the
original |.tex| source file. Text is extracted \emph{during}
@@ -140,94 +147,254 @@ described below, is effectively a wrapper around the Lua interface.
\emph{Implementing such wrappers for other formats shouldn't be too
difficult. The author is a \LaTeX-only user, though, and therefore
grateful for contributions. By the way, the \LaTeX\ package needs
- some polishing, too, \lpeg, a key-value interface is desirable.}
+ some polishing, too, \lpeg, a key-value interface is desirable.
+ Patches welcome!}
\subsection{Work-flow}
\label{sec:work-flow}
-The work-flow of the \pkg\ package is as follows:
+Here's a short outline of how using the \pkg\ package fits into the
+general process of compiling a document with Lua\TeX:
\begin{enumerate}
-\item After the package is loaded in the preamble of a |.tex| source
- file via °\usepackage{spelling}°, a list of bad spellings is read from
- a file named \descr{jobname}|.spell.bad|, if that file exists.
+\item After loading the package in the preamble of a |.tex| source file,
+ a list of bad spellings is read from a file (if that file exists).
\item During the Lua\TeX\ run, text is extracted from pages and all
words are checked against the list of bad spellings. Words with a
known incorrect spelling are highlighted in \acr{pdf} output.
\item At the end of the Lua\TeX\ run, in addition to the \acr{pdf} file,
- a text file is written, named \descr{jobname}|.spell.txt|, by default.
- The text file should contain most of the text of the original
+ a text file is written, containing most of the text of the typeset
document.
-\item The text file is then checked by your favourite spell-checker
- application, \lpeg, Aspell or Hunspell. The spell-checker should be
- able to write a list of bad spellings to a file. Otherwise, visual
- feedback in \acr{pdf} output won't work. Preferably, the file is
- named \descr{jobname}|.spell.bad|, but any other file name works just
- as well.
-
-\item Now, there are two ways to proceed:
-
- \begin{enumerate}
+\item The text file is then checked by your favourite external
+ spell-checker application, \lpeg, Aspell or Hunspell. The
+ spell-checker should be able to write a list of bad spellings to a
+ file. Otherwise, visual feedback in \acr{pdf} output won't work.
- \item Visually minded people may just compile their document a second
- time. This time, file \descr{jobname}|.spell.bad| is read-in again
- and the words with incorrect spelling found by the spell-checker
- should now be highlighted in \acr{pdf} output. Checking the
- \acr{pdf} file, the necessary corrections to the |.tex| source file
- can be applied.
-
- \item If you're not interested in visual feedback or if your
- spell-checker doesn't provide a non-interactive mode, you can as
- well apply the necessary corrections directly to the |.tex| source
- file(s), either interactively, during the spell-checker run, or by
- looking at the final list of bad spellings in an editor (whatever
- file it was saved to). That way, the benefit of this package is,
- that spell-checker input has already been processed by Lua\TeX, but
- contains no hyphenated words.
-
- \end{enumerate}
+\item Visually minded people may now compile their document a second
+ time. This time, the new list of bad spellings is read-in and words
+ with incorrect spelling found by the spell-checker should now be
+ highlighted in \acr{pdf} output. Users can then apply the necessary
+ corrections to the |.tex| source file.
\end{enumerate}
+Whatever way spell-checker output is employed, users not interested in
+visual feedback (because their spell-checker has an interactive mode
+only or because they prefer grabbing bad spellings from a file directly)
+can also benefit from this package. Using it, Lua\TeX\ writes a pure
+text file that is particularly well suited as spell-checker input,
+because it contains no hyphenated words (and neither macros, nor active
+characters). That way, any spell-checker application, even \TeX-unaware
+ones, can be used to check spelling of \TeX\ documents.
+
\subsection{Word lists}
\label{sec:wordlists}
-As described above, if a file \descr{jobname}|.spell.bad| exists, it is
-loaded by the \pkg\ package. The words found in the file are stored in
-an internal list of bad spellings and are later used for highlighting
-spelling mistakes in \acr{pdf} output.
-
-Additionally, a second file \descr{jobname}|.spell.good| is read, if
-that file exists. The words found in that file are stored in an
-internal list of good spellings. Words in the list of good spellings
-are never highlighted in \acr{pdf} output. That is, words in the
-Lua\TeX\ document are only considered spelling mistakes if they occur in
-the list of bad spellings, but not in the list of good spellings. The
-list of good spellings can be used to deal with false positives (words
-incorrectly reported as bad spellings by the spell-checker).
-
-Words from additional files can be appended to the internal lists of bad
-and good spellings with the \macro{spellingreadbad} and
-\macro{spellingreadgood} commands. Argument to both macros is a file
-name. File format is one word per line. Letter case is significant.
-The file must be in the \acr{utf-8} encoding. As an example, the
-command
+As described above, after loading the \pkg\ package, a list of bad
+spellings is read from a file \descr{jobname}.|spell.bad|, if that file
+exists. Words found in this file are stored in an internal list of bad
+spellings and are later used for highlighting spelling mistakes in
+\acr{pdf} output. Additionally, a list of good spellings is read from a
+file \descr{jobname}|.spell.good|, if that file exists. Words found in
+the latter file are stored in an internal list of good spellings. File
+format for both files is one word per line. Files must be in the
+\acr{utf-8} encoding. Letter case is significant.
+
+A word in the document is highlighted, if it occurs in the internal list
+of bad spellings, but not in the internal list of good spellings. That
+is, known good spellings take precedence over known bad spellings.
+
+Users can load additional files containing lists of bad or good
+spellings with macros \macro{spellingreadbad} and
+\macro{spellingreadgood}. Argument to both macros is a file name. If a
+file cannot be found, a warning is written to the console and |log| file
+and compilation continues. As an example, the command
\begin{lstlisting}[language={[LaTeX]TeX}]
\spellingreadgood{myproject.whitelist}
\end{lstlisting}
%
reads words from a file |myproject.whitelist| and adds them to the list
-of good spellings. Note, most spell-checkers provide means to deal with
-unknown words via additional dictionaries. It is recommended to
-configure your spell-checker to report as few false positives as
-possible.
+of good spellings.
+
+Known good spellings can be used to deal with words wrongly reported as
+bad spellings by the spell-checker (false positives). But note, most
+spell-checkers also provide means to deal with unknown words via
+additional dictionaries. It is recommended to configure your
+spell-checker to report as few false positives as possible.
+
+
+\subsection{Match rules}
+\label{sec:matchrules}
+
+\emph{This section describes an advanced feature. You may safely skip
+ this section upon first reading.}
+
+The \pkg\ package provides an additional way to deal with bad and good
+spellings, match rules. Match rules can be used to employ regular
+patterns within certain ‘words’. A typical example are bibliographic
+references like \emph{Lin86}, which are often flagged by spell-checkers,
+but need not be highlighted as they are generated by \TeX.
+
+There are two kinds of rules, bad and good rules. A rule is a Lua
+function whose boolean return value indicates whether a word
+\emph{matches} the rule. A bad rule should return a true value for all
+strings identified as bad spellings, otherwise a false value. A good
+rule should return a true value for all strings identified as good
+spellings, otherwise a false value. A word in the document is
+highlighted if it matches any bad rule, but no good rule.
+
+Function arguments are a \emph{raw} string and a \emph{stripped} string.
+The raw string is a string representing a word as it is found in the
+document possibly surrounded by punctuation characters. The stripped
+string is the same string with surrounding punctuation already stripped.
+
+As an example, the rule in \autoref{lst:mr-three-letter-words} matches
+all words consisting of exactly three letters. The function matches the
+stripped string against the Lua string pattern |^%a%a%a$| via function
+|unicode.utf8.find| from the Selene Unicode library. The latter
+function is a \acr{utf-8} capable version of Lua's built-in function
+|string.find|. It returns |nil| (a false value) if there has been no
+match and a number (a true value) if there has been a match. The string
+|%a| represents a string class matching a single letter. Characters |^|
+and |$| are anchors for the beginning and the end of the string in
+question. Note, the pattern |%a%a%a| without anchors would match
+any string which contains \emph{at least} three letters in a row. More
+information about Lua string patterns can be found in the Lua reference
+manual%
+\footnote{\url{http://www.lua.org/manual/5.2/manual.html\#6.4}}%
+%
+, the Selene Unicode library documentation%
+\footnote{\url{https://github.com/LuaDist/slnunicode/blob/master/unitest}}
+%
+and in the Unicode standard%
+\footnote{\url{http://www.unicode.org/Public/4.0-Update1/UCD-4.0.1.html\#General_Category_Values}}%
+.
+
+\suppressfloats[b]
+
+\begin{lstlisting}[style=Lua, float, label=lst:mr-three-letter-words, caption={Matching three-letter words.}]
+function three_letter_words(raw, stripped)
+ return unicode.utf8.find(stripped, '^%a%a%a$')
+end
+\end{lstlisting}
+
+\autoref{lst:mr-double-punctuation} shows a rule matching all ‘words’
+containing double punctuation.
+
+\begin{lstlisting}[style=Lua, float, label=lst:mr-double-punctuation, caption={Matching double punctuation.}]
+function double_punctuation(raw, stripped)
+ return unicode.utf8.find(raw, '%p%p')
+end
+\end{lstlisting}
+
+The rule in \autoref{lst:mr-bibtex-alpha} combines the results of three
+string searches to match bibliographic references as generated by the
+Bib\TeX\ \emph{alpha} style.
+
+\begin{lstlisting}[style=Lua, float, label=lst:mr-bibtex-alpha, caption={Matching references generated by the Bib\TeX\ alpha style.}]
+function bibtex_alpha(raw, stripped)
+ return unicode.utf8.find(stripped, '^%u%l%l%d%d$')
+ or unicode.utf8.find(stripped, '^%u%u%u?%u?%d%d$')
+ or unicode.utf8.find(stripped, '^%u%u%u%+%d%d$')
+end
+\end{lstlisting}
+
+Match rules have to be provided by means of a Lua module. Such modules
+can be loaded with the \macro{spellingmatchrules} command. Argument is
+a module name. To tell bad rules from good rules, the table returned by
+the module must follow this convention: Function identifiers
+representing bad and good match rules are prefixed |bad_rule_| and
+|good_rule_|, resp. The rest of an identifier is actually irrelevant.
+Other and non-function identifiers are ignored.
+
+\autoref{lst:mr-module} shows an example module declaring the rules from
+\autoref{lst:mr-three-letter-words} and
+\autoref{lst:mr-double-punctuation} as \emph{bad} match rules and the
+rule from \autoref{lst:mr-bibtex-alpha} as a \emph{good} match rule.
+Note, how function identifiers are made local and how exported function
+identifiers are prefixed |bad_rule_| and |good_rule_|, while local
+function identifiers have no prefixes. When the module resides in a
+file named |myproject.rules.lua|, it can be loaded in the preamble of a
+document via
+\begin{lstlisting}[language={[LaTeX]TeX}]
+\spellingmatchrules{myproject.rules}
+\end{lstlisting}
+
+\begin{lstlisting}[style=Lua, float=p, label=lst:mr-module, caption={A module containing two bad and one good match rule.}]
+-- Module table.
+local M = {}
+
+-- Import Selene Unicode library.
+local unicode = require('unicode')
+-- Add short-cut.
+local Ufind = unicode.utf8.find
+
+local function three_letter_words(raw, stripped)
+ return Ufind(stripped, '^%a%a%a$')
+end
+M.bad_rule_three_letter_words = three_letter_words
+
+local function double_punctuation(raw, stripped)
+ return Ufind(raw, '%p%p')
+end
+M.bad_rule_double_punctuation = double_punctuation
+
+local function bibtex_alpha(raw, stripped)
+ return Ufind(stripped, '^%u%l%l%d%d$')
+ or Ufind(stripped, '^%u%u%u?%u?%d%d$')
+ or Ufind(stripped, '^%u%u%u%+%d%d$')
+end
+M.good_rule_bibtex_alpha = bibtex_alpha
+
+return M
+\end{lstlisting}
+
+How are match rules and lists of bad and good spellings related?
+Internally, the lists of bad and good spellings are referred to by two
+special default match rules, that look-up raw and stripped strings and
+return a true value if either argument has been found in the
+corresponding list. Since good rules take precedence over bad rules, an
+entry in the list of good spellings takes precedence over any
+user-supplied bad rule. Likewise, any user-supplied good rule takes
+precedence over an entry in the list of bad spellings.
+
+Some final remarks on match rules:
+
+\begin{itemize}
+
+\item It must be stressed that the boolean return value of a match rule
+ \emph{does not} indicate whether a spelling is bad or good, but
+ whether a word matches a certain rule or not. Whether it's a bad or a
+ good spelling, depends on the name of the match rule in the module
+ table.
+
+\item When written without care, match rules can easily produce false
+ positives as well as false negatives. While false positives in bad
+ rules and false negatives in good rules can easily be spotted due to
+ the unexpected highlighting of words, the other cases are more
+ problematic. To avoid all kinds of false results, match rules should
+ be stated as specific as possible.
+
+\item Match rules are only called upon the first occurrence of a
+ spelling in a document. The information, whether a spelling needs to
+ be highlighted, is stored in a cache table. Subsequent occurrences of
+ a spelling just need a table look-up to determine highlighting status.
+ For that reason, it is safe to do relatively expensive operations
+ within a match rule without affecting compilation time too much.
+ Nevertheless, match rules should be stated as efficient as possible.%
+ \footnote{Some Lua performance tips can be found in the book \emph{Lua
+ Programming Gems} by Figueiredo, Celes and Ierusalimschy
+ \emph{(eds.)}, 2008, ch.~2. That chapter is also available online
+ at \url{http://www.lua.org/gems/}.}
+
+\end{itemize}
\subsection{Highlighting spellling mistakes}
@@ -245,9 +412,7 @@ colour statement in the \acr{pdf} language. As an example, the colour
red in the \acr{rgb} colour space is represented by the statement %
|1 0 0 rg|. In the \acr{cmyk} colour space, a reddish colour is
represented by |0 1 1 0 k|. Default colour used for highlighting is %
-|1 0 0 rg|, \lpie, red in the \acr{rgb} colour space. \emph{Warning:
- There's currently no error checking. Make sure, you're applying a
- valid PDF colour statement!}
+|1 0 0 rg|, \lpie, red in the \acr{rgb} colour space.
\subsection{Text output}
@@ -301,40 +466,11 @@ file name. Default text output file name is
\paragraph{Line length} In text output, paragraphs can either be put on
a single line or broken into lines of a fixed length. The behaviour can
be controlled via command \macro{spellingoutputlinelength}. Argument is
-a number. If the number is~0 or less, paragraphs are put on a single
-line. For larger arguments, the number specifies the maximum line
-length. Note, lines are broken at spaces only. Words longer than
-maximum line length are put on a single line exceeding maximum line
-length. Default line length is~72.
-
-\paragraph{Line ending convention} The end-of-line (\acr{eol}) character
-in text output can be configured via command \macro{spellingoutputeol}.
-Argument is an arbitrary sequence of characters in the \acr{utf-8}
-encoding.
-
-Well, things are a bit more complicated, because in Lua\TeX, as in the
-original \TeX, some characters are treated special. To keep Lua\TeX\
-from messing with our \acr{eol} characters in the input, we need to set
-their category codes accordingly. As an example, to set \acr{eol}
-character to follow \acr{dos} line ending convention (carriage return
-followed by line feed, \TeX\ notation |^^M^^J|), the following code can
-be used:
-
-\begin{lstlisting}[language={[LaTeX]TeX}]
-\begingroup
-\catcode`\^^J=12% make line feed and carriage return
-\catcode`\^^M=12% of category Other
-\spellingoutputeol{^^M^^J}
-\endgroup
-\end{lstlisting}
-%
-For the \acr{unix} line ending convention (a single line feed), just
-leave out |^^M| in the argument to |\spellingoutputeol|.
-
-Default line ending convention depends on the operating system
-determined by Lua\TeX. If |os.type| is either |windows| or |msdos|,
-\acr{dos} line ending convention is used. Otherwise \acr{unix} line
-ending convention is used.
+a number. If the number is less than~1, paragraphs are put on a single
+line. For larger arguments, the number specifies maximum line length.
+Note, lines are broken at spaces only. Words longer than maximum line
+length are put on a single line exceeding maximum line length. Default
+line length is~72.
\subsection{Text extraction}
@@ -370,32 +506,45 @@ characters corresponding to their constituting letters. The default
mappings applied can be found in \autoref{tab:cp-mapping}.
\begin{table}
- \centering
-
- \begin{tabular}{>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}
- \normalfont Unicode name & \normalfont code point & \normalfont target characters\\
+ \begin{minipage}{1.0\linewidth}
+ \centering
+
+ \newcommand*{\coltitle}[2]{%
+ \normalfont%
+ \vbox{
+ \hbox{\strut#1}
+ \hbox{\strut#2}
+ }%
+ }
+
+ \begin{tabular}{>{\ttfamily}l>{\fontspec{Linux Libertine
+ O}}l>{\ttfamily}l>{\ttfamily}l}
+ \normalfont Unicode name & \coltitle{sample}{glyph\footnote{Sample
+ glyphs are taken from font \emph{Linux Libertine~O}.}} &
+ \coltitle{code}{point} & \coltitle{target}{characters}\\
\addlinespace
\toprule
\addlinespace
- LATIN CAPITAL LIGATURE IJ & 0x0132 & IJ\\
- LATIN SMALL LIGATURE IJ & 0x0133 & ij\\
- LATIN CAPITAL LIGATURE OE & 0x0152 & OE\\
- LATIN SMALL LIGATURE OE & 0x0153 & oe\\
- LATIN SMALL LETTER LONG S & 0x017f & s\\
- LATIN CAPITAL LETTER SHARP S & 0x1e9e & SS\\
- LATIN SMALL LIGATURE FF & 0xfb00 & ff\\
- LATIN SMALL LIGATURE FI & 0xfb01 & fi\\
- LATIN SMALL LIGATURE FL & 0xfb02 & fl\\
- LATIN SMALL LIGATURE FFI & 0xfb03 & ffi\\
- LATIN SMALL LIGATURE FFL & 0xfb04 & ffl\\
- LATIN SMALL LIGATURE LONG S T & 0xfb05 & st\\
- LATIN SMALL LIGATURE ST & 0xfb06 & st\\
+ LATIN CAPITAL LIGATURE IJ & ^^^^0132 & 0x0132 & IJ \\
+ LATIN SMALL LIGATURE IJ & ^^^^0133 & 0x0133 & ij \\
+ LATIN CAPITAL LIGATURE OE & ^^^^0152 & 0x0152 & OE \\
+ LATIN SMALL LIGATURE OE & ^^^^0153 & 0x0153 & oe \\
+ LATIN SMALL LETTER LONG S & ^^^^017f & 0x017f & s \\
+ \addlinespace
+ LATIN SMALL LIGATURE FF & ^^^^fb00 & 0xfb00 & ff \\
+ LATIN SMALL LIGATURE FI & ^^^^fb01 & 0xfb01 & fi \\
+ LATIN SMALL LIGATURE FL & ^^^^fb02 & 0xfb02 & fl \\
+ LATIN SMALL LIGATURE FFI & ^^^^fb03 & 0xfb03 & ffi \\
+ LATIN SMALL LIGATURE FFL & ^^^^fb04 & 0xfb04 & ffl \\
+ LATIN SMALL LIGATURE LONG S T & ^^^^fb05 & 0xfb05 & st \\
+ LATIN SMALL LIGATURE ST & ^^^^fb06 & 0xfb06 & st \\
\end{tabular}
\caption{Default code point mappings.}
\label{tab:cp-mapping}
+ \end{minipage}
\end{table}
Additional mappings can be declared by command \macro{spellingmapping}.
@@ -444,33 +593,33 @@ Installing spell-checkers and dictionaries can be a difficult task if
there are no pre-built packages available for an architecture. That's
one reason the \pkg\ package is rather spell-checker agnostic and the
manual doesn't recommend a particular spell-checker application.
-Another reason is, there's no best spell-checker. The only
+Another reason is, there is no best spell-checker. The only
recommendation the author makes is not to trust in one spell-checker,
but to use multiple spell-checkers at the same time, with different
dictionaries or, better yet, different checking engines under the hood.
-Among the set of options available, LanguageTool, a style and grammar
-checker%
-\footnote{\url{http://www.languagetool.org/}}
+Among the set of options available, LanguageTool%
+\footnote{\url{http://www.languagetool.org/}}%
%
-that can also check spelling since version~1.8, deserves some notice for
-its portability, ease of installation and active development. For these
-reasons, the \pkg\ package provides explicit LanguageTool support.
-LanguageTool uses Hunspell as the spell-checking engine, augmenting
-results with a rule based engine and a morphological analyser (depending
-on the language). The \pkg\ package can parse LanguageTool's error
-reports in the \acr{xml} format, pick those errors that are spelling
-related and use them to highlight bad spellings.%
-\footnote{Support for style and grammar errors found by LanguageTool
+, a style and grammar checker that can also check spelling since
+version~1.8, deserves some notice for its portability, ease of
+installation and active development. For these reasons, the \pkg\
+package provides explicit LanguageTool support. LanguageTool uses
+Hunspell as the spell-checking engine, augmenting results with a rule
+based engine and a morphological analyser (depending on the language).
+The \pkg\ package can parse LanguageTool's error reports in the
+\acr{xml} format, pick those errors that are spelling related and use
+them to highlight bad spellings.%
+\footnote{Highlighting style and grammar errors found by LanguageTool
should be possible, but requires major restructuring of the \pkg\
- package that won't happen any time soon.}
+ package.}
\subsection{Installation}
\label{sec:lt-installation}
Here are some brief installation instructions for the stand-alone
-version of LanguageTool (tested with LanguageTool~2.0). The stand-alone
+version of LanguageTool (tested with LanguageTool~2.1). The stand-alone
version contains a \acr{gui} as well as a command-line interface. For
the \pkg\ package, the latter is needed.
@@ -494,10 +643,10 @@ java -version
\item Uncompress the downloaded archive to a location of your choice.
\item Open a command-line in the directory containing file
- |LanguageTool.jar| and type
+ |languagetool-commandline.jar| and type
\begin{lstlisting}[escapeinside=°°]
-°\descr{path to}°/java -jar LanguageTool.jar --help
+°\descr{path to}°/java -jar languagetool-commandline.jar --help
\end{lstlisting}
%
Prepending the path to the Java executable is optional, depending on
@@ -509,17 +658,17 @@ java -version
\begin{itemize}
- \item For users of Unixoid systems, the script might look like
+ \item For users of unixoide systems, the script might look like
\begin{lstlisting}[escapeinside=°°]
#!/bin/sh
-°\descr{path to}°/java -jar °\descr{path to}°/LanguageTool.jar $*
+°\descr{path to}°/java -jar °\descr{path to}°/languagetool-commandline.jar $*
\end{lstlisting}
%
where \texttt{\descr{path to}} should point to the Java executable
- (optional) and file |LanguageTool.jar| (mandatory). If the script
- is named |lt.sh|, you should be able to run LanguageTool on the
- command shell by typing, \lpeg,
+ (optional) and file |languagetool-commandline.jar| (mandatory). If
+ the script is named |lt.sh|, you should be able to run LanguageTool
+ on the command shell by typing, \lpeg,
\begin{lstlisting}
sh lt.sh --version
@@ -533,13 +682,13 @@ sh lt.sh --version
\begin{lstlisting}[escapeinside=°°]
@echo off
-°\descr{path to}°\java -jar °\descr{path to}°\LanguageTool.jar %*
+°\descr{path to}°\java -jar °\descr{path to}°\languagetool-commandline.jar %*
\end{lstlisting}
%
where \texttt{\descr{path to}} should point to the Java executable
- (optional) and file |LanguageTool.jar| (mandatory). If the script
- is named |lt.bat|, you should be able to run LanguageTool on the
- command-line by typing, \lpeg,
+ (optional) and file |languagetool-commandline.jar| (mandatory). If
+ the script is named |lt.bat|, you should be able to run LanguageTool
+ on the command-line by typing, \lpeg,
\begin{lstlisting}
lt --version
@@ -615,9 +764,9 @@ bad spellings and to use LanguageTool as a spell-checker, the following
commands should be typed on the command-line:
\begin{lstlisting}
-lualatex myproject
+lualatex myletter
lt --api -c utf-8 -l fr myletter.spell.txt > myletter.spell.xml
-lualatex myproject
+lualatex myletter
\end{lstlisting}
@@ -652,12 +801,6 @@ The most user-visible issues are listed below:
\item Text in head and foot lines is neither extracted nor highlighted
(\href{https://github.com/sh2d/spelling/issues/7}{issue~7}).
- \item Punctuation characters are currently not stripped from words.
- For that reason, misspellings of words with leading or trailing
- punctuation will currently slip through. This affects at least one
- word per sentence, the last one
- (\href{https://github.com/sh2d/spelling/issues/8}{issue~8}).
-
\item The first word starting right after an |hlist|, \lpeg, the first
word within an |\mbox|, is never highlighted. It is extracted and
written to the text file, though. This might affect acronyms, names
@@ -672,7 +815,7 @@ The most user-visible issues are listed below:
\end{itemize}
-Any contributions are warmly welcome!
+Patches welcome!
\bigskip
\emph{Happy \TeX ing!}