Recent changes to Home

Home modified by Tim Van Patten

Tim Van Patten — Tue, 09 Apr 2013 04:50:32 -0000

--- v3
+++ v4
@@ -3,6 +3,10 @@
 The redditIWidget is an iWidget that shows if the user has any comments, private messages, or moderator mail.   It also shows the current Comment and Link Karma.   In order to use this iWidget, you must have iWidget installed, and a server running Python 2.7 that can be accessed whenever you want the iWidget to be updated.

 When a message is present, the Reddit alien icon changes to show a picture of him holding an orangered envelope.   In addition, there will be a count of the number of messages, preceded by the initial for the type of message ('C' for comment reply, 'P' for Private Message, 'M' for mod mail).   Only the relevant message type counts (those with a count greater than zero) will be shown.
+
+Here is a sample of what it looks like when a message is present:
+
+

 Normally, the karma counts are shown in white.   However, if the count changed, then the color of the number will change.   When the count increases, the color will change to orange (the color of an upvote).   When the count decreases, the color will change to blue (the color of a downvote).

Home modified by Tim Van Patten

Tim Van Patten — Tue, 09 Apr 2013 04:12:36 -0000

--- v2
+++ v3
@@ -1,13 +1,31 @@
 # redditIWidget

-The following pages describe various aspects of the widget and the server that the widget connects to.
+The redditIWidget is an iWidget that shows if the user has any comments, private messages, or moderator mail.   It also shows the current Comment and Link Karma.   In order to use this iWidget, you must have iWidget installed, and a server running Python 2.7 that can be accessed whenever you want the iWidget to be updated.
+
+When a message is present, the Reddit alien icon changes to show a picture of him holding an orangered envelope.   In addition, there will be a count of the number of messages, preceded by the initial for the type of message ('C' for comment reply, 'P' for Private Message, 'M' for mod mail).   Only the relevant message type counts (those with a count greater than zero) will be shown.
+
+Normally, the karma counts are shown in white.   However, if the count changed, then the color of the number will change.   When the count increases, the color will change to orange (the color of an upvote).   When the count decreases, the color will change to blue (the color of a downvote).
+
+In order for the widget to operate, it needs to be able to get the necessary data from Reddit (current message and karma counts).   However, iWidget doesn't provide a platform that allows widgets to directly perform these types of queries from Reddit, since Reddit requires the user to be logged in to get their comment counts (FYI - message counts are available as semi-private RSS feeds).   So, in order to get the necessary data, another server must be running that is able to do the heavy lifting, that the widget can query for an update.
+
+To do this, I chose to take advantage of PRAW, which provides a very simple interface to authenticate with Reddit with OAuth.   Once the server is authenticated with Reddit, the iWidget can simply make a request to the server for an update.   The server will ask Reddit for the necessary data, parse the JSON and repackage as simple XML and send it to the iWidget to be displayed on the phone.
+
+The server can theoretically handle multiple Reddit accounts at once (the point of using the database to hold the data), though I have only barely tested this.   I do want to thank the PRAW developers, since they were very quick to fix a caching bug I came across in their package.
+
+
+
+# The following pages describe various aspects of the widget and the server that the widget connects to.

 ## Server
 [Packages]
 [Database]
+[How to Configure the Server]

+##
+##
 ## Widget
 [Loading Code to iPhone]
+[Using the Widget]

 [[project_admins]]

Home modified by Tim Van Patten

Tim Van Patten — Tue, 09 Apr 2013 03:57:17 -0000

--- v1
+++ v2
@@ -1,8 +1,14 @@
-Welcome to your wiki!
+# redditIWidget

-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+The following pages describe various aspects of the widget and the server that the widget connects to.

-The wiki uses [Markdown](/p/redditiwidget/wiki/markdown_syntax/) syntax.
+## Server
+[Packages]
+[Database]
+
+## Widget
+[Loading Code to iPhone]
+

 [[project_admins]]
 [[download_button]]

Home modified by Tim Van Patten

Tim Van Patten — Tue, 09 Apr 2013 03:16:04 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Tim Van Patten