Crate tpnote_lib

The tpnote-lib library is designed to embed Tp-Note’s core function in common text editors and text editor plugins. It is dealing with templates and input files and is also part of the command line application Tp-Note. This library also provides a default configuration in the static variable LIB_CFG that can be customized at runtime. The defaults for the variables grouped in LIB_CFG, are defined as constants in the module config (see Rustdoc).

Tp-Note’s high-level API, c.f. module workflow, abstracts most implementation details. Roughly speaking, the input path correspond to Tp-Note’s first positional command line parameter and the output path is the same that is printed to stdout after usage. The main consumer of tpnote-lib’s high-level API is the module workflow in tp-note crate.

Modules

config

Set configuration defaults, reads and writes Tp-Note’s configuration file and exposes the configuration as static variable behind a mutex. This makes it possible to modify all configuration defaults (and templates) at runtime.

content

Self referencing data structures to store the note’s content as a raw string.

context

Extends the built-in Tera filters.

error

Custom error types.

filename

Helper functions dealing with filenames.

highlight

Syntax highlighting for (inline) source code blocks in Markdown input.

html

Helper functions dealing with HTML conversion.

markup_language

Helper functions dealing with markup languages.

template

Abstractions for content templates and filename templates.

workflow

Tp-Note’s high level API.

Macros

note_error_tera_template

Macro to construct a NoteError::TeraTemplate from a Tera::Error` .