schemaorg

Documentation

Index

• Constants
• type ArticleItem
  • func NewArticleItem(element *html.Node) *ArticleItem
• type BaseThingItem
• type ImageItem
  • func NewImageItem(element *html.Node) *ImageItem
• type OrganizationItem
  • func NewOrganizationItem(element *html.Node) *OrganizationItem
• type Parser
  • func NewParser(root *html.Node, timingInfo *data.TimingInfo) *Parser
  • func (ps *Parser) Article() *data.MarkupArticle
  • func (ps *Parser) Author() string
  • func (ps *Parser) Copyright() string
  • func (ps *Parser) Description() string
  • func (ps *Parser) Images() []data.MarkupImage
  • func (ps *Parser) OptOut() bool
  • func (ps *Parser) Publisher() string
  • func (ps *Parser) Title() string
  • func (ps *Parser) Type() string
  • func (ps *Parser) URL() string
• type PersonItem
  • func NewPersonItem(element *html.Node) *PersonItem
• type SchemaType
• type ThingItem
• type UnsupportedItem
  • func NewUnsupportedItem(element *html.Node) *UnsupportedItem

Constants

const (
	NameProp            = "name"
	URLProp             = "url"
	DescriptionProp     = "description"
	ImageProp           = "image"
	HeadlineProp        = "headline"
	PublisherProp       = "publisher"
	CopyrightHolderProp = "copyrightHolder"
	CopyrightYearProp   = "copyrightYear"
	ContentURLProp      = "contentUrl"
	EncodingFormatProp  = "encodingFormat"
	CaptionProp         = "caption"
	RepresentativeProp  = "representativeOfPage"
	WidthProp           = "width"
	HeightProp          = "height"
	DatePublishedProp   = "datePublished"
	DateModifiedProp    = "dateModified"
	AuthorProp          = "author"
	CreatorProp         = "creator"
	SectionProp         = "articleSection"
	AssociatedMediaProp = "associatedMedia"
	EncodingProp        = "encoding"
	FamilyNameProp      = "familyName"
	GivenNameProp       = "givenName"
	LegalNameProp       = "legalName"
	AuthorRel           = "author"
)

Types

type ArticleItem

type ArticleItem struct {
	BaseThingItem
}

func NewArticleItem

func NewArticleItem(element *html.Node) *ArticleItem

type BaseThingItem

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

type ImageItem

type ImageItem struct {
	BaseThingItem
}

func NewImageItem

func NewImageItem(element *html.Node) *ImageItem

type OrganizationItem

type OrganizationItem struct {
	BaseThingItem
}

func NewOrganizationItem

func NewOrganizationItem(element *html.Node) *OrganizationItem

type Parser

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

Parser recognizes and parses schema.org markup tags, and returns the properties that matter to distilled content. Schema.org markup (http://schema.org) is based on the microdata format (http://www.whatwg.org/specs/web-apps/current-work/multipage/microdata.html).

For the basic Schema.org Thing type, the basic properties are: name, url, description, image. In addition, for each type that we support, we also parse more specific properties:

• Article: headline (i.e. title), publisher, copyright year, copyright holder, date published, date modified, author, article section
• ImageObject: headline (i.e. title), publisher, copyright year, copyright holder, content url, encoding format, caption, representative of page, width, height
• Person: family name, given name
• Organization: legal name.

The value of a Schema.Org property can be a Schema.Org type, i.e. embedded. E.g., the author or publisher of article or publisher of image could be a Schema.Org Person or Organization type; in fact, this is the reason we support Person and Organization types.

func NewParser

func NewParser(root *html.Node, timingInfo *data.TimingInfo) *Parser

func (*Parser) Article

func (ps *Parser) Article() *data.MarkupArticle

func (*Parser) Author

func (ps *Parser) Author() string

func (*Parser) Copyright

func (ps *Parser) Copyright() string

func (*Parser) Description

func (ps *Parser) Description() string

func (*Parser) Images

func (ps *Parser) Images() []data.MarkupImage

func (*Parser) OptOut

func (ps *Parser) OptOut() bool

func (*Parser) Publisher

func (ps *Parser) Publisher() string

func (*Parser) Title

func (ps *Parser) Title() string

func (*Parser) Type

func (ps *Parser) Type() string

func (*Parser) URL

func (ps *Parser) URL() string

type PersonItem

type PersonItem struct {
	BaseThingItem
}

func NewPersonItem

func NewPersonItem(element *html.Node) *PersonItem

type SchemaType

type SchemaType uint

const (
	Unsupported SchemaType = iota
	Image
	Article
	Person
	Organization
)

type ThingItem

type ThingItem interface {
	// contains filtered or unexported methods
}

type UnsupportedItem

type UnsupportedItem struct {
	BaseThingItem
}

func NewUnsupportedItem

func NewUnsupportedItem(element *html.Node) *UnsupportedItem