diff options
author | Justin Mayer <entroP@gmail.com> | 2021-01-06 07:36:21 +0100 |
---|---|---|
committer | Justin Mayer <entroP@gmail.com> | 2021-01-06 07:36:21 +0100 |
commit | b17e4a5ffaab2f4f235cbb76c6a05b91cf69c878 (patch) | |
tree | 1f93b315d6f9ff975c03d27b73eca5277f1f9c43 | |
parent | 9e72b29fc1a9bbd10725cc98878840e015d626a0 (diff) | |
download | pelican-b17e4a5ffaab2f4f235cbb76c6a05b91cf69c878.tar.gz |
Add FAQ re: Atom full-post vs. summary-only feeds
Replaces a FAQ about upgrading from a very old version of Pelican, which
isn't relevant to most folks at this point.
-rw-r--r-- | docs/faq.rst | 32 |
1 files changed, 11 insertions, 21 deletions
diff --git a/docs/faq.rst b/docs/faq.rst index 8532ab3f..2902a0e4 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -174,28 +174,18 @@ your site. Feeds are still generated when this warning is displayed, but links within may be malformed and thus the feed may not validate. -My feeds are broken since I upgraded to Pelican 3.x -=================================================== - -Starting in 3.0, some of the FEED setting names were changed to more explicitly -refer to the Atom feeds they inherently represent (much like the FEED_RSS -setting names). Here is an exact list of the renamed settings:: - - FEED -> FEED_ATOM - TAG_FEED -> TAG_FEED_ATOM - CATEGORY_FEED -> CATEGORY_FEED_ATOM - -Starting in 3.1, the new feed ``FEED_ALL_ATOM`` has been introduced: this feed -will aggregate all posts regardless of their language. This setting generates -``'feeds/all.atom.xml'`` by default and ``FEED_ATOM`` now defaults to ``None``. -The following feed setting has also been renamed:: - - TRANSLATION_FEED -> TRANSLATION_FEED_ATOM +Can I force Atom feeds to show only summaries instead of article content? +========================================================================= -Older themes that referenced the old setting names may not link properly. In -order to rectify this, please update your theme for compatibility by changing -the relevant values in your template files. For an example of complete feed -headers and usage please check out the ``simple`` theme. +Instead of having to open a separate browser window to read articles, the +overwhelming majority of folks who use feed readers prefer to read content +within the feed reader itself. Mainly for that reason, Pelican does not support +restricting Atom feeds to only contain summaries. Unlike Atom feeds, the RSS +feed specification does not include a separate ``content`` field, so by default +Pelican publishes RSS feeds that only contain summaries (but can optionally be +set to instead publish full content RSS feeds). So the default feed generation +behavior provides users with a choice: subscribe to Atom feeds for full content +or to RSS feeds for just the summaries. Is Pelican only suitable for blogs? =================================== |