From f629e3b012ed4d49bce1b4721664af8f15ebd5c8 Mon Sep 17 00:00:00 2001 From: Duncan Lock Date: Sun, 23 Jun 2013 21:24:20 -0700 Subject: [PATCH] Tidy up readme --- post_stats/readme.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/post_stats/readme.rst b/post_stats/readme.rst index f607d3b..89fc13b 100644 --- a/post_stats/readme.rst +++ b/post_stats/readme.rst @@ -4,8 +4,8 @@ Post Statistics A Pelican plugin to calculate various statistics about a post and store them in an article.stats dictionary: - ``wc``: how many words -- ``read_mins``: how many minutes to read this article, based on 250 wpm (http://en.wikipedia.org/wiki/Words_per_minute#Reading_and_comprehension) -- ``word_counts``: frquency count of all the words in the article; can be used for tag/word clouds/ +- ``read_mins``: how many minutes would it take to read this article, based on 250 wpm (http://en.wikipedia.org/wiki/Words_per_minute#Reading_and_comprehension) +- ``word_counts``: frquency count of all the words in the article; can be used for tag/word clouds - ``fi``: Flesch-kincaid Index/ Reading Ease (see: http://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) - ``fk``: Flesch-kincaid Grade Level @@ -31,16 +31,16 @@ This allows you to output these values in your templates, like this, for example
  • Flesch-kincaid Grade Level: {{ article.stats['fk'] }}
    • -The ``word_counts`` variable is a Counter dictionary and looks like this, with each unique word and it's frequency: +The ``word_counts`` variable is a python ``Counter`` dictionary and looks something like this, with each unique word and it's frequency: .. code-block:: python Counter({u'to': 98, u'a': 90, u'the': 83, u'of': 50, u'karma': 50, ..... -and could be used to create a tag/word cloud for a post. +and can be used to create a tag/word cloud for a post. Requirements -============ +---------------- `post_stats` requires BeautifulSoup.