[jboss-cvs] JBossBlog SVN: r261 - trunk/docs.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Mar 13 09:37:46 EDT 2008
Author: adamw
Date: 2008-03-13 09:37:45 -0400 (Thu, 13 Mar 2008)
New Revision: 261
Modified:
trunk/docs/tutorial.html
Log:
Modified: trunk/docs/tutorial.html
===================================================================
--- trunk/docs/tutorial.html 2008-03-13 07:54:20 UTC (rev 260)
+++ trunk/docs/tutorial.html 2008-03-13 13:37:45 UTC (rev 261)
@@ -37,7 +37,7 @@
<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>
+ <code class="email"><<a href="mailto:adam.warski at jboss.org">adam.warski at jboss.org</a>></code>
</div>
</div>
</div>
@@ -60,11 +60,11 @@
</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>
+ Wordpress or wherever), which you use for authoring, 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>
+ improvements, .... Thanks :).</p>
<p>Also, when using the application, you'll probably notice a "Tips" box on the right - it often contains
description of configuration parameters, explains the meaning of some options etc.</p>
@@ -81,14 +81,14 @@
<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>
+ for some types of feeds, there are no posts which originate from them, 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>
+ one group, and all feeds that belong to that project should be in that group. For example, all feeds of blogs
+ of people involved in a project should belong to that 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
+ id for a post is determined basing on its title, and the ids for feeds and groups are determined by their
creators.</p>
</div>
@@ -111,8 +111,8 @@
<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
+ by aggregating that group. You may 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 accept only
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
@@ -135,12 +135,12 @@
</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>
+ as part of a feed page, or as part of a post page), there is always a link back to the original post, so that
+ users can, for example, add comments. 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>
+ <code>FEED_ID</code>, starting from post number <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
@@ -152,12 +152,12 @@
a link to the owning feed of that post.</p>
<p>How many posts appear on each page when viewing a feed, and how many posts appear in the ATOM feed, depends
- on feed settings. See the section for administration for information on how to set his, and other properties.</p>
+ on feed settings. See the section on administration for information on how to set these and other properties.</p>
<p>You can also customize the right part of the "View feed" page a little. For example, you may want to include
a "Back to MyProject page" link and a logo. You can do that, by setting a "Group header". It is a piece of HTML,
- which will be displayed right below the "Feeds home" link. To set it, got to administration -> manage groups ->
- edit group.</p>
+ which will be displayed right below the "Feeds home" link, when viewing any feed or post belonging to that group.
+ To set it, got to administration -> manage groups -> edit group.</p>
<p>Here is an example:</p>
@@ -188,7 +188,7 @@
<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
+ which group they think it should belong). You may also create separate groups
for community and employee blogs.</p>
</div>
@@ -221,18 +221,21 @@
</div>
</div>
</div>
- <p>To access the administration of feeds, simply login using your jboss.com login and password. If you authorized
- to manage anything, you should see additional links like this, near the top, on the right:</p>
+ <p>To access the administration of feeds, simply login using your jboss.com login and password. If you are
+ authorized to manage anything, you should see additional links like this, near the top, on the right:</p>
<p><img src="admin_link.png" alt=""/></p>
<p>If you don't see it, then you don't have any administrative rights. Mail your manager or me if you think
- you should have them.</p>
+ you should have them. Basically, if you are a manager of a project in Labs (that is, after loggin in to
+ labs.jboss.com you can see the "Edit project" button), you should be a manager of a corresponding group
+ in feeds.</p>
<p>After clicking that link, you'll see the following options:</p>
<div class="itemizedlist">
<ul>
- <li><span class="bold"><strong>Manage feed groups</strong></span> - lets you edit and add feed groups</li>
+ <li><span class="bold"><strong>Manage feed groups</strong></span> - lets you edit and add feed groups
+ (for example, group headers)</li>
<li><span class="bold"><strong>Manage security</strong></span> - lets you configure permissions for
accessing feeds and groups that you have permissions to</li>
<li>for each feed: <span class="bold"><strong>Edit common</strong></span> - lets you edit "common"
@@ -253,10 +256,43 @@
<div class="titlepage">
<div>
<div>
- <h2 class="title">8. Future improvements</h2>
+ <h2 class="title">8. Feeds portlet</h2>
</div>
</div>
</div>
+ <p>You can place one or more feeds portlets on your project page. To do that, log into Labs
+ (http://labs.jboss.com), navigate to your project and click the "Edit project" button. There
+ go to "Portlet selection". Choose the portal page on which you want the portlet placed, and
+ then from the left combo box choose "blog". Click the right arrow and the portlet is then
+ added to the selected page. Finally, specify its properties:</p>
+ <div class="itemizedlist">
+ <ul>
+ <li><span class="bold"><strong>feedName</strong></span> - id of the feed that you want to display; this is
+ the id that you input when editing feed properties, and that is also visible in URLs when viewing this
+ feed</li>
+ <li><span class="bold"><strong>numberOfPosts</strong></span> - how many headers of posts you want to display
+ </li>
+ <li><span class="bold"><strong>summaryLength</strong></span> - if a summary of post content should be shown
+ below the post headings, this should be the number of characters you'd like it to contain (200 is a sensible
+ default). If you don't want to have a summary displayed, set it to 0</li>
+ <li><span class="bold"><strong>showDate</strong></span> - should the date of publishing the post be
+ displayed below the header</li>
+ </ul>
+ </div>
+
+ <p>The portlet always renders a number of post titles, which link to "View post" pages, optionally with a summary
+ of the post content and the publishing date of the post. At the bottom, you'll also see two links: one to the
+ "View feed" page of the selected feed, other to the home feeds page.</p>
+</div>
+
+<div class="sect1">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title">9. Future improvements</h2>
+ </div>
+ </div>
+ </div>
<p>Here's some features planned for the future:</p>
<div class="itemizedlist">
<ul>
@@ -267,7 +303,7 @@
<li>DiggIt integration</li>
<li>adding more structure to authors (binding authors to users, searching for posts by a specific
author/user)</li>
- <li>anything you suggest -> <a href="mailto:adam at warski.org">adam at warski.org</a></li>
+ <li>anything you suggest -> <a href="mailto:adam.warski at jboss.org">adam.warski at jboss.org</a></li>
</ul>
</div>
</div>
More information about the jboss-cvs-commits
mailing list