inspector

package
v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2026 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Image 

type Image struct {
	Filesystem fs.FS
	Algorithms []manifest.HashAlgorithm
}

func (*Image) InspectHREF 

func (n *Image) InspectHREF(href manifest.HREF) (*manifest.HREF, error)

InspectHREF implements Inspector 

func (n *Image) InspectLink(link manifest.Link) (*manifest.Link, error)

InspectLink implements Inspector

func (*Image) InspectManifest 

func (n *Image) InspectManifest(manifest manifest.Manifest) (*manifest.Manifest, error)

InspectManifest implements Inspector

func (*Image) InspectMetadata 

func (n *Image) InspectMetadata(metadata manifest.Metadata) (*manifest.Metadata, error)

InspectMetadata implements Inspector

func (*Image) Name 

func (n *Image) Name() string

Name implements Inspector

type ImageReference 

type ImageReference struct {
	Href        url.URL                                      `json:"href"`
	Description guidednavigation.GuidedNavigationDescription `json:"description,omitempty"`
	Role        []guidednavigation.GuidedNavigationRole      `json:"role,omitempty"`
}

func (ImageReference) MarshalJSON 

func (r ImageReference) MarshalJSON() ([]byte, error)

type ImageUsage 

type ImageUsage struct {
	GuidedNavigationService pub.GuidedNavigationService
	// contains filtered or unexported fields
}

func (*ImageUsage) InspectHREF 

func (n *ImageUsage) InspectHREF(href manifest.HREF) (*manifest.HREF, error)

InspectHREF implements Inspector 

func (n *ImageUsage) InspectLink(link manifest.Link) (*manifest.Link, error)

InspectLink implements Inspector

func (*ImageUsage) InspectManifest 

func (n *ImageUsage) InspectManifest(m manifest.Manifest) (*manifest.Manifest, error)

InspectManifest implements Inspector

func (*ImageUsage) InspectMetadata 

func (n *ImageUsage) InspectMetadata(metadata manifest.Metadata) (*manifest.Metadata, error)

InspectMetadata implements Inspector

func (*ImageUsage) Name 

func (n *ImageUsage) Name() string

Name implements Inspector

type Inspector 

type Inspector interface {
	Name() string
	InspectHREF(href manifest.HREF) (*manifest.HREF, error)
	InspectLink(link manifest.Link) (*manifest.Link, error)
	InspectManifest(manifest manifest.Manifest) (*manifest.Manifest, error)
	InspectMetadata(metadata manifest.Metadata) (*manifest.Metadata, error)
}

type PageBreakMarkers added in v0.10.1 

type PageBreakMarkers struct {
	GuidedNavigationService pub.GuidedNavigationService
	Mode                    streamer.InferA11yMetadata
	// contains filtered or unexported fields
}

PageBreakMarkers detects page break markers in a publication's (X)HTML documents through their guided navigation representation, and adds the pageBreakMarkers accessibility feature to the manifest when it finds one.

A page break marker is any guided navigation object carrying the guidednavigation.RolePagebreak role, which the HTML converter assigns to elements with epub:type="pagebreak" or role="doc-pagebreak". A single marker is enough for the feature to apply, so scanning stops at the first one found.

Mode selects where the feature is written, mirroring the streamer's own accessibility inference: merged into the metadata's accessibility object, or into the separate inferred accessibility object stored in OtherMetadata. With streamer.InferA11yMetadataNo, the inspector does nothing.

func (*PageBreakMarkers) InspectHREF added in v0.10.1 

func (n *PageBreakMarkers) InspectHREF(href manifest.HREF) (*manifest.HREF, error)

InspectHREF implements Inspector 

func (n *PageBreakMarkers) InspectLink(link manifest.Link) (*manifest.Link, error)

InspectLink implements Inspector

func (*PageBreakMarkers) InspectManifest added in v0.10.1 

func (n *PageBreakMarkers) InspectManifest(m manifest.Manifest) (*manifest.Manifest, error)

InspectManifest implements Inspector

func (*PageBreakMarkers) InspectMetadata added in v0.10.1 

func (n *PageBreakMarkers) InspectMetadata(metadata manifest.Metadata) (*manifest.Metadata, error)

InspectMetadata implements Inspector

func (*PageBreakMarkers) Name added in v0.10.1 

func (n *PageBreakMarkers) Name() string

Name implements Inspector

type Run 

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

func CreateInspection 

func CreateInspection(inspectors []Inspector) *Run

func (*Run) Error 

func (n *Run) Error() error

func (*Run) TransformHREF 

func (n *Run) TransformHREF(href manifest.HREF) manifest.HREF

TransformHREF implements ManifestTransformer 

func (n *Run) TransformLink(link manifest.Link) manifest.Link

TransformLink implements ManifestTransformer

func (*Run) TransformManifest 

func (n *Run) TransformManifest(manifest manifest.Manifest) manifest.Manifest

TransformManifest implements ManifestTransformer

func (*Run) TransformMetadata 

func (n *Run) TransformMetadata(metadata manifest.Metadata) manifest.Metadata

TransformMetadata implements ManifestTransformer

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.