HammeriteManualSearchHit

Editor. Inherits RefCounted

One result of HammeriteManual.search().

Properties

Property descriptions

location

var location: String

Where to go: <section>/<page>.md, with #anchor when a heading is what matched.

score

var score: int

How well it matched; higher is better. Only meaningful against other hits of the same search.

section_title

var section_title: String

The title of the section the page is in, for a result list that mixes sections.

snippet

var snippet: String

Up to about 160 characters of the page's text around the first match, with ellipses where it was cut.

title

var title: String

The page's title.