-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
103 lines (103 loc) · 10.2 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<title></title>
<meta name="Generator" content="Cocoa HTML Writer">
<meta name="CocoaVersion" content="1404.11">
<style type="text/css">
p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
span.Apple-tab-span {white-space:pre}
</style>
</head>
<body>
<p class="p1">Welcome to Yale IMs!</p>
<p class="p2"><br></p>
<p class="p1">Our project is a web based application that intends to motivate people to be more involved with the IMs and, by doing that, increase Yale’s students engagement and participation in the competition.</p>
<p class="p2"><br></p>
<p class="p1">The main proposal of the website is to provide to all users a fun and interactive experience in which they can check their colleges’ performances in the Yale Intramural competition.</p>
<p class="p2"><br></p>
<p class="p1">Navigating through the website:</p>
<p class="p2"><br></p>
<p class="p1">Permission definitions:</p>
<p class="p1">The website allows three kinds of users.</p>
<p class="p1">Regular users:</p>
<p class="p1"><span class="Apple-tab-span"> </span>The general public. With no need to sign in, any person could navigate through all the pages of the website BUT “input scores”, “remove scores”, “register user”, “remove user”. The regular users are not allowed to input any <span class="Apple-tab-span"> </span>information into the website.</p>
<p class="p1">Admin users:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Intended to be the IMs staff, they are allowed to see all the pages BUT “register user”and “remove user”. The admin users are allowed to input the scores of the matches and remove them.</p>
<p class="p1">Master users:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Intended to be the masters of each college, the master users have permission to see all the pages and, on top of inputting and removing scores, they can also register or remove users.</p>
<p class="p2"><br></p>
<p class="p1">Navigation Bar:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Yale IMs: link to the home page</p>
<p class="p1"><span class="Apple-tab-span"> </span>Schedule: link to the schedule of the competition</p>
<p class="p1"><span class="Apple-tab-span"> </span>Media: link to a page containing tweets and updates about the competition</p>
<p class="p1"><span class="Apple-tab-span"> </span>Log in: link to a page that logs the user in (made for the colleges’ masters and IMs admins)</p>
<p class="p1"><span class="Apple-tab-span"> </span>Log out: button to log the user out</p>
<p class="p1"><span class="Apple-tab-span"> </span>Admin: dropdown menu with the following options</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Input scores: link to a page made for admins and master users to insert the scores of the matches</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Remove scores: link to a page made for admins and master users to remove the scores of a particular match</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Register user: link to a page made for the master users to register new users (either admin or masters) to the database</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Remove user: link to a page made for the master users to remove users from the database</p>
<p class="p2"><br></p>
<p class="p1">Home page:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Introduction: brief description of the Yale IMs</p>
<p class="p1"><span class="Apple-tab-span"> </span>The Podium: shows the three top colleges based on their total scores</p>
<p class="p1"><span class="Apple-tab-span"> </span>The Ranking: table that shows every colleges’ ranking, their shield and total scores. <b>Click on a college’s shield to navigate to that college’s own page!</b></p>
<p class="p2"><br></p>
<p class="p1">Footer:</p>
<p class="p1"><span class="Apple-tab-span"> </span>A link to the email intramuralsyale@gmail.com that redirects the user to their email, allowing them to communicate with us!</p>
<p class="p1"><span class="Apple-tab-span"> </span>Youtube: link to Youtube =D.</p>
<p class="p1"><span class="Apple-tab-span"> </span>F: link to the IMs page on Facebook.</p>
<p class="p2"><br></p>
<p class="p1">Schedule:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that contains a public google calendar of the email intramuralsyale@gmail.com that allows all users to check the schedule of the competition.</p>
<p class="p1"><span class="Apple-tab-span"> </span>Events on the calendar can be clicked to show their details. This also makes possible for the user to copy the event to their calendar.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The calendar shows every moth the user wants and can be printed by the user or completely added to the user’s google calendar by clicking the +GoogleCalendar button on the bottom right corner of the page.</p>
<p class="p2"><br></p>
<p class="p1">Media:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that shows the latest tweets with the hashtags #yaleintramurals.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The intent of this page is that the players, supporters and IMs staff can post their pictures and comments before/after the games and the results of the matches by posting them directly into their Tweeter accounts.<span class="Apple-tab-span"> </span></p>
<p class="p2"><br></p>
<p class="p1">Individual College page:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that contains information about a particular college, chosen by the user in the home page.</p>
<p class="p1"><span class="Apple-tab-span"> </span>Among the information, there is a picture of the college’s courtyard, a small text about the college’s history, the score of the college in every individual sport and a chart at the bottom that shows how much every sport has contributed <span class="Apple-tab-span"> </span>to the college’s total score<span class="Apple-converted-space"> </span></p>
<p class="p2"><br></p>
<p class="p1">Input Scores:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that allows master and admin users to input the scores for the matches one by one.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The user must provide a sport, a valid date and may either write or use the arrows below every college name to add the amount of points that this college has made in that match -<span class="Apple-converted-space"> </span>according to the IMs regulation.</p>
<p class="p1"><span class="Apple-tab-span"> </span>Colleges with no score provided will be counted as 0. <b>To submit the scores, press either the “ENTER” key or the “Input scores” button at the end of the page.</b></p>
<p class="p1"><span class="Apple-tab-span"> </span>As the user inputs the scores, they will be prompted with a popup message showing the scores they’re adding and asking if the scores are correct. <b>If they are, the user should click “OK”. If they aren’t, the user can click <span class="Apple-tab-span"> </span>“Cancel” and set the scores properly before proceeding.</b></p>
<p class="p1"><span class="Apple-tab-span"> </span>The scores added will be added to the tables “matches” and “stats”.</p>
<p class="p2"><br></p>
<p class="p1">Remove Scores:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that allows master and admin users to remove the added scores for a match if they make a mistake inputing the scores, for example.</p>
<p class="p1"><span class="Apple-tab-span"> </span>To better understand how the scores to a particular sport are calculated, the user can click the hyperlink under “Yale Intramurals Regulations” and be redirected to the page with the proper calculation of the scores.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The table shows the number of the match in the order the matches were inputed into the system, the sport, the date and how many points each college received for that particular match.</p>
<p class="p1"><b><span class="Apple-tab-span"> </span>To remove a match, the user must click the match number, on the left column.</b></p>
<p class="p1"><span class="Apple-tab-span"> </span>When a match is clicked, the user will be prompted with a message showing the match they are about to remove and asking if that is correct. <b>If it is, the user should click “OK”. If it isn’t, the user can click “Cancel” and <span class="Apple-tab-span"> </span>choose another match before proceeding.</b></p>
<p class="p2"><br></p>
<p class="p1">Register User:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that allows a master user to register new admin and new master users.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The user must provide a name, residential college, username, password and confirm the password of the new user.</p>
<p class="p1"><span class="Apple-tab-span"> </span><b>The user in charge of registering might also choose if this user will be a master user or not by clicking the “Master” check-box.</b></p>
<p class="p2"><br></p>
<p class="p1">Remove User:</p>
<p class="p1"><span class="Apple-tab-span"> </span>Page that allows master users to remove users from the database, taking away their power to log ing, input and remove scores.</p>
<p class="p1"><span class="Apple-tab-span"> </span>In order to do that, the user has to click the username of the user he intend to remove from the system.</p>
<p class="p1"><span class="Apple-tab-span"> </span>The taste user will then be prompted with a message to confirm their decision. <b>They should click “OK” to confirm the decision or “Cancel” to choose a different user to be removed.</b></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p2"><br></p>
</body>
</html>