logo

split filter

Dexy Filter Reference

Here you will find reference pages for each of the built-in dexy filters. Filters are what let dexy run code, transform text, and wrap libraries and tools so you can easily and reproducibly create any kind of document.

If you have worked through the getting started tutorial, then you are already familiar with some of these filters like pyg and jinja.

You can browse through the alphabetical list or browse filters by tag (not all filters are tagged yet, so the alphabetical list is more reliable).

Alphabetical List of Filters

{% set current_release = DEXY_VERSION -%} {% set new_feature_release_cutoff = '1.0.0' -%}

Symbols

An example is provided for this filter.
This is a newly added filter (in version {{new_feature_release_cutoff}} or later).
This filter was added after the current released version {{current_release}}. Will be in the next dexy release, and is available now if you install dexy from the develop branch.
{% set filter_info = d['filter-info.json'].json_as_dict() -%} {% for k in sorted(filter_info) -%} {% set v = filter_info[k] -%} {% set count=len(v['examples']) -%} {% if v['settings']['added-in-version'][1] > current_release -%} {% set newicon = "" -%} {% elif v['settings']['added-in-version'][1] >= new_feature_release_cutoff -%} {% set newicon = "" -%} {% else -%} {% set newicon = "" -%} {% endif -%} {% if v['firstdoc'] -%}

{{ v['firstdoc'] | e }}

{% endif -%}

← Back to Filter List

{{ k }}


{% if count > 0 -%}

↓ examples

{% endif -%} {% if v['doc'] -%}

{{ v['doc'] }}

{% endif -%}

Aliases for this filter

    {% for alias in v['aliases'] -%}
  • {{ alias }}
  • {% endfor -%}

Converts from file formats:

    {% for ext in v.settings['input-extensions'][1] -%}
  • {{ ext }}
  • {% endfor -%}

To file formats:

    {% for ext in v.settings['output-extensions'][1] -%}
  • {{ ext }}
  • {% endfor -%}

Available settings:

{% for name in sorted(v.settings) -%} {% set setting_info = v.settings[name] -%} {% if not name in ('aliases',) -%} {% endif -%} {% endfor -%}
SettingDescriptionDefault
{{ name }}{{ setting_info[0] }}{{ setting_info[1] }}
{% for example_text in v.examples -%} {{ example_text }} {% endfor -%} {% if v['defined_by_subclass'] -%}
Filter Source Code
{{ v['html_source'] }} {% endif -%} {% endfor %}

← Back to Filter List

Tags

{% for tag, aliases in d['filter-tags.json'].from_json() -%}

{{ tag }}

{% for alias, helpstring in aliases -%}

   {{ alias }}: {{ helpstring }}

{% endfor -%} {% endfor -%}

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.