data.markdownparser.elements #

fn doc_new(args DocNewArgs) !Doc

fn is_list_item_start(line string) bool

fn line_is_list(line string) bool

fn parser_char_new_text(text string) ParserChar

fn txt_is_nr(txt_ string) bool

enum Alignment as u8 {
	left
	center
	right
}

enum LinkState {
	init          // the original state (prob means already processed)
	linkprocessed // means we have found the original information
	ok
	missing
	error
}

enum LinkType {
	file
	image
	page
	unknown
	html
	data
	email
	anchor
	code
}

enum ListCat {
	bullet
	star
	nr
}

struct Action {
	DocBase
pub mut:
	action           playbook.Action
	action_processed bool
}

fn (mut self Action) process() !int

we don't allow an action to make child processes

fn (self Action) markdown() !string

fn (self Action) html() !string

fn (self Action) pug() !string

struct ActionsGetArgs {
pub mut:
	actor string
	name  string
}

struct Codeblock {
	DocBase
pub mut:
	category string
}

fn (mut self Codeblock) process() !int

fn (self Codeblock) markdown() !string

fn (self Codeblock) html() !string

fn (self Codeblock) pug() !string

struct Comment {
	DocBase
pub mut:
	replaceme  string
	singleline bool
}

fn (mut self Comment) process() !int

fn (self Comment) markdown() !string

fn (self Comment) html() !string

fn (self Comment) pug() !string

struct Def {
	DocBase
pub mut:
	pagekey   string
	pagename  string
	nameshort string
}

fn (mut self Def) process() !int

fn (mut self Def) process_link() !

fn (self Def) markdown() !string

fn (self Def) html() !string

fn (self Def) pug() !string

struct Doc {
	DocBase
pub mut:
	// gid smartid.GID
	pre             []HtmlSource
	linked_pages    []string // to know which collection:pages are needed to make this doc complete
	collection_name string
}

fn (mut self Doc) pre_add(arg HtmlSource) string

add a css or script link to a document url: is source where the data comes from, can be CDN or local link path: can be relative or absolute path to the info bookname, if in memory in a book chaptername, if in memory in a book filename string, if in memory in a book cat, is .css or .script

fn (mut self Doc) process() !int

fn (self Doc) pug() !string

pub fn (self Doc) html() string { return "" }

struct DocBase {
mut:
	parent_doc_ ?&Doc @[skip; str: skip]
pub mut:
	id        int
	content   string
	path      ?pathlib.Path
	processed bool
	// params    paramsparser.Params
	type_name string
	changed   bool
	children  []Element
	// trailing_lf bool = true // NO LONGER NEEDED !!!!
}

fn (mut base DocBase) action_new(mut docparent ?Doc, content string) &Action

fn (mut self DocBase) actionpointers(args ActionsGetArgs) []&Action

fn (self DocBase) actions(args ActionsGetArgs) []playbook.Action

get all actions from the children

fn (self DocBase) children() []Element

fn (self DocBase) children_recursive() []Element

fn (mut base DocBase) codeblock_new(mut docparent ?Doc, content string) &Codeblock

fn (mut base DocBase) comment_new(mut docparent ?Doc, content string) &Comment

fn (mut self DocBase) content_set(element_id int, c string)

fn (mut base DocBase) def_new(mut docparent ?Doc, content string) &Def

fn (mut self DocBase) defpointers() []&Def

fn (mut self DocBase) delete_last() !

fn (mut base DocBase) empty_new() &Empty

fn (self DocBase) first() !Element

fn (self DocBase) header_name() !string

fn (mut base DocBase) header_new(mut docparent ?Doc, content string) &Header

fn (self DocBase) html() !string

fn (mut base DocBase) html_new(mut docparent ?Doc, content string) &Html

fn (mut self DocBase) id_set(latestid_ int) int

fn (self DocBase) last() !Element

fn (mut base DocBase) link_new(mut docparent ?Doc, content string) &Link

fn (mut base DocBase) list_item_new(mut docparent ?Doc, content string) &ListItem

fn (mut base DocBase) list_new(mut docparent ?Doc, content string) !&List

fn (self DocBase) markdown() !string

the markdown which represents how it created the element

