View Source Magma.Concept (Magma v0.2.0)

The basic Magma document type used for generating concrete artefacts.

It contains all user-contributed content necessary for artefact generation, such as descriptions of the subject matter, background knowledge, and task descriptions for various artefacts.

This module provides functions for creating, loading and updating these concept documents, as well as functions for accessing specific sections of the document such as the description and context knowledge sections. It also allows for the creation of prompts based on a concept.

Summary

Types

t()

Functions

context_knowledge_section(concept)

context_knowledge_section_title()

create(subject, attrs \\ [], opts \\ [])

Creates a new concept document for a given subject matter in the Magma.Vault.

create!(subject, attrs \\ [], opts \\ [])

Creates a new concept document for a given subject matter in the Magma.Vault.

create_prompts(concept, opts \\ [])

description_section(concept)

description_section_title()

fetch(concept, key)

See Magma.DocumentStruct.fetch/2.

from!(document)

Fetches a document from a related document and immediately loads it with load!/1

load(document)

Loads a document from the given path or document.

load!(document_or_path)

Loads a document from the given path or document and raises an exception in error cases.

load_linked(link)

Loads a document from the given Obsidian link, i.e. a string of the form "[[name]]".

new(subject, attrs \\ [])

Creates a new concept document struct for a given subject matter.

new!(subject, attrs \\ [])

update_content_from_ast(concept)

Types

t()

@type t() :: %Magma.Concept{
  aliases: term(),
  content: term(),
  created_at: term(),
  custom_metadata: term(),
  name: term(),
  path: term(),
  prologue: term(),
  sections: term(),
  subject: term(),
  tags: term(),
  title: term()
}

Functions

context_knowledge_section(concept)

context_knowledge_section_title()

create(subject, attrs \\ [], opts \\ [])

Creates a new concept document for a given subject matter in the Magma.Vault.

create!(subject, attrs \\ [], opts \\ [])

Creates a new concept document for a given subject matter in the Magma.Vault.

Fails in error cases.

create_prompts(concept, opts \\ [])

description_section(concept)

description_section_title()

fetch(concept, key)

See Magma.DocumentStruct.fetch/2.

from!(document)

Fetches a document from a related document and immediately loads it with load!/1

load(document)

Loads a document from the given path or document.

If the loaded document is not of the proper document type an Magma.InvalidDocumentType exception is returned in an :error tuple.

load!(document_or_path)

Loads a document from the given path or document and raises an exception in error cases.

load_linked(link)

Loads a document from the given Obsidian link, i.e. a string of the form "[[name]]".

If the referenced document is not of the proper document type an Magma.InvalidDocumentType exception is returned in an :error tuple.

new(subject, attrs \\ [])

Creates a new concept document struct for a given subject matter.

Note, this function doesn't create the document in the Magma.Vault. Use create/3 for this purpose.

new!(subject, attrs \\ [])

update_content_from_ast(concept)

@spec update_content_from_ast(t()) :: t()