fr.jeremyschoffen.prose.alpha.document.lib — fr.jeremyschoffen/prose-alpha 32

Api providing several tools to use inside or outside of prose document.

<> clj/s

(<> & content)

Fragment tag whose content is meant to be spliced into its parent's content.

conform-or-throw clj/s

(conform-or-throw spec v)

Conforms the value v using the spec spec and throws an ex-info if v is invalid.

def-s clj/s macro

(def-s & args)

Same as def except that it returns and empty string.

def-xml-tag clj/s≠ macro

clj

(def-xml-tag name docstring? keyword-name?)

cljs

(def-xml-tag & args)

Helper in making functions that construct tags.

Args:

• name: name of the function
• docstring?: a docstring for the function
• keyword-name?: the actual name of the tag, defaults to the keyword version of name

def-xml-tags clj/s macro

(def-xml-tags & tags)

defmacro-s clj/s macro

(defmacro-s & args)

Same as defmacro except that it returns and empty string.

defn-s clj/s macro

(defn-s & args)

Same as defn except that it returns and empty string.

eval-doc clj/s

(eval-doc & args)

Eval a document using the function given by get-eval-doc.

get-env clj/s

(get-env)

(get-env k)

Get the evaluation environment or the value for one of its keys.

get-eval-doc clj/s

(get-eval-doc)

Get the eval-forms function from the evaluation environment.

get-input clj/s

(get-input)

Get the input value from the evaluation environment.

get-read-doc clj/s

(get-read-doc)

Get the reading function from the evaluation environment.

get-slurp-doc clj/s

(get-slurp-doc)

Get the slurping function from the evaluation environment.

insert-doc clj/s macro

(insert-doc path)

Insert the slurped and read content of another document.

read-doc clj/s

(read-doc & args)

Read a string using the function given by get-read-doc.

require-doc clj/s

(require-doc path)

Insert the slurped, read and evaluated content of another document.

slurp-doc clj/s

(slurp-doc & args)

Slurp a document using the function given by get-slurp-doc.

special? clj/s

(special? x)

Determine if x is a special tag.

tag-type clj/s

(tag-type x)

Returns the type of a tag x or nil isn't a map or doesn't have a type.

tag? clj/s

(tag? x)

Determine if x is a normal tag.

xml-tag clj/s≠

clj

(xml-tag name attrs? & content)

cljs

(xml-tag & args)

Constructor of normal tags.

args:

• name: a keyword giving the tag his name (:div, :my-tag, etc...)
• attrs: a map of attributes
• content: the content of the tag, strings, other (special)tags or sequences of both.

Returns a map similar to:

{:type :tag
 :tag name
 :attrs attrs?
 :content content}