buckwalter

Documentation

Index

• func Ar2Bw(s string) (string, error)
• func Bw2Ar(s string) (string, error)
• type CharEntry
  • func BuildCharTable() []CharEntry

Functions

func Ar2Bw

func Ar2Bw(s string) (string, error)

Ar2Bw converts an input Arabic string into Buckwalter. An error is returned if there are unknown symbols in the input string. The resulting string always contains the full converted string (but with '?' for unknown chars). The output is in Buckwalter order (cons + cons length + vowel) -- i.e., not matching Arabic script NFC normalisation.

func Bw2Ar

func Bw2Ar(s string) (string, error)

Bw2Ar converts an input Buckwalter string into Arabic alphabet. An error is returned if there are unknown symbols in the input string. The resulting string always contains the full converted string (but with '?' for unknown chars). The Arabic output is NFC normalised (cons + vowel + cons length).

Types

type CharEntry

type CharEntry struct {
	Ar   string
	Bw   string
	Desc string
}

func BuildCharTable

func BuildCharTable() []CharEntry

BuildCharTable creates a list of the character mappings, for use in human readable docs