Adding the documentation for the user account

bioclipse · Sep 21, 2012 · 9fab9da · 9fab9da
1 parent 2755d44
commit 9fab9da
Show file tree

Hide file tree

Showing 7 changed files with 88 additions and 52 deletions.
diff --git a/plugins/net.bioclipse.ui/html/images/editAccount.png b/plugins/net.bioclipse.ui/html/images/editAccount.png
diff --git a/plugins/net.bioclipse.ui/html/images/userPrefs.png b/plugins/net.bioclipse.ui/html/images/userPrefs.png
diff --git a/plugins/net.bioclipse.ui/html/usermanager/accountWizardHelp.html b/plugins/net.bioclipse.ui/html/usermanager/accountWizardHelp.html
@@ -8,9 +8,10 @@
 </head>
 
 <body>
-<h1>Adding a third-part account to Bioclise</h1>
+<h1>Creating a new user account</h1>
 The creation of a Bioclipse account and adding the third-part account can be done in two ways:
-Either from <a href="#prefs"><b>Window > Preferences... > Users</b></a>. Or by using the wizard you find under <a href="#wizard"><b>File > New... > General > Account</b></a>.
+Either from <b>Window > Preferences... > Users</b>, see <a href="usingPrefs.html">Using Preferences</a>. Or by using the wizard you find under <b>File > New... > 
+Account</b>. The wizard is described below.
 <br><br>
 <a name="Wizard"><h2>Using the wizard</h2></a>
 This is probably the easiest way, especially if you don't have any Bioclipse user-account yet. If you can't find this alternative, it's probably because you don't have any feature 
@@ -38,41 +39,13 @@ <h3>Creating a new user account</h3>
 <tr><td class="caption"><small>Figure 2. The wizard page where you can add a third-part account.</small></td></tr>
 </table>
 After creating a new user-account, or logged in to one, it's now time to add a new third-part account to your user-account. First choose the account-type, i.e. which of the installed 
-features hows web-services that it is that you want to add a log-in to. This is done in the dropdown-menu at the top of the window, only the installed features that have have an web-
+features web-services that it is that you want to add a log in to. This is done in the dropdown-menu at the top of the window. Only the installed features that have have an web-
 service are visibly. Observe that you can only have one account type per Bioclipse account.<br>
-In the filed with the label "Account name" in-front of it is the name of this third-part account, but you can choose another name by writing that in this field instead. In the fields 
+In the filed with the label "Account name" in-front of it is the name of this third-part account, but you can choose another name and write that in this field instead. In the fields 
 below you add the information that is needed for Bioclipse to be able to log in to the web-service. As stated in the introduction, 
 it will in most cases be a field for our username and one for the password to the service. Fill in those fields, and then click the finish-button. The wizard will now log in to your 
 Bioclipse account and you will see a green padlock in status line at the bottom of the Bioclipse window.<br>
 If some reason Bioclipse failed to log-in to any of your third-part accounts, you will get a dialog telling you which of them that failed. See more about that in the section 
