Edited wiki page through web user interface.
diff --git a/SocialFeaturesMelangeGSoC2010.wiki b/SocialFeaturesMelangeGSoC2010.wiki index 8a84e7c..8ced9d4 100644 --- a/SocialFeaturesMelangeGSoC2010.wiki +++ b/SocialFeaturesMelangeGSoC2010.wiki
@@ -113,4 +113,127 @@ = Project Design and Implementation = - The software design and implementation details will be added here. \ No newline at end of file +== Main Feature 1: Tabbed User Pages == + +===Overview=== +User Page feature will be used by each user to share information about themselves with the rest of the GSoC community. The UI of this feature is designed with tabs, hence users will remain on a single page while navigating between multiple tabs. The design details of this feature's design and implementation are as follows. + +The tabs of the user page will be as follows: + * Profile + * Project + * My Stuff (to be renamed later) + +===Workflow=== + +Workflow for Users +The workflow for using this feature is largely similar for all user roles in the soc framework, with some differences for the program and organization admins. + +Workflow for Student, Mentor, Organization_Admin User roles + + + # User receives acceptance notification email that they have been accepted to participate in the program. A short message is appended to this email, mentioning that users can now update their respective user pages on Melange as well as view other users’ pages. + # (i) if users click the link, they are redirected to the profile tab of their user page, where they see their partially filled profile based on current user information provided at sign up (i.e. name, current/past user roles).(ii) If they do not click on the email link, whenever they next log into Melange, they will see ‘User Page’ on their sidebar under the ‘User’ tab. Clicking on this will take them to the profile tab of their user page. + # They may further update the data on their profile tab by clicking on the ‘Edit Profile’ button or navigate to the Project tab or My Stuff tab to update the respective data. + # In the Project tab, similar to the Profile Tab, default project data is filled in such as organization name, project name etc. Users can fill in more details by clicking on the ‘Edit Project’ button. Here, students can fill in details of the project they are working on, while mentors can provide details about the project they are mentoring for. Organization_Admins can use this page to provide information about all their student projects. Program_Admins can use this page to provide general information about the program details itself. + # In the My Stuff tab, users can click on “Add Blog Feed”, to insert their blog url to display updates from their blogs using Melange’s RSS widget. (To be confirmed: Can users add more than one feed? Eg. An org_admin might want to add the org’s blog feed as well as their personal blog feed.) + # Once changes are saved, users may return anytime during the course of the program to change and save the information in their user pages. + +===Data Models=== + +*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 - *ReferenceProperty* + * email – *StringProperty* + * phone_number – *IntegerProperty* + * address - *StringProperty* + * website - *LinkProperty* + * about_myself - *StringProperty* + * activities – *StringProperty* + * books – *StringProperty* + * movies – *StringProperty* + * television - *StringProperty* + * profile_picture – *BlobProperty* + * education – *ListProperty* + * job – *ListProperty* + * last_modified - *DateTimeProperty* + +Properties of education.py + * user - *ReferenceProperty* + * college_name – *StringProperty* + * major_name – *StringProperty* + * start_date – *DateProperty* + * end_date – *DateProperty* + +Properties of job.py + * 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 - *ReferenceProperty* + * student - *ReferenceProperty* + * organization - *ReferenceProperty* + * mentor – *ReferenceProperty* + * project_details – *ListProperty* + +Properties for user_project_details.py + * project_title - *StringProperty* + * languages – *StringProperty* + * apis_frameworks – *IntegerProperty* + * related_url - *LinkProperty* + * project_overview - *StringProperty* + * other_general_info – *StringProperty* + * proposal_link = *LinkProperty* + * user_project_update – *ListProperty* (Nice to have, if time permits) + * current_project – *BooleanProperty* + * past_project - *BooleanProperty* + +Properties of for user_project_update.py + * user - *ReferenceProperty* + * update_text – *StringProperty* + * update_time – *DateTimeProperty* + * user_project_comment – *ListProperty* (Nice to have, if time permits) + +Properties of for user_project_comment.py + * user – *ReferenceProperty* + * user_project_update - *ReferenceProperty* + * comment_text – *StringProperty* + * comment_time – *DateTimeProperty* + * comment_user – *ReferenceProperty* + +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.). + +Data Models + * user_stuff.py + +Properties of for user_stuff.py + * user – *ReferenceProperty* + * feed_url - *LinkProperty* + +===State Diagrams=== + \ No newline at end of file