NAME

www-staticblog - Generate a static site using WWW::StaticBlog

VERSION

0.02

SYNOPSIS

    www-staticblog --title <title> [options...]
    www-staticblog --configfile <file>
    www-staticblog ( -? | --usage | --help )

DESCRIPTION

You can use this program to generate a static site (most likely a blog) from a set of templates, and posts.

COMMAND-LINE OPTIONS

--title <title>

The site's title. Populated in site_title for the templates.

--tagline <tagline>

The site's tagline. Populated in site_tagline for the templates.

--posts_dir <posts_dir>

Directory contining the post entry files to parse.

--authors_dir <authors_dir>

Directory containing the author files to parse.

--static_dir <static_dir>

Directory containing static/pre-generated files to be copied into --output_dir.

--output_dir <output_dir> (Default: `pwd`)

Directory to ouput the generated site.

--template_class <template_class> (Default: '::Template::Toolkit')

Module to use for templating. Will look under WWW::StaticBlog::, if it starts with ::.

--template_options <template_options>

Options to pass to the template class constructor.

--index_template <index_template>

Template to use when rendering the site's index page.

--index_post_count <#> (Default: 10)

The number of posts to show on the index page (by populating this many in posts for the template).

--post_template <post_template>

Template to use when rendering posts.

--author_template <author_template>

Template to use when rendering author pages.

--tag_template <tag_template>

Template to use when rendering tag pages.

--debug

Render site in debugging mode, by setting debug for the templates.

--post_feed <post_feed>

The location of where to generate an Atom feed of posts.

    --post_feed feed/atom.xml

--post_feed_count <#> (Default: 10)

The number of posts to show in the Atom feed.

--recent_posts_count <#> (Default: 15)

Used to determine how many (at most) posts to populate in recent_posts for the templates.

--url <url>

Base URL of the site being generated. (Must be provided when --post_feed is given.)

--configfile <file>

Configuration file to read options from.

For example http://technosorcery.net uses the following www-staticblog.yaml config file:

    ---
    title: Technosorcery Networks
    tagline: Ramblings of Jacob Helwig
    authors_dir: authors
    posts_dir: articles
    static_dir: static
    output_dir: build
    template_class: '::Template::Toolkit'
    template_options:
        INCLUDE_PATH:
            - template/src
            - template/lib
        WRAPPER: site
    index_template: index.tt2
    post_template: post.tt2
    author_template: author.tt2
    tag_template: tag.tt2
    post_feed: feed/atom.xml
    url: http://technosorcery.net/

-?, --usage, --help

Output a list of all of the options.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-www-staticblog@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/J/JH/JHELWIG/>.

AUTHOR

Jacob Helwig <jhelwig at cpan.org>

COPYRIGHT AND LICENSE

Copyright 2010 by Jacob Helwig

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