bibnotes

Documentation

Overview

Package for

Index

• type BibNotesClient
  • func LoadBibNotes(file2RefReader, refNo2ParallelReader, refNo2TransReader io.Reader) (BibNotesClient, error)
• type ParellelRef
• type TransRef

Types

type BibNotesClient

type BibNotesClient interface {

	// Get references for parallel texts for the given collection file name
	GetParallelRefs(fileName string) []ParellelRef

	// Get references for English translations for the given collection file name
	GetTransRefs(fileName string) []TransRef
}

Load the bibliographic notes database

func LoadBibNotes

func LoadBibNotes(file2RefReader, refNo2ParallelReader, refNo2TransReader io.Reader) (BibNotesClient, error)

Load the bibliographic notes database

type ParellelRef

type ParellelRef struct {
	Lang string // Parallel language
	Ref  string // Harvard style citation, may have markup
}

ParellelRef holds information on references for parallel versions of texts These may be Chinese-Chinese, Chinese-Sanskrit, etc)

type TransRef

type TransRef struct {
	Kind string // full or partial
	Ref  string // Harvard style citation, may have markup
}

TransRef holds information on references for English translations of texts