|
@@ -9,26 +9,26 @@ There is also an option to include a minimum of one image.
|
|
|
|
|
|
##Settings##
|
|
##Settings##
|
|
|
|
|
|
-plugin has two settings. `CLEAN_SUMMARY_MAXIMUM` which takes an int, and
|
|
|
|
-`CLEAN_SUMMARY_MINIMUM_ONE` which takes a boolean. They deafult to 0 and False.
|
|
|
|
|
|
+This plugin has two settings. `CLEAN_SUMMARY_MAXIMUM` which takes an int, and
|
|
|
|
+`CLEAN_SUMMARY_MINIMUM_ONE` which takes a boolean. They default to 0 and False.
|
|
|
|
|
|
`CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in
|
|
`CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in
|
|
your summary.
|
|
your summary.
|
|
|
|
|
|
if `CLEAN_SUMMARY_MINIMUM_ONE` is set to `True` and your summary doesn't already
|
|
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
|
|
|
|
|
|
+contain an image, the plugin will add the first image in your article (if one
|
|
exists) to the beginning of the summary.
|
|
exists) to the beginning of the summary.
|
|
|
|
|
|
##Requirements##
|
|
##Requirements##
|
|
|
|
|
|
-requires Beautiful Soup
|
|
|
|
|
|
+Requires Beautiful Soup:
|
|
|
|
|
|
pip install BeautifulSoup4
|
|
pip install BeautifulSoup4
|
|
|
|
|
|
|
|
|
|
##Usage with Summary Plugin##
|
|
##Usage with Summary Plugin##
|
|
|
|
|
|
-if using the summary plugin, make sure summary appears in your plugins before
|
|
|
|
|
|
+If using the summary plugin, make sure summary appears in your plugins before
|
|
clean summary. Eg.
|
|
clean summary. Eg.
|
|
|
|
|
|
PLUGINS = ['summary', 'clean_summary', ... ]
|
|
PLUGINS = ['summary', 'clean_summary', ... ]
|