From c34e1be4ac83285be4e0eeff0936f5a1f630fec8 Mon Sep 17 00:00:00 2001 From: Ger Teck <111064611+gerteck@users.noreply.github.com> Date: Mon, 15 Apr 2024 22:17:07 +0800 Subject: [PATCH] Update UG Add cards to user interface --- docs/UserGuide.md | 63 +++++++++++++++++++++++++++++---- docs/images/befriendeeCard.png | Bin 0 -> 93565 bytes docs/images/logCard.png | Bin 0 -> 66673 bytes docs/images/volunteerCard.png | Bin 0 -> 105673 bytes 4 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 docs/images/befriendeeCard.png create mode 100644 docs/images/logCard.png create mode 100644 docs/images/volunteerCard.png diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 294230316af..8abc9d6d67c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -181,29 +181,80 @@ After this, you're all set to begin using Elder Scrolls! Let's make managing vol ### 2.1 Toolbar -The toolbar at the top provides functionality for accessing help and exiting Elder Scrolls. The application window contains the following buttons: +The toolbar at the top provides functionality for **accessing help and exiting** Elder Scrolls. The application window contains the following buttons: * `File`: Hovering over opens a dropdown menu, click on Exit to close the application! * `Help`: Hovering over opens a dropdown menu, whereby clicking on Help F1 opens a help pop-up! ### 2.2 Command Input Box -The command input box at the top of the application window is where you can type commands to interact with Elder Scrolls. Press `Enter` to execute the command. +The command input box at the top of the application window is where you can **type commands to interact** with Elder Scrolls. **Press `Enter` to execute** the command. ### 2.3 Command Output Box -The command output box displays the results of the commands you have executed. It also displays error messages when an invalid command is entered. Paying close attention to the feedback provided here helps enhance your experience with Elder Scrolls! +The command output box displays the **results of the commands** you have executed. It also **displays error messages** when an invalid command is entered. Paying close attention to the feedback provided here helps enhance your experience with Elder Scrolls! ### 2.4 Befriendee List Panel -This section displays all your registered befriendees, and you may filter the display using our supported find commands. The list is updated in real time as you execute commands. +This section **displays all your registered befriendees**, and you may filter the display using our supported find commands. The list is updated in real time as you execute commands. + +
Befriendee List Card
+ +Each befriendee list card displays the following information: + +Volunteer List Card
+ +Log List Card
+ +gZ3l>Yj
zyYMani~KR%UGA$?Rnfm}@c*liI&>0QhQIS}jXQb!i}aX2^0z&LE-AGFwm1B3`*mH|
zq-AGz;Ss`O^lgNHLT8#X&91x!=HNBa?~K8U?q_-3X%|0X@GHk$ma)=R+L^%Jeg1F6
z- eD@UoOYhDYT
zo1X((_5n9svGcr!Bbgwbiuy1pM_Jv4#Xfn5&5P!sQm2;sx-af&B25tTo-8{2Fko$h
zF~;q%^B~qBdA`c81|d_XEbEr!XlFR1Fq-Dz^(5*DaoI*WRq%1YI0rMgl8r}2A4f}X
z@%Lx#TA3SW=PD-_Nf_L#){iw#Ip02amSpdKieSsqHE<6YxGA4MXKLQgWj
zEwsIh?c5RWN-R )dcJ;nV&>2;52oV0P|MmP$^cR2lV@HQc0sa_;KrZJf4uzw>l$#)Phei7}R2LY&)}
z5~{(|c>9)|*K*|HLEM-sU$Uj?wpI6nk(B7{RGT5NO!)L-4_jnCY(}V0hI{4!4}FH~
zTub*sx$WYanc*40Zm6wex|E3w5(YxX<4)#Kcs9BbfOJP!_!PJ*ulVSUF^#NrApvYV
z;jz%d1r*TYJl*w1*J^AI8>M}6A&B;=hQymMf1F4b?9#AI3_pGVwf*hLm$;R-{^=$B
zV%?JYl9jR>wyWlvlX G6wm-6iJFXe>~
zcot~_nsnbVO~?e3K#U4wF5ze|vf#{c=6U`wU)-i*N2Ozcs`PRU0j=R2IJ#qZhf_VI
z)FtFc^&&b>V_zsMBLOt*DT?F3)+%`?G-pX#i^dMO)ZPWIALmDF(oFgauC
zzchFW6jb()IV$5)sjj7s-W+HhvKrA;(ZEA0P}uVVzM3NlyW1_hTd8B!qV9L4?2CzznC
zzmzlIENp8bJWO!ErEh?iNs|XP>}_{HH~zim1I+TUbeaFSag{x~eH!=8RzzI2BPPc>
zBR~PlRbw)$6fuK98D9SQb!EC*^yQ<{@Ylz~tf2GyrVYNw0rvjR_m3qy6o?9Ql(Lqz
zmXb)n%B8LgenRJfAv(MK%@M!cG0IPVs^JX_yYaWUe)IA`K!LJ#A%NWEq7MYuw>Oqv
zvZ#6=TFbJH2y}liMVQZZ%9p(=xs~l_8o2QGEpy%CqDEZ0LMP%nTSdu0BzWHS%F4P!
zr|(U6bGhsbqUQdWM9l+EiJC%B4Ip=TbD(${h26O=Z(=2GvlllomyxR!Z5K#7okQvS
z-brY<(MiS|y}`yCttxLQ<%Yx4ns>Wv7ylfNg7sE(r!*EMu#D@j8JfvbY+o%3T3
zr6)B0JEY&G1oQ-VEB9BUiWP0QA#=>O!}^PmY1NU34Tfq-wv$RXir+=bG7V$jpjS$p
ztc(HyT~B!)^8K9$Ux6_Qm$l{02&2Ys!%plsGp=B~m>-^8Xa8h%+J5p=0b?we%+t0S
zf~aR@q#_ZF3{<
Ax#dQa%FeVCU_Tnp=3#kV;
zypDv5@l&bEiqB*Zz4W6h<)7xvPZ=*s$erLsI<+NROP1K7or`z3uqD3R3Yr<7f5b}!
z1W|=UU@gHJ=BTgojMAd?1vLU<@33fCpqP`{;y_=CYmckumAX^uzJeOjM3fQpB@u@?
z-
%M7A(?$mbIq^oY
z)SyKK2p#u8li^|0{Xv(&n)WKF(g_2o=FA7~FA_Q6i?6%4XFpniVjLi^c2q{g(81ux
zn+3X=Pvo97o$a6h2->Z7TJ%Rs0y6f=uoJ7$YQ=3{0ROO|>G6M!!R*TG(x82Rlup!7
z)(%Us5mCOU#(J?{5Px|6u;=vx)S0nf&VCHhdnQ{aC-J!Www4@Y*0({%H_Vly5`KSV
ze|