View Source Magma.View (Magma v0.2.0)

Utility module with helper functions for creating the content of Magma documents.

Summary

Functions

button(label, command, opts \\ [])

callout(text, type \\ "info")

comment(text)

delete_current_file_button()

include(document_or_section, subsection \\ nil, opts \\ [])

include_context_knowledge(concept)

link_to(document_or_target, label \\ nil)

Creates an internal Obsidian link to the given document.

link_to_concept(document, section \\ nil)

link_to_preview(document, section \\ nil)

link_to_prompt(document, section \\ nil)

link_to_prompt_result(document, section \\ nil)

link_to_version(document, section \\ nil)

prompt_results_table()

transclude(document_or_target, section \\ nil)

Creates an Obsidian transclusion of the given document or section.

transclude_concept(document, section \\ nil)

transclude_preview(document, section \\ nil)

transclude_prompt(document, section \\ nil)

transclude_prompt_result(document, section \\ nil)

transclude_version(document, section \\ nil)

yaml_list(list)

yaml_nested_map(struct)

Functions

button(label, command, opts \\ [])

callout(text, type \\ "info")

comment(text)

delete_current_file_button()

include(document_or_section, subsection \\ nil, opts \\ [])

include_context_knowledge(concept)

link_to(document_or_target, label \\ nil)

Creates an internal Obsidian link to the given document.

The document can be given by name or as a Magma.Document struct.

The optional second argument allows set an alternative label.

Examples

iex> Magma.View.link_to("Document")
"[[Document]]"

iex> Magma.View.link_to("Document", "Alt")
"[[Document|Alt]]"

link_to_concept(document, section \\ nil)

link_to_preview(document, section \\ nil)

link_to_prompt(document, section \\ nil)

link_to_prompt_result(document, section \\ nil)

link_to_version(document, section \\ nil)

prompt_results_table()

transclude(document_or_target, section \\ nil)

Creates an Obsidian transclusion of the given document or section.

The document can be given by name or as a Magma.Document struct.

The optional second argument can be used to specify a specific section to be transcluded.

Examples

iex> Magma.View.transclude("Document")
"![[Document|]]"

iex> Magma.View.transclude("Document", "Section")
"![[Document#Section|]]"

transclude_concept(document, section \\ nil)

transclude_preview(document, section \\ nil)

transclude_prompt(document, section \\ nil)

transclude_prompt_result(document, section \\ nil)

transclude_version(document, section \\ nil)

yaml_list(list)

yaml_nested_map(struct)