% \iffalse meta comment
% !TEX encoding = UTF-8 Unicode
% !TEX TS-program = lualatex

%<*internal>
\begingroup
\input docstrip.tex
\keepsilent
\preamble
Copyright 2025 Claudio Beccari All rights reserved.

 This system is distributed in the hope that it will
 be useful, but WITHOUT ANY WARRANTY; without even 
 the implied warranty of MERCHANTABILITY or FITNESS 
 FOR A PARTICULAR PURPOSE.

This file is distributed under the LPPL licence, 
version 1.3c dated 2008-05-04 or later as it appears 
in CTAN/macros/latex/base/lppl.tex.
See the end of this file.

\endpreamble
\askforoverwritefalse
%
\generateFile{testhyphens.sty}{f}{\from{testhyphens.dtx}{package}}

\def\tmpa{plain}
\ifx\tmpa\fmtname\endgroup\expandafter\bye\fi
\endgroup
%</internal>
% \fi
%
% \iffalse 
%^^A The following trick uses the same date for every file header.
%<package>\NeedsTeXFormat{LaTeX2e}
%<*driver>
\ProvidesFile{testhyphens.dtx}[%
%</driver>
%<package>\ProvidesPackage{testhyphens}[%
%<*driver,package>
2025/01/16 v.1.0 
%<package>Prints list of hyphenated words]
%</driver,package>
%<*driver>
]
%</driver>
%<*driver>
\documentclass{ltxdoc}
\GetFileInfo{testhyphens.dtx}
  \title{The \textsf{testhyphens} package\\[3mm]
        {\Large Version number \fileversion, last
        revised on \filedate.}}
 \author{Claudio Beccari\\
 email: claudio(dot)beccari(at)gmail(dot)com}
 \date{}
 \providecommand\babel{\pack{babel}}
 \newcommand\lbr{\char123\relax}
 \newcommand\rbr{\char125\relax}
