Module Expr Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore Str ImportFrom alias alias ImportFrom alias ImportFrom alias Import alias FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr If UnaryOpNot CompareIn Str NameLoad body Expr Call NameLoad Str Return NameLoad decorator_list ClassDef bases body FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body If CompareIs AttributeLoad NameLoad attr NameLoad body Expr Call AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list Call NameLoad Str NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Dict Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad Assign NameStore ListLoad Assign NameStore Dict Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr Str Str For NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad Assign NameStore Dict For NameStore ListLoad Str Str Str Str body Assign SubscriptStore NameLoad Index NameLoad Call AttributeLoad NameLoad attr BinOpAdd Str NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Assign NameStore SubscriptLoad NameLoad Index Str If UnaryOpNot CompareIn NameLoad NameLoad body Assign SubscriptStore NameLoad Index NameLoad BinOpMod NameLoad NameLoad Expr Call AttributeLoad NameLoad attr ListLoad BinOpMod Str NameLoad BinOpMod Str NameLoad Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Assign NameStore ListLoad For NameStore NameLoad body Expr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad Str attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str BinOpAdd NameLoad Str Assign SubscriptStore NameLoad Index Str NameLoad Assign AttributeStore NameLoad attr BinOpAdd NameLoad Str Assign SubscriptStore NameLoad Index Str Str Assign SubscriptStore NameLoad Index Str Str Assign SubscriptStore NameLoad Index Str Str Assign SubscriptStore NameLoad Index Str Str Expr Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr NameLoad Str Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list Assign NameStore Str FunctionDef arguments args NameParam defaults body Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr Assign SubscriptStore NameLoad Index Str Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr If CompareIn NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str Str Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore ListComp NameLoad comprehension NameStore NameLoad NameLoad If UnaryOpNot NameLoad body Return Assign NameStore SubscriptLoad NameLoad Index Num If BoolOpOr UnaryOpNot Call AttributeLoad NameLoad attr UnaryOpNot CompareEq Call NameLoad NameLoad Num body Return If CompareEq Call NameLoad NameLoad Num body Return TupleLoad NameLoad NameLoad If BoolOpAnd CompareEq Call NameLoad NameLoad Num Call AttributeLoad SubscriptLoad NameLoad Index Num attr Str body Assign NameStore NameLoad If CompareIn Str SubscriptLoad NameLoad Index Num body Assign NameStore SubscriptLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr Str Num Index Num Return TupleLoad NameLoad NameLoad Return decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call NameLoad NameLoad If CompareEq NameLoad NameLoad body Return Assign TupleStore NameStore NameStore NameLoad Assign SubscriptStore NameLoad Index NameLoad Num Assign NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign NameStore ListComp NameLoad comprehension NameStore NameLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr NameLoad Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr If UnaryOpNot NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Str Call AttributeLoad NameLoad attr Str Str Assign SubscriptStore NameLoad Index Str NameLoad Assign NameStore BinOpAdd BinOpAdd BinOpAdd BinOpAdd Str NameLoad Str NameLoad Str Assign NameStore Str Assign NameStore Str Assign NameStore Str Assign NameStore ListLoad Assign NameStore ListLoad Assign NameStore ListLoad For NameStore NameLoad body If UnaryOpNot NameLoad body Assign NameStore SubscriptLoad NameLoad Index Num If UnaryOpNot NameLoad body Assign NameStore SubscriptLoad NameLoad Index Num If CompareNotEq NameLoad SubscriptLoad NameLoad Index Num body Expr Call AttributeLoad NameLoad attr BinOpMod NameLoad TupleLoad NameLoad Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr Call NameLoad NameLoad NameLoad Call AttributeLoad Str attr NameLoad Assign NameStore SubscriptLoad NameLoad Index Num Assign NameStore SubscriptLoad NameLoad Index Num Assign NameStore ListLoad Assign NameStore ListLoad orelse If CompareNotEq NameLoad SubscriptLoad NameLoad Index Num body Expr Call AttributeLoad NameLoad attr BinOpMod NameLoad TupleLoad NameLoad Call AttributeLoad Str attr NameLoad Assign NameStore SubscriptLoad NameLoad Index Num Assign NameStore ListLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Index Str Expr Call AttributeLoad NameLoad attr BinOpMod NameLoad NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr BinOpMod NameLoad TupleLoad NameLoad Call AttributeLoad Str attr NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr Call NameLoad NameLoad NameLoad Call AttributeLoad Str attr NameLoad Return NameLoad decorator_list
N/A N/A 
Summary
=======

