Adding group feed documentation, a=chris
Adding group feed documentation, a=chris
diff --git a/en-US/pages/documentation.thtml b/en-US/pages/documentation.thtml
index d7fb757..07ea8d0 100755
--- a/en-US/pages/documentation.thtml
+++ b/en-US/pages/documentation.thtml
@@ -1889,14 +1889,83 @@ Yioop from a mobile device.
<p><a href="#toc">Return to table of contents</a>.</p>
<h3 id='feeds-wikis'>Feeds and Wikis</h3>
+ <p>The initial screen of the Feeds and Wikis page has an integrated list
+ of all the recent posts to any groups to which a user subscribes:</p>
<img src='resources/FeedsWikis.png' alt='The Main Feeds and Wiki Page'/>
+ <p>The [<<] arrow link at the top let's one collapse the right hand
+ Activity element to free up screen real estate for the feed. Once collapsed,
+ a link [>>] will appear to let you show the Activity Element again.
+ </p>
+ <p>Notice posts are displayed with the most recent post at the top.
+ If there has been very recent activity (within the last five minute),
+ this page will refresh every 15 seconds for up to twenty minutes, checking
+ for new posts.
+ Each post has a title which links to a thread for that post. This
+ is followed by the group title which although gray can be clicked to go
+ to that particular group feed. Next is the time when the post was made.
+ Beneath the title of the post, is the username of the person who posted.
+ Again, this is clickable and will take you to a page of all recent
+ posts of that person. Beneath the username, is the content of the post.
+ On the opposite side of the post box may appear links to Edit or X (delete)
+ the post, as well as a link to comment on a post or start a new thread.
+ The Edit and X delete links only appear if you are the poster or the owner
+ of the group the post was made in. The Comment link let's you make a
+ follow up post to that particular thread in that group. The Start New Thread
+ link would let you start a new thread for that group. For example, for the
+ first post above, it would let you start a new thread in the Chris Blog
+ group. If you are not the owner of a group then the Comment and Start a
+ New Thread links only appear if you have the necessary privileges on that
+ group. So for example, above the user was cpollett and the Comment link
+ does not appear for the post to Public as that is a read only feed. The
+ image below shows what happens when one clicks on a group link,
+ in this case, the Chris Blog link.
+ </p>
<img src='resources/SingleGroupFeed.png' alt='A Single Group Feed'/>
+ <p>On the opposite side of the screen there is a link My Group Feeds,
+ which let's one go back to the previous screen. At the top
+ of this screen is clickable title of the group, in this case, Chris Blog,
+ this takes one to the Manage Groups activity where properties of this
+ group could be examined. Next we see a toggle between Feed and Wiki.
+ Currently, on group feed page, clicking Wiki would take one to the
+ Main page of the wiki. Posts in the single group view are grouped
+ by thread with the thread containing the most recent activity at the
+ top. Notice next to each thread link there is a count of the number
+ of posts to that thread. The content of the thread post is the content
+ of the starting post to the thread, to see latter comments one has to click
+ the thread link.
+ There is now a Start New Thread button at the top of the single group feed
+ as it is clear which group the thread will be started in. Clicking
+ this button would reveal the following form:</p>
<img src='resources/StartNewThread.png' alt='Starting a new thread from
a group feed'/>
+ <p>Adding a Subject and Post to this form and clicking save would start
+ a new thread. Clicking the comment link of any existing thread reveals
+ the following form to add a comment to that thread:</p>
<img src='resources/AddComment.png' alt='Adding a comment to an existing
thread'/>
+ <p>Below we see an example of the feed page we get after clicking on
+ the My First Blog Post thread in the Chris Blog group:</p>
<img src='resources/FeedThread.png' alt='A Group Feed Thread'/>
+ <p>Since we are now within a single thread, there is no Start New Thread
+ button at the top. Instead, we have a Comment button. Posts in the
+ thread are displayed with the most recent post at the top and the starting
+ post for the thread at the bottom (this is a little awkward and might
+ be changed in future versions of Yioop). The next image below is an example
+ of the feed page one gets when one clicks on a username link, in this case,
+ cpollett:</p>
<img src='resources/UserFeed.png' alt='User Feed'/>
+ <p>Single Group, Threads, and User feeds of groups which anyone can join
+ (i.e., public groups) all have RSS feeds which could be used in
+ a news aggregator or crawled by Yioop. To see what the link would
+ be for the item you are interested in, first collapse the activity
+ element if its not collapsed (i.e., click the [<<] link
+ at the top of the page). Take the URL in the browser in the url bar,
+ and add &f=rss to it. It is okay to remove the YIOOP_TOKEN= variable
+ from this URL. Doing this for the cpollett user feed, one gets the url:</p>
+ <pre>
+ http://www.yioop.com/?c=group&a=groupFeeds&just_user_id=4&f=rss
+ </pre>
+ <p>whose RSS feed looks like:</p>
<img src='resources/UserRssFeed.png' alt='User Rss Feed'/>
<img src='resources/NonexistantPage.png' alt='Screenshot of going to
location of a non-existant wiki page'/>
@@ -2629,7 +2698,7 @@ define('HHVM_PATH', '/usr/local/bin');
should have changed to text that reads "Finalizing..." (but if
the training set is very small, training may complete almost immediately).
After starting finalization, it's fine to walk away for a bit, reload the
- page, or carry out some unrelated task in the admin console. You shouldn't
+ page, or carry out some unrelated task for the user account. You should not
however, make further changes to the classifier's training set, or start a
new crawl that makes use of the classifier. When the classifier finishes
its training phase, the Finalizing message will be replaced by one that