reference

Documentation

Overview

Package reference defines the elements of a <reference> block.

Index

• type Address
• type AddressPostal
• type Author
• type Date
• type Format
• type Front
• type Organization
• type Reference
• type SeriesInfo

Types

type Address

type Address struct {
	Phone  string         `xml:"phone,omitempty"`
	Email  string         `xml:"email,omitempty"`
	URI    string         `xml:"uri,omitempty"`
	Postal *AddressPostal `xml:"postal,omitempty"`
}

Address denotes the address of an RFC author.

type AddressPostal

type AddressPostal struct {
	PostalLine []string `xml:"postalline,omitempty"`

	Streets   []string `xml:"street,omitempty"`
	Cities    []string `xml:"city,omitempty"`
	Codes     []string `xml:"code,omitempty"`
	Countries []string `xml:"country,omitempty"`
	Regions   []string `xml:"region,omitempty"`
}

AddressPostal denotes the postal address of an RFC author.

type Author

type Author struct {
	Fullname     string        `xml:"fullname,attr,omitempty"`
	Initials     string        `xml:"initials,attr,omitempty"`
	Surname      string        `xml:"surname,attr,omitempty"`
	Role         string        `xml:"role,attr,omitempty"`
	Organization *Organization `xml:"organization,omitempty"`
	Address      *Address      `xml:"address,omitempty"`
}

Author is the reference author.

type Date

type Date struct {
	Year  string `xml:"year,attr,omitempty"`
	Month string `xml:"month,attr,omitempty"`
	Day   string `xml:"day,attr,omitempty"`
}

Date is the reference date.

type Format

type Format struct {
	Type   string `xml:"type,attr,omitempty"`
	Target string `xml:"target,attr"`
}

Format is the reference <format>. This is deprecated in RFC 7991, see Section 3.3.

type Front

type Front struct {
	Title   string   `xml:"title"`
	Authors []Author `xml:"author,omitempty"`
	Date    *Date    `xml:"date,omitempty"`
}

Front the reference <front>.

type Organization

type Organization struct {
	Abbrev string `xml:"abbrev,attr,omitempty"`
	Value  string `xml:",chardata"`
}

type Reference

type Reference struct {
	XMLName    xml.Name     `xml:"reference"`
	Anchor     string       `xml:"anchor,attr"`
	Front      Front        `xml:"front"`
	Format     *Format      `xml:"format,omitempty"`
	Target     string       `xml:"target,attr"`
	Series     []SeriesInfo `xml:"seriesInfo,omitempty"`
	RefContent []string     `xml:"refcontent,omitempty"`
	Annotation []string     `xml:"annotation,omitempty"`
}

Reference is the entire <reference> structure.

type SeriesInfo

type SeriesInfo struct {
	Name       string `xml:"name,attr,omitempty"`       // name of the document, values are "RFC", "Internet-Draft", and "DOI"
	AsciiName  string `xml:"asciiName,attr,omitempty"`  // ascii name of the document, values are "RFC", "Internet-Draft", and "DOI"
	Value      string `xml:"value,attr,omitempty"`      // either draft name, or number
	AsciiValue string `xml:"asciiValue,attr,omitempty"` // value in ascii: either draft name, or number
	Status     string `xml:"status,attr,omitempty"`     // The status of this document, values: "standard", "informational", "experimental", "bcp", "fyi", and "full-standard"
	Stream     string `xml:"stream,attr,omitempty"`     // "IETF" (default), "IAB", "IRTF" or "independent"
}

SeriesInfo holds details on the Internet-Draft or RFC, see https://tools.ietf.org/html/rfc7991#section-2.47