namen

Documentation

Overview

ilo Namen adapts Toki Pona words so that they can be used within a sitelen pona cartouche.

Index

• Variables
• func OAnteENimi(nimi string, nasin Nasin) (string, error)
• type Nasin

Variables

var (
	// ErrNimiLiPakala means that a word was encountered that does not follow
	// the sound rules of Toki Pona.
	ErrNimiLiPakala = errors.New("nimi li pakala")
)

Functions

func OAnteENimi

func OAnteENimi(nimi string, nasin Nasin) (string, error)

OAnteENini adapts Toki Pona words so that they can be used within a sitelen pona cartouche.

The method of generating the glyphs to use is decided by the Nasin provided. If unsure, use NasinPu to follow the rules described in lipu pu.

The algorithm used is deterministic, meaning the same glyphs will always be selected for the same word.

If nimi does not follow the sound rules of Toki Pona, ErrNimiLiPakala is returned.

Types

type Nasin

type Nasin interface {
	// contains filtered or unexported methods
}

Nasin represents the method of chosing which glyphs to use.

var (
	// Using NasinPu, glyphs are chosen using the lipu pu method.
	//
	// For example, "Amoli" becomes "ale mi ona lupa ike".
	NasinPu Nasin = nasinPu{}

	// Using NasinKalama, glyphs are chosen using the [nasin sitelen kalama]
	// method.
	//
	// For example, "Amoli" becomes "ale moli :".
	//
	// [nasin sitelen kalama]: https://sona.pona.la/wiki/nasin_sitelen_kalama
	NasinKalama Nasin = nasinKalama{}
)