manifest

package

Go to main page

Versions in this module

v0

v0.11.0

Jul 30, 2025

Changes in this version

+ type AltIdentifier struct

+ Scheme string

+ Value string

+ func AltIdentifierFromJSON(rawJson any) (*AltIdentifier, error)

+ func AltIdentifierFromJSONArray(rawJsonArray any) ([]AltIdentifier, error)

+ func (s *AltIdentifier) UnmarshalJSON(data []byte) error

+ func (s AltIdentifier) MarshalJSON() ([]byte, error)

type Contributor

+ AltIdentifier []AltIdentifier

+ type Layout string

+ const LayoutFixed

+ const LayoutNone

+ const LayoutReflowable

+ const LayoutScrolled

+ func (l Layout) EffectiveValue(profiles Profiles) Layout

type Metadata

+ AltIdentifiers []AltIdentifier

+ Layout Layout

+ func (m Metadata) EffectiveLayout() Layout

type Page

+ const PageNone

type ReadingProgression

+ const None

v0.10.2

Jul 11, 2025

v0.10.1

May 8, 2025

v0.10.0

May 8, 2025

Changes in this version

type HashAlgorithm

+ const HashAlgorithmBlake3

type HashList

+ func (h HashList) Find(algorithm HashAlgorithm) (HashValue, bool)

+ func (h HashList) ToJSONArray() []interface{}

type HashValue

+ func (h HashValue) Equal(other HashValue) bool

+ func (h HashValue) String() string

v0.9.0

Apr 30, 2025

Changes in this version

type A11yFeature

+ const A11yFeaturePageBreakMarkers

+ type HashAlgorithm string

+ const HashAlgorithmBlake2b

+ const HashAlgorithmBlake2s

+ const HashAlgorithmCRC32

+ const HashAlgorithmMD5

+ const HashAlgorithmPhashDCT

+ const HashAlgorithmSHA1

+ const HashAlgorithmSHA256

+ const HashAlgorithmSHA512

+ const HashAlgorithmXXH3

+ type HashList []HashValue

+ func HashListFromJSONArray(rawJsonArray []interface{}) (HashList, error)

+ func (h *HashList) Deduplicate()

+ func (h HashList) Value(algorithm HashAlgorithm) (string, bool)

+ type HashValue struct

+ Algorithm HashAlgorithm

+ Value string

type Link

+ Size uint

type Properties

+ func (p Properties) Hash() HashList

v0.8.1

Feb 25, 2025

v0.8.0

Feb 24, 2025

Changes in this version

+ var ToolkitVersionKey = "https://github.com/readium/go-toolkit/releases"

type A11yProfile

+ const EPUBA11y11WCAG20A

+ const EPUBA11y11WCAG20AA

+ const EPUBA11y11WCAG20AAA

+ const EPUBA11y11WCAG21A

+ const EPUBA11y11WCAG21AA

+ const EPUBA11y11WCAG21AAA

+ const EPUBA11y11WCAG22A

+ const EPUBA11y11WCAG22AA

+ const EPUBA11y11WCAG22AAA

+ func (p A11yProfile) Compare(other A11yProfile) int

+ type A11yProfileList []A11yProfile

+ func (l A11yProfileList) Sort()

v0.7.1

Feb 7, 2025

Changes in this version

type A11yExemption

+ const A11yExemptionEAADisproportionateBurden

type Metadata

+ TDM *TDM

+ type TDM struct

+ Policy string

+ Reservation TDMReservation

+ func TDMFromJSON(rawJSON map[string]interface{}) (*TDM, error)

+ func (t *TDM) IsEmpty() bool

+ func (t *TDM) UnmarshalJSON(data []byte) error

+ type TDMReservation string

+ const TDMReservationAll

+ const TDMReservationNone

+ func (t TDMReservation) String() string

v0.7.0

Feb 1, 2025

Changes in this version

type A11y

+ Exemptions []A11yExemption

+ type A11yExemption string

+ const A11yExemptionEAAFundamentalAlteration

+ const A11yExemptionEAAMicroenterprise

+ const A11yExemptionEAASisproportionateBurden

+ func A11yExemptionsFromStrings(strings []string) []A11yExemption

type A11yFeature

+ const A11yFeaturePageNavigation

v0.6.1

Jan 11, 2025

v0.6.0

Dec 16, 2024

Changes in this version

type Contributor

+ func (c Contributor) Copy(transformer ManifestTransformer) Contributor

type Contributors

+ func (c Contributors) Copy(transformer ManifestTransformer) Contributors

+ type HREF struct

