review fixes

doc/source/_static/jquery.tweet.js

@@ -0,0 +1,154 @@
+(function($) {
+ 
+  $.fn.tweet = function(o){
+    var s = {
+      username: ["seaofclouds"],              // [string]   required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"]
+      list: null,                              //[string]   optional name of list belonging to username
+      avatar_size: null,                      // [integer]  height and width of avatar if displayed (48px max)
+      count: 3,                               // [integer]  how many tweets to display?
+      intro_text: null,                       // [string]   do you want text BEFORE your your tweets?
+      outro_text: null,                       // [string]   do you want text AFTER your tweets?
+      join_text:  null,                       // [string]   optional text in between date and tweet, try setting to "auto"
+      auto_join_text_default: "i said,",      // [string]   auto text for non verb: "i said" bullocks
+      auto_join_text_ed: "i",                 // [string]   auto text for past tense: "i" surfed
+      auto_join_text_ing: "i am",             // [string]   auto tense for present tense: "i was" surfing
+      auto_join_text_reply: "i replied to",   // [string]   auto tense for replies: "i replied to" @someone "with"
+      auto_join_text_url: "i was looking at", // [string]   auto tense for urls: "i was looking at" http:...
+      loading_text: null,                     // [string]   optional loading text, displayed while tweets load
+      query: null                             // [string]   optional search query
+    };
+    
+    if(o) $.extend(s, o);
+    
+    $.fn.extend({
+      linkUrl: function() {
+        var returning = [];
+        var regexp = /((ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?)/gi;
+        this.each(function() {
+          returning.push(this.replace(regexp,"<a href=\"$1\">$1</a>"));
+        });
+        return $(returning);
+      },
+      linkUser: function() {
+        var returning = [];
+        var regexp = /[\@]+([A-Za-z0-9-_]+)/gi;
+        this.each(function() {
+          returning.push(this.replace(regexp,"<a href=\"http://twitter.com/$1\">@$1</a>"));
+        });
+        return $(returning);
+      },
+      linkHash: function() {
+        var returning = [];
+        var regexp = / [\#]+([A-Za-z0-9-_]+)/gi;
+        this.each(function() {
+          returning.push(this.replace(regexp, ' <a href="http://search.twitter.com/search?q=&tag=$1&lang=all&from='+s.username.join("%2BOR%2B")+'">#$1</a>'));
+        });
+        return $(returning);
+      },
+      capAwesome: function() {
+        var returning = [];
+        this.each(function() {
+          returning.push(this.replace(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'));
+        });
+        return $(returning);
+      },
+      capEpic: function() {
+        var returning = [];
+        this.each(function() {
+          returning.push(this.replace(/\b(epic)\b/gi, '<span class="epic">$1</span>'));
+        });
+        return $(returning);
+      },
+      makeHeart: function() {
+        var returning = [];
+        this.each(function() {
+          returning.push(this.replace(/(&lt;)+[3]/gi, "<tt class='heart'>&#x2665;</tt>"));
+        });
+        return $(returning);
+      }
+    });
+
+    function relative_time(time_value) {
+      var parsed_date = Date.parse(time_value);
+      var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
+      var delta = parseInt((relative_to.getTime() - parsed_date) / 1000);
+      var pluralize = function (singular, n) {
+        return '' + n + ' ' + singular + (n == 1 ? '' : 's');
+      };
+      if(delta < 60) {
+      return 'less than a minute ago';
+      } else if(delta < (45*60)) {
+      return 'about ' + pluralize("minute", parseInt(delta / 60)) + ' ago';
+      } else if(delta < (24*60*60)) {
+      return 'about ' + pluralize("hour", parseInt(delta / 3600)) + ' ago';
+      } else {
+      return 'about ' + pluralize("day", parseInt(delta / 86400)) + ' ago';
+      }
+    }
+
+    function build_url() {
+      var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
+      if (s.list) {
+        return proto+"//api.twitter.com/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?per_page="+s.count+"&callback=?";
+      } else if (s.query == null && s.username.length == 1) {
+        return proto+'//twitter.com/status/user_timeline/'+s.username[0]+'.json?count='+s.count+'&callback=?';
+      } else {
+        var query = (s.query || 'from:'+s.username.join('%20OR%20from:'));
+        return proto+'//search.twitter.com/search.json?&q='+query+'&rpp='+s.count+'&callback=?';
+      }
+    }
+
+    return this.each(function(){
+      var list = $('<ul class="tweet_list">').appendTo(this);
+      var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
+      var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
+      var loading = $('<p class="loading">'+s.loading_text+'</p>');
+
+      if(typeof(s.username) == "string"){
+        s.username = [s.username];
+      }
+
+      if (s.loading_text) $(this).append(loading);
+      $.getJSON(build_url(), function(data){
+        if (s.loading_text) loading.remove();
+        if (s.intro_text) list.before(intro);
+        $.each((data.results || data), function(i,item){
+          // auto join text based on verb tense and content
+          if (s.join_text == "auto") {
+            if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
+              var join_text = s.auto_join_text_reply;
+            } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) {
+              var join_text = s.auto_join_text_url;
+            } else if (item.text.match(/^((\w+ed)|just) .*/im)) {
+              var join_text = s.auto_join_text_ed;
+            } else if (item.text.match(/^(\w*ing) .*/i)) {
+              var join_text = s.auto_join_text_ing;
+            } else {
+              var join_text = s.auto_join_text_default;
+            }
+          } else {
+            var join_text = s.join_text;
+          };
+
+          var from_user = item.from_user || item.user.screen_name;
+          var profile_image_url = item.profile_image_url || item.user.profile_image_url;
+          var join_template = '<span class="tweet_join"> '+join_text+' </span>';
+          var join = ((s.join_text) ? join_template : ' ');
+          var avatar_template = '<a class="tweet_avatar" href="http://twitter.com/'+from_user+'"><img src="'+profile_image_url+'" height="'+s.avatar_size+'" width="'+s.avatar_size+'" alt="'+from_user+'\'s avatar" title="'+from_user+'\'s avatar" border="0"/></a>';
+          var avatar = (s.avatar_size ? avatar_template : '');
+          var date = '<a href="http://twitter.com/'+from_user+'/statuses/'+item.id+'" title="view tweet on twitter">'+relative_time(item.created_at)+'</a>';
+          var text = '<span class="tweet_text">' +$([item.text]).linkUrl().linkUser().linkHash().makeHeart().capAwesome().capEpic()[0]+ '</span>';
+
+          // until we create a template option, arrange the items below to alter a tweet's display.
+          list.append('<li>' + avatar + date + join + text + '</li>');
+
+          list.children('li:first').addClass('tweet_first');
+          list.children('li:odd').addClass('tweet_even');
+          list.children('li:even').addClass('tweet_odd');
+        });
+        if (s.outro_text) list.after(outro);
+      });
+
+    });
+  };
+})(jQuery);

doc/source/_static/tweaks.css

@@ -0,0 +1,65 @@
+ul.todo_list {
+    list-style-type: none;
+    margin: 0;
+    padding: 0;
+}
+
+ul.todo_list li {
+    display: block;
+    margin: 0;
+    padding: 7px 0;
+    border-top: 1px solid #eee;
+}
+
+ul.todo_list li p {
+    display: inline;
+}
+
+ul.todo_list li p.link {
+    font-weight: bold;
+}
+
+ul.todo_list li p.details {
+    font-style: italic;
+}
+
+ul.todo_list li {
+}
+
+div.admonition {
+    border: 1px solid #8F1000;
+}
+
+div.admonition p.admonition-title {
+    background-color: #8F1000;
+    border-bottom: 1px solid #8E8E8E;
+}
+
+a {
+	color: #CF2F19;
+}
+
+div.related ul li a {
+	color: #CF2F19;
+}
+
+div.sphinxsidebar h4 {
+	background-color:#8E8E8E;
+	border:1px solid #255E6E;
+	color:white;
+	font-size:1em;
+	margin:1em 0 0.5em;
+	padding:0.1em 0 0.1em 0.5em;
+}
+
+em {
+    font-style: normal;
+}
+
+table.docutils {
+	font-size: 11px;
+}
+
+a tt {
+	color:#CF2F19;
+}

doc/source/client.rst

@@ -27,7 +27,7 @@ metadata about an image, change metadata about an image, remove images, and
 of course retrieve an image itself via this client class.
 
 Below are some examples of using Glance's Client class.  We assume that
-there is a Glance server running at the address `glance.openstack.org`
+there is a Glance server running at the address `glance.example.com`
 on port `9292`.
 
 Requesting a List of Public VM Images
@@ -40,7 +40,7 @@ Using Glance's Client, we can do this using the following code::
 
   from glance import client
 
-  c = client.Client("glance.openstack.org", 9292)
+  c = client.Client("glance.example.com", 9292)
 
   print c.get_images()
 
@@ -55,7 +55,7 @@ Using Glance's Client, we can do this using the following code::
 
   from glance import client
 
-  c = client.Client("glance.openstack.org", 9292)
+  c = client.Client("glance.example.com", 9292)
 
   print c.get_images_detailed()
 
@@ -76,9 +76,9 @@ first public image returned, we can use the following code::
 
   from glance import client
 
-  c = client.Client("glance.openstack.org", 9292)
+  c = client.Client("glance.example.com", 9292)
 
-  print c.get_image_meta("http://glance.openstack.org/images/1")
+  print c.get_image_meta("http://glance.example.com/images/1")
 
 
 Retrieving a Virtual Machine Image
@@ -97,9 +97,9 @@ first public image returned and its image data, we can use the following code::
 
   from glance import client
 
-  c = client.Client("glance.openstack.org", 9292)
+  c = client.Client("glance.example.com", 9292)
 
-  meta, image_file = c.get_image("http://glance.openstack.org/images/1")
+  meta, image_file = c.get_image("http://glance.example.com/images/1")
 
   print meta
 
@@ -124,7 +124,7 @@ wish to do two things:
 
 We can do the above two activities in a single call to the Glance client.
 Assuming, like in the examples above, that a Glance API server is running
-at `glance.openstack.org`, we issue a call to `glance.client.Client.add_image`.
+at `glance.example.com`, we issue a call to `glance.client.Client.add_image`.
 
 The method signature is as follows::
 
@@ -219,7 +219,7 @@ Glance::
 
   from glance.client import Client
 
-  c = Client("glance.openstack.org", 9292)
+  c = Client("glance.example.com", 9292)
 
   meta = {'name': 'Ubuntu 10.10 5G',
           'type': 'machine',

doc/source/glanceapi.rst

@@ -24,7 +24,7 @@ A host that runs the `bin/glance-api` service is said to be a *Glance API
 Server*.
 
 Assume there is a Glance API server running at the URL
-http://glance.openstack.org. 
+http://glance.example.com. 
 
 Let's walk through how a user might request information from this server.
 
@@ -34,12 +34,12 @@ Requesting a List of Public VM Images
 We want to see a list of available virtual machine images that the Glance
 server knows about.
 
-We issue a `GET` request to http://glance.openstack.org/images/ to retrieve
+We issue a `GET` request to http://glance.example.com/images/ to retrieve
 this list of available *public* images. The data is returned as a JSON-encoded
 mapping in the following format::
 
   {'images': [
-    {'uri': 'http://glance.openstack.org/images/1',
+    {'uri': 'http://glance.example.com/images/1',
      'name': 'Ubuntu 10.04 Plain',
      'type': 'kernel',
      'size': '5368709120'}
@@ -56,12 +56,12 @@ Requesting Detailed Metadata on Public VM Images
 We want to see more detailed information on available virtual machine images
 that the Glance server knows about.
 
-We issue a `GET` request to http://glance.openstack.org/images/detail to
+We issue a `GET` request to http://glance.example.com/images/detail to
 retrieve this list of available *public* images. The data is returned as a
 JSON-encoded mapping in the following format::
 
   {'images': [
-    {'uri': 'http://glance.openstack.org/images/1',
+    {'uri': 'http://glance.example.com/images/1',
      'name': 'Ubuntu 10.04 Plain 5GB',
      'type': 'kernel',
      'size': '5368709120',
@@ -79,7 +79,7 @@ Notes:
  * All images returned from the above `GET` request are *public* images
  * All timestamps returned are in UTC
  * The `updated_at` timestamp is the timestamp when an image's metadata
-   was last updated, not it's image data, as all image data is immutable
+   was last updated, not its image data, as all image data is immutable
    once stored in Glance
  * The `properties` field is a mapping of free-form key/value pairs that
    have been saved with the image metadata
@@ -100,13 +100,13 @@ Continuing the example from above, in order to get metadata about the
 first public image returned, we can issue a `HEAD` request to the Glance
 server for the image's URI.
 
-We issue a `HEAD` request to http://glance.openstack.org/images/1 to
+We issue a `HEAD` request to http://glance.example.com/images/1 to
 retrieve complete metadata for that image. The metadata is returned as a
 set of HTTP headers that begin with the prefix `x-image-meta-`. The
 following shows an example of the HTTP headers returned from the above
 `HEAD` request::
 
-  x-image-meta-uri              http://glance.openstack.org/images/1
+  x-image-meta-uri              http://glance.example.com/images/1
   x-image-meta-name             Ubuntu 10.04 Plain 5GB
   x-image-meta-type             kernel
   x-image-meta-size             5368709120
@@ -122,7 +122,7 @@ Notes:
 
  * All timestamps returned are in UTC
  * The `x-image-meta-updated_at` timestamp is the timestamp when an
-   image's metadata was last updated, not it's image data, as all 
+   image's metadata was last updated, not its image data, as all 
    image data is immutable once stored in Glance
  * There may be multiple headers that begin with the prefix
    `x-image-meta-property-`.  These headers are free-form key/value pairs
@@ -145,7 +145,7 @@ Continuing the example from above, in order to get metadata about the
 first public image returned, we can issue a `HEAD` request to the Glance
 server for the image's URI.
 
-We issue a `GET` request to http://glance.openstack.org/images/1 to
+We issue a `GET` request to http://glance.example.com/images/1 to
 retrieve metadata for that image as well as the image itself encoded
 into the response body.
 
@@ -153,7 +153,7 @@ The metadata is returned as a set of HTTP headers that begin with the
 prefix `x-image-meta-`. The following shows an example of the HTTP headers
 returned from the above `GET` request::
 
-  x-image-meta-uri              http://glance.openstack.org/images/1
+  x-image-meta-uri              http://glance.example.com/images/1
   x-image-meta-name             Ubuntu 10.04 Plain 5GB
   x-image-meta-type             kernel
   x-image-meta-size             5368709120
@@ -169,7 +169,7 @@ Notes:
 
  * All timestamps returned are in UTC
  * The `x-image-meta-updated_at` timestamp is the timestamp when an
-   image's metadata was last updated, not it's image data, as all 
+   image's metadata was last updated, not its image data, as all 
    image data is immutable once stored in Glance
  * There may be multiple headers that begin with the prefix
    `x-image-meta-property-`.  These headers are free-form key/value pairs
@@ -194,10 +194,10 @@ wish to do two things:
 
 We can do the above two activities in a single call to the Glance API.
 Assuming, like in the examples above, that a Glance API server is running
-at `glance.openstack.org`, we issue a `POST` request to add an image to
+at `glance.example.com`, we issue a `POST` request to add an image to
 Glance::
 
-  POST http://glance.openstack.org/images/
+  POST http://glance.example.com/images/
 
 The metadata about the image is sent to Glance in HTTP headers. The body
 of the HTTP request to the Glance API will be the MIME-encoded disk