title.go

package mast

import (
	"time"

	"github.com/gomarkdown/markdown/ast"
	"github.com/mmarkdown/mmark/v2/mast/reference"
)

// Title represents the TOML encoded title block.
type Title struct {
	ast.Leaf
	*TitleData
}

// NewTitle returns a pointer to TitleData with some defaults set.
func NewTitle() *Title {
	t := &Title{
		TitleData: &TitleData{
			Area:         "Internet",
			Ipr:          "trust200902",
			Consensus:    true,
			IndexInclude: true,
		},
	}
	return t
}

// TitleData holds all the elements of the title.
type TitleData struct {
	Title  string
	Abbrev string

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

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

	Language string
}

type Link struct {
	Href string
	Rel  string
}

// Author denotes an RFC author.
type Author struct {
	Initials           string
	Surname            string
	Fullname           string
	Organization       string
	OrganizationAbbrev string `toml:"abbrev"`
	Role               string
	ASCII              string
	Address            Address
}

// Contact denotes an RFC contact.
type Contact Author

// Address denotes the address of an RFC author.
type Address struct {
	Phone  string
	Email  string
	URI    string
	Postal AddressPostal

	Emails []string // Plurals when these need to be specified multiple times.
}

// AddressPostal denotes the postal address of an RFC author.
type AddressPostal struct {
	Street     string
	City       string
	CityArea   string
	Code       string
	Country    string
	ExtAddr    string
	Region     string
	PoBox      string
	PostalLine []string

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