Walks through your blog root figuring out all the available years for
the archives list.  It stores the years with links to year summaries
in the variable ``$(archivelinks)``.  You should put this variable in
either your head or foot template.


Install
=======

This plugin comes with Pyblosxom.  To install, do the following:

1. Add ``Pyblosxom.plugins.yeararchives`` to the ``load_plugins`` list
   in your ``config.py`` file.

2. Add ``$(archivelinks)`` to your head and/or foot templates.

3. Configure as documented below.


Usage
=====

When the user clicks on one of the year links
(e.g. ``http://base_url/2004/``), then yeararchives will display a
summary page for that year.  The summary is generated using the
``yearsummarystory`` template for each month in the year.

My ``yearsummarystory`` template looks like this::

   <div class="blosxomEntry">
   <span class="blosxomTitle">$title</span>
   <div class="blosxomBody">
   <table>
   $body
   </table>
   </div>
   </div>


The ``$(archivelinks)`` link can be configured with the
``archive_template`` config variable.  It uses the Python string
formatting syntax.

Example::

    py['archive_template'] = (
        '<a href="%(base_url)s/%(Y)s/index.%(f)s">'
        '%(Y)s</a><br />')

The vars available with typical example values are::

    Y      4-digit year   ex: '1978'
    y      2-digit year   ex: '78'
    f      the flavour    ex: 'html'

.. Note::

   The ``archive_template`` variable value is formatted using Python
   string formatting rules--not Pyblosxom template rules!

 N/A __author__ Will Kahn-Greene N/A __email__ willg at bluesock dot org N/A __version__ 2010-05-08 N/A __url__ http://pyblosxom.github.com/ N/A __description__ Builds year-based archives listing. N/A __category__ archives N/A __license__ MIT N/A __registrytags__ 1.4, 1.5, core Pyblosxom tools entries Pyblosxom.memcache memcache_decorator Pyblosxom.tools pwrap N/A time verify_installation N/A N/A request N/A N/A N/A config N/A N/A request get_configuration N/A N/A N/A archive_template config N/A N/A N/A pwrap missing optional config property 'archive_template' which allows you to specify how the archive links are created.  refer to yeararchives plugin documentation for more details. N/A True N/A YearArchives N/A N/A __init__ N/A N/A self request N/A N/A N/A N/A self _request request N/A N/A self _archives None N/A N/A self _items None N/A __str__ N/A N/A self N/A N/A N/A N/A N/A self _archives None N/A N/A N/A N/A self gen_linear_archive N/A N/A self _archives N/A N/A memcache_decorator yeararchives True gen_linear_archive N/A N/A self N/A N/A N/A config N/A N/A N/A self _request get_configuration N/A data N/A N/A N/A self _request get_data N/A root N/A config N/A datadir N/A archives N/A N/A archive_list N/A N/A tools walk N/A self _request root N/A items N/A N/A fulldict N/A N/A N/A N/A fulldict update config N/A N/A N/A fulldict update data N/A flavour N/A N/A data get flavour N/A N/A config get default_flavour html N/A template N/A N/A config get archive_template <a href="%(base_url)s/%(Y)s/index.%(f)s">%(Y)s</a><br /> N/A mem archive_list N/A N/A timetuple N/A N/A tools filestat N/A self _request mem N/A timedict N/A N/A x N/A m Y y d N/A N/A N/A timedict N/A x N/A N/A time strftime N/A % x timetuple N/A N/A N/A fulldict update timedict N/A N/A fulldict N/A f flavour N/A year N/A fulldict N/A Y N/A N/A N/A year archives N/A N/A N/A archives N/A year N/A template fulldict N/A N/A N/A items append N/A N/A %(Y)s-%(m)s fulldict N/A %(Y)s-%(m)s-%(d)s fulldict N/A N/A time mktime timetuple mem N/A arc_keys N/A N/A archives keys N/A N/A N/A arc_keys sort N/A N/A N/A arc_keys reverse N/A result N/A N/A key arc_keys N/A N/A N/A N/A result append N/A archives N/A key N/A N/A self _archives N/A N/A join result N/A N/A self _items items N/A N/A new_entry N/A N/A request yearmonth body N/A N/A N/A 
    Takes a bunch of variables and generates an entry out of it.  It
    creates a timestamp so that conditionalhttp can handle it without
    getting all fussy.
     N/A entry N/A N/A N/A entries base EntryBase request N/A N/A entry N/A title yearmonth N/A N/A entry N/A filename N/A yearmonth /summary N/A N/A entry N/A file_path yearmonth N/A N/A entry _id N/A yearmonth ::summary N/A N/A entry N/A template_name yearsummarystory N/A N/A entry N/A nocomments yes N/A N/A entry N/A absolute_path N/A N/A entry N/A fn N/A N/A N/A entry set_time N/A N/A time strptime yearmonth %Y-%m N/A N/A N/A entry set_data body N/A entry N/A N/A INIT_KEY yeararchives_initiated cb_prepare N/A N/A args N/A N/A N/A request N/A args N/A request N/A data N/A N/A request get_data N/A N/A data N/A archivelinks N/A YearArchives request N/A cb_date_head N/A N/A args N/A N/A N/A request N/A args N/A request N/A data N/A N/A request get_data N/A N/A INIT_KEY data N/A N/A N/A args N/A template N/A args N/A parse_path_info N/A N/A path N/A N/A N/A Returns None or (year, flav) tuple.

    Handles urls of this type:

    - /2003
    - /2003/
    - /2003/index
    - /2003/index.flav
     N/A path N/A N/A path split / N/A path N/A m N/A m path m N/A N/A path N/A N/A N/A year N/A path N/A 0 N/A N/A N/A N/A N/A year isdigit N/A N/A N/A len year 4 N/A N/A N/A N/A N/A len path 1 N/A N/A N/A year None N/A N/A N/A N/A len path 2 N/A N/A N/A path N/A 1 startswith index N/A N/A flav None N/A N/A . N/A path N/A 1 N/A N/A flav N/A N/A N/A N/A path N/A 1 split . 1 N/A 1 N/A N/A year flav N/A N/A cb_filelist N/A N/A args N/A N/A N/A request N/A args N/A request N/A pyhttp N/A N/A request get_http N/A data N/A N/A request get_data N/A config N/A N/A request get_configuration N/A baseurl N/A N/A config get base_url N/A path N/A pyhttp N/A PATH_INFO N/A ret N/A parse_path_info path N/A N/A ret None N/A N/A N/A N/A year flavour ret N/A N/A data N/A INIT_KEY 1 N/A wa N/A YearArchives request N/A N/A N/A wa gen_linear_archive N/A items N/A wa _items N/A items N/A m N/A m items N/A N/A N/A m N/A 0 startswith year N/A N/A N/A items sort N/A N/A N/A items reverse N/A N/A flavour N/A N/A flavour N/A N/A data get flavour N/A N/A config get default_flavour html N/A N/A data N/A flavour flavour N/A l N/A N/A N/A N/A (%(path)s) <a href=" baseurl /%(file_path)s. flavour ">%(title)s</a><br> N/A e <tr>
<td valign="top" align="left">%s</td>
<td>%s</td></tr>
 N/A d N/A m N/A day N/A N/A month N/A N/A entrylist N/A N/A mem items N/A N/A N/A m N/A N/A m N/A mem N/A 0 N/A N/A d N/A N/A d N/A mem N/A 1 N/A N/A m N/A mem N/A 0 N/A N/A N/A N/A month append N/A e N/A d N/A N/A join day N/A N/A N/A entrylist append N/A new_entry request m N/A N/A join month N/A m N/A mem N/A 0 N/A d N/A mem N/A 1 N/A day N/A N/A month N/A N/A N/A N/A d N/A mem N/A 1 N/A N/A N/A N/A month append N/A e N/A d N/A N/A join day N/A d N/A mem N/A 1 N/A day N/A N/A entry N/A N/A N/A entries fileentry FileEntry request N/A mem N/A 3 N/A config N/A datadir N/A N/A N/A day append N/A l entry N/A day N/A N/A N/A N/A month append N/A e N/A d N/A N/A join day N/A month N/A N/A N/A N/A entrylist append N/A new_entry request m N/A N/A join month N/A entrylist N/A