Justin Mayer dca3427da0 Improve Clean Summary plugin ReadME 8 years ago
..
README.md dca3427da0 Improve Clean Summary plugin ReadME 8 years ago
__init__.py f3549dd296 plugin to specify maxmium number of images to appear in summary 10 years ago
clean_summary.py 246fd05d44 Have relevant plugins use all_generators_finalized signal 8 years ago

README.md

Clean Summary Plugin

This plugin cleans your summary of excess images. Images can take up much more space than text and lead to summaries being different sizes on archive and index pages. With this plugin, you can specify a maximum number of images that will appear in your summaries.

There is also an option to include a minimum of one image.

Settings

This plugin has two settings: CLEAN_SUMMARY_MAXIMUM, which takes an integer, and CLEAN_SUMMARY_MINIMUM_ONE, which takes a Boolean value. They default to 0 and False, respectively.

CLEAN_SUMMARY_MAXIMUM sets the maximum number of images that will appear in your summary.

If CLEAN_SUMMARY_MINIMUM_ONE is set to True and your summary doesn't already contain an image, the plugin will add the first image in your article (if one exists) to the beginning of the summary.

Requirements

Requires Beautiful Soup:

pip install BeautifulSoup4

Usage with Summary Plugin

If using the Summary plugin, make sure it appears in your plugin list before the Clean Summary plugin. For example:

PLUGINS = ['summary', 'clean_summary', ... ]