-<a href="loginoutHelp.html">Logging in and out</a> below.
-<br><br>
-<a name="prefs"><h2>Using Preferences</h2></a>
-As mentioned in the introduction you may also add a third-part account from Bioclipse Preferences. Choose <b>Window > Preferences </b> and then <b>Users</b> in the list to the 
-left of the preferences dialog. The view to the right will now show a list of the different Bioclipse user accounts. It's also from here that you administrate your account(s), i.e. change password etc, 
-so it might be good to notice the different settings that can be made, even though they are not discussed here (see more about those in <a href="../workbench/wb_preferences.html">
-the preferences help page</a>).
-<br><br>
-<h3>Create a new user account</h3>
-To create a new Bioclipse user-account click on the button labeled <b>Create...</b> and a dialog looking almost as the one in <a href="#fig1">figure 1</a> above appears. In the top field
- you fill in your (Bioclipse) username, in the middle your password and then repeat it in the filed at the bottom. Then click the OK-button.
-<br><br>
-<a name="Pref3part"><h3>Add a third-part account</h3></a>
-The new dialog that appears after creating a your new user-account, is the same as the one used to change the settings of your user-account. If you instead return to the preferences dialog, it's probably
-because you do not have any feature that need a web-service installed.<br>
-To add a a new third-part account, just click the button labeled <b>Add account...</b> on in
-the top left corner of the dialog, just beneath the button with the label "Change Bioclipse Account Password". A new dialog appears, that look a lot like the one in <a href="#fig2">
-figure 2</a> above. The first thing to do is to choose the account type, i.e. which feature you want to create a third-part account to, this is done in the dropdown-menu at the top. Then 
-fill in the information that Bioclipse need to be able to log in to the third-part account. You may also change the name of the third-part account. Now click the <b>Finich</b>-button, then 
-the new third-part account is added to your Bioclipse user-account and you return to the previous dialog.<br>
-Then click on the OK-button and then you are back in the preferences-dialog again. Click on the OK-button in this dialog as well. Now it's just to log in to your bioclipse account,
-see the section <a href="loginoutHelp.html">Logging in and out</a> below.
-<br><br>
-<h2>To an existing Bioclipse user-account</h2>
-This is done in the Bioclipse user preferences, so choose <b>Window > Preferences </b> and then <b>Users</b>. To the right there's a list with all user-accounts, select the one you want to
-add a third-part account to and then press the button with the label <b>Edit...</b>. You will now be prompt for the password for this account (even if you are logged in to it), 
-fill in the password and press the OK-button.<br>
-Now the dialog mention in the section <a href="#Pref3part">Add a third-part account</a> above appear, here click on the button <b>Add account...</b>, and a 
-dialog for adding a third-part account appear, simular to the one shown in <a href="#fig2">figure 2</a> above. Choose the account-type in the dropdown menu at the top and then fill in the
- required fields and click the finish-button.
-<br><br>
+<a href="loginoutHelp.html">Logging in and out</a>.
+</body>
+</html>
diff --git a/plugins/net.bioclipse.ui/html/usermanager/introduction.html b/plugins/net.bioclipse.ui/html/usermanager/introduction.html
@@ -9,13 +9,15 @@
 
 <body>
 <h1>Introduction</h1>
-To be able to use all the capabilities that some of the features in Bioclipse (e.g. OpenTox) offers to you, you need to log on to 
-their web-service. In Bioclipse this is done via an Bioclipse account where the 
+To be able to use all the capabilities some of the features in Bioclipse (e.g. OpenTox) offers, you need to log on to 
+their web-service. In Bioclipse this is done via an Bioclipse user-account where the 
 the required information, normally your log-in name and password for the web-service, are stored.
-Then when you log-in to your Bioclipse account you will be automatically logged in to the installed 
+Then when you log in to your Bioclipse account you will be automatically logged in to the installed 
 features web-services.<br>
 You can easy see if you are logged in, then a green padlock will be visibly in the bottom of the Bioclipse window. See more of how to
-log in to your Bicoclipse account in the section <a href="loginoutHelp.html">Logging in to a Bioclipse User account</a>, and how to create 
+log in to your Bicoclipse account in the section <a href="loginoutHelp.html">Logging in to a Bioclipse user account</a>, and how to create 
 a Bioclipse account and add the information needed to log in to a third-part account in the section <a href="accountWizardHelp.html">
-Adding a third-part account</a>
-</body>
+Creating a new user account</a>. Then in the section <a href="usingPrefs.html">Using Preferences</a> you can read about how to change the settings for
+your user account.
+</body>
+</html>
diff --git a/plugins/net.bioclipse.ui/html/usermanager/loginoutHelp.html b/plugins/net.bioclipse.ui/html/usermanager/loginoutHelp.html
@@ -12,13 +12,15 @@ <h1>Logging in and out</h1></a>
 <h2>Log in</h2>
 Logging in to your Bioclipse account (and then also your different third-parts account) is simple; just choose <b>File > log in</b> or click on the orange padlock in the status line at 
 the bottom of the bioclipse window. Then fill in your username and password in the dialog that appears. When you have logged in the padlock will become green.<br>
