anil madhavapeddy // anil.recoil.org
Review2Atom is a result of my experiments with Ocamlduce, which is an extension to allow statically-typed XML processing using OCaml. The first problem I wanted to solve was an easy way to publish my (and friends) academic paper reviews while writing up our PhD theses. The application just grabs a set of "paper review files" in XML format and outputs them as an Atom feed suitable for aggregation. It also supports a simple Wiki-style markup to quickly markup content in the paper review.
Create a configuration file in ~/.review2atom.conf in the following format:
<conf> <title>Anil's Paper Feed</title> <!-- Any relative hrefs in your feed will use this as the base --> <baseurl>http://anil.recoil.org/paperreviews/</baseurl> <!-- Feed URL should be the online location of the Atom feed --> <feedurl>http://anil.recoil.org/paperfeed.atom</feedurl> <author> <name>Anil Madhavapeddy</name> <email>firstname.lastname@example.org</email> <uri>http://anil.recoil.org/</uri> </author> </conf>
Invoke the program with the list of review XML files to be converted into the Atom feed. The atom feed is output directly to stdout, so redirect it somewhere useful.
$ cp review2atom.conf.sample ~/.review2atom.conf (edit as appropriate) $ review2atom ~/reviews/*.xml > ~/public_html/mypaperfeed.xml
Review XML format
Each review file should be in the following format:
<review> <!-- Title of the paper --> <title></title> <!-- Online URL for the work --> <url></url> <!-- What problem are they trying to solve? --> <problem></problem> <!-- None or more categories to tag this paper under. Can be comma separated, or multiple tags specified depending on your preference --> <tag term="security,privacy" /> <tag term="mobile" /> <!-- Dump the bibtex in here. If possible, try to get a good entry from portal.acm.org or similar. --> <bibtex></bibtex> <!-- All tags below this point are optional --> <!-- What is their approach? --> <approach></approach> <!-- How do they evaluate their work? --> <evaluation></evaluation> <!-- What is your opinion on this work? --> <opinion></opinion> <!-- What future work does this lend itself to? --> <future></future> <!-- Misc comments go in here --> <comments></comments> </review>
Inside the tags, you can use Wiki-style text markup to avoid having to code in XHTML directly. The system is broadly based on Textile but is much simpler. Any phrase to be marked up must have whitespace at the start and end (or be the start/end of the tag) to be transformed to avoid catching normal punctuation.
review2atom-0.1.tar.gz (md5: ee102be232d3ce9821c6fbd815ef5d1a)
23 September 2005: Initial 0.1 test release.
Copyright © 2002-2010 by Anil Madhavapeddy. All rights reserved.
Original design used with kind permission from Jon Parise. Hosted by the awesome Bytemark.
Valid XHTML 1.0