mast

Documentation

Index

• type Address
• type AddressPostal
• type Author
• type Bibliography
• type BibliographyItem
• type DocumentIndex
• type IndexItem
• type IndexLetter
• type IndexLink
• type IndexSubItem
• type SeriesInfo
• type Title
  • func NewTitle() *Title
• type TitleData

Types

type Address

type Address struct {
	Phone  string
	Email  string
	URI    string
	Postal AddressPostal
}

Address denotes the address of an RFC author.

type AddressPostal

type AddressPostal struct {
	Street     string
	City       string
	Code       string
	Country    string
	Region     string
	PostalLine []string

	// Plurals when these need to be specified multiple times.
	Streets   []string
	Cities    []string
	Codes     []string
	Countries []string
	Regions   []string
}

AddressPostal denotes the postal address of an RFC author.

type Author

type Author struct {
	Initials           string
	Surname            string
	Fullname           string
	Organization       string
	OrganizationAbbrev string `toml:"abbrev"`
	Role               string
	ASCII              string
	Address            Address
}

Author denotes an RFC author.

type Bibliography

type Bibliography struct {
	ast.Container

	Type ast.CitationTypes
}

Bibliography represents markdown bibliography node.

type BibliographyItem

type BibliographyItem struct {
	ast.Leaf

	Anchor []byte
	Type   ast.CitationTypes

	Raw       []byte              // raw reference XML
	Reference reference.Reference // parsed reference XML
}

BibliographyItem contains a single bibliography item.

type DocumentIndex

type DocumentIndex struct {
	ast.Container
}

DocumentIndex represents markdown document index node.

type IndexItem

type IndexItem struct {
	ast.Container

	*ast.Index
}

IndexItem contains an index for the indices section.

type IndexLetter

type IndexLetter struct {
	ast.Leaf
}

IndexLetter has the Letter of this index item.

type IndexLink

type IndexLink struct {
	*ast.Link

	Primary bool
}

IndexLink links to the index in the document.

type IndexSubItem

type IndexSubItem struct {
	ast.Container

	*ast.Index
}

IndexSubItem contains an sub item index for the indices section.

type SeriesInfo

type SeriesInfo struct {
	Name   string // name of the document, values are "RFC", "Internet-Draft", and "DOI"
	Value  string // either draft name, or number
	Status string // The status of this document, values: "standard", "informational", "experimental", "bcp", "fyi", and "full-standard"
	Stream string // "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

type Title

type Title struct {
	ast.Leaf
	*TitleData
}

Title represents the TOML encoded title block.

func NewTitle

func NewTitle() *Title

NewTitle returns a pointer to TitleData with some defaults set.

type TitleData

type TitleData struct {
	Title  string
	Abbrev string

	SeriesInfo     SeriesInfo
	Consensus      bool
	Ipr            string // See https://tools.ietf.org/html/rfc7991#appendix-A.1
	Obsoletes      []int
	Updates        []int
	SubmissionType string // IETF, IAB, IRTF or independent

	Date      time.Time
	Area      string
	Workgroup string
	Keyword   []string
	Author    []Author
}

TitleData holds all the elements of the title.