Newcomen

Description A static content generator.
Newcomen > Perl Manuals > Newcomen::Manual::Summary::Meta
Source

Index


NAME ^

Newcomen::Manual::MetaData - Summary of all meta data used.

DESCRIPTION ^

This summary is generated automatically!

This manual contains a summary of all meta data set or recognized by the different plugins and backends. The data is extracted from the individual modules' documentation. Please see there for details. Modules are sorted alphabetically by module name in this document.

META DATA ^

Collections

Newcomen::Plugin::Blog::Feed::Lists:

{
   'order_ascending'  => <ascending configuration option>,
   'index_collection' => <original index collection>,
   'atom_url'         => <URL of the Atom feed (see description!)>,
}

Newcomen::Plugin::Blog::Feed::Main:

{
   'order_ascending' => <ascending configuration option>,
   'atom_url'        => <URL of the Atom feed (see description!)>,
}

Newcomen::Plugin::Blog::Index::Lists:

{
   'list_id'           => $list_id,
   'list_id_sha1'      => $list_id_sha1,
   'list_source'       => $list_source,
   'list_item'         => $list_item,
   'list_path'         => $list_path,
   'list_hierarchical' => $list_hierarchical,
   'list_no_children'  => $list_no_children,
}

Newcomen::Plugin::Blog::Index::Lists::Date:

{
   'year'           => $year,
   'month'          => $month,
   'day'            => $day,
   'ymd'            => $ymd,
   'archive_type'   => $archive_type,
   'archive_source' => $archive_source,
}

Pages

Newcomen::Plugin::Blog::Feed::Lists:

{
   'atom_uuid'    => <UUID for the Atom feed>,
   'atom_updated' => <last modification time>,
}

Newcomen::Plugin::Blog::Feed::Main:

{
   'atom_uuid'    => <UUID for the Atom feed>,
   'atom_updated' => <last modification time>,
}

Newcomen::Plugin::Blog::Index::Lists:

{
   'page'        => $cur_page,
   'pages'       => $pages,
   'posts_total' => $count,
   'posts_from'  => $posts_from,
   'posts_to'    => $posts_to,
   'prev_page'   => $prev_page,
   'next_page'   => $next_page,
   'type'        => 'multiple'
}

Newcomen::Plugin::Blog::Index::Main:

{
   'page'        => <current page>,
   'pages'       => <total number of pages>,
   'posts_total' => <total number of posts in the collection>,
   'posts_from'  => <number of first post on the page>,
   'posts_to'    => <number of last post on the page>,
   'prev_page'   => <URL of previous page>,
   'next_page'   => <URL of next page>,
   'page_type'   => 'multiple',
}

Newcomen::Plugin::Blog::Single:

{
   'page_type' => 'single',
}

Newcomen::Plugin::Static:

{
   'source_file' => $source_file,
}

Sources

Newcomen::Plugin::Blog::Feed::UUID:

{
   'atom_uuid' => $uuid,
}

Newcomen::Plugin::Blog::Feed::Updated:

{
   'atom_updated'   => $updated,
   'atom_published' => $published,
}

Newcomen::Plugin::Blog::Index::Lists::Date:

{
   'time'        => {
      'lists'    => {
         'day'   => [ "$year/$month/$day" ],
         'month' => [ "$year/$month"      ],
         'year'  => [ "$year"             ]
      },
   },
}

Newcomen::Plugin::Blog::Menu:

{
   'menu'       => <menu specification>,
   'single_url' => <used as URL unless overridden>,
}

Newcomen::Plugin::Blog::Single:

{
   'single_url' => $single_url,
}

Newcomen::Plugin::Blog::Source:

{
   'stat'       => {
      'dev'     => $dev,
      'ino'     => $ino,
      'mode'    => $mode,
      'nlink'   => $nlink,
      'uid'     => $uid,
      'gid'     => $gid,
      'rdev'    => $rdev,
      'size'    => $size,
      'atime'   => $atime,
      'mtime'   => $mtime,
      'ctime'   => $ctime,
      'blksize' => $blksize,
      'blocks'  => $blocks,
   },
}

Newcomen::Plugin::Blog::Source::Slug:

{
   'slug' => $slug,
}

Newcomen::Plugin::Blog::Source::Time:

{

   'published'         => $published,
   'modified'          => $modified,

   'time'              => {
      'published'      => {
         'year'        => $pub_year,
         'month'       => $pub_month,
         'day'         => $pub_day,
         'hour'        => $pub_hour,
         'minute'      => $pub_minute,
         'second'      => $pub_second,
         'day_of_week' => $pub_dow,
         'day_of_year' => $pub_doy,
         'week'        => $pub_week,
         'month_short' => $pub_m_short,
         'month_name'  => $pub_m_name,
         'day_short'   => $pub_d_short,
         'day_name',   => $pub_d_name,
         'is_dst'      => $pub_is_dst,
         'epoch'       => $pub_epoch,
         'iso'         => $pub_iso,
         'offset'      => $pub_offset,
         'Month'       => $pub_Month,
         'Day'         => $pub_Day,
         'Hour'        => $pub_Hour,
         'Minute'      => $pub_Minute,
         'Second'      => $pub_Second,
         'string'      => $pub_string,
      },
      'modified'       => {
         'year'        => $mod_year,
         'month'       => $mod_month,
         'day'         => $mod_day,
         'hour'        => $mod_hour,
         'minute'      => $mod_minute,
         'second'      => $mod_second,
         'day_of_week' => $mod_dow,
         'day_of_year' => $mod_doy,
         'week'        => $mod_week,
         'month_short' => $mod_m_short,
         'month_name'  => $mod_m_name,
         'day_short'   => $mod_d_short,
         'day_name',   => $mod_d_name,
         'is_dst'      => $mod_is_dst,
         'epoch'       => $mod_epoch,
         'iso'         => $mod_iso,
         'offset'      => $mod_offset,
         'Month'       => $mod_Month,
         'Day'         => $mod_Day,
         'Hour'        => $mod_Hour,
         'Minute'      => $mod_Minute,
         'Second'      => $mod_Second,
         'string'      => $mod_string,
      },
   },

}

Newcomen::Role::Crawler::Filesystem:

{
   'path'           => {
      'root'        => {
         'absolute' => $root_abs,
         'config'   => $root_cfg,
      },
      'data'        => {
         'absolute' => $data_abs,
         'relative' => $data_rel,
         'config'   => $data_cfg,
      },
      'source'      => {
         'absolute' => $src_abs,
         'data'     => $src_data,
         'root'     => $src_root,
         'basename' => $src_base,
      },
      'parent'      => {
         'absolute' => $parent_abs,
         'data'     => $parent_data,
         'root'     => $parent_root,
      },
   },
}

VERSION ^

This is version 2014052501.

AUTHOR ^

Stefan Goebel - newcomen {at} subtype {dot} de

COPYRIGHT AND LICENSE ^

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/>.