dict

package

v0.0.0-...-fad336a Latest Latest Go to latest Published: Mar 30, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pgaskin/lithiumpatch

Links

Open Source Insights

Documentation ¶

Index ¶

func Build(path string) error
func BuildDict(path string, dict []Entry) error
func Dicts() []string
func JS() []byte
func Normalize(term string) string
func Parse(verbose bool) error
func Register(name string, parse ParseFunc)
type Entry
type EntryMeaning
type EntryMeaningItem
type ParseFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(path string) error

Build builds all dictionaries into subdirectories of the provided path, which should be empty.

func BuildDict ¶

func BuildDict(path string, dict []Entry) error

BuildDict builds a single dictionary into the provided path.

func Dicts ¶

func Dicts() []string

Dicts gets the registered dictionary names.

func JS ¶

func JS() []byte

JS gets the javascript for reading the parsed dictionaries.

func Normalize ¶

func Normalize(term string) string

Normalize reduces term to a limited set of ASCII characters.

func Parse ¶

func Parse(verbose bool) error

Parse parses dictionaries.

func Register ¶

func Register(name string, parse ParseFunc)

Register adds a dictionary to be parsed when Parse is called.

Types ¶

type Entry ¶

type Entry struct {
	Terms         []string       // matched terms (will be normalized)
	Name          string         //
	Pronunciation string         // optional
	MeaningGroups []EntryMeaning //
	Info          string         // optional; e.g., etymology
	Source        string         // optional
}

Entry contains a single result.

Name • Pronunciation
...
Info
Source

type EntryMeaning ¶

type EntryMeaning struct {
	Info         []string           // optional
	Meanings     []EntryMeaningItem //
	WordVariants []string           // for sorting results by relevance; not used for matching or display, so it can be imperfect (note that the headword is also checked first)
}

EntryMeaning contains the definitions for one sub-form of a word.

Info[0] — Info[*] <-- like parts of speech, word forms, etc

[Meanings[0].Tags[0]] [Meanings[0].Tags[*]] Meanings[0].Text Meanings[0].Example <-- can be disabled
Meanings[*]

type EntryMeaningItem ¶

type EntryMeaningItem struct {
	Tags     []string // optional
	Text     string   //
	Examples []string // optional
}

EntryMeaningItem contains a single definition.

type ParseFunc ¶

type ParseFunc func() ([]Entry, error)

ParseFunc parses a dictionary.

Source Files ¶

View all Source files

dict.go

Directories ¶

Path	Synopsis
edgedict
webster1913

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL