# 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
# .
=head1 NAME
Newcomen::Manual::MetaData - Summary of all meta data used.
=head1 DESCRIPTION
B
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.
=head1 META DATA
=head2 Collections
L:
=over
{
'order_ascending' => ,
'index_collection' => ,
'atom_url' => ,
}
=back
L:
=over
{
'order_ascending' => ,
'atom_url' => ,
}
=back
L:
=over
{
'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,
}
=back
L:
=over
{
'year' => $year,
'month' => $month,
'day' => $day,
'ymd' => $ymd,
'archive_type' => $archive_type,
'archive_source' => $archive_source,
}
=back
=head2 Pages
L:
=over
{
'atom_uuid' => ,
'atom_updated' => ,
}
=back
L:
=over
{
'atom_uuid' => ,
'atom_updated' => ,
}
=back
L:
=over
{
'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'
}
=back
L:
=over
{
'page' => ,
'pages' => ,
'posts_total' => ,
'posts_from' => ,
'posts_to' => ,
'prev_page' => ,
'next_page' => ,
'page_type' => 'multiple',
}
=back
L:
=over
{
'page_type' => 'single',
}
=back
L:
=over
{
'source_file' => $source_file,
}
=back
=head2 Sources
L:
=over
{
'atom_uuid' => $uuid,
}
=back
L:
=over
{
'atom_updated' => $updated,
'atom_published' => $published,
}
=back
L:
=over
{
'time' => {
'lists' => {
'day' => [ "$year/$month/$day" ],
'month' => [ "$year/$month" ],
'year' => [ "$year" ]
},
},
}
=back
L:
=over
{
'menu' =>