News

2014-10-12 22:53 UTC

News Guide

Created 2012-07-24
Last Modified 2012-08-31 03:19 UTC
Archive Link http://example.com/news/2012/07

About

The news feed plugin manages an announcement directory. Markdown files placed in this directory will be used to generate announcement pages. Each page will be accompanied by an Atom feed.

When Xac detects a new item in the directory, it will prefix the file name with a timestamp if necessary and archive it into a subdirectory (image generated by tex2pngmonth).

After all of the new files have been archived, symlinks will be created to the most recent feeds. "Most recent" is determined by the age of the entry and by absolute number of entries on the page. By default, Xac will consider all entries created in the last 30 days to be recent, and it will always keep at least 5 entries on the page no matter how old they are. Both criteria can be set with simple function arguments. See publish.py for examples.

Entries are fully processed by Xac the same way the other content markdown files are. It is therefore possible to generate content using the pluging system.

Entry Format

To create a news entry, just create a markdown file in the news directory (e.g. files/news/foo.markdown). The entry should contain a header with a title and your name, e.g.

% My First Announcement
% Bobo

# New Website
I finally uploaded my new...

Other Uses

The plugin can also be used to publish blog entries or anything else with periodic updates. Custom templates that include comment sections or feedback forms can be used to create interactive pages as well. See the documentation and examples for the get_pandoc_template function.

Contact
foo@example.com