chronicle-entry-filter(1) [debian man page]

CHRONICLE-ENTRY-FILTER(1)				User Contributed Perl Documentation				 CHRONICLE-ENTRY-FILTER(1)

NAME

       chronicle-entry-filter - Convert blog files to HTML, if required.

SYNOPSIS

	 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.

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:

	 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.

       Once the conversion has been applied the code will also be scanned for <code> tags to expand via the Text::VimColour module, if it is
       installed, which allows the pretty-printing of source code.

       To enable the syntax highlighting of code fragments you should format your code samples as follows:

	  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>

       Notice the use of lang="perl", which provides a hint as to the type of syntax highlighting to apply.

       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.

       For example you might wish the blog to be upper-case only for some reason, and this could be achieved via:

	 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>

       You may chain arbitrarily complex filters together via the filters.  Each filter should read the entry on STDIN and return the updated
       content to STDOUT.

       (If you wish to apply a global filter simply pass that as an argument to chronicle, or in your chroniclerc file.)

AUTHOR

	Steve
	--
	http://www.steve.org.uk/

LICENSE

       Copyright (c) 2009-2010 by Steve Kemp.  All rights reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  The LICENSE file contains the
       full text of the license.

perl v5.12.3							    2011-05-03						 CHRONICLE-ENTRY-FILTER(1)

Mail::Filter(3) 					User Contributed Perl Documentation					   Mail::Filter(3)

NAME

       Mail::Filter - Filter mail through multiple subroutines

SYNOPSIS

	use Mail::Filter;

	my $filter = Mail::Filter->new( &filter1, &filter2 );

	my $mail   = Mail::Internet->new( [<>] );
	my $mail   = $filter->filter($mail);

	my $folder = Mail::Folder->new( .... );
	my $filter->filter($folder);

DESCRIPTION

       "Mail::Filter" provides an interface to filtering Email through multiple subroutines.

       "Mail::Filter" filters mail by calling each filter subroutine in turn. Each filter subroutine is called with two arguments, the first is
       the filter object and the second is the mail or folder object being filtered.

       The result from each filter sub is passed to the next filter as the mail object. If a filter subroutine returns undef, then "Mail::Filter"
       will abort and return immediately.

       The function returns the result from the last subroutine to operate on the mail object.

METHODS

   Constructors
       Mail::Filter->new([FILTER [, ... ]])
	   Create a new "Mail::Filter" object with the given filter subroutines. Each filter may be either a code reference or the name of a
	   method to call on the <Mail::Filter> object.

   Accessors
       $obj->add(FILTER [, FILTER ...])
	   Add the given filters to the end of the filter list.

   Processing
       $obj->filter(MAIL-OBJECT | MAIL-FOLDER)
	   If the first argument is a "Mail::Internet" object, then this object will be passed through the filter list. If the first argument is a
	   "Mail::Folder" object, then each message in turn will be passed through the filter list.

       $obj->folder()
	   While the "filter" method is called with a "Mail::Folder" object, these filter subroutines can call this method to obtain the folder
	   object that is being processed.

       $obj->msgnum()
	   If the "filter" method is called with a "Mail::Folder" object, then the filter subroutines may call this method to obtain the message
	   number of the message that is being processed.

SEE ALSO

       This module is part of the MailTools distribution, http://perl.overmeer.net/mailtools/.

AUTHORS

       The MailTools bundle was developed by Graham Barr.  Later, Mark Overmeer took over maintenance without commitment to further development.

       Mail::Cap by Gisle Aas <aas@oslonett.no>.  Mail::Field::AddrList by Peter Orbaek <poe@cit.dk>.  Mail::Mailer and Mail::Send by Tim Bunce
       <Tim.Bunce@ig.co.uk>.  For other contributors see ChangeLog.

LICENSE

       Copyrights 1995-2000 Graham Barr <gbarr@pobox.com> and 2001-2007 Mark Overmeer <perl@overmeer.net>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.18.2							    2014-01-05							   Mail::Filter(3)