hyph-malagasy -- Hyphenation patterns for Malagasy / Motifs de cesure pour le malgache
=========================================================================================

Package     : hyph-malagasy
Version     : 0.3.1-dev (2026-09-02)
Author      : RALAHADY Bruno Bakys <ralahadybru@yahoo.fr>
License     : LaTeX Project Public License, version 1.3c or later
              (see LICENSE or https://www.latex-project.org/lppl.txt)

--------------------------------------------------------------------
English summary
--------------------------------------------------------------------

This package provides TeX hyphenation patterns (Liang's algorithm)
for the Malagasy language, intended for eventual integration into
the hyph-utf8 mechanism of TeX Live (loaded via \uselanguage, no
hard-coded \language number -- see tex/loadhyph-mg.tex).

*** THIS MATERIAL IS STILL NOT READY FOR FULL INTEGRATION INTO TeX
DISTRIBUTIONS. *** It is submitted to CTAN for display and review
purposes only, at the suggestion of the CTAN team, while development
continues. In particular:

  - The pattern corpus currently covers only 29 words, chosen to
    illustrate specific consonant clusters and prefixes of Malagasy,
    not general-purpose coverage.
  - UPDATE (2026-09-02): the corpus has now been reviewed by a native
    Malagasy speaker, who confirmed all 29 words as correct with no
    changes needed. It has not yet been validated by the Academia
    Malgache.
  - An earlier cross-contamination bug (unrelated words getting
    spurious hyphens from unrelated corpus entries) was found and
    fixed by restricting pattern generation to whole-word patterns
    only (see doc/methodology.md, section 4) -- this trades away
    generalisation to unseen words in favour of safety.

Feedback, corrections, and native-speaker review are very welcome at
the contact address above. The author does not intend to update this
package frequently while it remains in this early stage.

Contents (flat structure, as requested by the CTAN team)
------------------------------------------------------------

tex/
    hyph-mg.tex        -- raw hyphenation patterns (\patterns{...})
    loadhyph-mg.tex     -- loader following the hyph-utf8 convention

doc/
    methodology.md                     -- methodology notes (source)
    hyph-malagasy-documentation.pdf    -- same content, formatted as PDF
    hyph-malagasy-guide-utilisation.pdf -- user guide: install, build, contribute (French)
    relecture-malgache-completee.docx  -- completed native-speaker review (French)

source/
    malagasy-hyphenation.txt   -- annotated corpus (Liang notation)
    manual-overrides.txt       -- occasional manual pattern fixes
    generate_patterns.py       -- generates patterns from the corpus
    validate.py                -- validation (clusters, sync, coverage)
    extract_hyphenation.py     -- parses compiler output for testing
    test/                       -- pdfTeX and LuaTeX tests + expected output

--------------------------------------------------------------------
Resume en francais
--------------------------------------------------------------------

*** CE MATERIEL N'EST PAS ENCORE PRET POUR UNE INTEGRATION DANS LES
DISTRIBUTIONS TeX. *** Il est soumis a CTAN a des fins d'affichage et
de relecture uniquement, a la suggestion de l'equipe CTAN, pendant que
le developpement se poursuit.

Le corpus de motifs ne couvre actuellement que 29 mots, choisis pour
illustrer certains clusters consonantiques et prefixes du malgache.
Mise a jour du 2026-09-02 : ce corpus a ete relu par un locuteur natif,
qui a confirme les 29 mots comme corrects, sans aucune correction. Il
n'a pas encore ete valide par l'Academia Malgache. Une contamination
croisee identifiee lors des premiers tests a ete corrigee (voir
doc/methodology.md, section 4) en restreignant la generation aux
motifs mot-entier -- ce qui elimine le risque de contamination au prix
de l'absence de generalisation a des mots non vus.

Les retours, corrections et relectures par des locuteurs natifs sont
les bienvenus a l'adresse ci-dessus. L'auteur ne prevoit pas de mises
a jour frequentes tant que le paquet reste a ce stade precoce.

Installation
------------

Place the files under a local texmf tree following the layout above
(tex/, doc/, source/), then run `texhash` (or your distribution's
equivalent). Full integration into the hyph-utf8 \uselanguage
mechanism (an AddHyphen declaration in a .tlpsrc file) has not been
tested in a real TeX Live build -- see doc/methodology.md, section 2.

Contact
-------

RALAHADY Bruno Bakys
ralahadybru@yahoo.fr