-If you can't find any log-in, it's probably because you don't have any feature that supports this installed, or that you don't have created any Bioclipse account yet.<br>
-If, for some reason, Bioclipse failed to log-in to any of your third-part accounts, you will get a dialog telling you for which of them that that the log in failed. Then check your internet connection and/or your 
-user settings for the third-part account(s) that failed, this is done in <b>Window > Preferences... > Users</b>. However, you will still be logged in to your Bioclipse account as well as 
-the the third that didn't failed to log in.<br><br>
+If you can't find any log-in, it's probably because you don't have any feature that supports this installed, or that you don't have created any Bioclipse account yet. You can read about how to creat one in <a 
+href="accountWizardHelp.html">Creating a new user account</a>.<br>
+If, for some reason, Bioclipse failed to log-in to any of your third-part accounts, you will get a dialog telling you for which of them that the log in failed. Then check your internet connection and/or your 
+user settings for the third-part account(s) that failed. This is done in <b>Window > Preferences... > Users</b>, see <a href="usingPrefs.html">Using Preferences</a> for more information. 
+However, you will still be logged in to your Bioclipse account and third that didn't failed to log in.<br><br>
 <h2>Log out</h2>
-Logging out is done by either choosing <b> log out</b> from the <b>File</b>-menu (this option is only visibly when your logged in). Or click on the green padlock. You will then get a 
-question if you are sure that you want to log out. If you don't want to be asked this any more, just mark the checkbox in the dialog before clicking on OK. This can also be set in 
-<b>Window > Preferences... > Users</b> with help of the checkbox &quot;Always logout without prompt&quot;.
+Logging out is done by either choosing <b> log out</b> from the <b>File</b>-menu (this option is only visibly when you are logged in) or by click on the green padlock at the bottom of the Bioclipse
+window. You will then get a question if you are sure that you want to log out. If you don't want to be asked this any more, just mark the checkbox in the dialog before clicking on OK. 
+This can also be set in <b>Window > Preferences... > Users</b> with help of the checkbox &quot;Always logout without prompt&quot;, see also <a href="usingPrefs.html">Using Preferences</a>.
 