+ func MustNewHREFFromString(href string, templated bool) HREF

+ func NewHREF(href url.URL) HREF

+ func NewHREFFromString(href string, templated bool) (HREF, error)

+ func (h HREF) Copy(transformer ManifestTransformer) HREF

+ func (h HREF) IsTemplated() bool

+ func (h HREF) Parameters() []string

+ func (h HREF) Resolve(base url.URL, parameters map[string]string) url.URL

+ func (h HREF) ResolveTo(baseURL url.URL) HREF

+ func (h HREF) String() string

+ type HREFNormalizer struct

+ func NewHREFNormalizer(baseURL url.URL) HREFNormalizer

+ func (n HREFNormalizer) TransformHREF(href HREF) HREF

+ func (n HREFNormalizer) TransformLink(link Link) Link

+ func (n HREFNormalizer) TransformManifest(manifest Manifest) Manifest

+ func (n HREFNormalizer) TransformMetadata(metadata Metadata) Metadata

type Link

+ func (l Link) Copy(transformer ManifestTransformer) Link

+ func (l Link) NormalizeHREFsToBase(baseURL url.URL) Link

+ func (l Link) URL(base url.URL, parameters map[string]string) url.URL

type LinkList

+ func (ll LinkList) Copy(transformer ManifestTransformer) LinkList

+ func (ll LinkList) Flatten() LinkList

type Locator

+ MediaType mediatype.MediaType

type Manifest

+ func (m Manifest) Copy(transformer ManifestTransformer) Manifest

+ func (m Manifest) NormalizeHREFsToBase(baseURL url.URL) Manifest

+ func (m Manifest) NormalizeHREFsToSelf() Manifest

+ type ManifestTransformer interface

+ TransformHREF func(href HREF) HREF

+ TransformLink func(link Link) Link

+ TransformManifest func(manifest Manifest) Manifest

+ TransformMetadata func(metadata Metadata) Metadata

type Metadata

+ func (m Metadata) Copy(transformer ManifestTransformer) Metadata

type PublicationCollection

+ func (p PublicationCollection) Copy(transformer ManifestTransformer) PublicationCollection

type PublicationCollectionMap

+ func (p PublicationCollectionMap) Copy(transformer ManifestTransformer) PublicationCollectionMap

type Subject

+ func (s Subject) Copy(transformer ManifestTransformer) Subject

type Text

+ func (t Text) Substring(start, end int64) Text

v0.5.0

Oct 9, 2024

Changes in this version

+ type GuidedNavigationDocument struct

+ Guided []GuidedNavigationObject

+ Links []Link

+ type GuidedNavigationObject struct

+ AudioRef string

+ Children []GuidedNavigationObject

+ ImgRef string

+ Role []string

+ Text string

+ TextRef string

+ type MediaOverlay struct

+ ActiveClass string

+ PlaybackActiveClass string

type Metadata

+ MediaOverlay *MediaOverlay

v0.4.4

May 29, 2024

v0.4.3

May 29, 2024

v0.4.2

May 29, 2024

v0.4.1

May 29, 2024

Changes in this version

+ const InferredAccessibilityMetadataKey

+ const PresentationDefaultClipped

+ const PresentationDefaultContinuous

+ const ProfileAudiobook

+ const ProfileDivina

+ const ProfileEPUB

+ const ProfilePDF

+ const UndefinedLanguage

+ const WebpubManifestContext

+ func IsHorizontal(progression ReadingProgression) *bool

+ func LinkHrefNormalizerIdentity(href string) (string, error)

+ type A11y struct

+ AccessModes []A11yAccessMode

+ AccessModesSufficient [][]A11yPrimaryAccessMode

+ Certification *A11yCertification

+ ConformsTo []A11yProfile

+ Features []A11yFeature

+ Hazards []A11yHazard

+ Summary string

+ func A11yFromJSON(rawJSON map[string]interface{}) (*A11y, error)

+ func NewA11y() A11y

+ func (a *A11y) Merge(other *A11y)

+ func (a A11y) IsEmpty() bool

+ func (e *A11y) UnmarshalJSON(data []byte) error

+ type A11yAccessMode string

+ const A11yAccessModeAuditory

+ const A11yAccessModeChartOnVisual

+ const A11yAccessModeChemOnVisual

+ const A11yAccessModeColorDependent

+ const A11yAccessModeDiagramOnVisual

+ const A11yAccessModeMathOnVisual

+ const A11yAccessModeMusicOnVisual

+ const A11yAccessModeTactile

+ const A11yAccessModeTextOnVisual

+ const A11yAccessModeTextual

