Skip to content

Commit 25a77fc

Browse files
Merge pull request #1613 from virtualcell/help_7_6_Ann
VCell Help Updates
2 parents 99514df + 47fb524 commit 25a77fc

48 files changed

Lines changed: 255 additions & 450 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

vcell-client/UserDocumentation/originalXML/TOC.xml

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,29 @@
55
<tocitem target="General" text="Overview"/>
66
<!-- <tocitem target="RuleBasedOverview" text="Rule-Based Features"/> -->
77
<tocitem target="GeneralNavAndWinSetup" text="General Navigation and Window Setup"/>
8+
<tocitem target="Login" text="Logging into VCell"/>
89
<tocitem target="TopMenu" text="Top Menu"/>
9-
<tocitem target="Login" text="User Login"/>
1010
<tocitem target="File" text="File Menu">
1111
<tocitem target="New" text="File->New Menu"/>
1212
<tocitem target="Open" text="File->Open Menu"/>
1313
<tocitem target="SaveAs" text="File->Save As Menu"/>
1414
<tocitem target="RevertToSaved" text="File->Revert to Saved Menu"/>
15+
<tocitem target="CompareWithSaved" text="Compare With Saved"/>
1516
<tocitem target="Permissions" text="File->Permissions Menu"/>
1617
<tocitem target="FieldData" text="File->Field Data Menu"/>
1718
<tocitem target="Import" text="File->Import Menu (SBML files)"/>
1819
<tocitem target="ImportBNGL" text="File->Import Menu (BNGL files)"/>
1920
<tocitem target="Export" text="File->Export Menu"/>
2021
</tocitem>
2122
<tocitem target="Account" text="Account Menu">
22-
<tocitem target="Auth0Overview" text="Website Login">
23-
<tocitem target="Auth0ProfilePage" text="Website Profile Page">
24-
<tocitem target="Auth0ExistingUserAccountLinking" text="Existing Users Profile Help"/>
25-
<tocitem target="Auth0ReturningUserAccountLinking" text="Returning Users Profile Help"/>
26-
<tocitem target="Auth0NewUserAccountCreation" text="New Users Profile Help"/>
27-
</tocitem>
28-
</tocitem>
23+
<tocitem target="Auth0ProfilePage" text="Login"/>
2924
<tocitem target="SetProxy" text= "Set Proxy Window"/>
3025
<tocitem target="ViewSimStatus" text="View Simulation Jobs"/>
3126
</tocitem>
3227
<tocitem target="Window" text="Window Menu"/>
3328
<tocitem target="Tools" text="Tools Menu">
3429
<tocitem target="LaunchVirtualFRAP" text="Launch Virtual FRAP Menu"/>
3530
<tocitem target="ExportedDataViewer" text="Exported Data Viewer"/>
36-
<tocitem target="TransformToStochCapable" text="Transform to Stochastic Capable Menu"/>
3731
</tocitem>
3832
<tocitem target="Help" text="Help Menu"/>
3933
</tocitem>
@@ -62,8 +56,8 @@
6256
<tocitem target="PathLink" text="Edit Pathway Links"/>
6357
</tocitem>
6458
<tocitem target="Molecules" text="Molecules Table">
65-
<tocitem target="PP_Molecules" text="Edit Molecule"/>
66-
</tocitem>
59+
<tocitem target="PP_Molecules" text="Specify Molecular Details"/>
60+
</tocitem>
6761
<tocitem target="Observables" text="Observables Table">
6862
<tocitem target="PP_Observables" text="Edit Observable"/>
6963
</tocitem>

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ExistingUserAccountLinking.xml

Lines changed: 0 additions & 22 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0LinkAccount.xml

Lines changed: 0 additions & 24 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0NewUserAccountCreation.xml

Lines changed: 0 additions & 23 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0Overview.xml

Lines changed: 0 additions & 26 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ProfilePage.xml

Lines changed: 0 additions & 28 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ReturningUserAccountLinking.xml

Lines changed: 0 additions & 24 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/Auth0/NewUserRegistration.xml

Lines changed: 0 additions & 23 deletions
This file was deleted.

vcell-client/UserDocumentation/originalXML/topics/ch_1/Introduction/Account.xml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,26 @@
33
<page title="Account">
44

