John SJ Anderson > HiD-1.5 > HiD::Role::IsPublished

Download:
HiD-1.5.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.5   Source  

NAME ^

HiD::Role::IsPublished - Role to be consumed by classes that are published during processing

SYNOPSIS ^

    package MyThingThatIsPublished;
    use Moose;
    with 'HiD::Role::IsPublished';

    ...

    1;

DESCRIPTION ^

This role is for all objects that go through the HiD publishing process. It provides attributes and methods that are needed during that process.

ATTRIBUTES ^

basename ( ro / isa = Str / lazily built from input_filename )

Basename of the file for this object (that is, without any leading directory path and without any file extension).

baseurl

Base URL for use in Templates

dest_dir ( ro / isa = HiD_DirPath / required )

The path to the directory where the output_filename will be written.

ext ( ro / isa = HiD_FileExtension / lazily built from filename )

The extension on the input filename of the consuming object.

input_filename ( ro / isa = HiD_FilePath / required )

The path of the consuming object's file. Required for instantiation.

input_path ( ro / isa = HiD_DirPath / lazily built from input_filename )

The path component of the input filename.

output_filename

Path to the file that will be created when the write method is called.

source ( ro / isa = Str )

Same as 'source' in HiD.pm. Normally shouldn't need to be provided.

url ( ro / isa = Str / lazily built from output_filename and dest_dir )

The URL to the output path for the written file.

VERSION ^

version 1.5

AUTHOR ^

John SJ Anderson <genehack@genehack.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by John SJ Anderson.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: