orgo

Documentation

Index

• Constants
• type Document
  • func Parse(r io.Reader) *Document
• type HeadingNode
  • func (n *HeadingNode) Type() string
• type LogbookEntry
• type Metadata
• type Node
• type SourceNode
  • func (n *SourceNode) Type() string
• type TodoKeyword

Constants

const (
	HeadingNodeType = "Heading"
	SourceNodeType  = "Source"
)

Types

type Document

type Document struct {
	Metadata
	Nodes []Node
}

func Parse

func Parse(r io.Reader) *Document

type HeadingNode

type HeadingNode struct {
	Title         string
	Level         int
	Todo          string
	Tags          []string
	Properties    map[string]any
	ScheduledTime *time.Time
	DeadlineTime  *time.Time
	Logbook       []LogbookEntry
	Children      []Node
}

func (*HeadingNode) Type

func (n *HeadingNode) Type() string

type LogbookEntry

type LogbookEntry struct {
	From time.Time
	To   *time.Time
}

type Metadata

type Metadata struct {
	Title        string
	Author       string
	Tags         map[string][]string
	TodoKeywords []TodoKeyword
	Properties   map[string]string
}

type Node

type Node interface {
	Type() string
}

type SourceNode

type SourceNode struct {
	Language   string
	Properties map[string]string
	Content    string
}

func (*SourceNode) Type

func (n *SourceNode) Type() string

type TodoKeyword

type TodoKeyword struct {
	Pre  []string
	Post []string
}