55
<introduction>
6-
The <bold>Account</bold> menu bar option allows the user to change the account settings for the current user of VCell.
6+
The <bold>Account</bold> menu bar option allows the user to change the login status the current user of VCell, and to manage account settings using the VCell Auth0 app.
77
</introduction>
88

99
<appearance>
1010
<imgReference target = "AccountMenu.png"/>
1111
</appearance>
1212

1313
<operations>
14-
Clicking the Account menu displays the following selections
15-
<list>
14+
<list>
1615
<item>
17-
<bold>Login</bold> - allows user to login if they have not do so already.
16+
<bold>Login</bold> directs the user to the <link target = "Auth0ProfilePage">VCell Auth0 Profile page</link> to login to VCell if they are not currently logged in.
1817
</item>
1918
<item>
20-
<bold>Login as Guest</bold> - allows user to login as guest if they are not logged in already.
19+
<bold>Login as Guest</bold> allows user to login as a "guest" if they are not logged in already. Guest login can only access public models and cannot be used to save a model to the database.
2120
</item>
2221
<item>
23-
<bold>Logout</bold> - allows user to logout if they are logged in.
22+
<bold>Logout</bold> allows user to logout if they are logged in. The user will be directed to the VCell Auth0 site to complete the logout. Once logged out the user can only use VCell in an offline mode, with no connection to the VCell database or servers.
2423
</item>
2524
<item>
26-
<link target = "Auth0ProfilePage">Manage User</link> - takes the user to the Auth0 profile page.
25+
<link target = "Auth0ProfilePage">Manage User</link> - takes the user to their Auth0 profile web page to manage VCell credentials.
2726
</item>
2827
<item>
2928
<link target = "SetProxy">Set Proxy...</link> - allows the user to set a Proxy if local policy prevents direct connection to the VCell server.
@@ -32,7 +31,7 @@
3231
<bold>Reconnect (Refresh)</bold> - allows user to reconnect to the server. The status bar displays the connecting status.
3332
</item>
3433
<item>
35-
<link target = "ViewSimStatus">View Simulation Jobs</link> - provides a way to view and stop simulation jobs.
34+
<link target = "ViewSimStatus">View Simulation Jobs</link> provides a way to view and currently running, stopped or failed simulation jobs and to stop any jobs currently running.
3635
</item>
3736
</list>
3837
</operations>
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<vcelldoc>
3+
<page title="Auth0 Profile Page">
4+
5+
<introduction>
6+
When <bold>Login</bold> is selected at first use, the user is redirected to the <bold>AuthO Profile</bold> page to create a user profile and complete creating an Auth0 account. A VCell username is required to access all the functionality of VCell. The VCell username will then be mapped to an Auth0 login account.
7+
<para></para>
8+
</introduction>
9+
<appearance>
10+
</appearance>
11+
12+
<operations>
13+
<bold>Existing Users</bold> need to provide the username
14+
and password of their existing VCell account.
15+
<imgReference target = "ProfileOldLogin.png"/>
16+
<para>
17+
<bold>Select Forgot my password</bold> if you have forgotten your password. Provide the username and associated email of the account and an email will be sent with a link that will immediately approve linking the VCell account to an Auth0 account. If you do not remember both old username and email, contact VCell Support
18+
<imgReference target = "ProfileRecoverAccount.png"/>
19+
</para>
20+
<para>
21+
<bold>New VCell Users</bold> need to create a username and provide a valid email address. VCell usernames are case-sensitive. Click the checkbox at the bottom of the registration dialog if you wish to decline receiving VCell notification emails.
22+
<imgReference target = "ProfileCreateNew.png"/>
23+
</para>
24+
<para>
25+
Once a unique VCell Username is applied, a new Auth0 account is created and you are directed to a Success Auth0 profile page. Simply close the page and return to VCell. A message saying Failed to map new user, please try again will appear if the username provided is already in use. Pick a new one and try again.
26+
</para>
27+
<imgReference target = "ProfileUserMapped.PNG"/>
28+
29+
</operations>
30+
</page>
31+
</vcelldoc>

0 commit comments

Comments
 (0)