Ionel Cristian Mărieș b2a2fe3eeb Also fill related_posts for draft articles (against published articles of course). 8 years ago
..
Readme.rst ab63994cf9 Add related_posts option RELATED_POSTS_SKIP_SAME_CATEGORY 9 years ago
__init__.py 9e70c17839 import plugins from core and restructure repo 11 years ago
related_posts.py b2a2fe3eeb Also fill related_posts for draft articles (against published articles of course). 8 years ago

Readme.rst

Related posts
-------------

This plugin adds the ``related_posts`` variable to the article's context.
By default, up to 5 articles are listed. You can customize this value by
defining ``RELATED_POSTS_MAX`` in your settings file::

RELATED_POSTS_MAX = 10

You can then use the ``article.related_posts`` variable in your templates.
For example::

{% if article.related_posts %}

    {% for related_post in article.related_posts %}
  • {{ related_post.title }}

  • {% endfor %}

{% endif %}


Your related posts should share a common tag. You can also use ``related_posts:`` in your post's meta data.
The 'related_posts:' meta data works together with your existing slugs::

related_posts: slug1, slug2, slug3, ... slugN

``N`` represents the ``RELATED_POSTS_MAX``.

Additionally, you can specify::

RELATED_POSTS_SKIP_SAME_CATEGORY = True

in your settings file. With this setting, ``article.related_posts`` will
contain only related posts from categories other than the original article's.