[Carbon-dev] svn commit r30420 - in branches/carbon/1.5/trunk/registry/docs: resources/images xdoc

janapriya at wso2.com janapriya at wso2.com
Thu Feb 5 00:04:57 PST 2009


Author: janapriya
Date: Thu Feb  5 00:04:57 2009
New Revision: 30420
URL: http://wso2.org/svn/browse/wso2?view=rev&revision=30420

Log:
main user guide

Added:
   branches/carbon/1.5/trunk/registry/docs/resources/images/activities.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/associations.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/comments-widgets.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/date.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/filter-by.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/permissions.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/ratings-widget.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/search-widget.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/search.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/resources/images/tag-widget.png   (contents, props changed)
   branches/carbon/1.5/trunk/registry/docs/xdoc/user_guide.xml

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/activities.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/activities.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/associations.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/associations.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/comments-widgets.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/comments-widgets.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/date.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/date.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/filter-by.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/filter-by.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/permissions.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/permissions.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/ratings-widget.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/ratings-widget.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/search-widget.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/search-widget.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/search.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/search.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/resources/images/tag-widget.png
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/resources/images/tag-widget.png?pathrev=30420
==============================================================================
Binary file. No diff available.

Added: branches/carbon/1.5/trunk/registry/docs/xdoc/user_guide.xml
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/xdoc/user_guide.xml?pathrev=30420
==============================================================================
--- (empty file)
+++ branches/carbon/1.5/trunk/registry/docs/xdoc/user_guide.xml	Thu Feb  5 00:04:57 2009
@@ -0,0 +1,232 @@
+<?xml version="1.0"?>
+<!--
+  ~  Copyright (c) 2005-2008, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+  ~
+  ~  WSO2 Inc. licenses this file to you under the Apache License,
+  ~  Version 2.0 (the "License"); you may not use this file except
+  ~  in compliance with the License.
+  ~  You may obtain a copy of the License at
+  ~
+  ~    http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~  Unless required by applicable law or agreed to in writing,
+  ~  software distributed under the License is distributed on an
+  ~  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  ~  KIND, either express or implied.  See the License for the
+  ~  specific language governing permissions and limitations
+  ~  under the License.
+  ~
+  -->
+<!DOCTYPE html
+   PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" >
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title> WSO2 Registry - User Guide </title>
+<link href="css/registry-docs.css" rel="stylesheet"/>
+<link href="styles/dist-docs.css" rel="stylesheet" type="text/css" media="all"/>
+</head>
+<body>
+[ <a href="docs_index.html"> Documentation Index </a> ]
+<h1> WSO2 Registry User Guide </h1>
+<p> The User Guide describes how to configure the WSO2 Registry using the
+  Web based management console. The WSO2 Management Console has been tested
+  on the Mozilla Firefox 2.0, 3.0 and Internet Explorer 6.0, 7.0 Web Browsers at a
+  resolution of 1024x768. </p>
+<h2> Table of Contents </h2>
+<div class="toc">
+  <ul>
+    <li> <a href="#Installing">Installing and Running the WSO2 Registry</a> </li>
+    <li> <a href="#Accessing">Accessing the Registry Web based Management Console</a>
+      <ul>
+        <li> <a href="#Known">Known Issues and Limitations in this Version</a> </li>
+      </ul>
+    </li>
+    <li> <a href="#Signing">Signing In</a> </li>
+    <li> <a href="#ResourcesUI">Resources User Interface</a>
+      <ul>
+        <li> <a href="#Proxy">Proxy Services</a>
+          <ul>
+            <li> <a href="#Adding">Adding a Proxy Service</a> </li>
+            <li> <a href="#Proxy1">Proxy Service Actions</a> </li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li> <a href="#Activities">Activities</a> </li>
+    <li> <a href="#Search">Search</a> </li>
+    <li> <a href="#Monitoring">Monitoring the System</a>
+      <ul>
+        <li> <a href="#System">System Information</a> </li>
+        <li> <a href="#System1">System Logs</a> </li>
+      </ul>
+    </li>
+    <li> <a href="#References">References</a> </li>
+  </ul>
+</div>
+<h2 id="Installing"> Installing and Running the WSO2 Registry </h2>
+<p> Please refer the <a href="installation_guide.html">Installation Guide</a> for details on how to install and run the WSO2 Registry. </p>
+<p> <a id="access"/> </p>
+<h2 id="Accessing"> Accessing the Registry Web based Management Console </h2>
+<p> Once WSO2 Registry has been successfully installed and started, launch a Web
+  browser instance and point it to the URL <a
+      href="https://localhost:9443/carbon">https://localhost:9443/carbon</a>.
+  This will take you to the <em>Sign In</em> page of the WSO2 Registry
+  Management Console. </p>
+<h3 id="Known"> Known Issues and Limitations in this Version </h3>
+<ol>
+  <li> This release doesn't support clustering </li>
+  <li> Remote Registry API doesn't support User Management </li>
+  <li> Remote Registry API doesn't support custom media type processing </li>
+</ol>
+<hr />
+<h2 id="Signing"> Signing In </h2>
+<p> Enter your user name and password to log on to the Registry Management Console. </p>
+<p> <strong>The default username / password is : admin / admin</strong> </p>
+<p> If you get any errors when trying
+  to sign in, click <strong>Sign-in Help</strong>. A list of
+  possible errors, their descriptions and solutions will be displayed. </p>
+<hr/>
+<h2 id="ResourcesUI"> Resources User Interface </h2>
+<p>In the navigator, under Registry, click <strong>Resources</strong>.</p>
+<p><img src="images/registry.png" width="837" height="1068"/></p>
+<p>Figure 1 : Registry User Interface </p>
+<h3>Components of Registry User Interface</h3>
+<ul>
+  <li><a href="#Breadcrumb">Breadcrumb</a>:- Shows the current directory
+    hierarchy </li>
+  <li><a href="#Meta">Meta Data</a>:- Shows meta data for the
+    resource/collection </li>
+  <li><a href="#Content">Content</a>:- Shows the contents of the
+    resource/collection </li>
+  <li><a href="#Permissions">Permissions</a>:- Provides the user interface to change permissions and roles</li>
+  <li><a href="#TagsW">Tags</a>:- Provides the user interface to add/view tags of a resource or collection </li>
+  <li><a href="#SearchW">Search</a>:- Allows to perform a simple tag search</li>
+  <li><a href="#RatinsW">Ratings</a>:- Provides the user interface to set/view ratings of a resource or collection</li>
+  <li><a href="#CommentsW">Comments</a>:- Provides the user interface to add/view comments of a resource or collection</li>
+  <li><a href="#Associations">Dependencies and Associations</a>:- Provides the user interface to add/view dependencies and associations</li>
+</ul>
+<p></p>
+<h3><a name="Breadcrumb" id="Breadcrumb">Resource Breadcrumb</a></h3>
+<p>Use the breadcrumb to navigate backward in the current branch of the
+  directory path, by clicking on a directory name in the breadcrumb. Note
+  that you can access the root of the directory path by clicking the Home
+  icon in the breadcrumb. </p>
+<p><img src="images/breadcrumb.png" width="301" height="72"/></p>
+<p>Figure 2: The Breadcrumb </p>
+<h3><a name="Meta" id="Meta">Meta Data Panel</a></h3>
+<p>The meta data panel displays the following properties of the resource
+  or the collection </p>
+<ul>
+  <li>Created Time and Author </li>
+  <li>Last Updated Time and Author </li>
+  <li>Media Type </li>
+  <li>URL for the permanent link </li>
+  <li>Versions of the resource </li>
+  <li>Description about the resource/collection. </li>
+</ul>
+<p></p>
+<p><img src="images/metadata.png" width="837" height="331"/></p>
+<p>Figure 3 : The meta data panel </p>
+<h3><a name="Content" id="Content">Content Panel</a></h3>
+<p>If the currently selected entity is a collection, the Content Panel
+  shows the child entries under that collection. It provides details of each
+  entry. An entry can be either another collection or a resource. </p>
+<ul>
+  <li>Name - Click to access the content of this entry </li>
+  <li>Created Date </li>
+  <li>Author </li>
+  <li>Ratings</li>
+  <li>The link to the Atom feed </li>
+</ul>
+<p><img src="images/entries.png" width="837" height="545"/></p>
+<p>Figure 4 : View of Directory Entries </p>
+<h4>Adding a new Resource</h4>
+<p>Adding a resource could be done for a collection of resources or for an
+  individual resource. To add a collection or directory, click on the "Add resource"/"Add collection" link
+  provided and a page will be presented to fill in the required information.
+  Optionally, a description can be included for the resource in question.</p>
+<p></p>
+<p>Note : Adding and and deleting resources within the registry are considered version operations. Therefore, provision is made to rollback or restore a resource to any previous version. 		Refer Versions for additional information on this topic.</p>
+<p></p>
+<h4>Deleting a Resource</h4>
+<p>To delete a resource , click on the cylindric icon provided. However, upon
+  doing so a resource will not be removed from the database but instead marked
+  as deleted. This provides the opportunity to restore a previously deleted
+  resource.</p>
+<p>If the currently selected entity is a resource, the Content panel
+  provides a user interface through which you can display, edit and
+  download the content.</p>
+<p><img src="images/content.png" width="837" height="90"/></p>
+<p>Figure 5 : View of the Content </p>
+<h3><a name="Permissions" id="Permissions">Permissions</a></h3>
+<p>Using the following screen, WSO2 Registry permissions can be assigned to different roles and individual users. The top half of the permission's screen is used to define user roles and the bottom half for defining role permissions.</p>
+<p><img src="images/permissions.png" width="812" height="620"/></p>
+<p>Figure : Permissions </p>
+<p>To assign permissions to users or roles follow the steps given below:</p>
+<ol>
+  <li>select user/role from User/Role drop down</li>
+  <li>choose an action from the 'Action' drop down menu</li>
+  <li>select permission type. users are able to choose 'Allow' or 'Deny' by selecting appropriate option button.</li>
+  <li>Click 'Add Permission' to apply selection</li>
+</ol>
+<p>Existing permissions can be changed by selecting and clearing the check boxes  for required permissions and clicking the "Apply All Permissions" button.</p>
+<p><b>Note:</b> 'User permissions' have higher priority over 'role permissions'. 'Deny' permissions have higher priority over 'allow' priorities. Essentially, this means that permissions assigned to users overrides permissions assigned for a role and that a deny permission always overrides an 'allow' permission assigned to a user.</p>
+<p>The right side of the resources page houses 3 additional blocks, namely: Tags, Comments and Versions.</p>
+<h3><a name="TagsW" id="TagsW">Tags</a></h3>
+<p>Provides space to enter tags for a given resource. These tags can be used when searching for a resource as key words for search criteria.</p>
+<p>Users can enter as many tags as they like provided individual tags are separated by commas and a given tag is not used by the same author to identify the same resource repeatedly.</p>
+<p><img src="images/tag-widget.png" width="317" height="107"/></p>
+<p> Figure : Tags </p>
+<h3><a name="SearchW" id="SearchW">Search</a></h3>
+<p> Users can perform a "tag" search using the search block. To perform an advanced search, in the navigator, under Registry, click <strong>Search</strong>.</p>
+<p><img src="images/search-widget.png" width="317" height="111"/></p>
+<p> Figure : Search </p>
+<h3><a name="RatingsW" id="RatingsW">Ratings</a></h3>
+<p>Users can either rate or view ratings made by others using the ratings block.</p>
+<p><img src="images/ratings-search.png" width="317" height="118"/></p>
+<p> Figure : Ratings </p>
+<h3><a name="CommentsW" id="CommentsW">Comments</a></h3>
+<p>Users can either comment or refer comments made by others using the comments block.</p>
+<p>To add a new comment:</p>
+<p></p>
+<p>1. select the &quot;Add Comment&quot; located on the comments block</p>
+<p>2. enter comment in the text box provided</p>
+<p>3. click the 'Add' button to continue.</p>
+<p><img src="comments-widgets.png" width="317" height="169" alt="Registry console - Comments" /></p>
+<p> Figure : Comments </p>
+<h3><a name="Associations"> Dependencies and Associations </a></h3>
+<p>Resources or collections stored in the Registry can be associated according to the user's requirements. These can either be dependencies or named custom associations.</p>
+<p><img src="images/associations.png" width="317" height="214"/></p>
+
+<h2 id="Activities"> Activities </h2>
+<p>In the navigator, under Registry, click <strong>Activities</strong>.</p>
+<p> All registry related activities can be searched through this interface. Your search can be refined by providing optional fields, username, resource path and date range. </p>
+<p><img src="images/activities.png" width="856" height="316"/></p>
+<p>Figure 1: Registry activity search interface.</p>
+<p>The date can be either entered in the format of MM/DD/YYYY or used the date picker user interface provided.</p>
+<p><img src="images/date.png" width="465" height="222"/></p>
+<p>Figure 2: Date picker user interface</p>
+<p>Your search can be further refined by selecting one of the following options under &quot;Filter By&quot; field. </p>
+<p><img src="images/filter-by.png" width="277" height="159"/></p>
+<p>Figure 3: Options under filter by field.</p>
+<h2 id="Search"> Search </h2>
+<p>In the navigator, under Registry, click <strong>Search</strong>.</p>
+<p> All  resouces found in the registry, can be searched through this interface. Search could be refined by optionally providing, resource name, created date range, updated date range, tags, comments, property name, property value and the  content.</p>
+<p><img src="images/main.png" width="728" height="521"/></p>
+<p>Figure 1: Search Interface</p>
+<p>Created or Updated dates can be either entered in the format of MM/DD/YYYY or used the date picker user interface provided.</p>
+<p><img src="images/date.png" width="465" height="222"/></p>
+<p>Figure 2: Date picker user interface</p>
+
+
+<hr/>
+<h2 id="Monitoring"> Monitoring the System </h2>
+<p> This feature provides information about the Registry on the Administrator
+  Console. It displays <a href="statistics/docs/userguide.html">system statistics</a> and <a href="log-view/docs/userguide.html">system logs</a>. </p>
+<p/>
+<p/>
+<h2 id="References"> References </h2>
+<p> <a href="installationguide.html">WSO2 Registry Installation Guide</a> </p>
+<p/>
+</body></html>
\ No newline at end of file



More information about the Carbon-dev mailing list