110swag / docs

Download as
Browse Code ยป

Commit d8905e066831ee73c0408e1b3afc1dae8fb6d5a6

Authored by Chung Wang
2 parents 4d2ee9e3e9 9c16a53268
Exists in master

Merge branch 'master' of https://git.ucsd.edu/110swag/docs

Showing 4 changed files Side-by-side Diff

DesignUseCases.tex View file @ d8905e0
... ... @@ -114,7 +114,6 @@
114 114 future requests.}
115 115 \end{enumerate}
116 116  
117   -{}
118 117 {Verification Workflow:}
119 118  
120 119 \begin{enumerate}
... ... @@ -137,7 +136,7 @@
137 136 \end{description}
138 137  
139 138 \newpage
140   -\subsection{\texorpdfstring{{{[}A2{]} User
  139 +\subsection{{{{[}A2{]} User
141 140 Login}}{{[}A2{]} User Login}}
142 141  
143 142 \begin{description}
... ... @@ -293,7 +292,7 @@
293 292  
294 293 {}
295 294  
296   -\subsection{\texorpdfstring{{{[}A4{]} }{Drop a
  295 +\subsection{{{{[}A4{]} }{Drop a
297 296 Class}}{{[}A4{]} Drop a Class}}
298 297  
299 298 \begin{description}
... ... @@ -370,7 +369,7 @@
370 369  
371 370 {}
372 371  
373   -\subsection{\texorpdfstring{{{[}A5{]} Password
  372 +\subsection{{{{[}A5{]} Password
374 373 change}}{{[}A5{]} Password change}}
375 374  
376 375 \begin{description}
... ... @@ -457,7 +456,7 @@
457 456  
458 457 {}
459 458  
460   -\subsection{\texorpdfstring{{{[}A6{]} Password reset
  459 +\subsection{{{{[}A6{]} Password reset
461 460 }}{{[}A6{]} Password reset }}
462 461  
463 462 \begin{description}
... ... @@ -575,7 +574,7 @@
575 574  
576 575 {}
577 576  
578   -\subsection{\texorpdfstring{{{[}A7{]} Limit Student Access to Courses
  577 +\subsection{{{{[}A7{]} Limit Student Access to Courses
579 578 }}{{[}A7{]} Limit Student Access to Courses }}
580 579  
581 580 \begin{description}
... ... @@ -640,7 +639,7 @@
640 639 \end{description}
641 640 \newpage
642 641  
643   -\subsection{\texorpdfstring{{{[}A8{]} User
  642 +\subsection{{{{[}A8{]} User
644 643 Logout}}{{[}A8{]} User Logout}}
645 644  
646 645 \begin{description}
... ... @@ -684,7 +683,7 @@
684 683  
685 684  
686 685  
687   -\subsection{\texorpdfstring{{{[}A9{]} Contact
  686 +\subsection{{{{[}A9{]} Contact
688 687 Admin}}{{[}A9{]} Contact Admin}}
689 688  
690 689 \begin{description}
... ... @@ -722,7 +721,7 @@
722 721  
723 722 {}
724 723 \section{Flashcards}
725   -\subsection{\texorpdfstring{{{[}F1{]} Push Flashcard
  724 +\subsection{{{{[}F1{]} Push Flashcard
726 725 }}{{[}F1{]} Push Flashcard }}
727 726  
728 727 \begin{description}
... ... @@ -840,7 +839,7 @@
840 839  
841 840 {}
842 841  
843   -\subsection{\texorpdfstring{{{[}F2{]} Edit
  842 +\subsection{{{{[}F2{]} Edit
844 843 Flashcard}}{{[}F2{]} Edit Flashcard}}
845 844  
846 845 \begin{description}
... ... @@ -927,7 +926,7 @@
927 926  
928 927 {}
929 928  
930   -\subsection{\texorpdfstring{{{[}F3{]} Pull
  929 +\subsection{{{{[}F3{]} Pull
931 930 Flashcard}}{{[}F3{]} Pull Flashcard}}
932 931 \begin{description}
933 932 \item[Description]{The User shall be able to add flash cards to their own
... ... @@ -1002,7 +1001,7 @@
1002 1001  
1003 1002 {}
1004 1003  
1005   -\subsection{\texorpdfstring{{{[}F4{]} Flag Inappropriate
  1004 +\subsection{{{{[}F4{]} Flag Inappropriate
1006 1005 Cards}}{{[}F4{]} Flag Inappropriate Cards}}
1007 1006  
1008 1007 \begin{description}
... ... @@ -1080,7 +1079,7 @@
1080 1079  
1081 1080 {}
1082 1081  
1083   -\subsection{\texorpdfstring{{{[}F5{]} Filter
  1082 +\subsection{{{{[}F5{]} Filter
1084 1083 Flashcards}}{{[}F5{]} Filter Flashcards}}
1085 1084  
1086 1085 \begin{description}
... ... @@ -1149,7 +1148,7 @@
1149 1148  
1150 1149 {}
1151 1150  
1152   -\subsection{\texorpdfstring{{{[}F6{]} Blank Out Words in
  1151 +\subsection{{{{[}F6{]} Blank Out Words in
1153 1152 Flashcard}}{{[}F6{]} Blank Out Words in Flashcard}}
1154 1153  
1155 1154 \begin{description}
... ... @@ -1252,7 +1251,7 @@
1252 1251  
1253 1252 {}
1254 1253  
1255   -\subsection{\texorpdfstring{{{[}F7{]} Fix
  1254 +\subsection{{{{[}F7{]} Fix
1256 1255 Flashcard}}{{[}F7{]} Fix Flashcard}}
1257 1256  
1258 1257 \begin{description}
... ... @@ -1331,7 +1330,7 @@
1331 1330  
1332 1331 {}
1333 1332  
1334   -\subsection{\texorpdfstring{{{[}F8{]} Hide cards from
  1333 +\subsection{{{{[}F8{]} Hide cards from
1335 1334 feed}}{{[}F8{]} Hide cards from feed}}
1336 1335  
1337 1336 \begin{description}
... ... @@ -1381,7 +1380,7 @@
1381 1380  
1382 1381 {}
1383 1382  
1384   -\subsection{\texorpdfstring{{{[}F9{]} View a
  1383 +\subsection{{{{[}F9{]} View a
1385 1384 Feed}}{{[}F9{]} View a Feed}}
1386 1385  
1387 1386 \begin{description}
... ... @@ -1429,7 +1428,7 @@
1429 1428  
1430 1429 {}
1431 1430 \section{Decks}
1432   -\subsection{\texorpdfstring{{{[}-D2-{]} Making a
  1431 +\subsection{{{{[}-D2-{]} Making a
1433 1432 deck}}{{[}-D2-{]} Making a deck}}
1434 1433  
1435 1434 \begin{description}
... ... @@ -1522,7 +1521,7 @@
1522 1521  
1523 1522 {}
1524 1523  
1525   -\subsection{\texorpdfstring{{{[}D1{]} Remove a card from a
  1524 +\subsection{{{{[}D1{]} Remove a card from a
1526 1525 deck}}{{[}D1{]} Remove a card from a deck}}
1527 1526  
1528 1527 \begin{description}
... ... @@ -1616,7 +1615,7 @@
1616 1615 \end{enumerate}
1617 1616 \end{description}
1618 1617  
1619   -\subsection{\texorpdfstring{{{[}-D2-{]} Shuffling
  1618 +\subsection{{{{[}-D2-{]} Shuffling
1620 1619 deck}}{{[}-D2-{]} Shuffling deck}}
1621 1620  
1622 1621 \begin{description}
... ... @@ -1705,7 +1704,7 @@
1705 1704  
1706 1705 {}
1707 1706  
1708   -\subsection{\texorpdfstring{{{[}D2{]} Viewing cards in deck by pull
  1707 +\subsection{{{{[}D2{]} Viewing cards in deck by pull
1709 1708 time}}{{[}D2{]} Viewing cards in deck by pull time}}
1710 1709  
1711 1710 \begin{description}
... ... @@ -1793,7 +1792,7 @@
1793 1792 {}
1794 1793  
1795 1794 \section{Review}
1796   -\subsection{\texorpdfstring{{{[}R1{]} Study
  1795 +\subsection{{{{[}R1{]} Study
1797 1796 Deck}}{{[}R1{]} Study Deck}}
1798 1797  
1799 1798 \begin{description}
... ... @@ -1871,7 +1870,7 @@
1871 1870  
1872 1871 {}
1873 1872  
1874   -\subsection{\texorpdfstring{{{[}R2{]} Review
  1873 +\subsection{{{{[}R2{]} Review
1875 1874 Notification}}{{[}R2{]} Review Notification}}
1876 1875  
1877 1876 \begin{description}
... ... @@ -1939,7 +1938,7 @@
1939 1938  
1940 1939 {}
1941 1940  
1942   -\subsection{\texorpdfstring{{{[}R3{]} Configure Account
  1941 +\subsection{{{{[}R3{]} Configure Account
1943 1942 Notifications}}{{[}R3{]} Configure Account Notifications}}
1944 1943 \begin{description}
1945 1944 \item[Description]{The User shall be able to turn notifications on or off
Makefile View file @ d8905e0
1   -PNGS = built/use_cases_diagram.png built/schema_diagram.png built/schema_graph.png built/screen_sequence_diagram1.png built/screen_sequence_diagram2.png
  1 +PNGS = built/use_cases_diagram.png built/schema_diagram.png built/schema_graph.png built/screen_sequence_diagram.png
2 2 PDFS = built/DesignUseCases.pdf built/screen_sequence_diagram.pdf
3 3  
4 4 all: built/ $(PNGS) $(PDFS)
... ... @@ -17,7 +17,7 @@
17 17  
18 18  
19 19 built/screen_sequence_diagram.pdf: built/screen_sequence_diagram.png
20   - convert built/screen_sequence_diagram1.png built/screen_sequence_diagram2.png built/screen_sequence_diagram.pdf
  20 + convert built/screen_sequence_diagram.png built/screen_sequence_diagram.pdf
21 21  
22 22 built/%.pdf: %.tex
23 23 cd built/; pdflatex ../$<
screen_sequence_diagram.dot View file @ d8905e0
  1 +digraph G{
  2 + ratio=0.75;
  3 + rankdir="LR";
  4 + node[shape = box];
  5 + "[A1] Register"[fillcolor="#aaaaff", style=filled];
  6 + "[A2] Login"[fillcolor="#aaaaff", style=filled];
  7 + "[A8] Logout"[fillcolor="#aaaaff", style=filled];
  8 + "[A6] Forgot Password"[fillcolor="#aaaaff", style=filled];
  9 + "[A5] Change Password"[fillcolor="#aaaaff", style=filled];
  10 + "[A3] Add Class"[fillcolor="#aaaaff", style=filled];
  11 + #"[R40] Configure Notifications"[fillcolor="#ffaaff", style=filled];
  12 + "[A1] Register"->"[A2] Login";
  13 + "[A2] Login"->"[A2] Login";
  14 + "[A2] Login"->"[A6] Forgot Password";
  15 + "[A8] Logout"->"[A2] Login";
  16 + "[A2] Login"->"[A8] Logout";
  17 + "[A2] Login" -> "[A5] Change Password";
  18 + "[A2] Login" -> "[R40] Configure Notifications";
  19 + "[A2] Login"->"[A3] Add Class";
  20 + "[A3] Add Class"->"[F10] View Class Feed";
  21 + "[F1] Push Flashcard"->"[F6] Select Blanks"
  22 + "[F10] View Class Feed"->"[F1] Push Flashcard";
  23 + "[F1] Push Flashcard"->"[F10] View Class Feed";
  24 + "[F6] Select Blanks"->"[F10] View Class Feed";
  25 + "[F10] View Class Feed"->"[F3] Pull Flashcard";
  26 + "[D] Edit Deck" -> "Unpull Cards";
  27 + "[D] Edit Deck" -> "[F2] Edit Card";
  28 + "[F2] Edit Card" -> "[F6] Select Blanks";
  29 + "[F10] View Class Feed" ->"[R16] Study Deck";
  30 + "[F10] View Class Feed" ->"[D] Edit Deck";
  31 + "[A9] Contact Admins"
  32 + "User" [shapefile="stick.png"];
  33 + "User"->"[A1] Register";
  34 +}
use_cases_diagram.dot View file @ d8905e0
1 1 digraph G{
2 2 ratio=0.75;
3 3 rankdir="LR";
4   - node[shape = box];
5   - "[A1] Register"[fillcolor="#aaaaff", style=filled];
6   - "[A2] Login"[fillcolor="#aaaaff", style=filled];
7   - "[A8] Logout"[fillcolor="#aaaaff", style=filled];
8   - "[A6] Forgot Password"[fillcolor="#aaaaff", style=filled];
9   - "[A5] Change Password"[fillcolor="#aaaaff", style=filled];
10   - "[A3] Add Class"[fillcolor="#aaaaff", style=filled];
11   - #"[R40] Configure Notifications"[fillcolor="#ffaaff", style=filled];
  4 + node[shape=box];
  5 + "[A1] Register"[fillcolor="#6699ff", style=filled];
  6 + "[A2] Login"[fillcolor="#6699ff", style=filled];
  7 + "[A3] Add Class"[fillcolor="#6699ff", style=filled];
  8 + "[A5] Change Password"[fillcolor="#6699ff", style=filled];
  9 + "[A6] Forgot Password"[fillcolor="#6699ff", style=filled];
  10 + "[A8] Logout"[fillcolor="#6699ff", style=filled];
  11 + "[A9] Contact Admins"[fillcolor="#6699ff", style=filled];
  12 +
  13 + "[D] Edit Deck"[fillcolor="#ccff99", style=filled];
  14 +
  15 + "[F1] Push Flashcard"[fillcolor="#ff5050", style=filled];
  16 + "[F2] Edit Card"[fillcolor="#ff5050", style=filled];
  17 + "[F3] Pull Flashcard"[fillcolor="#ff5050", style=filled];
  18 + "[F6] Select Blanks"[fillcolor="#ff5050", style=filled];
  19 + "[F10] View Class Feed"[fillcolor="#ff5050", style=filled];
  20 +
  21 + "[R40] Configure Notifications"[fillcolor="#ffaaff", style=filled];
  22 +
12 23 "[A1] Register"->"[A2] Login";
13 24 "[A2] Login"->"[A2] Login";
14 25 "[A2] Login"->"[A6] Forgot Password";
... ... @@ -29,7 +40,7 @@
29 40 "[F10] View Class Feed" ->"[R16] Study Deck";
30 41 "[F10] View Class Feed" ->"[D] Edit Deck";
31 42 "[A9] Contact Admins"
32   - "User" [shapefile="stick.png"];
  43 + "User" [shape=none, shapefile="stick.png"];
33 44 "User"->"[A1] Register";
34 45 }