Description | A static content generator. |
Newcomen::Plugin::Blog::Feed::Defaults - Sets some defaults for atom feeds.
This plugin will add default formatters for all content on feed pages, and set renderer and writer for these feeds (unless a renderer/writer is already set).
The default formatter(s) will always be added to all Newcomen::Content instances on a page with a
creator ID starting with 'Blog::Feed::'
, early during the hook_formatters() hook (see
HOOKS). However, formatters will not be added twice, if a formatter of the same name
already exists in the content's formatter list, it will not be added again.
The default renderer and writer will be set for all Newcomen::Page instances with a creator ID
starting with 'Blog::Feed::'
, unless a renderer or writer is already set for the page. This will
be done late during the hook_renderer()/hook_writer() hook, respectively. See HOOKS.
{ 'blog' => { 'feed' => { 'defaults' => { 'ascending' => undef, 'entries' => undef, 'uuid_ns' => undef, 'feed_info' => {}, 'formatters' => undef, 'renderer' => undef, 'writer' => undef, }, }, }, }
These are the default options set by this plugin. They may be overridden by user configuration.
The options blog/feed/defaults/formatters, blog/feed/defaults/renderer and blog/feed/defaults/writer work like described in Newcomen::Plugin::Blog::Defaults, please see there for details.
blog/feed/defaults/ascending specifies whether to sort the articles in ascending order, i.e. oldest articles first.
blog/feed/defaults/entries is a default setting for the number of articles per list feed.
blog/feed/defaults/feed_info may contain defaults for additional information to be stored in the pages' meta data. This has to be a hashref (may be empty).
It is up to the individual feed plugins to respect these last three options. See the individual plugins for details (e.g. Newcomen::Plugin::Blog::Feed::Main).
The uuid_ns options must be set unless a UUID is specified explicitly for every feed in the configuration! It must be a valid UUID string, and it will be used as the UUID namespace from which the individual feed UUIDs will be derived. Please see the individual feed plugins for details.
This plugin implements the following hooks: hook_formatters() (priority 300
),
hook_renderer() (priority 700
) and hook_writer() (priority 700
).
Newcomen::Content, Newcomen::Page, Newcomen::Plugin::Blog::Defaults, Newcomen::Plugin::Blog::Feed::Main
This is version 2014052501
.
Stefan Goebel - newcomen {at} subtype {dot} de
Copyright 2013-2014 Stefan Goebel.
This file is part of Newcomen.
Newcomen is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version.
Newcomen is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Newcomen. If not, see <http://www.gnu.org/licenses/>.