[jboss-cvs] JBossBlog SVN: r257 - trunk/docs.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Wed Mar 12 11:15:11 EDT 2008


Author: adamw
Date: 2008-03-12 11:15:11 -0400 (Wed, 12 Mar 2008)
New Revision: 257

Added:
   trunk/docs/admin_link.png
   trunk/docs/group_header.png
Modified:
   trunk/docs/tutorial.html
Log:


Added: trunk/docs/admin_link.png
===================================================================
(Binary files differ)


Property changes on: trunk/docs/admin_link.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/docs/group_header.png
===================================================================
(Binary files differ)


Property changes on: trunk/docs/group_header.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: trunk/docs/tutorial.html
===================================================================
--- trunk/docs/tutorial.html	2008-03-12 13:43:35 UTC (rev 256)
+++ trunk/docs/tutorial.html	2008-03-12 15:15:11 UTC (rev 257)
@@ -48,7 +48,7 @@
     <div class="titlepage">
         <div>
             <div>
-                <h2 class="title"> 1. About</h2>
+                <h2 class="title">1. About</h2>
             </div>
         </div>
     </div>
@@ -65,6 +65,9 @@
     <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>
+
+    <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>
 </div>
 
 <div class="sect1">
@@ -147,13 +150,37 @@
     <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>
+
+    <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>
+
+    <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>
+
+    <p>Here is an example:</p>
+
+    <p><img src="group_header.png" alt="" /></p>
+
+    <p>And the corresponding HTML:</p>
+
+    <code>
+&lt;a href="/jbossjbpm"&gt;<br />
+&lt;img width="200" src="/file-access/default/members/jbossjbpm/images/jbpm_logo.png" alt="" /&gt;<br />
+&lt;/a&gt;<br />
+<br />
+&lt;ul&gt;<br />
+   &lt;li&gt;&lt;a href="/jbossjbpm"&gt;Back to the JBoss jBPM project page&lt;/a&gt;&lt;/li&gt;<br />
+&lt;/ul&gt;
+    </code>
 </div>
 
 <div class="sect1">
     <div class="titlepage">
         <div>
             <div>
-                <h2 class="title">5. Community involvment</h2>
+                <h2 class="title">5. Community involvement</h2>
             </div>
         </div>
     </div>
@@ -165,5 +192,85 @@
     for community and employee blogs.</p>
 </div>
 
+<div class="sect1">
+    <div class="titlepage">
+        <div>
+            <div>
+                <h2 class="title">6. Permissions</h2>
+            </div>
+        </div>
+    </div>
+    <p>You can have the following administrative permissions:</p>
+    <div class="itemizedlist">
+        <ul>
+            <li><span class="bold"><strong>group X manager</strong></span> - having this role, you can edit
+            the name, id, header of the given group. You can also add new feeds, and edit properties of existing ones.
+            Moreover, you're able to create new feed groups. Finally, you can administrate security for that group -
+            that is, grant other users/user groups the permission to be a group or feed manager</li>
+            <li><span class="bold"><strong>feed X manager</strong></span> - having this role, you can edit
+            the properties of the given feed</li>
+        </ul>
+    </div>
+</div>
+
+<div class="sect1">
+    <div class="titlepage">
+        <div>
+            <div>
+                <h2 class="title">7. Administration</h2>
+            </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><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>
+
+    <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 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"
+            properties of a feed, that is, properties that all feed types share, like the number of posts in
+            a feed, number of posts displayed on a "View feed" page, title and author of the feed, etc.</li>
+            <li>for each feed: <span class="bold"><strong>Edit specific</strong></span> - lets you edit "specifc"
+            properties of a feed, that is, properties unique to that type of feed. That is, for a remote feed -
+            the address of the XML, for an aggregated feed - what is aggregated and with what filters, for a
+            highlights feed - the order of posts, for a shotoku feed - the directory, from which posts are read.</li>
+        </ul>
+    </div>
+
+    <p>To add posts to a highlights feed, simply create the feed (if it's not yet created), navigate to the post
+    that you want to add and click the "Add to a highlights feed ..." link that should appear there.</p>
+</div>
+
+<div class="sect1">
+    <div class="titlepage">
+        <div>
+            <div>
+                <h2 class="title">8. Future improvements</h2>
+            </div>
+        </div>
+    </div>
+    <p>Here's some features planned for the future:</p>
+    <div class="itemizedlist">
+        <ul>
+            <li>statistics</li>
+            <li>search</li>
+            <li>users proposing a single post, not a whole feed</li>
+            <li>del.icio.us integration</li>
+            <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>
+        </ul>
+    </div>
+</div>
+
 </body>
 </html>
\ No newline at end of file




More information about the jboss-cvs-commits mailing list