[jboss-cvs] JBossBlog SVN: r256 - in trunk: docs and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Mar 12 09:43:36 EDT 2008
Author: adamw
Date: 2008-03-12 09:43:35 -0400 (Wed, 12 Mar 2008)
New Revision: 256
Added:
trunk/docs/
trunk/docs/tutorial.html
Log:
Added: trunk/docs/tutorial.html
===================================================================
--- trunk/docs/tutorial.html (rev 0)
+++ trunk/docs/tutorial.html 2008-03-12 13:43:35 UTC (rev 256)
@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+ <title>JBoss.ORG Feeds tutorial</title>
+ <link rel="stylesheet" href="http://labs.jboss.com/files/portletcontainer/docs/2.0.0.CR1/css/jbossorg.css" type="text/css"/>
+</head>
+<body>
+<p id="title">
+ <a href="http://www.jboss.org" class="jbossOrg_href">
+ <strong>
+ JBoss.org
+ </strong>
+ </a>
+ <a href="http://labs.jboss.com/projects/docs" class="commDoc_href">
+ <strong>
+ Community Documentation
+ </strong>
+ </a>
+</p>
+<div class="book" lang="en">
+ <div class="titlepage">
+ <div>
+ <div>
+
+ <h1 class="title">
+ <a id="d0e1"/>JBoss.ORG Feeds</h1>
+ </div>
+ <div>
+ <h2 class="subtitle">Tutorial</h2>
+ </div>
+ <div>
+ <div class="author">
+
+ <h3 class="author">
+ <span class="firstname">Adam</span>
+ <span class="surname">Warski</span>
+ </h3>
+ <code class="email"><<a href="mailto:adam at warski.org">adam at warski.org</a>></code>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title"> 1. About</h2>
+ </div>
+ </div>
+ </div>
+ <p>The Feeds application has two main functions:</p>
+ <div class="itemizedlist">
+ <ul>
+ <li><span class="bold"><strong>aggregating</strong></span> blogs of JBoss employees</li>
+ <li><span class="bold"><strong>archiving</strong></span> posts</li>
+ </ul>
+ </div>
+ <p>It is not meant to be a blog-authoring application. So you should have an outside blog (on Blogger,
+ Wordpress or wherever), and then aggregate it into the feeds system.</p>
+
+ <p>If you have any questions about the application, please mail me. If you see a bug, mail me or create
+ a bug in <a href="http://jira.jboss.com/jira/browse/JBBLOG">JIRA</a>. The same applies for feature suggestions,
+ improvements etc. Thanks :).</p>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title">2. Groups, feeds, posts</h2>
+ </div>
+ </div>
+ </div>
+ <p>The application is organized around <span class="bold"><strong>feeds</strong></span>. A feed is linked to an
+ arbitrary number of <span class="bold"><strong>posts</strong></span>. However, the fact that a feed is linked to
+ a post doesn't imply that it is the owner of that post. A feed owns a post if that post originated from that feed;
+ from some types of feeds, there are no posts which originate from it, see below.</p>
+
+ <p>Feeds are organized in <span class="bold"><strong>groups</strong></span>. Basically, one project should have
+ one group, and all feeds that belong to that project. For example, all feeds of blogs of people involved in that
+ project should belong to the project's feed group.</p>
+
+ <p>Each post, feed and group have a unique id, which is a sequence of lowercase letters, numbers and _. The
+ id for a post is determined basing on its title, and the ids for a feed and group are determined by their
+ creators.</p>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title">3. Types of feeds</h2>
+ </div>
+ </div>
+ </div>
+ <p>There are currently 4 types of feeds. The "type" of a feed is invisible to the user. It just determines the
+ way that posts of a feed are determined. The types are:</p>
+ <div class="itemizedlist">
+ <ul>
+ <li><span class="bold"><strong>remote feed</strong></span> - a feed which reads and archives posts
+ from an XML feed, given as an internet address. The XML feed can be of any type (RSS2/ATOM/RDF).
+ All posts that are linked to this feed are also owned
+ by this feed, so if you delete a remote feed, you also delete all posts that where archived.</li>
+ <li><span class="bold"><strong>aggregated feed</strong></span> - a feed which combines posts from other
+ feeds, or groups. For example, you may want to create an aggregated feed for all blog feeds of your
+ project. For simplicity, you may simply aggregate posts from feeds that belong to your group,
+ by aggregating that group. You may also include posts from any number of feeds/ groups. Moreover, you
+ can filter which posts from a feed/ group you want, by adding post filters. Such filters may only include
+ posts by a specific author, or from a specific category. This type of feed doesn't own the posts that
+ are linked to it.</li>
+ <li><span class="bold"><strong>shotoku feed</strong></span> - a feed which reads posts
+ from a directory in SVN. The posts are files in that directory; post titles are the svn 'title' property
+ on that files. This feed also owns all posts that are linked to it.</li>
+ <li><span class="bold"><strong>highlights feed</strong></span> - a feed which lets you choose posts
+ that will appear in it, and their order. This can be very useful if you'd like to have on your webpage
+ a "top news" or "top blog posts of the month" window. Of course, this feed doesn't own the posts that
+ are linked to it.
+ </ul>
+ </div>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title">4. Viewing</h2>
+ </div>
+ </div>
+ </div>
+ <p>Users can view the feeds and posts using the webpage, or using an ATOM feed. When viewing a post (either
+ as part of a feed page, or as part of a post page), there is always a link back to the orignal post, so that
+ users can add comments, for example. The URL schemes are:</p>
+ <div class="itemizedlist">
+ <ul>
+ <li><code>http://labs.jboss.com/blogs/view/FEED_ID?from=X</code> - for viewing a feed with id
+ <code>FEED_ID</code>, starting from post <code>X</code>.</li>
+ <li><code>http://labs.jboss.com/blogs/feed/FEED_ID?type=atom</code> - for getting an ATOM feed of a feed
+ with id <code>FEED_ID</code>.</li>
+ <li><code>http://labs.jboss.com/blogs/post/POST_ID</code> - for viewing a single post, with id
+ <code>POST_ID</code>.</li>
+ </ul>
+ </div>
+ <p>Because all posts are archived, the URLs for posts will be valid even after the posts disappear from a blog
+ feed (normally blog feeds contain only the 10 or so newest posts). Also, the page for viewing a single post contains
+ a link to the owning feed of that post.</p>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title">5. Community involvment</h2>
+ </div>
+ </div>
+ </div>
+ <p>Normal users (which aren't JBoss employees) have the possibility to
+ <span class="bold"><strong>propose</strong></span> their feeds for inclusion in the system. Of course, the
+ posts have to be JBoss- or JBoss project X- related. Users can only add remote feeds, and before they get
+ included in the system, they have to be accepted by a group administrator (when proposing a blog, users state to
+ which group they think it should belong). You may also create a separate group
+ for community and employee blogs.</p>
+</div>
+
+</body>
+</html>
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list