Product SiteDocumentation Site

BlazeBlogger Quick Reference

Creating a New Blog

Table A.1. Creating a New Blog Repository
Command Description
blaze-init Creates a new blog repository in a current directory.
blaze-init --blogdir ~/public_html Creates a new blog repository in ~/public_html/.
blaze-init --verbose Creates a new blog repository while displaying a list of created files.

Table A.2. Recovering a Corrupted Blog Repository
Command Description
blaze-init Recovers a corrupted blog repository while keeping existing files intact.
blaze-init --force Recovers a corrupted blog repository while reverting existing files to their initial state.
blaze-init --verbose Recovers a corrupted blog repository while displaying a list of created files.

Configuring a Blog

Table A.3. General Blog Settings
Command Description
blaze-config blog.title BlazeBlogger Changes the blog title to “BlazeBlogger”.
blaze-config blog.subtitle CMS without boundaries Changes the blog subtitle to “CMS without boundaries”.
blaze-config blog.description CMS without boundaries Changes the blog description to “CMS without boundaries”.
blaze-config blog.keywords blazeblogger, cms, blog Changes the blog keywords to “blazeblogger”, “cms”, and “blog”.
blaze-config blog.theme default.html Changes the blog theme to default.html.
blaze-config blog.style default.css Changes the style sheet to default.css.
blaze-config blog.lang en_US Changes the blog translation to en_US.
blaze-config blog.posts 10 Changes the number of blog posts to be listed on a single page to 10.

Table A.4. User Settings
Command Description
blaze-config user.name Jaromír Hradílek Changes the default blog post author to Jaromír Hradílek.
blaze-config user.nickname Blackened Changes the default blog post author's nickname to Blackened.
blaze-config user.email jhradilek@gmail.com Changes the email address to .

Table A.5. RSS Feed Settings
Command Description
blaze-config feed.baseurl http://blaze.blackened.cz Changes the URL of the blog to http://blaze.blackened.cz.
blaze-config feed.posts 10 Changes the number of blog posts to be listed in the feed to 10.
blaze-config feed.fullposts true Enables inclusion of the whole content of a blog post to the feed.

Table A.6. Color Settings
Command Description
blaze-config color.list true Enables colors in the blaze-list utility output.
blaze-config color.log true Enables colors in the blaze-log utility output.

Table A.7. Advanced Blog Post Settings
Command Description
blaze-config post.author top Places the blog post author above the post.
blaze-config post.date top Places the date of publishing above the post.
blaze-config post.tags bottom Places the blog post tags below the post.

Table A.8. Advanced BlazeBlogger Settings
Command Description
blaze-config core.doctype html Changes the document type to HTML.
blaze-config core.extension html Changes the file extension to html.
blaze-config core.encoding UTF-8 Changes the character encoding to UTF-8.
blaze-config core.editor 'gvim -f' Changes the external text editor to GVim.
blaze-config core.processor 'markdown %in% > %out%' Configures Markdown to process each blog post or a page.

Adding a Blog Post or a Page

Table A.9. Adding a Blog Post
Command Description
blaze-add Opens an external text editor for you to write the blog post in.
blaze-add release.txt changelog.txt Creates blog posts from the release.txt and changelog.txt files.
blaze-add --editor nano Opens the nano text editor for you to write the blog post in.
blaze-add --no-processor Opens an external text editor for you to write the blog post in while disabling processing it by an external application afterwards.

Table A.10. Adding a Page
Command Description
blaze-add --page Opens an external text editor for you to write the page in.
blaze-add --page about.txt downloads.txt Creates pages from the about.txt and downloads.txt files.
blaze-add --page --editor nano Opens the nano text editor for you to write the page in.
blaze-add --page --no-processor Opens an external text editor for you to write the page in while disabling processing it by an external application afterwards.

Editing a Blog Post or a Page

Table A.11. Editing a Blog Post
Command Description
blaze-edit 10 Opens an external text editor for you to edit the blog post with ID 10 in.
blaze-edit --editor nano 10 Opens the nano text editor for you to edit the blog post with ID 10 in.
blaze-edit --no-processor 10 Opens an external text editor for you to edit the blog post with ID 10 in while disabling processing it by an external application afterwards.
blaze-edit --force 10 Opens an external text editor for you to edit the blog post with ID 10 in, creating an empty source file in case it does not already exist.

Table A.12. Editing a Page
Command Description
blaze-edit --page 4 Opens an external text editor for you to edit the page with ID 4 in.
blaze-edit --page --editor nano 4 Opens the nano text editor for you to edit the page with ID 4 in.
blaze-edit --page --no-processor 4 Opens an external text editor for you to edit the page with ID 4 in while disabling processing it by an external application afterwards.
blaze-edit --page --force 4 Opens an external text editor for you to edit the page with ID 4 in, creating an empty source file in case it does not already exist.

Removing a Blog Post or a Page

