NAME
Statocles::Document - Base class for all Statocles documents
DESCRIPTION
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.
ATTRIBUTES
path
The path to this document. This is not settable from the frontmatter.
title
The title of this document.
author
The author of this document.
content
The raw content of this document, in markdown. This is everything below the frontmatter.
tags
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.
links
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:
- stylesheet
-
Additional stylesheets for the content of this document.
- script
-
Additional scripts for the content of this document.
- alternate
-
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:
- href
-
The URL for the link.
- text
-
The text of the link. Not needed for stylesheet or script links.
date
The date/time this document is for. For pages, this is the last modified date. For blog posts, this is the post's date.
template
A template override for this document. If set, the document page will use this instead of the template provided by the application.
layout
A layout template override for this document. If set, the document page will use this instead of the layout provided by the application.
data
Any kind of miscellaneous data. This is available immediately in the document content.
SEE ALSO
- Statocles::Help::Content
-
The content guide describes how to edit content in Statocles sites, which are represented by Document objects.