+ const A11yAccessModeVisual

+ func A11yAccessModesFromStrings(strings []string) []A11yAccessMode

+ type A11yCertification struct

+ CertifiedBy string

+ Credential string

+ Report string

+ func (c A11yCertification) IsEmpty() bool

+ type A11yFeature string

+ const A11yFeatureAlternativeText

+ const A11yFeatureAnnotations

+ const A11yFeatureAria

+ const A11yFeatureAudioDescription

+ const A11yFeatureBookmarks

+ const A11yFeatureBraille

+ const A11yFeatureCaptions

+ const A11yFeatureChemML

+ const A11yFeatureDescribedMath

+ const A11yFeatureDisplayTransformability

+ const A11yFeatureHighContrastAudio

+ const A11yFeatureHighContrastDisplay

+ const A11yFeatureIndex

+ const A11yFeatureLargePrint

+ const A11yFeatureLatex

+ const A11yFeatureLongDescription

+ const A11yFeatureMathML

+ const A11yFeatureNone

+ const A11yFeaturePrintPageNumbers

+ const A11yFeatureReadingOrder

+ const A11yFeatureRubyAnnotations

+ const A11yFeatureSignLanguage

+ const A11yFeatureStructuralNavigation

+ const A11yFeatureSynchronizedAudioText

+ const A11yFeatureTTSMarkup

+ const A11yFeatureTableOfContents

+ const A11yFeatureTactileGraphic

+ const A11yFeatureTactileObject

+ const A11yFeatureTaggedPDF

+ const A11yFeatureTimingControl

+ const A11yFeatureTranscript

+ const A11yFeatureUnlocked

+ func A11yFeaturesFromStrings(strings []string) []A11yFeature

+ type A11yHazard string

+ const A11yHazardFlashing

+ const A11yHazardMotionSimulation

+ const A11yHazardNoFlashingHazard

+ const A11yHazardNoMotionSimulationHazard

+ const A11yHazardNoSoundHazard

+ const A11yHazardNone

+ const A11yHazardSound

+ const A11yHazardUnknown

+ func A11yHazardsFromStrings(strings []string) []A11yHazard

+ type A11yPrimaryAccessMode string

+ const A11yPrimaryAccessModeAuditory

+ const A11yPrimaryAccessModeTactile

+ const A11yPrimaryAccessModeTextual

+ const A11yPrimaryAccessModeVisual

+ func A11yPrimaryAccessModesFromStrings(strings []string) []A11yPrimaryAccessMode

+ type A11yProfile string

+ const EPUBA11y10WCAG20A

+ const EPUBA11y10WCAG20AA

+ const EPUBA11y10WCAG20AAA

+ func A11yProfilesFromStrings(strings []string) []A11yProfile

+ type Collection = Contributor

+ type Collections = Contributors

+ type Contributor struct

+ Identifier string

+ Links []Link

+ LocalizedName LocalizedString

+ LocalizedSortAs *LocalizedString

+ Position *float64

+ Roles Strings

+ func ContributorFromJSON(rawJson interface{}, normalizeHref LinkHrefNormalizer) (*Contributor, error)

+ func ContributorFromJSONArray(rawJsonArray interface{}, normalizeHref LinkHrefNormalizer) ([]Contributor, error)

+ func (c *Contributor) UnmarshalJSON(data []byte) error

+ func (c Contributor) MarshalJSON() ([]byte, error)

+ func (c Contributor) Name() string

+ func (c Contributor) SortAs() string

+ type Contributors []Contributor

+ func (c Contributors) MarshalJSON() ([]byte, error)

+ type EPUBLayout string

+ const EPUBLayoutFixed

+ const EPUBLayoutReflowable

+ type Encryption struct

+ Algorithm string

+ Compression string

+ OriginalLength int64

+ Profile string

+ Scheme string

+ func EncryptionFromJSON(rawJson map[string]interface{}) (*Encryption, error)

+ func (e *Encryption) UnmarshalJSON(data []byte) error

+ func (m Encryption) ToMap() map[string]interface{}

+ type Fit string

+ const FitContain

+ const FitCover

+ const FitHeight

+ const FitWidth

+ type Link struct

+ Alternates LinkList

+ Bitrate float64

+ Children LinkList

+ Duration float64

+ Height uint

+ Href string

+ Languages Strings

+ Properties Properties

+ Rels Strings

+ Templated bool

+ Title string

+ Type string

+ Width uint

+ func LinkFromJSON(rawJson map[string]interface{}, normalizeHref LinkHrefNormalizer) (*Link, error)

