links

type Check struct {
	// contains filtered or unexported fields
}

type Func func(ctx context.Context, locale string) ([]Source, error)

type Index struct {
	// contains filtered or unexported fields
}

type Link struct {
	// Module is the instance key of the module the content belongs to;
	// empty for a page.
	Module string
	// Locale is the language of the content.
	Locale string
	// Source is the content the link is in; it is shared by its links.
	Source *Source
	// Href is the link as written, such as "../contact#form".
	Href string
	// Address is where the link leads on the site, cleaned and without
	// query and fragment, such as "/en/contact".
	Address string
	// Page is the ID of the published page that answers at Address, or of
	// the module page above it; empty when none does.
	Page string
	// Found reports whether the site answers at Address with a page: a
	// published page, an address below a module page, which the module
	// answers, or the search screen.
	Found bool
}

type Options struct {
	// BaseURL is the site's address, such as "https://example.com": full
	// URLs to its host are links on the site.
	BaseURL string
	// IsCorePath reports the addresses the app serves itself, such as the
	// media files and visitor actions (webthings.App.IsCorePath): links to
	// them do not lead to pages.
	IsCorePath func(address string) bool
	// Version moves on with every change in this process of what visitors
	// see, such as the app's output cache version: the index is made again
	// once it did. Nil only follows the page tree and TTL.
	Version func() uint64
	// TTL is how long an index is kept at most, so changes by other
	// processes show; zero is 30 seconds, less than zero keeps none.
	TTL time.Duration
}

type Redirector interface {
	// Redirected returns where a redirect sends the visitors of address,
	// an address on the site such as "/en/about"; ok is false when no
	// redirect has it.
	Redirected(ctx context.Context, address string) (target string, ok bool)
	// Redirect sends the visitors of address to target, an address on the
	// site, from now on, with a permanent redirect (301), replacing a
	// redirect of address to elsewhere. A redirect of target itself, which
	// would hide the page that is there now, is removed.
	Redirect(ctx context.Context, address, target string) error
}

type Source struct {
	// ID identifies the content in its module, such as a post's ID; for a
	// page it is the page's ID.
	ID string
	// Title names the content for editors.
	Title string
	// URL is the content's own address on the site, such as
	// "/en/news/hello": its relative links lead from there. Content without
	// an address of its own, such as a banner, leaves it empty; its
	// relative links lead from the home page of its language.
	URL string
	// EditURL opens the content in the admin, such as the editor of a post
	// (see webthings.Env.AdminURL). Pages leave it empty: the admin knows
	// their editor.
	EditURL string
	// Markdown holds the content's texts in Markdown, such as a body; their
	// links count (see markdown.Links).
	Markdown []string
	// Addresses are the content's link fields, such as a button's address.
	Addresses []string
	// Revision names the revision Markdown comes from, for content with
	// revisions: the links found in it are then kept with the revision, as
	// those of pages are. Empty finds them again for every index.
	Revision string
}