Changes between Version 13 and Version 14 of Divan

Timestamp:

Nov 10, 2008, 1:41:42 PM (16 years ago)

Author:

cmlenz

Comment:

View creation is now handled automatically

Divan

@@ -1 +1 @@
 = Divan =
+
 Divan is a simple blogging platform that is [source:trunk/examples/divan included] with Diva as an example application.
 
@@ -5 +6 @@
 
 It supports comments with [http://openid.net/ OpenID authentication], [http://hixie.ch/specs/pingback/pingback-1.0 pingbacks], [http://atomenabled.org/ Atom feeds] for the whole blog, individual categories, and comments, and the [http://atomenabled.org/developers/protocol/ Atom publishing protocol]. It does not provide a HTML-based interface for authoring entries, nor does it support the XML-RPC based !MetaWeblog API.
+
+== Setting Up ==
+
+You'll need Diva, [http://incubator.apache.org/couchdb/ CouchDB] (0.8 or later), and [http://code.google.com/p/couchdb-python/ CouchDB-Python] (trunk) installed. CouchDB needs to be running, and it needs to contain an empty database named "divan" (the name can be changed using a config option, see below).
+
+Change into the `examples/divan` directory in the Diva source, and run:
+
+{{{
+$ PYTHONPATH=. ./divan/app.py -v
+[INFO] diva.server: Serving <__main__.Blog object at 0x5c0290> on 127.0.0.1:8080
+}}}
+
+This will install (or update) the view definitions in the database, and run the web application on `http://localhost:8080/`.
+
+See the DevelopmentServer page for more server options.
 
 == Configuration Options ==
@@ -17 +33 @@
  `moderation_email_to`:: The email address that moderation notification mails should be sent to
 
-
-== CouchDB Views ==
-[[PageOutline(3-4, Views)]]
-
-All views are in Javascript.
-
-=== `_design/posts` ===
-
-==== `by_month` ====
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post') {
-    var year = parseInt(doc.published.substr(0, 4), 10);
-    var month = parseInt(doc.published.substr(5, 2), 10);
-    emit([year, month, doc.published], {
-      slug: doc.slug, title: doc.title, author: doc.author, summary: doc.summary,
-      published: doc.published, updated: doc.updated, tags: doc.tags
-    });
-  }
-}
-}}}
-
-==== `by_slug` ====
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post') {
-    var year = parseInt(doc.published.substr(0, 4), 10);
-    var month = parseInt(doc.published.substr(5, 2), 10);
-    emit([year, month, doc.slug], doc);
-  }
-}
-
-}}}
-
-==== `by_tag` ====
-
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post' && doc.tags) {
-    for (var idx in doc.tags) {
-      emit([doc.tags[idx], doc.published], {
-        slug: doc.slug, title: doc.title, author: doc.author, published: doc.published, updated: doc.updated,
-        summary: doc.summary, body: doc.body, tags: doc.tags, extended: doc.extended != '' ? '…' : null
-      });
-    }
-  }
-}
-}}}
-
-==== `by_time` ====
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post') {
-    emit([doc.published], {
-      slug: doc.slug, title: doc.title, author: doc.author, summary: doc.summary,
-      body: doc.body, published: doc.published, updated: doc.updated, extended: doc.extended != '' ? '…' : null,
-      tags: doc.tags, allow_comments: doc.allow_comments, num_comments: doc.num_comments,
-      allow_pings: doc.allow_pings, num_pings: doc.num_pings});
-  }
-}
-}}}
-
-==== `by_update` ====
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post') {
-    emit([doc.updated], null);
-  }
-}
-}}}
-
-==== `months` ====
-''Map'':
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post') {
-    var year = parseInt(doc.published.substr(0, 4), 10);
-    var month = parseInt(doc.published.substr(5, 2), 10);
-    emit([year, month], 1);
-  }
-}
-}}}
-
-''Reduce'':
-{{{
-#!javascript
-function(keys, values) {
-  return sum(values);
-}
-}}}
-
-==== `tags` ====
-''Map'':
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Post' && doc.tags) {
-    for (var idx in doc.tags) {
-      emit(doc.tags[idx], 1);
-    }
-  }
-}
-}}}
-
-''Reduce'':
-{{{
-#!javascript
-function(keys, values) {
-  return sum(values);
-}
-}}}
-
-=== `_design/comments` ===
-
-==== `whitelist` ====
-
-''Map'':
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Comment' && doc.published) {
-    emit(doc.openid, 1);
-  }
-}
-}}}
-
-''Reduce'':
-{{{
-#!javascript
-function(keys, values) {
-  return sum(values);
-}
-}}}
-
-=== `_design/pings` ===
-
-==== `by_uri` ====
-
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Ping') {
-    emit([doc.post_id, doc.uri], null);
-  }
-}
-}}}
-
-=== `_design/reactions` ===
-
-==== `by_post` ====
-
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Ping' && doc.published) {
-    emit([doc.post_id, doc.time], {
-      type: doc.type, uri: doc.uri, title: doc.title,
-      author: doc.author, excerpt: doc.excerpt,
-      time: doc.time
-    });
-  } else if (doc.type == 'Comment' && doc.published) {
-    emit([doc.post_id, doc.time], {
-      type: doc.type, openid: doc.openid, author: doc.author,
-      markup: doc.markup, time: doc.time
-    });
-  }
-}
-}}}
-
-==== `by_time` ====
-
-{{{
-#!javascript
-function(doc) {
-  if (doc.type == 'Ping' && !doc.published) {
-    emit([doc.time, doc.type], doc);
-  } else if (doc.type == 'Comment' && doc.authenticated && !doc.published) {
-    emit([doc.time, doc.type], doc);
-  }
-}
-}}}
-