# Copyright 2017-2018 Meik Michalke <meik.michalke@hhu.de>
#
# This file is part of the R package sylly.en.
#
# sylly.en is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# sylly.en 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.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with sylly.en.  If not, see <https://www.gnu.org/licenses/>.

#' Hyphenation patterns for English
#' 
#' Hyphenation patterns for English to be used by \code{\link[sylly:hyphen]{hyphen}}.
#' These data objects are not really intended to be used directly, but rather to be consulted
#' by the \code{hyphen()} function without further user interaction.
#'
#' @format The \code{pattern} slot of each hyphenation pattern object has three colums:
#'    \describe{
#'      \item{\code{orig}}{The original pattern in patgen style format.}
#'      \item{\code{char}}{Only the character elements of the pattern which can be matched to parts of an actual word.}
#'      \item{\code{nums}}{A code of digits defining the possibility to split syllables at respective places in this pattern.}
#'    }
#'
#' @source The patterns (as they are present in the \code{"orig"} column described above) were originally provided
#' by the LaTeX developers[1], under the terms of the LaTeX Project Public License[2].
#' Refer to Liang (1983) for a detailed explaination.
#' From these original patterns the values in the remaining columns were created using
#' \code{\link[sylly:read.hyph.pat]{read.hyph.pat}}.
#'
#' In case any changes to the patterns were necessary to be used in this package, they are
#' documented in the ChangeLog for the sources package. The unchanged original patterns can be found under [1].

#' @aliases hyph.en hyph.en.us
#' @docType data
#' @keywords datasets
#' @name hyph.en
#' @seealso
#'    \code{\link[sylly:read.hyph.pat]{read.hyph.pat}},
#'    \code{\link[sylly:manage.hyph.pat]{manage.hyph.pat}}
#' @references
#' Liang, F.M. (1983). \emph{Word Hy-phen-a-tion by Com-put-er}.
#'   Dissertation, Stanford University, Dept. of Computer Science.
#'
#' [1] \url{https://ctan.org/tex-archive/language/hyph-utf8/tex/patterns/txt/}
#'
#' [2] \url{https://www.ctan.org/tex-archive/macros/latex/base/lppl.txt}
#' @examples
#' library(sylly.en)
#' sampleText <- c("This", "is", "a", "rather", "stupid", "demonstration")
#' hyphen(sampleText, hyph.pattern="en")
NULL