fn (mut base DocBase) paragraph_new(mut docparent ?Doc, content string) &Paragraph

fn (mut self DocBase) process() !int

fn (mut self DocBase) process_children() !int

fn (self DocBase) pug() !string

example see https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/letter/letter.pug is to generate pdf's

fn (mut base DocBase) table_new(mut docparent ?Doc, content string) &Table

fn (mut base DocBase) text_new(mut docparent ?Doc, content string) &Text

fn (self DocBase) treeview() string

struct DocNewArgs {
pub mut:
	pre             []HtmlSource
	content         string
	collection_name string
}

struct Empty {
pub mut:
	id        int
	content   string
	processed bool
	type_name string
	changed   bool
	// trailing_lf bool
	children []Element
}

NOT USED FOR NOW

fn (mut self Empty) process() !int

fn (self Empty) markdown() !string

fn (self Empty) pug() !string

fn (self Empty) html() !string

fn (self Empty) treeview_(prefix string, mut out []string)

fn (self Empty) children_recursive() []Element

fn (self Empty) children_recursive_(mut e []Element)

fn (self Empty) content_set(i int, b string)

fn (self Empty) id_set(i int) int

fn (self Empty) actionpointers(args ActionsGetArgs) []&Action

fn (self Empty) defpointers() []&Def

fn (self Empty) header_name() !string

fn (self Empty) actions(args ActionsGetArgs) []playbook.Action

struct Header {
	DocBase
pub mut:
	depth int
}

fn (mut self Header) process() !int

fn (self Header) markdown() !string

fn (self Header) html() !string

fn (self Header) pug() !string

struct Html {
	DocBase
pub mut:
	replaceme string
}

fn (mut self Html) process() !int

fn (self Html) markdown() !string

fn (self Html) pug() !string

fn (self Html) html() !string

struct HtmlSource {
pub mut:
	url         string
	path        string
	bookname    string
	chaptername string
	filename    string
	cat         HtmlSourceCat
}

struct Link {
	DocBase
pub mut:
	cat         LinkType
	isexternal  bool // is not linked to a wiki (sites)
	include     bool // means we will not link to the remote location, content will be shown in context of local site
	newtab      bool // means needs to be opened on a new tab
	moresites   bool // this means we can look for the content on multiple source sites, site does not have to be specified
	description string
	url         string
	anchor      string
	// identification of link:
	filename string // is the name of the page/file where the link points too
	path     string // is path in the site
	site     string // is the sitename where the link points too (collection)
	extra    string // e.g. ':size=800x900'
	// internal
	state     LinkState
	error_msg string
}

fn (mut self Link) process() !int

fn (self Link) markdown() !string

fn (self Link) html() !string

fn (self Link) pug() !string

fn (mut link Link) pathfull() string

return path of the filename in the site

fn (mut link Link) name_fix_no_underscore_no_ext() string

return the name of the link

struct List {
	DocBase
pub mut:
	cat            ListCat
	interlinespace int // nr of lines in between
}

fn (mut self List) process() !int

fn (mut self List) add_list_item(line string) !&ListItem

fn (self List) markdown() !string

fn (self List) pug() !string

fn (self List) html() !string

struct ListItem {
	DocBase
pub mut:
	depth  int
	indent int
	order  ?int
}

fn (mut self ListItem) process() !int

fn (self ListItem) markdown() !string

fn (self ListItem) pug() !string

fn (self ListItem) html() !string

struct Paragraph {
	DocBase
}

import freeflowuniverse.crystallib.ui.console

fn (self Paragraph) pug() !string

struct Row {
pub mut:
	cells []&Paragraph
}

struct Table {
	DocBase
pub mut:
	num_columns int
	alignments  []Alignment
	header      []&Paragraph
	rows        []Row
}

fn (mut self Table) process() !int

fn (self Table) header_markdown() !string

fn (self Table) markdown() !string

fn (self Table) pug() !string

fn (self Table) html() !string

fn (mut self Table) parse() !

get all relevant info out of table

struct Text {
	DocBase // pub mut:
	// 	replaceme string
}

fn (mut self Text) process() !int

fn (self Text) markdown() !string

fn (self Text) pug() !string

fn (self Text) html() !string