+ func LinksFromJSONArray(rawJsonArray []interface{}, normalizeHref LinkHrefNormalizer) ([]Link, error)

+ func (l *Link) UnmarshalJSON(b []byte) error

+ func (l Link) ExpandTemplate(parameters map[string]string) Link

+ func (l Link) MarshalJSON() ([]byte, error)

+ func (l Link) MediaType() mediatype.MediaType

+ func (l Link) TemplateParameters() []string

+ func (l Link) ToURL(baseURL string) string

+ type LinkHrefNormalizer func(href string) (string, error)

+ type LinkList []Link

+ func (ll LinkList) AllAreAudio() bool

+ func (ll LinkList) AllAreBitmap() bool

+ func (ll LinkList) AllAreHTML() bool

+ func (ll LinkList) AllAreVideo() bool

+ func (ll LinkList) AllAreVisual() bool

+ func (ll LinkList) AllMatchMediaType(mt ...*mediatype.MediaType) bool

+ func (ll LinkList) FilterByMediaType(mt ...*mediatype.MediaType) LinkList

+ func (ll LinkList) FilterByRel(rel string) LinkList

+ func (ll LinkList) FirstWithHref(href string) *Link

+ func (ll LinkList) FirstWithMediaType(mt *mediatype.MediaType) *Link

+ func (ll LinkList) FirstWithRel(rel string) *Link

+ func (ll LinkList) IndexOfFirstWithHref(href string) int

+ type LocalizedString struct

+ Translations map[string]string

+ func LocalizedStringFromJSON(d interface{}) (*LocalizedString, error)

+ func NewLocalizedStringFromString(value string) LocalizedString

+ func NewLocalizedStringFromStrings(strings map[string]string) LocalizedString

+ func (l *LocalizedString) DefaultTranslation() string

+ func (l *LocalizedString) GetOrFallback(language string) string

+ func (l *LocalizedString) Length() int

+ func (l *LocalizedString) SetDefaultTranslation(value string)

+ func (l *LocalizedString) SetTranslation(language string, value string)

+ func (l *LocalizedString) String() string

+ func (l *LocalizedString) UnmarshalJSON(data []byte) error

+ func (l LocalizedString) MarshalJSON() ([]byte, error)

+ type Locations struct

+ Fragments []string

+ OtherLocations map[string]interface{}

+ Position *uint

+ Progression *float64

+ TotalProgression *float64

+ func LocationsFromJSON(rawJson map[string]interface{}) (l Locations, err error)

+ func (l *Locations) UnmarshalJSON(b []byte) error

+ func (l Locations) CSSSelector() string

+ func (l Locations) MarshalJSON() ([]byte, error)

+ type Locator struct

+ Href string

+ Locations Locations

+ Text Text

+ Title string

+ Type string

+ func LocatorFromJSON(rawJson map[string]interface{}) (Locator, error)

+ func (l *Locator) UnmarshalJSON(b []byte) error

+ func (l Locator) MarshalJSON() ([]byte, error)

+ type Manifest struct

+ Context Strings

+ Links LinkList

+ Metadata Metadata

+ ReadingOrder LinkList

+ Resources LinkList

+ Subcollections PublicationCollectionMap

+ TableOfContents LinkList

+ func ManifestFromJSON(rawJson map[string]interface{}, packaged bool) (*Manifest, error)

+ func (m *Manifest) UnmarshalJSON(b []byte) error

+ func (m Manifest) ConformsTo(profile Profile) bool

+ func (m Manifest) LinkWithHref(href string) *Link

+ func (m Manifest) LinkWithRel(rel string) *Link

+ func (m Manifest) LinksWithRel(rel string) []Link

+ func (m Manifest) LocatorFromLink(link Link) *Locator

+ func (m Manifest) MarshalJSON() ([]byte, error)

+ func (m Manifest) ToMap(selfLink *Link) map[string]interface{}

+ type Metadata struct

+ Accessibility *A11y

+ Artists Contributors

+ Authors Contributors

+ BelongsTo map[string]Collections

+ Colorists Contributors

+ ConformsTo Profiles

+ Contributors Contributors

+ Description string

+ Duration *float64

+ Editors Contributors

+ Identifier string

+ Illustrators Contributors

+ Imprints Contributors

+ Inkers Contributors

+ Languages Strings

+ Letterers Contributors

+ LocalizedSortAs *LocalizedString

+ LocalizedSubtitle *LocalizedString

+ LocalizedTitle LocalizedString

+ Modified *time.Time

+ Narrators Contributors

+ NumberOfPages *uint

+ OtherMetadata map[string]interface{}

