Overview
- Title
- improve the atom feed
- Duration
- 240
- Difficulty
- Hard
- Types
- Code, User Interface, Research
- Tags
- atom,python,xml,html,css,mercurial,jinja2
- Mentors
- thomaswaldmann,rb_proj,waldi,esyr,pkumar_7
- Count
- -1
Description
Abstract
moin2 has an rudimentary implementation of an atom feed, but it is neither complete, nor "nice" to look at.
Your task is to significantly improve the feed, its usability, its looks, how it shows different kinds of changes in the wiki.
Details
TODO:
- look at how the atom feed of moin2 and the rss feed of moin 1.9 currently look like
- look at the feeds of other wikis - how do they present changes to the feed user?
- make a suggestion about what you want to improve, why and how exactly
- improve diff display?
- when show a diff, when show full item?
- html diff or text diff?
- discuss your suggestion with moin devs
- cleanly implement the changes
Deliverables: changesets, screenshots before/after
Skill Requirements
See tags. Additionally, we expect that you regularly use lots of feeds and have experience with different (atom) feed readers. You must know what a feed reading user usually expects and how a nice feed looks like. You must know python, xml, atom etc. well enough to implement your ideas.
Links
Note: unless otherwise noted, tasks usually refer to moin2 (http://moinmo.in/MoinMoin2.0)!
http://hg.moinmo.in/moin/2.0 repository of moin2
http://hg.moinmo.in/moin/1.9 repository of moin 1.9
http://moimo.in/MoinMoinChat - please join us on IRC #moin-dev
Discussion
Shitiz Garg : DocuWiki doesn't provide atom feed, so looking at MediaWiki they provide a minimilastic HTML formatted diff. I believe that should be the way to go. Text diffs are much harder to read than HTML side by side diffs, and since atom standard supports HTML, a cleanly formatted HTML side by side diffs should be provided. Similar to how it is currently done in history diff, but with some information removed because one doesn't need to know the size itself in atom feed. The complete file should not be sent unless it's the first item, only the changed parts should be sent to make it easier for the reader to comprehend.