quran

README

go-quran-tree

Quran exloration in go

Documentation

Index

• type Aya
  • func (a *Aya) RemoveTashkeels() string
  • func (a *Aya) Tokens() []Token
• type Character
• type Quran
• type Sura
• type Token
  • func (t *Token) Characters() []Character
  • func (t *Token) Dump() string
  • func (t *Token) RemoveTashkeels() string

Types

type Aya

type Aya struct {
	Index int    `xml:"index,attr,str"`
	Text  string `xml:"text,attr"`
}

func (*Aya) RemoveTashkeels

func (a *Aya) RemoveTashkeels() string

func (*Aya) Tokens

func (a *Aya) Tokens() []Token

type Character

type Character struct {
	Letter    rune
	Tashkeels []rune
}

type Quran

type Quran struct {
	XMLName xml.Name `xml:"quran"`
	Suras   []Sura   `xml:"sura"`
}

Quran represents the whole scripture

type Sura

type Sura struct {
	Index int    `xml:"index,attr,str"`
	Name  string `xml:"name,attr"`
	Ayas  []Aya  `xml:"aya"`
}

type Token

type Token struct {
	Text string
}

func (*Token) Characters

func (t *Token) Characters() []Character

func (*Token) Dump

func (t *Token) Dump() string

func (*Token) RemoveTashkeels

func (t *Token) RemoveTashkeels() string