entry

Documentation

Overview

Format the list of sub entries for any given entry

Index

• type Entry
• type ExtractDeps
  • func (d *ExtractDeps) ExtractEntries(files []string) error
• type ListDeps
  • func (d *ListDeps) List(files []string) ([]string, error)

Types

type Entry

type Entry struct {
	Href         string
	Backlinks    []listing.Listing
	Relatedlinks []listing.Listing
	Body         []byte
	Metadata     parse.Metadata
}

An entry's data, containing: the metadata, the html body, the backlinks (entries that mention this entry) the related links (other entries that share tags), and the href.

type ExtractDeps

type ExtractDeps struct {
	Config   *config.Config
	InDir    string
	OutDir   string
	Entries  map[string]Entry
	Assets   map[string]bool
	Tags     []tag.Tag
	Metadata parse.Metadata
}

Required dependencies

func (*ExtractDeps) ExtractEntries

func (d *ExtractDeps) ExtractEntries(files []string) 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

type ListDeps

type ListDeps struct {
	Config   *config.Config
	Entries  map[string]Entry
	Missing  map[string]bool
	Skip     map[string]bool
	Listings map[string][]listing.Listing
	InDir    string
}

Required dependencies

func (*ListDeps) List

func (d *ListDeps) List(files []string) (
	[]string,
	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