Table A.13. Removing a Blog Post
Command Description
blaze-remove 3 4 11 Removes the blog posts with ID 3, 4, and 11.
blaze-remove --interactive 3 4 11 Removes the blog posts with ID 3, 4, and 11 while requiring manual confirmation of each removal.

Table A.14. Removing a Page
Command Description
blaze-remove --page 2 3 4 Removes the pages with ID 2, 3, and 4.
blaze-remove --page --interactive 2 3 4 Removes the pages with ID 2, 3, and 4 while requiring manual confirmation of each removal.

Listing Blog Posts or Pages

Table A.15. Listing Blog Posts
Command Description
blaze-list Lists all blog posts.
blaze-list --reverse Lists all blog posts in reverse order.
blaze-list --short Lists all blog posts, displaying each entry on a single line.
blaze-list --number 7 Lists the latest seven blog posts.
blaze-list --author "Jaromir Hradilek" Lists blog posts written by Jaromir Hradilek.
blaze-list --year 2009 --month 02 Lists blog posts written in February 2009.
blaze-list --tag release Lists blog posts tagged as release.
blaze-list --id 11 Displays the blog post with ID 11.

Table A.16. Listing Pages
Command Description
blaze-list --pages Lists all pages.
blaze-list --pages --reverse Lists all pages in reverse order.
blaze-list --pages --short Lists all pages, displaying each entry on a single line.
blaze-list --pages --number 3 Lists the latest three pages.
blaze-list --pages --id 4 Displays the page with ID 4.

Displaying Blog Statistics

Table A.17. Displaying Blog Statistics
Command Description
blaze-list --stats Displays blog statistics.
blaze-list --stats --short Displays blog statistics on a single line.

Generating a Blog

Table A.18. Generating a Blog
Command Description
blaze-make Generates a complete directory tree of static pages, including blog posts, single pages, monthly and yearly archives, tags, and an RSS feed.
blaze-make --destdir ~/public_html Generates a complete directory tree of static pages in the ~/public_html/ directory.
blaze-make --verbose Generates a complete directory tree of static pages while displaying a list of created files.
blaze-make --full-paths Generates a complete directory tree of static pages while including page names in generated links.
blaze-make --no-rss Generates a complete directory tree of static pages while omitting the creation of the RSS feed.

Displaying a Log

Table A.19. Displaying a Log
Command Description
blaze-log Lists all log entries.
blaze-log --reverse Lists all log entries in reverse order.
blaze-log --short Lists all log entries, displaying each record on a single line.
blaze-log --number 5 Lists the latest five log entries.

Creating a New Theme

Table A.20. List of Available Theme File Placeholders
Form Description
<!-- START-DOCUMENT --> Is replaced with the document header followed by the opening HTML tag.
<!-- END-DOCUMENT --> Is replaced with the closing HTML tag.
<!-- content-type --> Is replaced with the Content-Type META tag.
<!-- generator --> Is replaced with the Generator META tag.
<!-- copyright --> Is replaced with the Copyright META tag.
<!-- date --> Is replaced with the Date META tag.
<!-- description --> Is replaced with the Description META tag.
<!-- keywords --> Is replaced with the Keywords META tag.
<!-- stylesheet --> Is replaced with the Stylesheet LINK tag.
<!-- feed --> Is replaced with the RSS feed LINK tag.
<!-- page-title --> Is replaced with a page title.
<!-- title --> Is replaced with the blog title.
<!-- subtitle --> Is replaced with the blog subtitle.
<!-- name --> Is replaced with the author's name.
<!-- nickname --> Is replaced with the author's nickname.
<!-- e-mail --> Is replaced with the author's email.
<!-- year --> Is replaced with the current year.
<!-- tags --> Is replaced with the list of tags.
<!-- archive --> Is replaced with the list of months.
<!-- pages --> Is replaced with the list of pages.
<!-- posts --> Is replaced with the list of recent blog posts.
<!-- content --> Is replaced with the actual content.
%root% Is replaced with a relative path to the root directory of the blog.
%home% Is replaced with a relative path to the index page of the blog.
%page[id]% Is replaced with a relative path to a page with the given id.
%post[id]% Is replaced with a relative path to a blog post with the given id.
%tag[name]% Is replaced with a relative path to a tag with the given name.

Table A.21. List of Available Style Sheet Classes
Form Description
post A H2 tag containing the title of a blog post or a page.
section A DIV tag containing a section name.
information A DIV tag containing blog post meta information that are displayed above the post.
post-footer A DIV tag containing blog post meta information that are displayed below the post.
date A SPAN tag containing a date of publishing.
author A SPAN tag containing an author of a blog post.
tags A SPAN tag containing a list of attached tags.
previous A DIV tag containing a link to a page with older blog posts.
next A DIV tag containing a link to a page with newer blog posts.
more An A tag containing a “Read more” link.