extract

Documentation

Index

• type Meta
  • func (m *Meta) ExtractAllListings(files []string) ([]string, map[string][]listing.Listing, map[string]bool, error)
  • func (m *Meta) ExtractEntry(files []string) (map[string]entry.Entry, []tag.Tag, map[string]bool, error)

Types

type Meta

type Meta struct {
	C      *config.Config
	InDir  string
	OutDir string
	D      map[string]entry.Entry
	M      parse.Metadata
}

func (*Meta) ExtractAllListings

func (m *Meta) ExtractAllListings(files []string) (
	[]string,
	map[string][]listing.Listing,
	map[string]bool,
	error,
)

The main callable function for extract.go to call all the relevant functions to populate listing, update files to add missing indexes, and skipped files

func (*Meta) ExtractEntry

func (m *Meta) ExtractEntry(files []string) (
	map[string]entry.Entry,
	[]tag.Tag,
	map[string]bool,
	error,
)

Process files to build up the entry data for all files, the tags data, and the linked internal asset. Exclusive calls to parse.* are made here. Calls parse.ParseMetadata() to grab metadata. Calls parse.ParseSource() to grab html body. Calls parse.ParseInternalLinks() to grab backlinks and internal links. Additionally construct the backlinks, relatedlinks, asset map and tags slice

These are the returned data:

d: entry.Entry (key: entry absolute path)

i: linked internal assets (key: asset absolute path)