%
 \renewcommand*\meta[1]{{\normalfont\textlangle\textit{#1}\textrangle}}
 \newcommand*\pack[1]{\textsf{#1}}
 \newcommand*\prog[1]{\texttt{#1}}
 \providecommand*\marg[1]{{\normalfont\texttt{\{}\meta{#1}\texttt{\}}}}\let\Arg\marg
 \renewcommand*\oarg[1]{\texttt{[}\meta{#1}\texttt{]}}
 \newcommand\amb[1]{\texttt{\itshape#1}}
 \usepackage{multicol}
 \usepackage{iftex}
%
\ifpdftex%
  \usepackage[utf8]{inputenc}
  \usepackage[LGR,T1]{fontenc}
  \usepackage{lmodern,textcomp}
  \usepackage[greek,italian,english]{babel}
\else
  \usepackage{fontspec}
  \usepackage{polyglossia}
  \setotherlanguage[variant=mono]{greek}
  \setmainlanguage{english}
  \setotherlanguage{italian}
  \usepackage[default]{fontsetup}
\fi

\usepackage{metalogo,FramedSyntax}
\usepackage{testhyphens}
%
\begin{document}
 \maketitle
 \DocInput{testhyphens.dtx}
\end{document}
%</driver>
% \fi
%
% \begin{abstract}
% This small file implements some code that was
% already published on TUGboat, but it is adapted
% to \LaTeX\ engines, and it is usable as a
% specific environment.
% It helps those \TeX{}ers who create hyphenation
% patterns, as well normal \LaTeX\ users, in order
% to test the correctness of the hyphenation points
% of words lists.
% It works with \pack{pdflatex}, \prog{xelatex}, and
% \prog{lualatex}.
% \end{abstract}
%
%{\columnseprule=0.4pt
%\begin{multicols}{2}
%\tableofcontents
%\end{multicols}}
%
% \section{Introduction}
%
% This small package introduces the environment
% |checkhyphens|. This environment may set the
% hyphenation parameters to any specific values,
% even different from those setup for the language
% in use; it processes a list of one or more space
% delimited words typesetting them one per line with
% hyphens between each syllable. If typesetting
% this list takes place within a \amb{multicolulmn}
% environment, it renders much easier to read long
% lists.
%
% The hyphenation patterns of a specific language
% to be tested, may be those of the default
% language before entering the environment, or can
% be those of another language specified with
% |\selectlanguage| within the environment.
%
% The environment \amb{checkhyphens} accepts also an
% optional argument to set the hyphenation
% parameters, and a body consisting of a list
% of one or more space separated words; if the
% user just pastes a text copied from somewhere that
% includes punctuation, the punctuation signs are
% ignored, but are not taken off from the printed
% list.
%
% The main code was published long ago by Victor
% Eijkout, in “The bag of tricks”, \textsf{\slshape
% TUGboat} 14.4 (1993), p. 424. He himself states
% that the code was created by Jonathan Kew; Victor
% Eijkout just added an empty
% |\discretionary{}{}{}|. The idea came to him from
% the code created by Oliver Schoett that is used
% for the hyphenation exception list of TUGboat.
% Credit for the code goes completely to the
% authors mentioned above; I just added some sugar
% to use that code in \LaTeX\ documents for the
% benefit of hyphenation pattern creators, and of
% regular users who want to know how a certain word
% or the words of a certain sentence would be
% hyphenated by \TeX\ and friends.
%
% In 2018  a small extension package \pack{xltxtra}
% by Will Robertson was added to the \TeX\ system
% distribution that contains some fixes and
% facilities to be used when typesetting with
% \XeLaTeX; it contains the definition of the macro
% \cs{showhyphens} macro; this macro was provided by
% Enrico Gregorio; it is supposed to show the
% hyphenation of a small word list when using
% \XeLaTeX; unfortunately in these years, up to
% 2024, \LaTeX\  has undergone so many changes that
% this macro does not work any more, except perhaps
% with few selected languages.
%
% Of course this package does not tell the whole
% truth: in facts \TeX\ and friends hyphenate words
% only when certain conditions are met; these
% conditions are stated in Appendix~H of the
% \TeX\-book, which is and remains the primary
% reference for understanding the hyphenation
% process used by \TeX\ and friends.

% Sometimes users complain that certain words
% are not hyphenated; users might use this package
% and find out how their words are hyphenated; then
% what's happening if they are not hyphenated the
% right way? Simply those conditions are not met.
% Therefore the full understanding of the above
% mentioned Appendix~H is fundamental before
% complaining about \TeX\ not working as expected
% with hyphenation and possibly before raising a bug
% notice.
%
% \section{Incompatibility with the previous
% version 0.5a}
%
% In 2015 I had to change some definitions within
% the body of this package in order to avoid
% clashes mainly with the |french| language option
% of babel; in facts that option declares most
% punctuation marks as active characters.
% Unfortunately those characters receive global
% definitions, therefore they remain active even
% when they should not perform any action. 
%
% It is necessary to specify that the previous
% version used the colon as a parameter separator;
% while, in order to avoid conflicts with |french|,
% now the parameter separator is a simple hyphen.
%
% Defining active characters when using
% |polyglossia| may produce other incompatibilities
% that are easily circumvented by specifying
% languages in a different order. In facts, if you
% specify languages as such
%\begin{verbatim}
%\setmainlanguage[babelshorthands]{italian}
%\setotherlanguages{english,french}
%\end{verbatim}
% an error appears when |french| sets up its
% parameters for the UNICODE apostrophe: the cause
% of this error derives from the use of the
% |italian| option |babelshorthands|; of course if
% this option is not specified, no problems arise.
% But if you interchange the declarations as in
%\begin{verbatim}
%\setotherlanguages{english,french}
%\setmainlanguage[babelshorthands]{italian}
%\end{verbatim}
% no problems arise.
%
% \section{Changes from version 0.7}
%
% When version 0.7 was published, command
% \cs{testhyphens} worked regularly also with
% \XeLaTeX; this new version maintains the
% environment \amb{checkhyphens}, but lets down
% \cs{texthyphens} because this command raised
% errors that I was not able to repair. Something
% was changed in the \XeLaTeX\ format file that I
% could not spot.
%
% Never mind: in 2015 the environment was more
% effective than the command, and it survives in
% this new version with all its power.
%
% \section{Usage}
% This package has been tested with |pdflatex|,
% |xelatex|, and |lualatex|; for |lualatex| a
% package |showhyphens| exists that marks the hyphen
% points of an entire document with thin red
% vertical strokes at the possible break points.
% Users may use the package they prefer by taking
% into consideration their needs with respect with
% the features and the functionalities of package
% \pack{testhyphens} compared to those of
% \pack{showhyphens}.
%
% Notice that even normal Plain \TeX\ and \LaTeX\ 
% have available the command |\showhyphens| but,
% differently from this package, such command works
% only when the typesetting engine is |tex| or
% |pdftex|; moreover the result appears on the
% console window and in the \texttt{.log} file
% and it is not written down in the output document
% as a record that remains available to the user.
% This package |testhyphens|, on the opposite,
% prints the result in the output document and works
% with the typesetting engines |pdftex|, |xetex|,
% and |luatex| as expected.
%
% This simple package is loaded just with the usual
% statement 
% \begin{flushleft}
%|\usepackage{testhyphens}|
% \end{flushleft}
% 
% The package new version defines for the end user
% just the environment \amb{checkhyphens}: its
% syntax is the following:
%\begin{Sintassi}
% |\begin{checkhyphens}|\oarg{hyphenation parameters}
%\meta{space separated word list}
% |\end{checkhyphens}|
%\end{Sintassi}
% where \meta{hyphenation parameters} is a
% \emph{hyphen separated list} of two digits that in
% order will be locally assigned by the environment
% respectively to |\lefthyphenmin| and
% |\righthyphenmin|; the \meta{space separated word
% list} is self explanatory. Nevertheless it is good 
% to remember that the environment isolates single
% words by using a space as a word separator; this
% requires that the list is preceded and followed
% by spaces or end of lines, Actually the initial
% and final spaces are necessary when the opening
% statement is on the same source line of the first
% word and the closing statement is in the same
% source line of the last word.
%
% \section[Hyphenation parameters]{Using hyphenation parameters}
%
% The hyphenation parameters are just
% |\lefthyphenmin| and |\righthyphenmin|; they
% represent the minimum number of characters that
% the first and, respectively, the last word
% fragment must have before or until hyphenation
% takes place; for example in English the default
% values are 2 and~3; in Italian the default values
% are 2 and~2; in Greek the default values are
% 1 and~1.
%
% Let us make an example: the word \emph{idea} is
% spelt the same in English and in Italian, although
% it is pronounced differently; but 
% the word is not hyphenated at all in both
% languages. According to the Italian 
% syllabification rules its grammatical word
% division is \emph{i-de-a}; in American English
% the grammatical word division is the same; in any
% case the initial and the terminal syllables are
% too short to comply with the above mentioned
% \TeX\ hyphenation parameters, and \TeX\ refrains
% from hyphenating this word. On the opposite, in
% Greek \foreignlanguage{greek}{ιδέα} is hyphenated
% by \TeX\ as \foreignlanguage{greek}{ι-δέ-α}.
%
% If you use \amb{checkhyphens} with the optional
% hyphenation parameters specified to 1 and~1 in
% Italian or in English, as in
%\begin{verbatim}
%\begin{checkhyphens}[1-1] 
%idea
%\end{checkhyphens}
%\end{verbatim}
% you don't get any hyphenation in English; but in
% Italian hyphenation turns out to be \emph{i-de-a}
% as in Greek. 
%
% This happens because the Italian patterns were
% created by hand and tested with parameters
% 1 and~1, even if for typesetting purposes the
% parameters are set to 2 and~2. In English the
% patterns were created by means of the
% \prog{patgen} program where parameters 2 and~3
% were set.
%
% Typographically speaking the values 1 and~1 for
% Italian are almost useless, but in certain
% difficult narrow-measure texts the user has the
% possibility to locally set the first and/or the
% second parameter to 1, and solve that particular
% instance of problematic narrow-measure
% typesetting.
%
% \section{Examples}
% Here we show some actual examples by using the 
% \amb{checkhyphens} environment.
%
% While typesetting in English we might verify the
% hyphenation of some words.
% We set the source file with the following lines
% %\begin{verbatim}
%\begin{{chechhyphens}
%manifests instruments 
%he analyses the samples and submits the analyses to the federal office 
%\end{checkhyphens}
%\end{verbatim}
% The result produced by this package, typeset
% within a four-column \amb{multicols} environment,
% is the following:
%
%\begin{multicols}{4}
%\begin{checkhyphens} 
%he analyses the samples and submits the analyses to the federal office 
%\end{checkhyphens}
%\end{multicols}
% Notice the two instances of the word |analyses|;
% in English \TeX\ hyphenates them the same way, but
% one of the two words is hyphenated the wrong way;
% unfortunately there is no way for \TeX\ to
% distinguish homographic words that are not
% homophonic ones. In plain terms the verb
% “analyses” is stressed on the `y', while the noun
% “analyses” is stressed on the second `a';
% the standard phonetic hyphenation rules for
% English probably should hyphenate the verb as
% “an-a-lyses”, but \TeX\ works only on the spelling
% and not on the sound; furthermore it has no means
% to find out if a word plays the rôle of a noun or
% of a verb.
% In this and similar situations (for example: “the
% record” and “to record”) the user should
% check a good reliable dictionary and possibly
% insert an explicit discretionary hyphen~|\-|.
% A good although oldish such dictionary would be
% the \emph{Webster's New Word Speller divider} ---
% The 33\,000 most used words spelled and
% syllabified. World \& Collins World, (1971).
%
% In Italian any grammar book states the rules that
% are valid for all Latin derived words and are
% applicable also to technical scientific words,
% although a phonetic hyphenation is allowed and
% is more more adequate to the context; words
% derived from Greek (very common in medicine) and
% neologisms with foreign roots, do not find
% specific rules either in grammars and in most
% dictionaries; or better, if a word ends with one
% or more consonants, this consonantic group must
% not be separated from the word last vowel.
%
% While typesetting in Italian it is possible to
% insert into the source file a set of lines such as
% these:
%\begin{verbatim}
%\begin{checkhyphens}
%ebbe la bell’idea di viaggiare in scooter
%\end{checkhyphens}
%\end{verbatim}
% that produces the following result:
%\begin{multicols}{4}
%\begin{otherlanguage*}{italian}
%\begin{checkhyphens}
%ebbe la bell’idea di viaggiare in scooter
%\end{checkhyphens}
%\end{otherlanguage*}\end{multicols}
% Notice that “idea” cannot be hyphenated by \TeX\ 
% when it is an isolated word; but in Italian the
% apostrophe is used (also) to mark a vocalic
% elision, therefore for hyphenation purposes, even
% if it is not a letter, it is assigned a lowercase
% code, and it becomes part of a word, in
% our case the word string “bell'idea”. Therefore
% the patterns that involve the apostrophe produce
% the result shown above, where the first
% grammatical hyphen point shows up
% again\footnote{This is so with \prog{xelatex}; in
% \prog{lualatex} the apostrophe is not assigned a 
% a lowercase code, therefore with
% \prog{lualatex} “bell'idea” is not hyphenated at
% all; it would be if the Unicode single upper 
% quotation mark was used instead of the
% \textsc{ascii} character available with any
% keyboard: “bell’idea”. These characters look the
% same (at least with some OpenType fonts) but have
% different Unicode code points.}.
%
% While typesetting in Greek we might insert in the
% source file the following code:
%\begin{flushleft}\ttfamily\obeylines
%|\begin{checkhyphens}[1-1]|
%\begin{otherlanguage*}{greek}
% επεξεργάζεται αρχεία τα οποία περιέχουν τους
% χαρακτήρες που υπάρχουν στο πληκτρολόγιο του
% υπολογιστή σας
%\end{otherlanguage*}
%|\end{checkhyphens}|
%\end{flushleft}
%and we would get:
%\begin{multicols}{4}
%\begin{otherlanguage*}{greek}
%\begin{checkhyphens}[1-1]
%επεξεργάζεται αρχεία τα οποία περιέχουν τους χαρακτήρες που υπάρχουν 
%στο πληκτρολόγιο του υπολογιστή σας
%\end{checkhyphens}
%\end{otherlanguage*}\end{multicols}
%\noindent while, had we set the hyphenation parameters different from the default
% values 1~and~1, as in: 
%\begin{flushleft}\ttfamily\obeylines
%|\begin{checkhyphens}[2-2]|
%\begin{otherlanguage*}{greek}
%επεξεργάζεται αρχεία τα οποία περιέχουν τους
% χαρακτήρες που υπάρχουν στο πληκτρολόγιο του
% υπολογιστή σας
%\end{otherlanguage*}
%|\end{checkhyphens}|
%\end{flushleft}
%the result would be:
%\begin{multicols}{4}
%\begin{otherlanguage*}{greek}
%\begin{checkhyphens}[2-2]
%επεξεργάζεται αρχεία τα οποία περιέχουν τους χαρακτήρες που υπάρχουν 
%στο πληκτρολόγιο του υπολογιστή σας
%\end{checkhyphens}
%\end{otherlanguage*}
%\end{multicols}
%
% The pattern files for monotonic Greek used in
% these examples were rebuilt with Greek letters --
% avoiding the Latin transliteration originally
% used with the Latin Modern conformant Greek fonts
% encoded with the \texttt{LGR} encoding; that was
% done for the benefit of non-Greek Hellenists who
% would use their Latin national keyboards. The
% above mentioned upgrading was done by Dimitrios
% Filippou in 2011; since then no modifications were
% added, except for the patterns to be used with
% \prog{xelatex} and \prog{lualatex}.
%
% For OpenType fonts Antonis Tsolomitis
% produced a new font set that assembles the Latin
% Modern Fonts together with the CBfonts and some
% Cyrillic ones and other fonts for several other
% scripts; this remarkable pretty complete
% OpenType font is named “New Computer Modern”
% (documentation with \texttt{texdoc NewCM}) that
% uses the \pack{fontsetup} package for selecting
% its varieties; this package is described by the
% same documentation. This guide was
% typeset with \ifxetex\prog{xelatex}\else
% \ifluatex\prog{lualatex}\fi\fi, using this new
% font, and the above Greek language examples are
% correct.
%
% The first Greek example shows very clearly the
% effect of |\lefthyphenmin=1| compared to the
% second example where |\lefthyphenmin=2|. On the
% other hand, the fact that some hyphen points may
% be missing is certainly a feature that precludes
% full hyphenation, but it does not produce
% hyphenation errors.
%
% By using this package it was originally possible
% to highlight the features/bugs in the Greek
% hyphenation patterns.
% \StopEventually{}
% \CheckSum{101}
% \section{The code}
%\iffalse
%<*package>
%\fi
% The following code has very few modifications
% compared to the original code published by Victor
% Eijkout. For my own benefit I changed the
% declaration name from |\printhyphens| to
% |\t@sthyphens|; with an at-sign internal name
% it is less likely that this command is
% redefined by some user. I also moved the command
% |\offinterlineskip| from its penultimate position
% in the original code to the first command to be
% executed within a |\vbox|; in this way
% I avoided certain cases in which the lack of
% interline skip would remain active after closing
% the environment.
%
% The code is based on treating the inter word space
% as an active character that plays different rôles
% according to its position; it lets the
% environment isolate the words to be hyphenated
% and open suitable boxes, that are closed at the
% moment of processing the following word; the
% |\everypar| token-list distinguishes the various
% actions to be performed at each step.
%
% Another advantage is that the environment
% processes one word at a time, therefore the word
% list may be arbitrarily long; while creating the
% patterns for the Albanian language I initially
% worked with a half dozen pages taken from a
% book, about 7000 words. Initially I deleted all
% duplicate words then, while fine tuning
% the pattern set, I deleted a certain number of the
% test words; eventually a good set of patterns
% was created under the supervision or a learned
% Albanian friend.
%
% But the trick of this software is to set each word
% within a vertical box where the measure (the text
% width |\hsize|) is zero; in this way each word is
% hyphenated at the first hyphen point, but the word
% fragment that remains in the following line is
% still too long and gets hyphenated again; the
% process is repeated again and again until the
% initial string is exhausted. The contents of the
% |\vbox|, that now contains the syllables one per
% line, is reassembled to form one line, and this
% line is output within an |\hbox| and is therefore
% the box typeset in vertical mode; this is why the
% dommand must be issued in vertical mode, so as
% to start processing the word list with the right
% foot; this is also why the word list must start
% and end with spaces; the first space or end of
% line before the first word opens the first box,
% and the last space or end of line after the last
% word closes the box and outputs its contents in
% horizontal mode..
%    \begin{macrocode}
\def\t@sthyphens{%
  \everypar{\setbox0\lastbox
  \setbox1\hbox{\strut}\vbox\bgroup
  \offinterlineskip
  \everypar{\setbox0\lastbox \nobreak\hskip\z@}\dimen0=\hsize
  \hsize=\z@ \hfuzz\maxdimen \def\par{\endgraf \hsize=\dimen0\getlastline
  \egroup\endgraf}}\breakafterword
}

\def\breakafterword{%
\catcode`\^^M=13 \catcode`\ =13
}

{\breakafterword\gdef^^M{\par}\global\let ^^M}

\def\getlastline{\setbox0\lastbox
\ifvoid0
  \let\next\nomorelines
\else
  \unskip\unpenalty
  \setbox1\hbox{\unhbox0\strut\discretionary{}{}{}%
  \unhbox1}\let\next\getlastline
\fi
\next}

\def\nomorelines{\unhbox1}
%    \end{macrocode}
% The above code is substantially the original one;
% where the internal declaration control
% sequence |\t@sthyphens| is defined.
% Now we define the \amb{checkhyphens} environment
% where we make sure that the whole process of the
% word list contained in its body takes place in
% vertical mode. In oder to process the optional
% argument for setting the hyphenation parameters,
% we define a delimited argument macro
% |\s@thyphenpars| that uses the \emph{hyphen} as
% the argument delimiter.
%    \begin{macrocode}
\newenvironment{checkhyphens}[1][\lefthyphenmin-\righthyphenmin]{%
\@tempcnta=\lefthyphenmin
\@tempcntb=\righthyphenmin
\s@thyphenpars[#1]\par
\bgroup\t@sthyphens
}{%
\egroup\par
}

\def\s@thyphenpars[#1-#2]{%
\@tempcnta=#1\relax
\@tempcntb=#2\relax
\unless\ifnum\@tempcnta=\lefthyphenmin \lefthyphenmin=\@tempcnta\fi
\unless\ifnum\@tempcntb=\righthyphenmin \righthyphenmin=\@tempcntb\fi
}
%    \end{macrocode}
%\Finale 
%\iffalse
%</package>
%\fi
% That's all. Happy \TeX\-ing.
\endinput

