-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
801 lines (710 loc) · 41.1 KB
/
index.html
File metadata and controls
801 lines (710 loc) · 41.1 KB
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
<!doctype html>
<html lang="en-gb">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Examples</title>
<link rel="stylesheet" href="styles.css">
</head>
<body>
<header>
<h1 id="heading">CTEC3905 Past Student Work</h1>
<p>Here are some examples of the kind of work students have produced in previous years. They're in rough categories so you get an idea of how these websites were marked.</p>
<p>Overall stats:</p>
<ul>
<li>pass-rate was 96%</li>
<li>average grade was 64%</li>
<li>about 40% had firsts</li>
</ul>
<div id="banner">Deadline in <span>X days</span>!</div>
<h3>How to read this document:</h3>
<p>This document is organised in order of the marking criteria and shows examples of each of the three categories ("not addressed", "partially addressed", and "fully addressed") for each of the points (if suitable).</p>
<p>You can click on any image or gif to open a larger version in a modal, and click anywhere within the modal to hide it again.</p>
<button id="rubric">Print Marking Criteria Only</button>
<button id="everything">Print Everything</button>
<h3>Shortcuts:</h3>
<nav>
<a href="#design">Screenshots of overall design</a>
<a href="#quality">HTML and CSS Code Quality</a>
<a href="#js">JavaScript, APIs & JSON</a>
<a href="#rwd">Responsiveness, Accessibility and Interaction</a>
<a href="#git">GIT & GitHub</a>
<a href="#issues">General Issues</a>
</nav>
</header>
<hr>
<section>
<h2 id="design">Screenshots of overall design</h2>
<p>Here are some examples of student work from the previous two years, with a rough idea of how they were marked overall.</p>
<p>Please note that this <strong>only shows how the pages look</strong>, it <strong>doesn't show any animations or hover effects</strong>, and most of all it <strong>does not show the quality of the code</strong>. So some of the pages are marked higher or lower overall perhaps than you might expect due to underlying issues with the code. This includes for example <strong>API calls</strong> that bring in content dynamically from external sources which might not be clear from simply looking at the final design of the website.</p>
<section class="grid logs">
<figure id="example1">
<img src="screenshots/website10-20.gif">
<figcaption>10-20</figcaption>
</figure>
<figure id="example2">
<img src="screenshots/website30-40.gif">
<figcaption>30-40</figcaption>
</figure>
<figure id="example3">
<img src="screenshots/website40-50.gif">
<figcaption>40-50</figcaption>
</figure>
<figure id="example4">
<img src="screenshots/website50-60.gif">
<figcaption>50-60</figcaption>
</figure>
<figure id="example5">
<img src="screenshots/website60-70.gif">
<figcaption>60-70</figcaption>
</figure>
<figure id="example6">
<img src="screenshots/website60-70-1.gif">
<figcaption>60-70</figcaption>
</figure>
<figure id="example7">
<img src="screenshots/website70-80.gif">
<figcaption>70-80</figcaption>
</figure>
<figure id="example8">
<img src="screenshots/website90-100-1.gif">
<figcaption>90-100</figcaption>
</figure>
<figure id="example9">
<img src="screenshots/website90-100-2.gif">
<figcaption>90-100</figcaption>
</figure>
<figure id="example10">
<img src="screenshots/website90-100.gif">
<figcaption>90-100</figcaption>
</figure>
</section>
</section>
<hr>
<section>
<h2 id="quality">1. HTML and CSS Code Quality</h2>
<h3>1.1. Valid HTML5 and CSS3 source code throughout</h3>
<p>Try and fix any errors and address warnings that are raised by the validator. Mostly this will catch serious syntax errors but it also points the way to good practice in general.</p>
<p>For the HTML validation, errors must be avoided completely to get "partially" or "fully addressed". Warnings are less severe but you should still try to address them.</p>
<p>Depending on the amount of CSS errors you have you might still get "partially addressed" if they are minor (or for example are to do with browser compatibility). Again warnings are less severe but you should still try to address them.</p>
<p><strong>Validation is your friend! Use it often!</strong></p>
<p>Often, programmer's text editors will highlight syntax errors as shown below (either by squiggly underline or by a change in colouring (e.g. white text instead of green). This can help you debug your code.</p>
<section class="grid samples">
<div>
<figure>
<img src="screenshots/html-no-code.png">
<figcaption>HTML code with 2 errors</figcaption>
</figure>
<p class="figdetails">note the missing closing <code>></code> bracket of the <code>p</code> tag on line 96, and the typo on line 99 showing an opening <code>t</code> tag instead of a <code>p</code> tag</p>
</div>
<div>
<figure>
<img src="screenshots/html-no.png">
<figcaption>HTML code validation results</figcaption>
</figure>
<p class="figdetails">the validation for the HTML code shown just now highlights several issues, for instance a warning about the section missing a heading which can be ignored, but also error 2 which indicates to the missing bracket on line 96, error 4 points to the erroneous <code>t</code> tag, the other errors here are actually propagation errors</p>
</div>
<div>
<figure>
<img src="screenshots/css-no-code.png">
<figcaption>CSS code with 3 errors</figcaption>
</figure>
<p class="figdetails">note the typo on line 58, the missing semi-colon on line 64, and the extra closing brace on line 70</p>
</div>
<div>
<figure>
<img src="screenshots/css-no.png">
<figcaption>CSS validation results</figcaption>
</figure>
<p class="figdetails">the validation results here highlight very precisely were those errors are and even gives an idea of how to fix them</p>
</div>
</section>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">several errors in HTML or CSS, many of which could have been easily fixed or avoided and no attempt at fixing is evident</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">some minor obscure errors (with attempts to fix them clearly shown for example in the console)</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">we would expect there to be no errors in either the HTML or the CSS for this category</p>
</div>
</section>
<h3>1.2. Consistent code nesting and indentation (2 spaces is industry-standard)</h3>
<p>If you are unsure about your indentation practice you can use a beautifier to indent your code for you (yes, we are essentially giving away marks here)! See links below:</p>
<ul>
<li><a href="https://codebeautify.org/">codebeautify.org</a></li>
<li><a href="https://beautifier.io/">beautifier.io</a></li>
</ul>
<section class="grid samples">
<figure>
<img src="screenshots/indentation0.png">
<figcaption>not addressed</figcaption>
</figure>
<figure>
<img src="screenshots/indentation0-1.png">
<figcaption>not addressed</figcaption>
</figure>
<figure>
<img src="screenshots/indentation1.png">
<figcaption>partially addressed</figcaption>
</figure>
<figure>
<img src="screenshots/indentation2.png">
<figcaption>fully addressed</figcaption>
</figure>
</section>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">very inconsistent indentation, possibly causing errors with closing brackets and tags, in more than one file</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">a few minor and sporadic irregularities</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">very consistent indentation in all files</p>
</div>
</section>
<h3>1.3. Separate .css and .js files (e.g. no "style=" or "onclick" in HTML)</h3>
<p>This is largely marked on amount of inline logic in the HTML. So for instance one occurance of "onclick" or a "width" declaration inside an <code><img></code> tag would be considered "partially addressed". Several instances of this would be "not addressed" and of course no inline styles or scripts would be "fully addressed".</p>
<p>The examples below are taken out of context of the whole repository so I can't really show the grading element for these fairly. Suffice to say inline styles and scripts like these should not happen ever.</p>
<section class="grid samples">
<div>
<figure>
<img src="screenshots/inline0.png">
<figcaption>depends on overall number</figcaption>
</figure>
<p class="figdetails">note missing video tag instead of div, inline styles ("align" marked in red), spaces between attributes and values (e.g. <code>class = "VideoEmbed"</code> instead of <code>class="VideoEmbed"</code>), inline JS (onclick instead of eventListener)</p>
</div>
<div>
<figure>
<img src="screenshots/inline0-1.png">
<figcaption>not addressed</figcaption>
</figure>
<p class="figdetails">note excessive use of onclick, inline styles, the div with class "tab" should simply be a <code><nav></code> tag, the section with class "mainbody" should be a <code><main></code> tag</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-1.png">
<figcaption>depends on overall number</figcaption>
</figure>
<p class="figdetails">note the setting of background colour inline and also the div with class "Header" should be a <code><header></code> tag, and the <code><b></code> tag should be a <code><strong></code> tag instead</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-3.png">
<figcaption>depends on overall number</figcaption>
</figure>
<p class="figdetails">note line 51 shows a syntax error of a tag without a name just a class, indentation is bad, and contains inline CSS styles for the image</p>
</div>
</section>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">there really is no need to include "onclick" triggers in the HTML or inline styles, so don't use them, or clean up any code you copy from tutorials that uses them - translate it into JavaScript or move the styles into your CSS stylesheet</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">there has to be clear evidence otherwise of separate programming logic in separate files (e.g. handling eventListeners rather than "onlick", separate CSS file for styles)</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">no instances of inline style manipulation or inline JavaScript (with the exception of scripts for website analytics, e.g. Facebook or Google Analytics widgets)</p>
</div>
</section>
<h3>1.4. Use of CSS3 features e.g. flexbox, animations, CSS grid</h3>
<p>This largely depends on the number and quality of examples found in the code. There isn't a specific number of features you have to include, but it should cover at least one of the examples above well. For example you can use advanced flexbox to create multi-column layouts that adapt to screen-size, or you add a few different animations to your site, or you layout the page with grids that adapt to screen size too.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">only very basic CSS in general and no CSS3 features used at all, or very buggy or pointless (e.g. just slapping a <code>display: flex</code> on a random element with no effect</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">some attempts at using CSS3 features such as flexbox and animations but maybe slightly buggy or redundant, maybe contains an animation but includes lots of redundant vendor pre-fixes (e.g. "-webkit")</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">good use of flexbox and or grids for layout, and/or good use of animations (e.g. rotating icons on hover, responsive grid layout, etc)</p>
</div>
</section>
<h3>1.5. Tidy file and folder organisation with lower-case names</h3>
<p>This should be fairly self-explanatory. Keep file and folder names lower-case and don't include any spaces or underscores (use hyphens if necessary). We normally expect you to keep your images, CSS, and JS files in a separate folder each. Don't include any unused files you used during development. Clean the repository for your final commit. Your main homepage must be called "index.html". This is necessary for GitHub Pages to work and most web servers too.</p>
<section class="grid logs">
<figure>
<img src="screenshots/dir0.png">
<figcaption>not addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir0-1.png">
<figcaption>not addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir0-2.png">
<figcaption>not addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir1.png">
<figcaption>partially addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir1-1.png">
<figcaption>partially addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir2.png">
<figcaption>fully addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir2-1.png">
<figcaption>fully addressed</figcaption>
</figure>
<figure>
<img src="screenshots/dir2-2.png">
<figcaption>fully addressed</figcaption>
</figure>
</section>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this may include cases where all files are in the root directory, including code files and any other assetts such as images, or poorly organised folders overall, and file names may be inconsistent (lower-case, camel-case, upper-case, underscores, spaces, etc.), no <code>index.html</code> file</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">shows attempts at organising files well but has some issues, e.g. inconsistent naming convention, or some images outside of image folder</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">files are organised by type into sub-folders, file names are consistent and appropriate (e.g. no spaces, underscores)</p>
</div>
</section>
</section>
<hr>
<section>
<h2 id="js">2. JavaScript, APIs & JSON</h2>
<p>Please note that you should only use native code e.g. no JQuery, Bootstrap, etc. External assets such as images, FontAwesome icons and Google fonts are acceptable.</p>
<h3>2.1. No JavaScript errors in the browser console</h3>
<p>This largely depends on the number of instances found in the console and the severity of the errors. Errors that break functionality are worse than warnings for example.</p>
<p>It may be a good idea to include <code>console.log()</code> statements for debugging purposes. Remove them if things work out, or if not then leave them in to show your attempt of fixing them. Please also note that you should remove any <code>console.log()</code> statements before your site goes live as it is considered bad practice.</p>
<p>Warnings can often be ignored as they're browser related, e.g. ad-block.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this might include errors that could be easily fixed, not linking files properly (e.g. typos, wrong paths or wrong file names) and cases were there are no errors but no JS was used at all</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">this applies if we can see that you've tried to fix the errors either by using <code>console.log()</code> statements or comments in the code</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">note that this only applies if a decent amount of "handwritten" JavaScript was used; if all you've done is copy and paste some Google maps script then we can't give you full marks for not having errors</p>
</div>
</section>
<h3>2.2. Use of JavaScript for DOM manipulation and/or interaction</h3>
<p>This largely depends on how JS was used. The point of this crtieria is for you to use JS to manipluate some content on the HTML page, for instance feedback of user input from a form (e.g. user enters name, name gets printed into a paragraph on the page). An alert box does not really count as "DOM manipulation" so would get "not addressed".</p>
<p>This also includes "tabbed" layouts that dynamically show or hide content and hamburger mobile menus that are shown or hidden via JS.</p>
<p>Please not that PHP scripts for contact forms are unmarked - we will ignore them completely. It's not going to affect your mark to have a non-functional contact form.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">Google maps with minimal customisation (e.g. coords) does not count towards this or very basic attempts of including JS such as a single <code>alert()</code> statement</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">not fully functional perhaps due to some errors or very simple (e.g. basic innerHTML use)</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">more than one instance of DOM manipulation or more advanced changes such as styling (not just content) (e.g. this document uses conditional colouring of figure captions, see <a href="scripts.js">scripts.js</a>)</p>
</div>
</section>
<h3>2.3. ES6 syntax: e.g. "let" and "const" over "var", template literals, arrow functions</h3>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">code full of <code>var</code> and standard string concatenation (e.g. <code>'hello ' + name + '!'</code> instead of <code>`hello ${name}!`</code>), maybe even some JQuery</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">inconsistent use, maybe even some JQuery</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">ES6 features used throughout and consistently, if no JS was used at all or very little you are not automatically getting full marks for one single instance of <code>let</code>, you have to show proficiency</p>
</div>
</section>
<h3>2.4. Use of JavaScript to handle data (e.g. JSON from an external API)</h3>
<p>As mentioned briefly above in point 2.2 using a Google map in not technically handling JSON data via an API, so this might only get you "partially addressed" (depends on how much you customise the map for instance).</p>
<p>There are many services out there with APIs related to images, news, weather, videos, Wikipedia, translations, maps, etc.</p>
<p><strong>The use of the Google Fonts API or embedded YouTube videos, or Twitter "widgets" do not count towards this point.</strong></p>
<p>Although Google maps is used in the examples below it is not compulsory.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">very basic Google map, possible as a inline script and with errors</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">well customised Google map, some other basic API use</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">advanced API calls to get JSON data and display it on the page (e.g. populate an image gallery, change background image accroding to current weather, query Wikipedia and display top 3 results and related news articles from the Guardian, etc.</p>
</div>
</section>
<h3>2.5. DRY code e.g. no repeated similar functions without parameters</h3>
<p>Code can generally be divided into two categories: DRY and WET code. DRY stands for <strong>Don't Repeat Yourself</strong> and WET stands for <strong>Write Everything Twice</strong>. Industry best practice suggests you should use a DRY coding style instead of a WET one, as this is much more efficient and easier to debug and maintain.</p>
<section class="grid samples">
<div>
<figure>
<img src="screenshots/dry0.png">
<figcaption>WET</figcaption>
</figure>
<p class="figdetails">you can clearly see the amount of duplication here that could have been prevented by writing a function with parameters</p>
</div>
<div>
<figure>
<img src="screenshots/dry0-1.png">
<figcaption>WET</figcaption>
</figure>
<p class="figdetails">again, this could have easily been turned into a simple function. create two variables that hold the lists of images and modals, then loop through the images one by one and change the style for the corresponding modal</p>
</div>
</section>
<p>This second example above could be rewritten easily as such: </p><code>
const imgs = document.querySelectorAll("[id^=img]");
const modals = document.querySelectorAll("[id^=modal]");
for(let i=1; i <= imgs.length; i++){
imgs[i].addEventListener("click", function() {
modals[i].style.display = "block";
})
}</code>
<p>or even better (because <code>style.display</code> essentially adds an inline style to the HTML rather than a style rule to the CSS stylesheet) replace the "modals[i]" line with:</p>
<code>modals[i].classList.add("block");</code>
<p>and add this rule to the stylesheet:</p>
<code>.block { display: block }</code>
<p>This easily reduces down the roughly 200 lines of code the student had previously (only a tiny proportion is shown in the screenshot above) to 7 or 8.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">there is lots of repetitive code in both the CSS and JS perhaps, with no attempt to do intelligently loop through arrays of elements for example</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">mostly DRY code but maybe with a few exceptions, but commented well or shown attempts at solving this more efficiently</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">fully DRY code, no repetition of code blocks</p>
</div>
</section>
</section>
<hr>
<section>
<h2 id="rwd">3. Responsiveness, Accessibility and Interaction</h2>
<h3>3.1. Responsive at any size with mobile-first CSS breakpoints</h3>
<p>The starter code we have provided you with contains two breakpoints (<code>@media</code> rules in the CSS) in a mobile first style. This means that any styles for mobile go above (and outside of) the two media queries, any styles for tablet size devices should go into the first media query and styles for desktop monitors should go into the bottom media query.</p>
<p>Most websites will not need any more breakpoints unless you have a very complex laypout. In fact you may not need the intermediary "tablet" size breakpoint even.</p>
<p>There is no set number of breakpoints but we recommend either 1 or 2. For any specific extra breakpoints please explain in a code comment why they are needed.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">no attempt at all, or very poor attempt (for example having broken media queries, lots of duplicate breakpoints, broken code inside media queries, etc.)</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">there may be a mixture of media queries (perhaps in desktop first style), maybe an excessive number of breakpoints, or the changes made are very minimal (e.g. no substantial change in layout)</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">content is clearly readable on mobile and adapted to fit larger screen sizes by using more complex layout such as two or three column designs, styles are mobile first and appropriate number or breakpoints are used</p>
</div>
</section>
<h3>3.2. Well-ordered information architecture, ease of navigation at all sizes</h3>
<p>This largely refers to the site navigation, i.e. the menu. This needs to adjust to different screen sizes, for instance by having a "hamburger" menu on mobile, and has to be well organised.</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">might be very simple or inconsistent menu with no attempt to make it mobile friendly (or vice versa: having a "hamburger" menu on desktop screens is poor design)</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">this may be a very well designed menu that fails to adapt to different screen sizes, or a fairly basic collapsable menu that is used for all screen sizes</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">a well organised navigation menu that adapts well to all screen sizes</p>
</div>
</section>
<h3>3.3. Web accessibility (e.g. HTML5 semantic elements, "alt" attributes, heading structure, etc.)</h3>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">no attempt or very poor attempt of web accessibility, that is, no or little semantic elements, no alt attributes, and poor structure of heading tags</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">some effort to include accessibility features but inconsistent</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">excellent use of semantic tags were applicable, descriptive alt attributes for any images, and clear hierarchical heading structure</p>
</div>
</section>
<h3>3.4. Coherence of overall design - colour, content, styles, etc.</h3>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">messy design, inconsistent spacing and colours</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">some attempts at creating a consistent theme for content layout and styles</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">content displayed on pages clearly and consistently according to PARC principles</p>
</div>
</section>
<h3>3.5. CSS layout of HTML5 elements e.g. no tables</h3>
<p></p>
<section class="grid samples">
<div>
<figure>
<img src="screenshots/silly0-7.png">
<figcaption>not addressed</figcaption>
</figure>
<p class="figdetails">this is a goldmine: blockquote is used for centering an image, empty paragraphs with just a space (<code>&nbsp;</code>) inside are used for spacing, and also: the images folder has a capital "I", the image name has spaces in it, and there's an inline script ("onmouseover")</p>
</div>
</section>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this includes use of tables for layout of content (unless this is actual tabular data), inappropriate use of <code><br></code> tags for spacing instead of margins and paddings, use of <code><blockquote></code> tags for centering, etc.</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">layout is generally done via CSS stylesheets but mostly based on the natural flow of HTML elements</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">layout is handled fully by CSS (flexbox or grids or other ways of positioning elements) in creative and responsive ways (e.g. not just keeping elements in their natural flow)</p>
</div>
</section>
</section>
<hr>
<section>
<h2 id="git">4. GIT & GitHub</h2>
<section class="grid logs">
<div class="log">
<p class="top"><a href="logs/not.log">view log here</a></p>
<p class="mid">not addressed</p>
<p class="bot">very few commits, most on day of deadline, uploaded files via upload interface (rather than CLI)</p>
</div>
<div class="log">
<p class="top"><a href="logs/not-1.log">view log here</a></p>
<p class="mid">not addressed</p>
<p class="bot">very few commits, most on day of deadline</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/not-2.log">view log here</a></p>
<p class="mid">not addressed</p>
<p class="bot">very few commits, most on day of deadline</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/part.log">view log here</a></p>
<p class="mid">partially addressed</p>
<p class="bot">few commits but spread out over a slightly longer period, good commit messages</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/part-1.log">view log here</a></p>
<p class="mid">partially addressed</p>
<p class="bot">decent amount of commits although many on the day before the deadline, poor commit messages, note also some experiment with a branch but only to update readme</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/part-2.log">view log here</a></p>
<p class="mid">partially addressed</p>
<p class="bot">good number of commits spread out over time periods, poor commit messages, note also some experiment with a branch but only to update readme</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/full.log">view log here</a></p>
<p class="mid">fully addressed</p>
<p class="bot">good number of commits spread out well over time, very good commit messages</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/full-1.log">view log here</a></p>
<p class="mid">fully addressed</p>
<p class="bot">excellent number of commits although about half in the last three days before deadline, brief but acceptable commit messages</p>
</div>
<div class="log">
<p class="top"><a class="logs" href="logs/full-2.log">view log here</a></p>
<p class="mid">fully addressed</p>
<p class="bot">excellent number of commits spread over time, very good commit messages, note also excellent use of branching for feature development</p>
</div>
</section>
<h3>4.1. Source code and live site on GitHub Pages</h3>
<p>This should be "fully addressed" for all of you if you've managed to set up your GitHub Classroom repo properly and enables GitHub Pages in the settings. This is really only for some cases were students simply haven't followed these instructions at all and end up submitting a zip file via email (yes, we've seen it all).</p>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this only really applies to students who for some reason do not submit a GitHub repo and have no live site</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">the repo is ok and we can see the history of commits but the live "GitHub Pages" site does not work (perhaps because it has not been enabled) or because of errors in file paths or file names</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">properly set up repo and live site with no path or file name errors</p>
</div>
</section>
<h3>4.2. Use of GIT branches for feature development</h3>
<p>Branches are slightly more advanced feature of git. They should normally be used for feature development (e.g. a new JavaScript feature, or a re-design half way through).</p>
<p>Here's some excellent resources on git branches:</p>
<ul>
<li><a href="https://www.atlassian.com/git/tutorials/using-branches">Atlassian Git Branch Tutorial</a></li>
<li><a href="https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell">Git Branching - Branches in a Nutshell</a></li>
</ul>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">no evidence of a branch or attempt to use a branch</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">a branch exists but was not merged correctly or was used in a very basic way</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">clear evidence of merged branches in git log</p>
</div>
</section>
<h3>4.3. Regular commits, not all last few days</h3>
<p>There isn't a set amount of commits you have to create in order to get "partially" or "fully addressed" here. It is possible to get full marks for this component if you have ten excellent commits, with very good commit messages spread out over a decent period to show progress.</p>
<p>We might "checkout" individual commits to verify progress if there are concerns about the integrity of the code (i.e. suspected plagiarism).</p>
<!-- <p>Plagiarism comments here?</p> -->
<p>Here's an excellent resource on this topic in general:</p>
<ul>
<li><a href="https://sethrobertson.github.io/GitBestPractices/">Commit Often, Perfect Later, Publish Once: Git Best Practices</a></li>
</ul>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">very few commits, most of the in the few days before the deadline, with no clear progress of code progression seen</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">might be few commits but nicely spread out, or many commits but all bunched together before deadline</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">should be a decent amount of commits well spread over time with a clear progression of code evident</p>
</div>
</section>
<h3>4.4. Brief, informative commit messages</h3>
<p>Look at the examples above to get an idea of what would be considered bad, good, and excellent commit messages.</p>
<p>Normally, you should use <em>imperative</em> mood to write your messages, for example "add readme file" instead of "added readme file". Read this excellent resource on this if you'd like to know more:</p>
<ul>
<li><a href="https://chris.beams.io/posts/git-commit/">How to Write a Git Commit Message</a></li>
</ul>
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this may include commit messages that just number the commits or aren't explanative (e.g. "commit 1", "#2", etc. or "changes", "stuff")</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">this applies if a mix of messages is present, i.e. some that just say "change" and some that say "add mobile hamburger menu"</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">commit messages that clearly explain what the commit changes or fixes</p>
</div>
</section>
<h3>4.5. Basic readme.md file with references in Markdown format</h3>
<p>The readme ("readme.md" or "README.md") should contain some key information about your repository and website in valid Markdown text.</p>
<p><strong>Mini Markdown Cheatsheet:</strong></p>
<pre><code>
# Heading 1
## Heading 2, etc
[link text](https://link.url)
- bullet 1
- bullet 2, etc
1. numbered item 1
2. numbered item 2, etc
</code></pre>
<p>The content of your readme is very individual and depends on your site, the issues you've faced, etc. But at the very least you should include references here to any external sources you've used (e.g. images, text content, embeded videos, API code, code examples from CodePen, W3Schools or other sources, etc.) Note that this does not have to be in Harvard referencing format but could simply be a url with a short description of what it was used for, for example:</p>
<pre><code>
# References
- image gallery code adapted from [here](https://link.url)
- Google maps code adapted from [here](https://link.url)
</code></pre>
<p>The beauty of GitHub is that if your readme file is named and formatted correctly (and at the root of your repo, i.e. not in a sub-directory) then GitHub will automatically display it nicely on your repo website as shown below.</p>
<img class="sglimg" src="screenshots/readme.png" alt="screenshot of readme file on GitHub">
<!-- <figcaption>readme.md</figcaption> -->
<section class="grid grades">
<div>
<p class="mid">not addressed</p>
<p class="bot">this may include cases where there is no readme, or where the readme contains only a heading and very little information, perhaps in wrong format, wrong name, etc.</p>
</div>
<div>
<p class="mid">partially addressed</p>
<p class="bot">readme may be in incorrect Markdown (so does not display properly), does not contain references, contains very sloppy, poor language, etc.</p>
</div>
<div>
<p class="mid">fully addressed</p>
<p class="bot">well structured readme in Markdown format covering key details about the site (for example: acknowledgement of bugs, references to source code, images, or text content)</p>
</div>
</section>
</section>
<hr>
<section>
<h2 id="issues">General Issues</h2>
<section class="grid logs">
<div>
<figure>
<img src="screenshots/silly0.png">
<figcaption>redundant class</figcaption>
</figure>
<p class="figdetails">really no need to add a class to the table data tags, just style them directly</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-2.png">
<figcaption>lots of redundant code</figcaption>
</figure>
<p class="figdetails">note the strange indentation (probably tabs rather than spaces used), the amount of redundant code (e.g. the menu div is completely unnecessary) often the HTML tag can be styled directly without a class or id. no real need to make the menu a <code><ul></code> either.</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-4.png">
<figcaption>messy</figcaption>
</figure>
<p class="figdetails">note inconsistent indentation, the inline styles at the top, inline script in the middle (although fairly well commented), and the <code><br></code> tags at the bottom for layout (you should use CSS to pad things out)</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-5.png">
<figcaption>messy</figcaption>
</figure>
<p class="figdetails">note the "max-width" and "width" inline styles at the top, and inline script below (although fairly well commented)</p>
</div>
<div>
<figure>
<img src="screenshots/silly0-6.png">
<figcaption>out-of-date</figcaption>
</figure>
<p class="figdetails">note the vendor prefixes (-webkit, -moz, -ms) which are not needed since flexbox and transitions are supported in all browsers</p>
</div>
</section>
</section>
<script src="scripts.js"></script>
</body>
</html>