Design Modification & User cases
diff --git a/SocialFeaturesMelangeGSoC2010.wiki b/SocialFeaturesMelangeGSoC2010.wiki index 60fabec..8411d3a 100644 --- a/SocialFeaturesMelangeGSoC2010.wiki +++ b/SocialFeaturesMelangeGSoC2010.wiki
@@ -47,40 +47,19 @@ *UserPage* -This will be the master model for this feature which will enclose the three tabs that make up this feature. +This user_page.py will be the master model for this feature which will enclose the three tabs that make up this feature. The other data models created are for multiple-valued properties such as education, jobs, current/past projects, updates and comments. -Data Model for User Page +The Data Models * user_page.py + * education.py + * job.py + * project_details.py + * project_update.py (Nice to have, if time permits) + * project_comment.py (Nice to have, if time permits) + Properties of user_page.py * user - *ReferenceProperty* - * user_profile.py - *ReferenceProperty* - * user_project.py - *ReferenceProperty* - * user_stuff.py - *ReferencePropoerty* - * user_page_status - *StringProperty* - -The User page feature should be in one of the following states implied by the user_page_status property of the model. - * Uninitialized - This state occurs after the user is accepted into the program but has not yet made his first visit to his user page. Hence, no information is seen by visitors to his page. - * Initialized - This user_page is in this state when the user has entered the user page and authorized to display his basic user information already in the GSoC system. - * Updated - The user has entered or changed existing information in his user page. - * Deactivated - The user account has been terminated. - ------ -Comment (Madhu): Status is good, but I don't think Uninitialized, Initialized and Updated is a good idea. Instead we can just have three states like, visible, invisible and invalid. ------ - - -*Profile Tab* - -The additional data model for this feature will be user_profile.py, which will extend the existing user.py model in the soc_core famework. This model will contain additional properties on top of those in the user model. User information such as educational background, professional background, technical skills, interests, hobbies, etc. will be contained in this model. - -Data Models for Profile Tab - * user_profile.py - * education.py - * job.py - -Properties of user_profile.py - * user_page - *ReferenceProperty* * email – *StringProperty* * phone_number – *IntegerProperty* * address - *StringProperty* @@ -94,41 +73,29 @@ * education – *ListProperty* * job – *ListProperty* * last_modified - *DateTimeProperty* + * student - *ReferenceProperty* + * organization - *ReferenceProperty* + * mentor – *ReferenceProperty* + * project_details – *ListProperty* + * feed_url - *LinkProperty* + Properties of education.py - * user_profile - *ReferenceProperty* + * user - *ReferenceProperty* * college_name – *StringProperty* * major_name – *StringProperty* * start_date – *DateProperty* * end_date – *DateProperty* Properties of job.py - * user_profile - *ReferenceProperty* + * user - *ReferenceProperty* * employer_name – *StringProperty* * position_name – *StringProperty* * start_date – *DateProperty* * end_date – *DateProperty* - -*Project Tab* - -The main additional data model for this feature will be user_project.py. This model will contain particular project related details such as technical details of the project, mentors and students of a given project and other details which users wish to share about their project. - -Data Models - * user_project.py - * user_project_details.py - * user_project_update.py (Nice to have, if time permits) - * user_project_comment.py (Nice to have, if time permits) - -Properties of for user_project.py - * user_page - *ReferenceProperty* - * student - *ReferenceProperty* - * organization - *ReferenceProperty* - * mentor – *ReferenceProperty* - * project_details – *ListProperty* - -Properties for user_project_details.py - * user_project - *ReferenceProperty* +Properties for project_details.py + * user - *ReferenceProperty* * project_title - *StringProperty* * languages – *StringProperty* * apis_frameworks – *IntegerProperty* @@ -140,37 +107,58 @@ * current_project – *BooleanProperty* * past_project - *BooleanProperty* -Properties of for user_project_update.py - * user_project_details - *ReferenceProperty* +Properties of for project_update.py + * project_details - *ReferenceProperty* * update_text – *StringProperty* * update_time – *DateTimeProperty* - * user_project_comment – *ListProperty* (Nice to have, if time permits) + * project_comment – *ListProperty* (Nice to have, if time permits) -Properties of for user_project_comment.py - * user_project_update - *ReferenceProperty* +Properties of for project_comment.py + * project_update - *ReferenceProperty* * comment_text – *StringProperty* * comment_time – *DateTimeProperty* * comment_user – *ReferenceProperty* +The User page feature should be in one of the following states implied by the user_page_status property of the model. + * Visible - This state occurs after the user is accepted into the program. Only the minimal information about the user already entered during registration is shown here. In this state, the user may edit or add to his user page at any time during the program. + * Invisible - This state of the user page can be activated by the user if the user wishes to prevent other users from viewing their profile. (Should this be allowed?) + * Invalid - The user account has been terminated. + +----- +Comment (Madhu): Status is good, but I don't think Uninitialized, Initialized and Updated is a good idea. Instead we can just have three states like, visible, invisible and invalid. +----- + + +*Profile Tab* + +The profile tab will display a subset of the properties from the user_page data model. Profile related information such as contact, personal profile details, education and job information will be shown here. + +*Project Tab* + +Similar to the profile tab, the project tab will contain the project related information such as details of past and current GSoC projects. + Additional Note: Organization and program admins, will have more than one project and multiple students and mentors associated with them. Hence, the model needs to undergo some changes to accommodate them or to develop separate user_admin_project.py models for users with admin roles. *My Stuff Tab* -Currently, this data model is used to support the rss widget which displays blog feeds; however it can be extended to accommodate other widgets (twitter, calendar etc.). +This tab will currently only be used to display the blog feeds, if any for a user. If no valid url is entered in the feed_url property of the user_page model, this tab will be left blank. -Data Models - * user_stuff.py +*Edit User Page* -Properties of for user_stuff.py - * user_page – *ReferenceProperty* - * feed_url - *LinkProperty* - +The option to edit the data on the user page is also available to users. They may choose to edit the data anytime during the course of the program from their User Page in the application. ----- Comment (Madhu): Oh! I am extremely sorry for not making this clear earlier, when you started writing it out, but anyways better late than never. You need not create so many Python files and data models. From what I can see all the files and data models you have specified above can be merged into one single file with one single data model. So many reference properties is not good. Also, even if we keep all the data you have specified in a single data model we can write views in such a way that it shows only what data needs to be shown to a specific user and tabbing etc etc can all be controlled by views and templates. So we might not want so many data models. We will have to redesign this together. ----- -===State Diagrams=== +===Use-Case Diagrams=== +*User Page Feature* + +http://www.comp.nus.edu.sg/~savitha/gsoc/user_page_usecase.png + +*Maps + Calendar* + +http://www.comp.nus.edu.sg/~savitha/gsoc/social_usecase.png = Specification & Requirements = The detailed project specification will be added and updated here.