# Summary

This plugin extracts a representative image (i.e, featured image) from the article's summary or content if not specified in the metadata. 

The plugin also removes any images from the summary after extraction to avoid duplication. 

It allows the flexibility on where and how to display the featured image of an article together with its summary in a template page. For example, the article metadata can be displayed in thumbnail format, in which there is a short summary and an image. The layout of the summary and the image can be varied for aesthetical purpose. It doesn't have to depend on article's content format. 

## Installation

This plugin requires BeautifulSoup:

```bash
pip install beautifulsoup4
```

To enable, add the following to your settings.py:

```python
PLUGIN_PATH = 'path/to/pelican-plugins'
PLUGINS = ["representative_image"]
```

`PLUGIN_PATH` can be a path relative to your settings file or an absolute path.

## Usage

To override the default behavior of selecting the first image in the article's summary or content, set the image property the article's metadata to the URL of the image to display, e.g:

```markdown
Title: My super title
Date: 2010-12-03 10:20
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Author: Alexis Metaireau
Summary: Short version for index and feeds
Image: /images/my-super-image.png

Article content...
```

To include a representative image in a page add the following to the template:

```html
{% if  article.featured_image %}
    <img src="{{ article.featured_image }}">
{% endif %}
```