+ Pencilers Contributors

+ Presentation *Presentation

+ Published *time.Time

+ Publishers Contributors

+ ReadingProgression ReadingProgression

+ Subjects []Subject

+ Translators Contributors

+ Type string

+ func MetadataFromJSON(rawJson map[string]interface{}, normalizeHref LinkHrefNormalizer) (*Metadata, error)

+ func (m *Metadata) UnmarshalJSON(b []byte) error

+ func (m Metadata) BelongsToCollections() []Collection

+ func (m Metadata) BelongsToSeries() []Collection

+ func (m Metadata) EffectiveReadingProgression() ReadingProgression

+ func (m Metadata) InferredAccessibility() *A11y

+ func (m Metadata) MarshalJSON() ([]byte, error)

+ func (m Metadata) SetOtherMetadata(key string, value interface{}) error

+ func (m Metadata) SortAs() string

+ func (m Metadata) Subtitle() string

+ func (m Metadata) Title() string

+ type Orientation string

+ const OrientationAuto

+ const OrientationLandscape

+ const OrientationPortrait

+ type Overflow string

+ const OverflowAuto

+ const OverflowPaginated

+ const OverflowScrolled

+ type Page string

+ const PageCenter

+ const PageLeft

+ const PageRight

+ type Presentation struct

+ Clipped *bool

+ Continuous *bool

+ Fit *Fit

+ Layout *EPUBLayout

+ Orientation *Orientation

+ Overflow *Overflow

+ Spread *Spread

+ func NewPresentation() *Presentation

+ func (p *Presentation) UnmarshalJSON(data []byte) error

+ func (p Presentation) LayoutOf(link Link) EPUBLayout

+ func (p Presentation) MarshalJSON() ([]byte, error)

+ type Profile string

+ type Profiles []Profile

+ func (p Profiles) MarshalJSON() ([]byte, error)

+ type Properties map[string]interface

+ func (p *Properties) Get(key string) interface{}

+ func (p *Properties) UnmarshalJSON(data []byte) error

+ func (p Properties) Clipped() *bool

+ func (p Properties) Contains() []string

+ func (p Properties) Encryption() *Encryption

+ func (p Properties) Fit() Fit

+ func (p Properties) GetBool(key string) *bool

+ func (p Properties) GetString(key string) string

+ func (p Properties) Layout() EPUBLayout

+ func (p Properties) Orientation() Orientation

+ func (p Properties) Overflow() Overflow

+ func (p Properties) Page() Page

+ func (p Properties) Spread() Spread

+ func PropertiesFromJSON(rawJson interface{}) (Properties, error)

+ type PublicationCollection struct

+ Links []Link

+ Metadata map[string]interface{}

+ Subcollections PublicationCollectionMap

+ func PublicationCollectionFromJSON(rawJson interface{}, normalizeHref LinkHrefNormalizer) (*PublicationCollection, error)

+ func (pc *PublicationCollection) UnmarshalJSON(b []byte) error

+ func (pc PublicationCollection) MarshalJSON() ([]byte, error)

+ type PublicationCollectionMap map[string][]PublicationCollection

+ func PublicationCollectionsFromJSON(rawJson map[string]interface{}, normalizeHref LinkHrefNormalizer) (PublicationCollectionMap, error)

+ func (pcm *PublicationCollectionMap) UnmarshalJSON(b []byte) error

+ func (pcm PublicationCollectionMap) MarshalJSON() ([]byte, error)

+ type ReadingProgression string

+ const Auto

+ const BTT

+ const LTR

+ const RTL

+ const TTB

+ type Spread string

+ const SpreadAuto

+ const SpreadBoth

+ const SpreadLandscape

+ const SpreadNone

+ type Strings []string

+ func (s Strings) MarshalJSON() ([]byte, error)

+ type Subject struct

+ Code string

+ Links []Link

+ LocalizedName LocalizedString

+ LocalizedSortAs *LocalizedString

+ Scheme string

+ func SubjectFromJSON(rawJson interface{}, normalizeHref LinkHrefNormalizer) (*Subject, error)

+ func SubjectFromJSONArray(rawJsonArray interface{}, normalizeHref LinkHrefNormalizer) ([]Subject, error)

+ func (s *Subject) UnmarshalJSON(data []byte) error

+ func (s Subject) MarshalJSON() ([]byte, error)

+ func (s Subject) Name() string

+ func (s Subject) SortAs() string

+ type Text struct

+ After string

+ Before string

+ Highlight string

+ func TextFromJSON(rawJson map[string]interface{}) (t Text)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL