Skip to main content

Template parser preprocessor for Foliant.

Project description

TemplateParser preprocessor for Foliant

Preprocessor which allows to use templates in Foliant source files. Preprocessor now supports only Jinja2 templating engine, but more can be added easily.

Installation

$ pip install foliantcontrib.templateparser

Config

All params that are stated in foliant.yml are considered global params. All of them may be overriden in template tag options, which have higher priority.

preprocessors:
    - templateparser:
        engine: jinja2
        engine_params:
            root: '/usr/src/app'
        context:
            param1: 1008
            param2: 'Kittens'
        ext_context: context.yml
        param3: 'Puppies'

engine : name of the template engine which will be used to process template. Supported engines right now: jinja2.

engine_params : dictionary with parameters which will be transfered to the template engine.

context : dictionary with variables which will be redirected to the template.

ext_context : path to YAML- or JSON-file with context dictionary. (relative to current md-file)

All parameters with other names are also transfered to the template, as if they appeared inside the context dictionary. (param3 in the above example)

Please note that even if this may seem convenient, it is preferred to include template variables in the context dictionary, as in future more reserved parameters may be added which may conflict with your stray variables.

If some variable names overlap among these methods to supply context, preprocessor uses this priority order:

  1. Context dictionary.
  2. Stray variables.
  3. External context file.

Usage

To use the template in a Markdown file just insert a tag of the template engine name, for example:

This is ordinary markdown text.
<jinja2>
This is a Jinja2 template:
I can count to five!
{% for i in range(5) %}{{ i + 1 }}{% endfor %}
</jinja2>

After making a document with Foliant this will be transformed to:

This is ordinary markdown text.

This is a Jinja2 template:
I can count to five!
12345

You can also use a general <template> tag, but in this case you have to specify the engine you want to use in the engine parameter:

This is ordinary markdown text.
<template engine="jinja2">
This is a Jinja2 template:
I can count to five!
{% for i in range(5) %}{{ i + 1 }}{% endfor %}
</template>

Sending variables to template

To send a variable to template, add them into the context option. This option accepts yaml dictionary format.

Please note that foliant doesn't support multiline tag options yet, so use one-line dictionary format {'key1': value1, ...}

<jinja2 context="{'name': Andy, 'age': 8}">
Hi, my name is {{name}}!
I am {{age}} years old.
{% for prev in range(age - 1, 0, -1) %}
The year before I was {{prev}} years old.
{% endfor %}
</jinja2>

Result:

Hi, my name is Andy!
I am 8 years old.

The year before I was 7 years old.

The year before I was 6 years old.

The year before I was 5 years old.

The year before I was 4 years old.

The year before I was 3 years old.

The year before I was 2 years old.

The year before I was 1 years old.

Extends and includes

Extends and includes work in templates. The path of the extending\included file is relative to the Markdown file where the template lives.

In Jinja2 engine you can override the path of the included\extended files with root engine_param. Note that this param is relative to project root.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for foliantcontrib.templateparser, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size foliantcontrib.templateparser-1.0.2-py3-none-any.whl (6.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size foliantcontrib.templateparser-1.0.2.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page