pelican-bdates is an open source Pelican plugin to produce important date listings from yaml data structures. The plugin is developed to be used with Markdown content and Bootstrap 3 based template.

Author

Toni Heittola ([email protected]), GitHub, Home page

bs4 is required. To ensure that all external modules are installed, run:

pip install -r requirements.txt

bs4 (BeautifulSoup) for parsing HTML content

pip install beautifulsoup4

In order to regenerate minified CSS and JS files you need also:

rcssmin a CSS Minifier

pip install rcssmin

jsmin a JS Minifier

pip install jsmin

Make sure you include Bootstrap in your template.

Make sure the directory where the plugin was installed is set in pelicanconf.py. For example if you installed in plugins/pelican-bdates, add:

PLUGIN_PATHS = ['plugins']

Enable pelican-bdates with:

PLUGINS = ['pelican-bdates']

To allow plugin in include css file, one needs to add following to the base.html template, in the head:

{% if article %}
    {% if article.styles %}
        {% for style in article.styles %}
{{ style }}
        {% endfor %}
    {% endif %}
{% endif %}
{% if page %}
    {% if page.styles %}
        {% for style in page.styles %}
{{ style }}
        {% endfor %}
    {% endif %}
{% endif %}

Insert date listing in the page template:

{% if page.bdates %}
    {{ page.bdates }}
{% endif %}

Insert date listing in the article template:

{% if article.bdates %}
    {{ article.bdates }}
{% endif %}

Date listing generation is triggered for the page either by setting BDATES metadata for the content (page or article) or using <div> with class bdates.

There is two layout modes available for both of these: panel and list.

Example yaml-file:

- date: 9-11-2016
  title: Test 1
  category: category1
- date: 1-12-2016
  duration_days: 10
  title: Test 2
  url: test2
  category: category2

The parameters can be set in global, and content level. Globally set parameters are are first overwritten content meta data, and finally with div parameters.

Parameters for the plugin can be set in `pelicanconf.py' with following parameters:

Example:

Title: Test page
Date: 2017-01-05 10:20
Category: test
Slug: test-page
Author: Test Person
bdates: True
bdates_header: Dates
bdates_category: category1

Date listing is available in template in variable page.bdates or article.bdates

<div class="bdates" data-source="content/data/dates.yaml" data-category="category1" data-mode="panel" data-header="Important dates" data-date-format="%d %B %Y"></div>

Example with meta fields:

Title: Test page
Date: 2017-01-05 10:20
Category: test
Slug: test-page
Author: Test Person
bdates: True
bdates_category: category1
bdates_header: Important dates
bdates_panel_color: panel-default
bdates_source: content/data/dates.yaml
bdates_mode: panel
<div class="bdates"></div>