Statocles::Document - Base class for all Statocles documents
version 0.054
A Statocles::Document is the base unit of content in Statocles. Applications take documents to build pages.
This is the Model class in the Model-View-Controller pattern.
The path to this document. This is not settable from the frontmatter.
The title of this document.
The author of this document.
The raw content of this document, in markdown. This is everything below the frontmatter.
The tags for this document. Tags are used to categorize documents.
Tags may be specified as an array or as a comma-seperated string of tags.
Related links for this document. Links are used to build relationships to other web addresses. Link categories are named based on their relationship. Some possible categories are:
Additional stylesheets for the content of this document.
Additional scripts for the content of this document.
A link to the same document in another format or posted to another web site
Each category contains an arrayref of hashrefs of link objects. See the Statocles::Link documentation for a full list of supported attributes. The most common attributes are:
The URL for the link.
The text of the link. Not needed for stylesheet or script links.
The date/time this document is for. For pages, this is the last modified date. For blog posts, this is the post's date.
A template override for this document. If set, the document page will use this instead of the template provided by the application.
A layout template override for this document. If set, the document page will use this instead of the layout provided by the application.
Any kind of miscellaneous data. This is available immediately in the document content.
The content guide describes how to edit content in Statocles sites, which are represented by Document objects.
Doug Bell <preaction@cpan.org>
This software is copyright (c) 2015 by Doug Bell.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Statocles, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Statocles
CPAN shell
perl -MCPAN -e shell install Statocles
For more information on module installation, please visit the detailed CPAN module installation guide.