NAME
HiD::Role::IsConverted - Role for objects that are converted during the publishing process
SYNOPSIS
package HiD::ThingThatIsConverted
use Moose;
with 'HiD::Role::IsConverted';
...
1;DESCRIPTION
This role is consumed by objects that are converted during the publication process -- e.g., from Markdown or Textile to HTML, or rendered through a layout object. This role provides required attributes and methods used during that process.
ATTRIBUTES
content ( ro / Str / required )
Page content (stuff after the YAML front matter)
converted_content ( ro / Str / lazily built from content )
Content after it has gone through the conversion process.
converted_excerpt ( ro / Str / lazily built from content )
Excerpt after it has gone through the conversion process
hid
The HiD object for the current site. Here primarily to provide access to site metadata.
layouts ( ro / HashRef[HiD::Layout] / required )
Hashref of layout objects keyed by name.
metadata ( ro / HashRef )
Hashref of info from YAML front matter
readmore_link
Placed at the bottom of rendered excerpts. Intended to link to the full version of the content.
A string matching __URL__ will be replaced with the URL of the object (i.e., the output of $self-url>) being converted.
rendered_content
Content after any layouts have been applied
template_data
Data for passing to template processing function.
VERSION
version 1.8
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.