diff --git a/README.mkdn b/README.mkdn index 4f2f60be..6e0ba2c6 100644 --- a/README.mkdn +++ b/README.mkdn @@ -52,8 +52,8 @@ language](https://metacpan.org/pod/Mojo::Template#SYNTAX). - SEO-friendly features such as [sitemaps (sitemap.xml)](http://www.sitemaps.org). - [Automatic checking for broken links](https://metacpan.org/pod/Statocles::Plugin::LinkCheck). - [Syntax highlighting](https://metacpan.org/pod/Statocles::Plugin::Highlight) for code and configuration blocks. -- Hooks to add [your own plugins](https://metacpan.org/pod/Statocles::Plugin) and [your own custom -applications](https://metacpan.org/pod/Statocles::App). +- Hooks to add [your own plugins](https://metacpan.org/pod/Statocles::Role::Plugin) and [your own custom +applications](https://metacpan.org/pod/Statocles::Role::App). # ATTRIBUTES diff --git a/lib/Statocles.pm b/lib/Statocles.pm index bb83dfc6..b9600c82 100644 --- a/lib/Statocles.pm +++ b/lib/Statocles.pm @@ -263,8 +263,8 @@ L for code and configuration b =item * -Hooks to add L and L. +Hooks to add L and L. =back diff --git a/lib/Statocles/App/Basic.pm b/lib/Statocles/App/Basic.pm index 4ef5092e..f8e2abb6 100644 --- a/lib/Statocles/App/Basic.pm +++ b/lib/Statocles/App/Basic.pm @@ -5,7 +5,7 @@ our $VERSION = '0.094'; use Statocles::Base 'Class'; use Statocles::Document; use Statocles::Util qw( run_editor read_stdin ); -with 'Statocles::App::Role::Store'; +with 'Statocles::Role::App::Store'; =attr store diff --git a/lib/Statocles/App/Blog.pm b/lib/Statocles/App/Blog.pm index 4d1d3ec5..038ff646 100644 --- a/lib/Statocles/App/Blog.pm +++ b/lib/Statocles/App/Blog.pm @@ -10,7 +10,7 @@ use Statocles::Page::Document; use Statocles::Page::List; use Statocles::Util qw( run_editor read_stdin ); -with 'Statocles::App::Role::Store'; +with 'Statocles::Role::App::Store'; =attr store @@ -377,7 +377,7 @@ sub index { my @pages = $app->tag_pages( \%tag_pages ); -Get L for the tags in the given blog post documents +Get L for the tags in the given blog post documents (build from L, including relevant feed pages. @@ -448,7 +448,7 @@ sub tag_pages { my @pages = $app->pages( %options ); -Get all the L for this application. Available options +Get all the L for this application. Available options are: =over 4 @@ -606,7 +606,7 @@ sub recent_posts { my $url = $app->page_url( $page ) -Return the absolute URL to this L, removing the +Return the absolute URL to this L, removing the "/index.html" if necessary. =cut @@ -760,7 +760,7 @@ The post author =over 4 -=item L +=item L =back diff --git a/lib/Statocles/App/Perldoc.pm b/lib/Statocles/App/Perldoc.pm index c11e388f..8a3c7437 100644 --- a/lib/Statocles/App/Perldoc.pm +++ b/lib/Statocles/App/Perldoc.pm @@ -7,7 +7,7 @@ use Statocles::Page::Plain; use Scalar::Util qw( blessed ); use Pod::Simple::Search; use Pod::Simple::XHTML; -with 'Statocles::App'; +with 'Statocles::Role::App'; =attr inc @@ -92,7 +92,7 @@ has '+template_dir' => ( my @pages = $app->pages; -Render the requested modules as HTML. Returns an array of L objects. +Render the requested modules as HTML. Returns an array of L objects. =cut diff --git a/lib/Statocles/App/Static.pm b/lib/Statocles/App/Static.pm index 98497958..68f2cf96 100644 --- a/lib/Statocles/App/Static.pm +++ b/lib/Statocles/App/Static.pm @@ -5,7 +5,7 @@ our $VERSION = '0.094'; use Statocles::Base 'Class'; use Statocles::Page::File; use Statocles::Util qw( derp ); -with 'Statocles::App'; +with 'Statocles::Role::App'; =attr store @@ -24,7 +24,7 @@ has store => ( my @pages = $app->pages; -Get the L for this app. +Get the L for this app. =cut @@ -54,5 +54,5 @@ B This application's functionality has been added to L. You can use the Basic app to replace this app. This class will be removed with v2.0. See L. -This L manages static content with no processing, +This L manages static content with no processing, perfect for images, stylesheets, scripts, or already-built HTML. diff --git a/lib/Statocles/Deploy/File.pm b/lib/Statocles/Deploy/File.pm index e662dc83..eb56f3f3 100644 --- a/lib/Statocles/Deploy/File.pm +++ b/lib/Statocles/Deploy/File.pm @@ -3,7 +3,7 @@ our $VERSION = '0.094'; # ABSTRACT: Deploy a site to a folder on the filesystem use Statocles::Base 'Class'; -with 'Statocles::Deploy'; +with 'Statocles::Role::Deploy'; use Statocles::Util qw( dircopy ); =attr path @@ -60,13 +60,13 @@ __END__ This class allows a site to be deployed to a folder on the filesystem. -This class consumes L. +This class consumes L. =head1 SEE ALSO =over 4 -=item L +=item L =back diff --git a/lib/Statocles/Deploy/Git.pm b/lib/Statocles/Deploy/Git.pm index 168b875e..4a3c84b3 100644 --- a/lib/Statocles/Deploy/Git.pm +++ b/lib/Statocles/Deploy/Git.pm @@ -208,13 +208,13 @@ __END__ This class allows a site to be deployed to a Git repository. -This class consumes L. +This class consumes L. =head1 SEE ALSO =over 4 -=item L +=item L =back diff --git a/lib/Statocles/Document.pm b/lib/Statocles/Document.pm index b7b24565..498da0cc 100644 --- a/lib/Statocles/Document.pm +++ b/lib/Statocles/Document.pm @@ -312,7 +312,7 @@ This disables processing the content as a template. This can speed up processing when the content is not using template directives. This can be also set in the application -(L), or for the entire site +(L), or for the entire site (L). =cut @@ -461,8 +461,8 @@ __END__ =head1 DESCRIPTION A Statocles::Document is the base unit of content in Statocles. -L take documents to build -L. +L take documents to build +L. Documents are usually written as files, with the L in Markdown, and the other attributes as frontmatter, a block of YAML at the top of the file. diff --git a/lib/Statocles/Event.pm b/lib/Statocles/Event.pm index 07618a98..1970c7f6 100644 --- a/lib/Statocles/Event.pm +++ b/lib/Statocles/Event.pm @@ -17,13 +17,13 @@ extends 'Beam::Event'; =attr pages -An array of L objects +An array of L objects =cut has pages => ( is => 'ro', - isa => ArrayRef[ConsumerOf['Statocles::Page']], + isa => ArrayRef[ConsumerOf['Statocles::Role::Page']], required => 1, ); diff --git a/lib/Statocles/Help.pod b/lib/Statocles/Help.pod index bd2cce9e..ac039694 100644 --- a/lib/Statocles/Help.pod +++ b/lib/Statocles/Help.pod @@ -48,7 +48,7 @@ L =item * -L - Base app role +L - Base app role =over 4 @@ -76,7 +76,7 @@ L - Command module =item * -L - Base deploy role +L - Base deploy role =over 4 @@ -144,7 +144,7 @@ L - A link to another place =item * -L - Base page role +L - Base page role =over 4 @@ -172,7 +172,7 @@ L - Page with pre-generated HTML =item * -L - Base class for Statocles plugins +L - Base role for Statocles plugins =over 4 diff --git a/lib/Statocles/Help/Config.pod b/lib/Statocles/Help/Config.pod index 9efff465..95eeb46c 100644 --- a/lib/Statocles/Help/Config.pod +++ b/lib/Statocles/Help/Config.pod @@ -39,8 +39,8 @@ More on that later. =head2 An App -A L is the driver that turns documents into -L. To build pages, we need a store full of documents. We +A L is the driver that turns documents into +L. To build pages, we need a store full of documents. We define our store with the string C, which will get magically coerced into a L. @@ -61,7 +61,7 @@ C, later). =head2 A Deploy To deploy our site to Github, we need to build a L for Git repositories using +object|Statocles::Role::Deploy> for Git repositories using L. Our deploy object will copy our built pages into the Git repository and commit them. Our deploy will happen in the root directory of our site on the C branch. @@ -405,7 +405,7 @@ Each plugin has a name (C), and requires a C<$class> (the class name of the plugin) and optional C<$args> (the plugin's attributes). -See L. +See L. =head2 Custom Markdown diff --git a/lib/Statocles/Help/Content.pod b/lib/Statocles/Help/Content.pod index 27da6b17..353ce17c 100644 --- a/lib/Statocles/Help/Content.pod +++ b/lib/Statocles/Help/Content.pod @@ -16,7 +16,7 @@ file|Statocles::Help::Config>. We can use that name to access the app's command-line commands. Not all applications have or need commands. See L for more information. +documentation|Statocles::Role::App/"SEE ALSO"> for more information. =head3 Create a Blog Post @@ -211,7 +211,7 @@ When the content is being generated, you have access to the following variables: =item C<$site> - The current L -=item C<$app> - The current L +=item C<$app> - The current L =back diff --git a/lib/Statocles/Help/Deploy.pod b/lib/Statocles/Help/Deploy.pod index 1b55179f..b085f534 100644 --- a/lib/Statocles/Help/Deploy.pod +++ b/lib/Statocles/Help/Deploy.pod @@ -193,5 +193,5 @@ placed. =head1 Custom Deploy Module If none of these work for you, you can build your own deploy module. See -L for details. +L for details. diff --git a/lib/Statocles/Help/Develop.pod b/lib/Statocles/Help/Develop.pod index e3b11774..f204bc75 100644 --- a/lib/Statocles/Help/Develop.pod +++ b/lib/Statocles/Help/Develop.pod @@ -22,8 +22,8 @@ L read and write documents. =item * -L use Stores to read documents and create -L. +L use Stores to read documents and create +L. =item * @@ -36,7 +36,7 @@ L that are given to Pages. =item * -Finally, the Site writes the Page to a L. +Finally, the Site writes the Page to a L. =back @@ -100,7 +100,7 @@ with no processing whatsoever. =head1 PAGES -A L is collected information ready to be rendered into HTML +A L is collected information ready to be rendered into HTML (or whatever). Statocles Applications generate pages from the documents that the user provides. One document may generate multiple pages, and pages may have multiple formats like HTML or RSS. @@ -171,7 +171,7 @@ L plugin can search all the pages for broken links. For another example, the L plugin adds the C function to all the templates in the site. -Plugins consume the L and must +Plugins consume the L and must implement the C method to add themselves where they need to be added. @@ -198,7 +198,7 @@ Plugins are added to the Site object's C attribute: =head2 Event Handlers -Instead of making an entire Statocles::Plugin, we can respond only to +Instead of making an entire Statocles::Role::Plugin, we can respond only to certain events using Beam::Wire's event handling API. In this example, we're going to enable the same LinkCheck plugin as diff --git a/lib/Statocles/Help/Theme.pod b/lib/Statocles/Help/Theme.pod index b9d57cad..b3d01ce2 100644 --- a/lib/Statocles/Help/Theme.pod +++ b/lib/Statocles/Help/Theme.pod @@ -107,17 +107,17 @@ allow you to evaluate Perl code, which is why the templates are also called =head2 Template Variables -When an application assembles a L, it sets values +When an application assembles a L, it sets values inside. The page then gives those values to the template. The common values in every template are: =over 4 -=item C<$self> - The current L object +=item C<$self> - The current L object =item C<$site> - The current L object -=item C<$app> - The current L object +=item C<$app> - The current L object =back diff --git a/lib/Statocles/Page/Document.pm b/lib/Statocles/Page/Document.pm index 0acc2381..f5c9e74d 100644 --- a/lib/Statocles/Page/Document.pm +++ b/lib/Statocles/Page/Document.pm @@ -3,7 +3,7 @@ our $VERSION = '0.094'; # ABSTRACT: Render document objects into HTML use Statocles::Base 'Class'; -with 'Statocles::Page'; +with 'Statocles::Role::Page'; use Statocles::Template; use Statocles::Store; @@ -108,7 +108,7 @@ If true, disables the processing of the content as a template. This will improve performance if you're not using any template directives in your content. This can be set in the document (L), -the application (L), or the site +the application (L), or the site (L). =cut @@ -240,7 +240,7 @@ sub tags { my $tmpl = $page->template; The L