.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CHRONICLE-ENTRY-FILTER 1"
.TH CHRONICLE-ENTRY-FILTER 1 "2011-05-03" "perl v5.12.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
chronicle\-entry\-filter \- Convert blog files to HTML, if required.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  Help Options
\&
\&    \-\-help        Show a brief help overview.
\&    \-\-version     Show the version of this script.
\&
\&  Options
\&
\&    \-\-format      The global format of all entries.
\&    \-\-filename    The name of the single file to process.
\&
\&  Filters
\&
\&    \-\-pre\-filter  A filter to run before convertion to HTML.
\&    \-\-post\-filter A filter to run after HTML conversion.
.Ve
.SH "ABOUT"
.IX Header "ABOUT"
This script is designed to receive a filename and a global formatting type
upon the command line.  The formatting type specifies how the blog entry
file will be processed:
.PP
.Vb 2
\&  1.  If the format is "textile" the file will be converted from textile
\&     to HTML.
\&
\&  2.  If the format is "markdown" the file will be converted from markdown
\&     to HTML.  The related format "multimarkdown" is also recognised.
\&
\&  3.  If the format is "html" no changes will be made.
.Ve
.PP
Once the conversion has been applied the code will also be scanned for
<code> tags to expand via the \fBText::VimColour\fR module, if it is installed,
which allows the pretty-printing of source code.
.PP
To enable the syntax highlighting of code fragments you should format your
code samples as follows:
.PP
.Vb 3
\&   Subject: Some highlighted code.
\&   Date: 25th December 2009
\&   Tags: chronicle, perl, blah
\&
\&   <p>Here is some code which will look pretty ..</p>
\&   <code lang="perl">
\&   #!/usr/bin/perl \-w
\&   ...
\&   ..
\&   </code>
.Ve
.PP
Notice the use of lang=\*(L"perl\*(R", which provides a hint as to the type of
syntax highlighting to apply.
.PP
Additionally you may make use of the pre-filter and post-filter pseudo-headers
which allow you to transform the entry in further creative fashions.
.PP
For example you might wish the blog to be upper-case only for some reason,
and this could be achieved via:
.PP
.Vb 5
\&  Subject: I DONT LIKE LOWER CASE
\&  Tags: meta, random, silly
\&  Date: 25th December 2009
\&  Pre\-Filter: perl \-pi \-e "s/_\|_USER_\|_/\`whoami\`/g"
\&  Post\-filter: tr [a\-z] [A\-Z]
\&
\&  <p>This post, written by _\|_USER_\|_ will have no lower\-case values.</p>
\&  <p>Notice how my username was inserted too?</p>
.Ve
.PP
You may chain arbitrarily complex filters together via the filters.  Each
filter should read the entry on \s-1STDIN\s0 and return the updated content to
\&\s-1STDOUT\s0.
.PP
(If you wish to apply a global filter simply pass that as an argument to
chronicle, or in your chroniclerc file.)
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 3
\& Steve
\& \-\-
\& http://www.steve.org.uk/
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2009\-2010 by Steve Kemp.  All rights reserved.
.PP
This module is free software;
you can redistribute it and/or modify it under
the same terms as Perl itself.
The \s-1LICENSE\s0 file contains the full text of the license.