-</body>
+</body>
+</html>
diff --git a/plugins/net.bioclipse.ui/html/usermanager/usingPrefs.html b/plugins/net.bioclipse.ui/html/usermanager/usingPrefs.html
@@ -0,0 +1,58 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+    <title>Adding a third-part account</title>
+    <link rel="stylesheet" href="../../PRODUCT_PLUGIN/narrow_book.css" type="text/css">
+</head>
+
+<body>
+<h1>Using Preferences</h1>
+<img src="../images/userPrefs.png" width="300" align="right">
+You administrate your account(s) in the user view of Bioclipse preferences. Choose <b>Window > Preferences </b> and then <b>Users</b> in the list to the left of the preferences dialog to open it.<br>
+The user view has a list of all your accounts and beneath it there is some buttons:<br>
+<table>
+<tr><td><a href="#create">Create...</a></td><td>Create a new user account.</td></tr>
+<tr><td><a href="#edit">Edit...</a></td><td>Edit the user account selected in the list above.</td></tr>
+<tr><td>Delete</td><td>Delete the selected user account in the list above.</td></tr>
+<tr><td>Always logout without prompt</td><td>If this is checked in then you don't get any warning when logging out. See also <a href="loginoutHelp.html">Logging in and out</a>.</td></tr>
+<tr><td>Restore Defaults</td><td>Restore the settings to default.</td></tr>
+<tr><td>Apply</td><td>Apply the settings. I.e. it does the same as the OK-button but with out closing the preferences window.</td></tr>
+</table> 
+<br>
+<a name="create"><h2>Create a new user account</h2></a>
+To create a new Bioclipse user-account click on the button labeled <b>Create...</b> and a dialog looking almost as the one in the section <a href="accountWizardHelp.html#fig1">Creating a new user account</a> appears.
+In the top field you fill in your (Bioclipse) username, in the middle your password and then repeat it in the filed at the bottom. Then click the OK-button.
+<br>
+<a name="edit"><h2>Edit the user account</h2></a>
+<img src="../images/editAccount.png" width="400"><br>
+Before the edit dialog appears you will be prompt for the chosen user accounts password. Fill it in and click ok. Now the Edit-dialog (see above) will appear. To the left is a list with 
+the different third-part accounts associated with this user account. To the right is a <a href="#propView">view with the properties</a> of the account selected in the account list. The 
+four buttons above and below the account list are:
+<table>
+<tr><td>Change Bioclipse Account Password</a></td><td>Opens a dialog where you can change the password to this user account.</td></tr>
+<tr><td><a href="#Pref3part">Add account...</a></td><td>Create a new third-part account.</td></tr>
+<tr><td><a href="#edit3part">Edit account...</a></td><td>Edit the properties of the selected third-part account.</td></tr>
+<tr><td>Delete account</td><td>Delete the selected third-patrt account.</td></tr>
+</table>
+<br>
+<a name="propView"><h3>The account properties view</h3></a>
+This view contain all information about the third-part account. The uppermost is what type of account it is, e.g. OpenTox. Beneath is a spread sheet with the different properties, their 
+value and whether it's required or not. You may change the value of the different properties by changing it in the spread sheet or by using the <a href="edit3part">Edit...-button</a>
+to the left. One more thing worth to notice is the checkbox called "Show password" to the right and beneath the spread sheet. Selecting it and all the hidden values will be in plain language.
+<a name="Pref3part"><h3>Add a third-part account</h3></a>
+When clicking on the Add account-button a new window that look a lot like and with the same function as the one described in <a href="accountWizardHelp.html#Wizard3part">Add a third-part 
+account</a> appears. If the button is not enable, it's probably because you do not have any feature that need a web-service installed.<br>
+The first thing to do is to choose the account type, i.e. which feature you want to create a third-part account to, this is done in the dropdown-menu at the top. Then 
+fill in the information that Bioclipse need to be able to log in to the third-part account. You may also change the name of the third-part account. Now click the <b>Finich</b>-button, then 
+the new third-part account is added to your Bioclipse user-account and you return to the edit-dialog.<br>
+If you are logged in to a user account you may have to log out and then log in again to let Bioclipse log in to the new third-part account, see <a href="loginoutHelp.html">Logging in and
+ out</a>. 
+<a name="edit3part"><h3>Edit a third part account</h3></a>
+Clicking on this button and a simple dialog where the value of the properties of the third-part account can be edit appears. Just change the value of the property or properties, e.g. 
+the password, and then click ok. If you are logged in to the account when changing the properties, you may also have to log out and then log in again to the user account for the changes 
+to take effect, see <a href="loginoutHelp.html">Logging in and out</a>.   
+
+</body>
+</html>
diff --git a/plugins/net.bioclipse.ui/toc.xml b/plugins/net.bioclipse.ui/toc.xml
@@ -36,9 +36,10 @@
 		<topic label="About the Help system" href="html/workbench/wb_help.html"/>
 
    </topic>
-   <topic label="The Bioclipse Usermanager">
+   <topic label="Bioclipse user account">
         <topic label="Introduction" href="html/usermanager/introduction.html"/>
-        <topic label="Logging in to a Bioclipse User account" href="html/usermanager/loginoutHelp.html"/>
-        <topic label="Adding a third-part account" href="html/usermanager/accountWizardHelp.html" />
+        <topic label="Creating a new user account" href="html/usermanager/accountWizardHelp.html" />
+        <topic label="Using Preferences" href="html/usermanager/usingPrefs.html"/>
+        <topic label="Logging in and out" href="html/usermanager/loginoutHelp.html"/>
    </topic>
 </toc>