Newcomen

Description A static content generator.
Newcomen > Perl Modules > Newcomen::Writer::Specification
Source

Index


NAME ^

Newcomen::Writer::Specification - A writer backend specification.

SYNOPSIS ^

use Newcomen::Writer::Specification;

my $spec = Newcomen::Writer::Specification -> new (
   'name' => $backend_name
);

# Set some option:
$spec -> set (['some', 'option'], 'value');

DESCRIPTION ^

A writer backend specification contains a writer backend name and its options. This is for example used in Newcomen::Page instances to store the writer that should be used for the page.

CLASS METHODS ^

new

my $spec = Newcomen::Writer::Specification -> new (
   'name' => $backend_name
);

Constructor. The name parameter is mandatory, it specifies the writer backend by its basename (i.e. the module name without the 'Newcomen::Writer::' prefix). The name can not be changed later on. Newcomen::Writer::Specification does not check if a backend by the specified name exists.

INSTANCE METHODS ^

Please see Newcomen::Role::Backend::Specification for a list of instance methods and their description.

SEE ALSO ^

Newcomen::Data, Newcomen::Page, Newcomen::Role::Backend::Specification, Newcomen::Writer

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