new lualatex package spelling (1dec12)

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

5 files changed, 984 insertions, 0 deletions

diff --git a/Master/texmf-dist/doc/lualatex/spelling/LICENSE b/Master/texmf-dist/doc/lualatex/spelling/LICENSE
new file mode 100644
index 00000000000..22443139013
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/spelling/LICENSE
@@ -0,0 +1,416 @@
+The LaTeX Project Public License
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
+LPPL Version 1.3c  2008-05-04
+
+Copyright 1999 2002-2008 LaTeX3 Project
+    Everyone is allowed to distribute verbatim copies of this
+    license document, but modification of it is not allowed.
+
+
+PREAMBLE
+========
+
+The LaTeX Project Public License (LPPL) is the primary license under
+which the LaTeX kernel and the base LaTeX packages are distributed.
+
+You may use this license for any work of which you hold the copyright
+and which you wish to distribute.  This license may be particularly
+suitable if your work is TeX-related (such as a LaTeX package), but 
+it is written in such a way that you can use it even if your work is 
+unrelated to TeX.
+
+The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE',
+below, gives instructions, examples, and recommendations for authors
+who are considering distributing their works under this license.
+
+This license gives conditions under which a work may be distributed
+and modified, as well as conditions under which modified versions of
+that work may be distributed.
+
+We, the LaTeX3 Project, believe that the conditions below give you
+the freedom to make and distribute modified versions of your work
+that conform with whatever technical specifications you wish while
+maintaining the availability, integrity, and reliability of
+that work.  If you do not see how to achieve your goal while
+meeting these conditions, then read the document `cfgguide.tex'
+and `modguide.tex' in the base LaTeX distribution for suggestions.
+
+
+DEFINITIONS
+===========
+
+In this license document the following terms are used:
+
+   `Work'
+    Any work being distributed under this License.
+    
+   `Derived Work'
+    Any work that under any applicable law is derived from the Work.
+
+   `Modification' 
+    Any procedure that produces a Derived Work under any applicable
+    law -- for example, the production of a file containing an
+    original file associated with the Work or a significant portion of
+    such a file, either verbatim or with modifications and/or
+    translated into another language.
+
+   `Modify'
+    To apply any procedure that produces a Derived Work under any
+    applicable law.
+    
+   `Distribution'
+    Making copies of the Work available from one person to another, in
+    whole or in part.  Distribution includes (but is not limited to)
+    making any electronic components of the Work accessible by
+    file transfer protocols such as FTP or HTTP or by shared file
+    systems such as Sun's Network File System (NFS).
+
+   `Compiled Work'
+    A version of the Work that has been processed into a form where it
+    is directly usable on a computer system.  This processing may
+    include using installation facilities provided by the Work,
+    transformations of the Work, copying of components of the Work, or
+    other activities.  Note that modification of any installation
+    facilities provided by the Work constitutes modification of the Work.
+
+   `Current Maintainer'
+    A person or persons nominated as such within the Work.  If there is
+    no such explicit nomination then it is the `Copyright Holder' under
+    any applicable law.
+
+   `Base Interpreter' 
+    A program or process that is normally needed for running or
+    interpreting a part or the whole of the Work.    
+
+    A Base Interpreter may depend on external components but these
+    are not considered part of the Base Interpreter provided that each
+    external component clearly identifies itself whenever it is used
+    interactively.  Unless explicitly specified when applying the
+    license to the Work, the only applicable Base Interpreter is a
+    `LaTeX-Format' or in the case of files belonging to the 
+    `LaTeX-format' a program implementing the `TeX language'.
+
+
+
+CONDITIONS ON DISTRIBUTION AND MODIFICATION
+===========================================
+
+1.  Activities other than distribution and/or modification of the Work
+are not covered by this license; they are outside its scope.  In
+particular, the act of running the Work is not restricted and no
+requirements are made concerning any offers of support for the Work.
+
+2.  You may distribute a complete, unmodified copy of the Work as you
+received it.  Distribution of only part of the Work is considered
+modification of the Work, and no right to distribute such a Derived
+Work may be assumed under the terms of this clause.
+
+3.  You may distribute a Compiled Work that has been generated from a
+complete, unmodified copy of the Work as distributed under Clause 2
+above, as long as that Compiled Work is distributed in such a way that
+the recipients may install the Compiled Work on their system exactly
+as it would have been installed if they generated a Compiled Work
+directly from the Work.
+
+4.  If you are the Current Maintainer of the Work, you may, without
+restriction, modify the Work, thus creating a Derived Work.  You may
+also distribute the Derived Work without restriction, including
+Compiled Works generated from the Derived Work.  Derived Works
+distributed in this manner by the Current Maintainer are considered to
+be updated versions of the Work.
+
+5.  If you are not the Current Maintainer of the Work, you may modify
+your copy of the Work, thus creating a Derived Work based on the Work,
+and compile this Derived Work, thus creating a Compiled Work based on
+the Derived Work.
+
+6.  If you are not the Current Maintainer of the Work, you may
+distribute a Derived Work provided the following conditions are met
+for every component of the Work unless that component clearly states
+in the copyright notice that it is exempt from that condition.  Only
+the Current Maintainer is allowed to add such statements of exemption 
+to a component of the Work. 
+
+  a. If a component of this Derived Work can be a direct replacement
+     for a component of the Work when that component is used with the
+     Base Interpreter, then, wherever this component of the Work
+     identifies itself to the user when used interactively with that
+     Base Interpreter, the replacement component of this Derived Work
+     clearly and unambiguously identifies itself as a modified version
+     of this component to the user when used interactively with that
+     Base Interpreter.
+     
+  b. Every component of the Derived Work contains prominent notices
+     detailing the nature of the changes to that component, or a
+     prominent reference to another file that is distributed as part
+     of the Derived Work and that contains a complete and accurate log
+     of the changes.
+  
+  c. No information in the Derived Work implies that any persons,
+     including (but not limited to) the authors of the original version
+     of the Work, provide any support, including (but not limited to)
+     the reporting and handling of errors, to recipients of the
+     Derived Work unless those persons have stated explicitly that
+     they do provide such support for the Derived Work.
+
+  d. You distribute at least one of the following with the Derived Work:
+
+       1. A complete, unmodified copy of the Work; 
+          if your distribution of a modified component is made by
+          offering access to copy the modified component from a
+          designated place, then offering equivalent access to copy
+          the Work from the same or some similar place meets this
+          condition, even though third parties are not compelled to
+          copy the Work along with the modified component;
+
+       2. Information that is sufficient to obtain a complete,
+          unmodified copy of the Work.
+
+7.  If you are not the Current Maintainer of the Work, you may
+distribute a Compiled Work generated from a Derived Work, as long as
+the Derived Work is distributed to all recipients of the Compiled
+Work, and as long as the conditions of Clause 6, above, are met with
+regard to the Derived Work.
+
+8.  The conditions above are not intended to prohibit, and hence do not
+apply to, the modification, by any method, of any component so that it
+becomes identical to an updated version of that component of the Work as
+it is distributed by the Current Maintainer under Clause 4, above.
+
+9.  Distribution of the Work or any Derived Work in an alternative
+format, where the Work or that Derived Work (in whole or in part) is
+then produced by applying some process to that format, does not relax or
+nullify any sections of this license as they pertain to the results of
+applying that process.
+     
+10. a. A Derived Work may be distributed under a different license
+       provided that license itself honors the conditions listed in
+       Clause 6 above, in regard to the Work, though it does not have
+       to honor the rest of the conditions in this license.
+      
+    b. If a Derived Work is distributed under a different license, that
+       Derived Work must provide sufficient documentation as part of
+       itself to allow each recipient of that Derived Work to honor the 
+       restrictions in Clause 6 above, concerning changes from the Work.
+
+11. This license places no restrictions on works that are unrelated to
+the Work, nor does this license place any restrictions on aggregating
+such works with the Work by any means.
+
+12.  Nothing in this license is intended to, or may be used to, prevent
+complete compliance by all parties with all applicable laws.
+
+
+NO WARRANTY
+===========
+
+There is no warranty for the Work.  Except when otherwise stated in
+writing, the Copyright Holder provides the Work `as is', without
+warranty of any kind, either expressed or implied, including, but not
+limited to, the implied warranties of merchantability and fitness for a
+particular purpose.  The entire risk as to the quality and performance
+of the Work is with you.  Should the Work prove defective, you assume
+the cost of all necessary servicing, repair, or correction.
+
+In no event unless required by applicable law or agreed to in writing
+will The Copyright Holder, or any author named in the components of the
+Work, or any other party who may distribute and/or modify the Work as
+permitted above, be liable to you for damages, including any general,
+special, incidental or consequential damages arising out of any use of
+the Work or out of inability to use the Work (including, but not limited
+to, loss of data, data being rendered inaccurate, or losses sustained by
+anyone as a result of any failure of the Work to operate with any other
+programs), even if the Copyright Holder or said author or said other
+party has been advised of the possibility of such damages.
+
+
+MAINTENANCE OF THE WORK
+=======================
+
+The Work has the status `author-maintained' if the Copyright Holder
+explicitly and prominently states near the primary copyright notice in
+the Work that the Work can only be maintained by the Copyright Holder
+or simply that it is `author-maintained'.
+
+The Work has the status `maintained' if there is a Current Maintainer
+who has indicated in the Work that they are willing to receive error
+reports for the Work (for example, by supplying a valid e-mail
+address). It is not required for the Current Maintainer to acknowledge
+or act upon these error reports.
+
+The Work changes from status `maintained' to `unmaintained' if there
+is no Current Maintainer, or the person stated to be Current
+Maintainer of the work cannot be reached through the indicated means
+of communication for a period of six months, and there are no other
+significant signs of active maintenance.
+
+You can become the Current Maintainer of the Work by agreement with
+any existing Current Maintainer to take over this role.
+
+If the Work is unmaintained, you can become the Current Maintainer of
+the Work through the following steps:
+
+ 1.  Make a reasonable attempt to trace the Current Maintainer (and
+     the Copyright Holder, if the two differ) through the means of
+     an Internet or similar search.
+
+ 2.  If this search is successful, then enquire whether the Work
+     is still maintained.
+
+  a. If it is being maintained, then ask the Current Maintainer
+     to update their communication data within one month.
+     
+  b. If the search is unsuccessful or no action to resume active
+     maintenance is taken by the Current Maintainer, then announce
+     within the pertinent community your intention to take over
+     maintenance.  (If the Work is a LaTeX work, this could be
+     done, for example, by posting to comp.text.tex.)
+
+ 3a. If the Current Maintainer is reachable and agrees to pass
+     maintenance of the Work to you, then this takes effect
+     immediately upon announcement.
+     
+  b. If the Current Maintainer is not reachable and the Copyright
+     Holder agrees that maintenance of the Work be passed to you,
+     then this takes effect immediately upon announcement.  
+    
+ 4.  If you make an `intention announcement' as described in 2b. above
+     and after three months your intention is challenged neither by
+     the Current Maintainer nor by the Copyright Holder nor by other
+     people, then you may arrange for the Work to be changed so as
+     to name you as the (new) Current Maintainer.
+     
+ 5.  If the previously unreachable Current Maintainer becomes
+     reachable once more within three months of a change completed
+     under the terms of 3b) or 4), then that Current Maintainer must
+     become or remain the Current Maintainer upon request provided
+     they then update their communication data within one month.
+
+A change in the Current Maintainer does not, of itself, alter the fact
+that the Work is distributed under the LPPL license.
+
+If you become the Current Maintainer of the Work, you should
+immediately provide, within the Work, a prominent and unambiguous
+statement of your status as Current Maintainer.  You should also
+announce your new status to the same pertinent community as
+in 2b) above.
+
+
+WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE
+======================================================
+
+This section contains important instructions, examples, and
+recommendations for authors who are considering distributing their
+works under this license.  These authors are addressed as `you' in
+this section.
+
+Choosing This License or Another License
+----------------------------------------
+
+If for any part of your work you want or need to use *distribution*
+conditions that differ significantly from those in this license, then
+do not refer to this license anywhere in your work but, instead,
+distribute your work under a different license.  You may use the text
+of this license as a model for your own license, but your license
+should not refer to the LPPL or otherwise give the impression that
+your work is distributed under the LPPL.
+
+The document `modguide.tex' in the base LaTeX distribution explains
+the motivation behind the conditions of this license.  It explains,
+for example, why distributing LaTeX under the GNU General Public
+License (GPL) was considered inappropriate.  Even if your work is
+unrelated to LaTeX, the discussion in `modguide.tex' may still be
+relevant, and authors intending to distribute their works under any
+license are encouraged to read it.
+
+A Recommendation on Modification Without Distribution
+-----------------------------------------------------
+
+It is wise never to modify a component of the Work, even for your own
+personal use, without also meeting the above conditions for
+distributing the modified component.  While you might intend that such
+modifications will never be distributed, often this will happen by
+accident -- you may forget that you have modified that component; or
+it may not occur to you when allowing others to access the modified
+version that you are thus distributing it and violating the conditions
+of this license in ways that could have legal implications and, worse,
+cause problems for the community.  It is therefore usually in your
+best interest to keep your copy of the Work identical with the public
+one.  Many works provide ways to control the behavior of that work
+without altering any of its licensed components.
+
+How to Use This License
+-----------------------
+
+To use this license, place in each of the components of your work both
+an explicit copyright notice including your name and the year the work
+was authored and/or last substantially modified.  Include also a
+statement that the distribution and/or modification of that
+component is constrained by the conditions in this license.
+
+Here is an example of such a notice and statement:
+
+  %% pig.dtx
+  %% Copyright 2005 M. Y. Name
+  %
+  % 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.
+  %
+  % This work has the LPPL maintenance status `maintained'.
+  % 
+  % The Current Maintainer of this work is M. Y. Name.
+  %
+  % This work consists of the files pig.dtx and pig.ins
+  % and the derived file pig.sty.
+
+Given such a notice and statement in a file, the conditions
+given in this license document would apply, with the `Work' referring
+to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being
+generated from `pig.dtx' using `pig.ins'), the `Base Interpreter'
+referring to any `LaTeX-Format', and both `Copyright Holder' and
+`Current Maintainer' referring to the person `M. Y. Name'.
+
+If you do not want the Maintenance section of LPPL to apply to your
+Work, change `maintained' above into `author-maintained'.  
+However, we recommend that you use `maintained', as the Maintenance
+section was added in order to ensure that your Work remains useful to
+the community even when you can no longer maintain and support it
+yourself.
+
+Derived Works That Are Not Replacements
+---------------------------------------
+
+Several clauses of the LPPL specify means to provide reliability and
+stability for the user community. They therefore concern themselves
+with the case that a Derived Work is intended to be used as a
+(compatible or incompatible) replacement of the original Work. If
+this is not the case (e.g., if a few lines of code are reused for a
+completely different task), then clauses 6b and 6d shall not apply.
+
+
+Important Recommendations
+-------------------------
+
+ Defining What Constitutes the Work
+
+   The LPPL requires that distributions of the Work contain all the
+   files of the Work.  It is therefore important that you provide a
+   way for the licensee to determine which files constitute the Work.
+   This could, for example, be achieved by explicitly listing all the
+   files of the Work near the copyright notice of each file or by
+   using a line such as:
+
+    % This work consists of all files listed in manifest.txt.
+   
+   in that place.  In the absence of an unequivocal list it might be
+   impossible for the licensee to determine what is considered by you
+   to comprise the Work and, in such a case, the licensee would be
+   entitled to make reasonable conjectures as to which files comprise
+   the Work.
+
diff --git a/Master/texmf-dist/doc/lualatex/spelling/README b/Master/texmf-dist/doc/lualatex/spelling/README
new file mode 100644
index 00000000000..c6b8a9347a1
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/spelling/README
@@ -0,0 +1,68 @@
+This material is subject to the LaTeX Project Public License. See
+<http://www.latex-project.org/lppl/> for the details of that license.
+
+
+
+### Package information
+
+Package name: spelling  
+Summary description: Aid spell-checking LuaTeX documents.  
+Version: v0.1  
+Date: 2012-11-30  
+License: [LPPL v1.3c](http://www.latex-project.org/lppl/lppl-1-3c.html)  
+Maintenance status: maintained  
+Current maintainer: Stephan Hennig, <sh2d@arcor.de>  
+
+
+
+### Description
+
+This package aids 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-checkers, even dumb, TeX-unaware ones.
+
+
+
+### Development
+
+The development repository is currently hosted at
+[GitHub](https://github.com/sh2d/spelling/).  Code documentation is in
+[LuaDoc](http://keplerproject.github.com/luadoc/) format and can be
+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!
+
+
+_Happy TeXing!_
+
+
+
+### File list
+
+    LICENSE
+    README
+    spelling.lua
+    spelling.sty
+    spelling-doc.bad
+    spelling-doc.tex
+    spelling-recurse.lua
+    spelling-stage-1.lua
+    spelling-stage-2.lua
+    spelling-stage-3.lua
+    spelling-stage-4.lua
+
+
+
+<!--
+%%% Local Variables: 
+%%% coding: utf-8
+%%% mode: markdown
+%%% End: 
+-->
diff --git a/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.bad b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.bad
new file mode 100644
index 00000000000..4904a447e82
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.bad
@@ -0,0 +1,5 @@
+packgae
+Ther
+spellling
+foo’s
+incorect
diff --git a/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.pdf b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.pdf
new file mode 100644
index 00000000000..ee8c4492c93
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.pdf
diff --git a/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.tex b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.tex
new file mode 100644
index 00000000000..8d0d8a00af5
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/spelling/spelling-doc.tex
@@ -0,0 +1,495 @@
+%%% spelling-doc.sty
+%%% Copyright 2012 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.
+%%
+%% See file README for more information.
+%%
+\documentclass[11pt]{article}
+\usepackage{fontspec}
+\defaultfontfeatures{Ligatures=TeX}
+\usepackage{multicol}
+\usepackage{listings}
+\lstset{
+  basicstyle=\ttfamily,
+  columns=spaceflexible,
+}
+% Short-cut for non-language code snippets.
+\lstMakeShortInline\|
+% Short-cut for LaTeX code snippets.
+\lstMakeShortInline[
+language={[LaTeX]TeX},
+basicstyle=\ttfamily,
+]°
+\usepackage{xspace}
+\usepackage{array}
+\usepackage{booktabs}
+\usepackage[latin, UKenglish]{babel}
+\usepackage[rgb, x11names]{xcolor}
+\usepackage{hyperref}
+\hypersetup{
+  pdftitle={spelling},
+  pdfauthor={Stephan Hennig},
+  pdfkeywords={spell-checking, spelling, TeX, LuaTeX}
+}
+\hypersetup{
+  english,% For \autoref.
+  pdfstartview={XYZ null null null},% Zoom factor is determined by viewer.
+  colorlinks,
+  linkcolor=RoyalBlue3,
+  urlcolor=Chocolate4,
+  citecolor=DeepPink2
+}
+\usepackage{spelling}
+\spellingreadbad{\jobname.bad}
+\newcommand*{\pkg}{\textsf{spelling}}
+\newcommand*{\acr}[1]{\mbox{\scshape#1}}
+\newcommand*{\descr}[1]{〈\emph{#1}〉}
+\newcommand*{\cmd}[1]{\mbox{\ttfamily\textbackslash#1}}
+\newcommand*{\macro}[1]{\cmd{#1}\marginpar{\cmd{#1}}}
+\newcommand*{\latinphrase}[1]{\foreignlanguage{latin}{\emph{#1}}}
+\newcommand*{\lpcf}{\latinphrase{cf.}\xspace}
+\newcommand*{\lpeg}{\latinphrase{e.\,g.}\xspace}
+\newcommand*{\lpetc}{\latinphrase{etc.}\xspace}
+\newcommand*{\lpie}{\latinphrase{i.\,e.}\xspace}
+\begin{document}
+\author{Stephan Hennig\thanks{sh2d@arcor.de}}
+\title{\pkg\thanks{This document describes the \pkg\ packgae v0.1.}}
+\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
+  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.
+
+  \emph{Warning!  This package is in a very early state.  Everything may
+    change!}
+\end{abstract}
+
+\begin{multicols}{2}
+\small
+% Set toc entries ragged right.  Trick taken from tocloft.pdf.
+\makeatletter
+\renewcommand{\@tocrmarg}{2.55em plus1fil}
+\makeatother
+\tableofcontents
+\end{multicols}
+
+
+\section{Introduction}
+\label{sec:intro}
+
+Ther are three main approaches to spell-checking \TeX\ documents:
+
+\begin{enumerate}
+
+\item checking spelling in the |.tex| source file,
+
+\item converting a |.tex| file to another format, for which a proved
+  spell-checking solution exists,
+
+\item checking spelling after a |.tex| file has been processed by \TeX.
+
+\end{enumerate}
+
+All of these approaches have their strengths and weaknesses.  This
+package follows the third approach, providing some unique features:
+
+\begin{itemize}
+
+\item When extracting text from typeset \acr{dvi}, \acr{ps} or \acr{pdf}
+  files, hyphenation has to be switched off during the \TeX\ run to
+  avoid lots of false positives being reported by the spell-checker.
+  That is, one doesn't work on the original document.
+
+  In contrast to that, the \pkg\ package works transparently on the
+  original |.tex| source file.  Text is extracted \emph{during}
+  typesetting, after Lua\TeX\ has applied its catcode and macro
+  machinery, but before hyphenation takes place.
+
+\item The \pkg\ package can highlight words with known incorrect
+  spelling in \acr{pdf} output, giving visual feedback similar to
+  \acr{wysiwyg} word processors.%
+  \footnote{Currently, only colouring words is implemented.}
+
+\end{itemize}
+
+
+\section{Usage}
+\label{sec:usage}
+
+The \pkg\ package requires the Lua\TeX\ engine.  Currently, only the
+\LaTeX\ format is supported.  \emph{The package consists of Lua modules
+  that do the actual work.  The \LaTeX\ package is effectively a wrapper
+  around the modules' Lua-API.  Implementing support for other formats
+  shouldn't be too difficult.  Since the author is a \LaTeX-only user,
+  support has to be contributed by, \lpeg, you.  By the way, the \LaTeX\
+  package needs some polishing, too.  Contributions are welcome!}
+
+
+\subsection{Work-flow}
+\label{sec:work-flow}
+
+The work-flow of the \pkg\ package is as follows:
+
+\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}|.spb|, 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}|.txt|, by default.  The
+  text file should contain most of the text of the original 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.  The file should preferably
+  be named \descr{jobname}|.spb|, but any other file name works just as
+  well.
+
+\item Now, there are two ways to proceed:
+
+  \begin{enumerate}
+
+  \item Visually minded people may just compile their document a second
+    time.  This time, file \descr{jobname}|.spb| 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}
+
+\end{enumerate}
+
+
+\subsection{Word lists}
+\label{sec:wordlists}
+
+As described above, if a file \descr{jobname}|.spb| 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.  Words from additional files can
+be appended to the internal list of bad spellings with the
+\macro{spellingreadbad} command.  Argument is a file name.  The format
+of a word list file is one word per line.  The same word may occur
+multiple times.  The file must be in the \acr{utf-8} encoding.
+
+In addition to file \descr{jobname}|.spb|, a second file
+\descr{jobname}|.spg| is read, if that file exists.  The words found in
+that file are stored in an internal list of good spellings.  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.  That is, words in the list of good spellings are never
+highlighted in \acr{pdf} output.  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 list of good spellings with the
+\macro{spellingreadgood} command.  Argument is a file name.  File format
+is one word per line.  The same word may occur multiple times.  The file
+must be in the \acr{utf-8} encoding.
+
+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.
+
+
+\subsection{Highlighting spellling mistakes}
+\label{sec:highlight}
+
+\paragraph{Enabling/disabling} Highlighting spelling mistakes (words
+with known incorrect spelling) in \acr{pdf} output can be toggled on and
+off with command \macro{spellinghighlight}.  If the argument is |on|,
+highlighting is enabled.  For other arguments, highlighting is disabled.
+Highlighting is enabled, by default.
+
+\paragraph{Colour} The colour used for highlighting bad spellings can be
+determined by command \cmd{spellinghighlightcolor}.  Argument is a
+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!}
+
+
+\subsection{Text output}
+\label{sec:textoutput}
+
+\paragraph{Text file} After loading the \pkg\ package, at the end of the
+Lua\TeX\ run, a text file is written that contains most of the document
+text.  The text file is no close text rendering of the typeset document,
+but serves as input for your favourite spell-checker application.  It
+contains the document text in a simple format: paragraphs separated by
+blank lines.  A paragraph is anything that, during typesetting, starts
+with a |local_par| whatsit node in the node list representing a typeset
+page of the original document, \lpeg, paragraphs in running text,
+footnotes, marginal notes, (in-lined) °\parbox° commands or cells from
+°p°-like table columns \lpetc
+
+Paragraphs consist of words separated by spaces.  A word is the textual
+representation of a chain of consecutive nodes of type |glyph|, |disc|
+or |kern|.  Boxes are processed transparently.  That is, the \pkg\
+package (highly imperfectly) tries to recognise as a single word what in
+typeset output looks like a single word.  As an example, the \LaTeX\
+code
+
+\begin{center}
+  \begin{tabular}{c}
+\begin{lstlisting}[language={[LaTeX]TeX}]
+foo\mbox{'s bar}s
+\end{lstlisting}
+  \end{tabular}
+\end{center}
+which is typeset as
+
+\begin{center}
+  foo\mbox{'s bar}s
+\end{center}
+is considered two words \textit{foo's} and \textit{bars}, instead of the
+four words \textit{foo}, \textit{'s}, \textit{bar} and~\textit{s}.%
+\footnote{This document has been compiled with a custom list of bad
+  spellings, which is why the word \emph{foo's} should be highlighted.}
+
+\paragraph{Enabling/disabling} Text output can be toggled on and off
+with command \macro{spellingoutput}.  If the argument is |on|, text
+output is enabled.  For other arguments, text output is disabled.  Text
+output is enabled, by default.
+
+\paragraph{File name} \hspace{0pt plus 5em} Text output file name can be
+configured via command \macro{spellingoutputname}.  Argument is the new
+file name.  Default text output file name is \descr{jobname}|.txt|.
+
+\paragraph{Line length} In text output, paragraphs can either be broken
+into lines of a fixed length or paragraph can be put on a single line.
+The behaviour can be controlled via command
+\macro{spellingoutputlinelength}.  Argument is a number.  If the number
+is smaller than~1, 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.
+
+
+\subsection{Text extraction}
+\label{sec:textextraction}
+
+\paragraph{Enabling/disabling} Text extraction can be enabled and
+disabled in the document via command \macro{spellingextract}.  If the
+argument is |on|, text extraction is enabled.  For other arguments, text
+extraction is disabled.  The command should be used in vertical mode,
+\lpie, outside paragraphs.  If text extraction is disabled in the
+document preamble, an empty text file is written at the end of the
+Lua\TeX\ run.  Text extraction is enabled, by default.
+
+Note, text extraction and visual feedback are orthogonal features.  That
+is, if text extraction is disabled for part of a document, \lpeg, a long
+table, words with a known incorrect spelling are still highlighted in
+that part.
+
+
+\subsection{Code point mapping}
+\label{sec:cp-mapping}
+
+As explained in \autoref{sec:textoutput}, the text file written at the
+end of the Lua\TeX\ run is in the \acr{utf-8} encoding.  Unicode
+contains a wealth of code points with a special meaning, such as
+ligatures, alternative letters, symbols \lpetc Unfortunately, not all
+spell-checker applications are smart enough to correctly interpret all
+Unicode code points that may occur in a document.  For that reason, a
+code point mapping feature has been implemented that allows for mapping
+certain Unicode code points that may appear in a node list to arbitrary
+strings in text output.  A typical example is to map ligatures to the
+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\\
+    \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\\
+  \end{tabular}
+
+  \caption{Default code point mappings.}
+  \label{tab:cp-mapping}
+
+\end{table}
+
+Additional mappings can be declared by command \macro{spellingmapping}.
+This command takes two arguments, a number that refers to the Unicode
+code point, and a sequence of arbitrary characters that is the mapping
+target.  The code point number must be in a format that can be parsed by
+Lua.  The characters must be in the \acr{utf-8} encoding.
+
+New mappings only have effect on the following document text.  The
+command should therefore be used in the document preamble.  As an
+example, the character |A| can be mapped to |Z| and \latinphrase{vice
+  versa} with the following code:
+
+\begin{lstlisting}[language={[LaTeX]TeX}]
+\spellingmapping{65}{Z}% A => Z
+\spellingmapping{90}{A}% Z => A
+\end{lstlisting}
+
+Another command \macro{spellingclearallmappings} can be used to remove
+all existing code point mappings.
+
+
+\subsection{Tables}
+\label{sec:tables}
+
+How do tables fit into the simple text file format that has only
+paragraphs and blank lines as described in \autoref{sec:textoutput}?
+What is a paragraph with regards to tables?  A whole table?  A row?  A
+single cell?
+
+By default, only text from cells in °p°(aragraph)-like columns is put on
+their own paragraph, because the corresponding node list branches
+contain a |local_par| whatsit node (\lpcf \autoref{sec:textoutput}).
+The behaviour can be changed with the \macro{spellingtablepar} command.
+This command takes as argument a number.  If the argument is~0, the
+behaviour is described as above.  If the argument is~1, a blank line is
+inserted before and after every table row (but at most once between
+table rows).  If the argument is~2, a blank line is inserted before and
+after every table cell.  By default, no blank lines are inserted.
+
+
+\section{Bugs}
+\label{sec:bugs}
+
+Note, this package is in a very early state.  Expect bugs!  Package
+development is hosted at
+\href{http://github.com/sh2d/spelling/}{\bfseries GitHub}.  The full
+list of known bugs and feature requests can be found in the
+\href{http://github.com/sh2d/spelling/issues/}{\bfseries issue tracker}.
+New bugs should be reported there.
+
+The most user-visible issues are listed below:
+
+\begin{itemize}
+
+\item There's no support for the Plain \TeX\ or Con\TeX\ formats other
+  than the \acr{API} of the package's Lua modules, yet
+  (\href{https://github.com/sh2d/spelling/issues/1}{issue~1}).
+
+\item Macros provided by the \LaTeX\ package have very long names.  A
+  \emph{key-value} package option interface would be much more
+  user-friendly
+  (\href{https://github.com/sh2d/spelling/issues/2}{issue~2}).
+
+\item There are a couple of issues with text extraction and highlighting
+  incorrect spellings:
+
+  \begin{itemize}
+
+  \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.
+    If the list of bad spellings contains an entry, say,
+    \emph{incorect}, and the text contains that spelling directly
+    followed by a comma, a quotation mark \lpetc, the incorect spelling
+    is not highlighted
+    (\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
+    (\href{https://github.com/sh2d/spelling/issues/6}{issue~6}).
+
+  \item Bad spellings that are hyphenated at a page break are not
+    highlighted
+    (\href{https://github.com/sh2d/spelling/issues/10}{issue~10}).
+
+  \end{itemize}
+
+
+\end{itemize}
+
+Any contributions are warmly welcome!
+
+\bigskip
+\emph{Happy \TeX ing!}
+
+
+\end{document}
+
+
+
+%%% Local Variables: 
+%%% mode: latex
+%%% TeX-PDF-mode: t
+%%% TeX-master: t
+%%% coding: utf-8
+%%% End: