wiki:Specs/Front

Specs / Front

On a typical journal's front page the unauthenticated user can do the following:

  • click on the Login link;
  • click on the Register link;
  • click on a phrase in order to comment it;
  • click on a collapsed bubble (if any) to expand it;
  • click on a expanded bubble (if any) to collapse it;
  • click on other internal and external links on a page.

Login

If he clicks on a Login link, the Webmore Comment Box (we will refer to it as WCB later in the text) will open with authentication frame activated. It allows users to log in via two methods: basic username/password scheme and  OpenID. Here user can do the following:

  • fill out his username and password and click Login or press Enter key;
  • fill out his OpenID URL and click Login or press Enter key;
  • click on the Cancel button or press ESC key;
  • click on the 'Forgot your password?' link;
  • click on the 'Not registered?' link.

If user activates a basic authentication method by clicking on it, leaves either username or password field empty and clicks the Login button, warning message will appear.

If user fills out both fields, temporary progress frame will be activated and authentication request will be sent. In case of incorrect credentials a message will be displayed and authentication frame will be activated again. In case of correct credentials:

  • user will be logged in;
  • a box with links Login and Register (which position on a page depends on a journal layout) will be changed to Administrate and Logout (username);
  • all expanded comments written by that user (if any) will get a number of action links.

If user activates an OpenID authentication method by clicking on it, leaves the URL field empty and clicks the Login button, warning message will appear.

In other case, temporary progress frame will be activated and discovery process initiated. If no usable OpenID services will be found with the URL provided a message will be displayed and authentication frame will be activated again.

In case of successful discovery process, an OpenID frame will be activated asking a user to click Next in order to authenticate via OpenID. If user clicks on that button, an authentication page on his server will open in a new popup window and another OpenID frame will be activated. In a popup window user will have to authenticate himself and will be able to either grand or deny identity validation. In a frame, user can do the following:

  • click on the Done button to complete his authentication process;
  • click on the Cancel button to close WCB;
  • click on the Try another URL link to cancel current authentication process and start another one.

If user clicks on the Done button the system will try to finish the authentication process and, in case of success, user will be logged in (also, a number of actions will be fired as described above). In other case, a message will be displayed and authentication frame will be activated again.

If user clicks on the Cancel button on any step of the authentication process, the system will terminate it and close WCB.

Registration

If user clicks on a Register link, WCB will open with registration frame activated. Here user can fill out his data and press the Register button or press the Cancel button.

If he provides correct information and click Register, a new user will be created and automatically logged in. Then, WCB will be closed. In case of incorrect information, error message will be displayed.

Password reminder

If user clicks on a Forgot your password? link (which is available both on the authentication frame and registration frame), a new reminder frame will be activated. Here user can enter his username and press the Send new password button. If we have a user with such username, the system will send a new password to the email address specified in user's profile (django.contrib.auth.models.User). In other case, error message will be displayed.

Collapsed and expanded bubbles

If user clicks on a collapsed bubble it will be expanded, if on an expanded one, it will be collapsed. If a bubble can't be expanded/collapsed because of maintenance error message will be displayed.

Commenting

If user clicks on a phrase, WCB will open with comment frame activated. Comment frame consists of FCKeditor instance, a helper link and two buttons (Comment and Cancel). Here user can do the following:

  • [enter a comment and] press Comment;
  • [enter a comment and] press Cancel (or press ESC key);
  • click on a helper link;

If user clicks on Comment with no text typed, an error message will be displayed. If there is a comment the authentication frame will be activated where use can do all the steps described in the appropriate part.

After successful authorization, the system will try to post a comment. In case of success a new bubble will be added to a page. In other case (e. g. Invalid XHTML), an error message will be displayed.

If user clicks on a Cancel with non-empty comment box a notification frame will be activated. There user will confirm or rollback his action. If user confirms it, WCB will be closed. In other case, it will be switched back to the comment frame.

In case of empty comment box, no notification frame will be activated, WCB will be silently closed.

If user clicks on a helper link, a new popup window with some plain-text information will be opened.