-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathuserguide.html
More file actions
1919 lines (1451 loc) · 110 KB
/
userguide.html
File metadata and controls
1919 lines (1451 loc) · 110 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
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title> User Guide | Morea Framework</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootswatch/3.1.0/cerulean/bootstrap.min.css">
<!-- Load site-specific customizations after bootstrap. -->
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/syntax.css">
<link rel="stylesheet" href="/css/gh-fork-ribbon.css">
<link rel="stylesheet" type="text/css" href="//fonts.googleapis.com/css?family=Open+Sans:normal,italic,bold">
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.6.2/html5shiv.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/respond.js/1.2.0/respond.js"></script>
<![endif]-->
<!-- Load Bootstrap JavaScript components -->
<script src="//code.jquery.com/jquery.min.js"></script>
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.0/js/bootstrap.min.js"></script>
</head>
<body>
<!-- Responsive navbar -->
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<!-- Display three horizontal lines when navbar collapsed. -->
<span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span>
</button>
<a class="navbar-brand">Morea Framework</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="/index.html">Home</a></li>
<li><a href="/quickstart.html">Quick Start</a></li>
<li><a href="/userguide.html">User Guide</a></li>
<li><a href="/developerguide.html">Developer Guide</a></li>
<li><a href="/gallery.html">Gallery</a></li>
<li><a href="/news.html">News</a></li>
<li><a href="/help.html">Help</a></li>
</ul>
</div>
</div>
</div>
<div class="github-fork-ribbon-wrapper right">
<div class="github-fork-ribbon">
<a href="https://github.com/morea-framework">Find me on GitHub</a>
</div>
</div>
<!-- Load tocify css and js -->
<link type="text/css" rel="stylesheet" href="/css/jquery.tocify.css" />
<!-- Load tocify Javascript components -->
<script src="/js/jquery-ui-1.10.4.custom.js"></script>
<script src="/js/jquery.tocify.js"></script>
<div class="container">
<div class="row">
<div class="hidden-xs col-sm-3" >
<!-- Our table of contents will be here !-->
<div id="nav"></div>
</div>
<div class="col-xs-12 col-sm-9">
<h1>Pedagogical Pattern</h1>
<p>Morea implements a simple <a href="http://en.wikipedia.org/wiki/Pedagogical_patterns">pedagogical pattern</a> along with a combination of technologies (git, GitHub, Jekyll) that facilitiate development, maintenance, and collaboration. Here are some of the key features of the pattern.</p>
<p><strong>Morea defines five "entity types": module, outcome, reading, experience, and assessment.</strong></p>
<p>A <em>module</em> is a container that holds a set of outcomes, readings, experiences, and assessments related to course content. Modules have a sort order, which allows you to organize modules into a sequence. Most courses consist of 6 to 30+ modules. A module can contain zero to many instances of outcomes, readings, experiences, and assessments. It is possible to define a module without zero outcomes, zero readings, zero experiences, and zero assessments, though we're not sure of the utility of such a module.</p>
<p>An <em>outcome</em> represents some kind of knowledge or capability that the student should acquire as a result of the readings and experiences in the associated module. A module can have multiple outcomes. Conversely, the same outcome can be associated with multiple modules. We find that a useful way to organize and express learning outcomes is through <a href="http://www.utar.edu.my/fegt/file/Revised_Blooms_Info.pdf">Bloom's revised taxonomy</a>, which classifies outcomes into six categories: remembering, understanding, applying, analyzing, evaluating, and creating. The latter outcomes (analyzing, evaluating, and creating) are supposed to represent "high-order" cognitive skills.</p>
<p>A <em>reading</em> is an artifact that the student studies: it represents "passive" learning. Readings are typically chapters in a book, online web pages, and so forth.</p>
<p>In contrast to a reading, an <em>experience</em> represents a more "active" form of learning in which the student solves problems or performs other activities in order to acquire understanding and capability. Morea distinguishes between readings and experiences because modules that contain only readings without experiences will tend to have outcomes associated with lower levels of Bloom's taxonomy, while modules containing a mixture of readings and experiences are more likely to support outcomes at higher levels of Bloom's taxonomy.</p>
<p>An <em>assessment</em> is an activity that evaluates the success of the student in achieving the educational goals of the module. In the best case, the educational goals of the module are adequately expressed by learning outcomes, in which case each assessment should relate to one or more outcomes. The graphic <a href="images/Stobaugh_BloomsTaxonomy.png">Applying Bloom's Taxonomy in your Classroom</a> provides various examples of how outcomes and assessments can be linked together. While Morea can help make linkages between outcomes and assessments clear, it is common to assess skills not encapsulated by outcomes, or desire outcomes that are not assessed.</p>
<p><strong>Morea generates five "views" of the content, each organized according to an entity.</strong></p>
<p>Morea sites contain a navigation bar at the top of the page with links to pages that organize the content according to each of the five entities: modules, outcomes, readings, experiences, and assessments. For example, here is an example of the Readings page:</p>
<p><img src="images/ics311-readings.png" width="600px" class="img-responsive"/></p>
<p>And here is an example of the Outcomes page:</p>
<p><img src="images/ics311-outcomes.png" width="600px" class="img-responsive"/></p>
<p>You can see that the two pages highlight a single entity type but provide links to other entities for context.</p>
<p>We believe that presenting the content organized according to different entity types makes it easier for students and educators to understand the conceptual structure of the course. For educators, it also provides a useful way to see if the course is structurally coherent. For example, when the learning objectives are examined together, do they create a coherent set? For another example, are there assessments for each module, and if not, is that appropriate?</p>
<p><strong>Every Morea entity has its own markdown file.</strong></p>
<p>Every instance of a Morea entity (module, outcome, reading, experience, assessment) is represented by a single markdown file. There can also be other markdown files and other non-markdown files (such as the logo image file associated with each module).</p>
<p><strong>All of your course content is located in the src/morea/ directory.</strong></p>
<p>When you first clone a Morea site, you will find a potentially bewildering number of files and directories. For example:</p>
<p><img src="images/morea-source.png" width="200px" class="img-responsive"/></p>
<p>This organization exists because the Morea framework is basically just a Jekyll site with a custom plugin to process the Morea markdown files.</p>
<p>Fortunately, the only files you will typically need to manage are all located in the src/morea directory. Here is an example of the src/morea directory from the basic-template system:</p>
<p><img src="images/morea-folder.png" width="200px" class="img-responsive"/></p>
<p>This folder contains all of the files you will want to manage as part of your course content.</p>
<p><strong>You can organize the src/morea/ directory any way you like.</strong></p>
<p>The Morea framework does not care how you organize the files within the src/morea directory. For example, you can place all of your files at the top level of this directory. Alternatively, and more typically, you can create subdirectories within the src/morea directory, one per module, as shown in the previous screenshot.</p>
<p><strong>Morea makes a "mirror image" of the src/morea directory in the published HTML site.</strong></p>
<p>Because we want you to provide course content in the src/morea directory, and because course content can include (for example) image files, Morea creates a kind of "mirror image" of the src/morea directory in the published site so that your content can include links within itself as well as to external sites.</p>
<p>The basic rule is that markdown files are converted to HTML in the published site, and all other files get copied over without change. So, for example, here is the src/morea directory (on the left) and the site's published morea directory (on the right):</p>
<p><img src="images/mirror-image.png" width="400px" class="img-responsive"/></p>
<p>As you can see, the markdown files have become HTML, and the sole non-markdown file (logo.png) has been copied over unchanged. The directory structure below the morea/ directory is unchanged.</p>
<h1>Related systems</h1>
<p>Another way to understand Morea is by contrasting it with other tools used by educators to create course content.</p>
<p><a href="http://www.gitbook.io/">GitBook</a>, like Morea, creates educational websites using Markdown and Git. If you want to
write a textbook, GitBook is a better choice. Morea is preferred when you want to create a course curriculum from
a variety of sources including your own and/or other sources, and when you want to make learning objectives and
assessments explicit.</p>
<p><a href="http://www.blackboard.com/">Blackboard</a> is one instance of an "enterprise learning management system (LMS)" that provides comprehensive support for all
aspects of course management: content management, testing, grading, etc. (Others include <a href="http://www.efrontlearning.net/">eFront</a>, <a href="https://moodle.org/">Moodle</a>, <a href="http://www.ilias.de/docu/goto.php?target=st_229_35&client_id=docu">Ilias</a>, <a href="http://www.dokeos.com/">Dokeos</a>, <a href="http://www.sakaiproject.org/">Sakai</a>,
<a href="http://www.claroline.net/">Claroline</a>, <a href="http://www.atutor.ca/">Atutor</a>, and <a href="http://www.olat.org/">Olat</a>).<br>
Morea provides a small subset of the capabilities of these systems, but is oriented toward the needs of institutions
rather than individual teachers. </p>
<p><a href="http://www.metacademy.org/">Metacademy</a> is a site for community curated educational content. Unlike Morea,
Metacademy supports a single version of curriculum material for any given topic. In contrast, Morea tries to make it
as easy as possible for each educator to have their own, slightly (or radically) different version of curriculum
material for any given topic. It's much like the difference between centralized version control (i.e. SVN) where there is
always a single "golden" version of a system, and distributed version control (i.e. git) where there can be many "different
but equal" versions of a system.</p>
<p>If you know of a related system, please let us know and we'll include it here.</p>
<h1>Anatomy of a Module</h1>
<p>This section overviews the structure of the module <a href="https://github.com/morea-framework/basic-template/tree/master/src/morea/foo">Foo</a> in the <a href="https://github.com/morea-framework/basic-template">basic-template</a> system. Here is a
graphic to help illustrate the various components:</p>
<p><img src="images/module-anatomy.jpg" width="800px" class="img-responsive"/></p>
<p>The top row illustrates various "source" files, and the bottom row illustrates various "output" HTML pages
produced from these files.</p>
<p>The top right window shows the contents of the src/morea/foo directory. This directory defines
the content associated with the Foo module. Note that the directory contains two files that are
not associated with the Foo module. This is unusual but permissible in Morea.</p>
<p>The second window on the top row shows the content of module.md. The content of this file is mostly Front Matter,
and provides the definition of the Foo module. The outcomes, readings, experiences, and assessments associated with
the Foo module are all referenced by unique IDs.</p>
<p>The third and fourth windows on the top row show the content of two files that define a reading and an experience entity.These entities have unique IDs that are referenced in the definition of the Foo module, and that is the way that Morea connects them together.</p>
<p>The bottom row shows a variety of pages produced by Morea. Because a module was defined in the module.md file, it
will show up in the modules/ page. Clicking on the link in the modules page takes you to a page which details the
contents of that module. As you can see, the content associated with each of the unique IDs referenced in the module.md file shows up in this
page. The other pages illustrate the content (such as a Reading) will not only appear in the module (or modules) with
which it is associated, but also in the Readings page.</p>
<p>In summary, Morea markdown files create a set of entities, each of which are identified by a unique ID. The
contents of a module (outcomes, readings, experiences, and assessments) are specified by providing unique IDs. The
relationship between modules and its content entities is many-to-many. First, a module can refer to multiple outcomes,
readings, experiences, and assessments. Conversely, any given outcome, reading, experiences, and assessment can
appear in multiple modules.</p>
<h1>Morea entity types</h1>
<p>This section documents the structure and behavior of the five Morea entity types.</p>
<h3>Module</h3>
<p>Modules are represented by a markdown file where the Front Matter defines the structure of the module
and the body of the file (typically a sentence or two) summarizes the module contents.</p>
<p><strong>Sample module markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "Learn to Foo"
published: true
morea_id: foo
morea_outcomes:
- outcome1
morea_readings:
- reading1
morea_experiences:
- experience1
morea_assessments:
- assessment1
morea_type: module
morea_icon_url: /morea/foo/logo.png
morea_labels:
- required
- intro
morea_sort_order: 1
morea_start_date: "2015-06-15"
morea_end_date: "2015-06-22"
---
Provides everything you need to know to learn to Foo.
</code></pre></div>
<p><strong>Module Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>module</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of the module. The module title appears in all of the top-level pages
whereever the module is referenced.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, the module will appear in the output. If false, the module will not appear. Default: true
</td>
</tr>
<tr>
<td>morea_coming_soon</td>
<td>optional</td>
<td>If true, the module name will appear in the Modules page with a "Coming soon" button that does not link anywhere. Any outcomes, readings, experiences, and assessments defined for the module will not appear in the associated top-level pages. However, the module page can still be retrieved by entering its URL manually. This parameter is useful during early course deployment where you want to indicate to students the set of topics in the course and their sequence but have not yet finished the internal structure of certain modules. Default: false
</td>
</tr>
<tr>
<td>morea_prerequisites</td>
<td>optional</td>
<td>If present, a list of Morea IDs indicating the Prerequisites associated with this module.</td>
</tr>
<tr>
<td>morea_outcomes</td>
<td>optional</td>
<td>If present, a list of Morea IDs indicating the Outcomes associated with this module.</td>
</tr>
<tr>
<td>morea_readings</td>
<td>optional</td>
<td>If present, a list of Morea IDs indicating the Readings associated with this module.</td>
</tr>
<tr>
<td>morea_experiences</td>
<td>optional</td>
<td>If present, a list of Morea IDs indicating the Experiences associated with this module.</td>
</tr>
<tr>
<td>morea_assessments</td>
<td>optional</td>
<td>If present, a list of Morea IDs indicating the Assessments associated with this module.</td>
</tr>
<tr>
<td>morea_icon_url</td>
<td>optional</td>
<td>If present, the URL of the icon appearing with this module in the modules/ page. For best
effect, the icon image should be square. Defaults to <a href="https://github.com/morea-framework/basic-template/blob/master/src/modules/default-icon.png">modules/default-icon.png</a>.
</tr>
<tr>
<td>morea_summary</td>
<td>optional</td>
<td>If present, a short string that will appear in the tile representing the module in the Modules page. If absent, then the module body text (see below) will be used in the tile.
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in the module's thumbnail on the modules/ page.
</td>
</tr>
<tr>
<td>morea_sort_order</td>
<td>optional</td>
<td>If present, an integer used to sort the set of published modules for presentation from low to high.
Defaults to zero.
</td>
</tr>
<tr>
<td>morea_start_date</td>
<td>optional</td>
<td>If present, a string that indicates the date (and potentially the time) where this module should be placed on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. You can specify a start date without an end date.
</td>
</tr>
<tr>
<td>morea_end_date</td>
<td>optional</td>
<td>If present, a string that indicates (along with the start date) the duration associated with this module on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. If you specify an end date, you should specify the start date as well.
</td>
</tr>
</table>
<p><strong>Module body text</strong></p>
<p>If morea_summary does not appear in the module's Front Matter, then the module body text will appear both in the tile and at the top of the page describing the module in full. </p>
<p>Alternatively, you can provide a short string as the morea_summary, and significantly more text as the module body text. In this case, the summary string will appear in the tile and the module body text will appear at the top of the page describing the module.</p>
<h3>Outcome</h3>
<p>Each outcome represents knowledge or capability that the educator hopes the students will acquire as a
result of the module or modules in which this outcome appears.</p>
<p><strong>Sample outcome markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "Remember concepts of asymptotic growth."
published: true
morea_id: outcome-growth
morea_type: outcome
morea_sort_order: 30
morea_labels:
- "Bloom: Remember"
---
Learn the concepts of asymptotic growth and recognize them in context.
</code></pre></div>
<p><strong>Outcome Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>outcome</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of this outcome. The outcome title appears in all of the top-level pages
whereever the outcome is referenced.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, the outcome will appear in the output. If false, the outcome will not appear. Default: true.
<strong>Note:</strong> if an outcome is not referenced by at least one module, it will not appear in the output
even if published is true.
</td>
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in this outcome's description.
</td>
</tr>
<tr>
<td>morea_sort_order</td>
<td>optional</td>
<td>If present, an integer used to sort the set of published outcomes for presentation from low to high
in the outcomes/ page. Defaults to zero.
</td>
</tr>
</table>
<p><strong>Outcome body text</strong></p>
<p>In an outcome definition, the text following the Front Matter describes
the outcome. This text appears both in all of the Module pages referring to this outcome,
as well as on the Outcomes page.</p>
<h3>Reading</h3>
<p>Each reading represents a "passive" learning opportunity associated with the module.
There are two types of readings:</p>
<ol>
<li>Readings in which the material is "inline", as the body text associated with the file.</li>
<li>Readings in which the material is "online", and the Front Matter provides a link to that material.</li>
</ol>
<p>Whether or not the reading is "inline" or "online" depends upon whether the keyword morea_url appears
in the Front Matter. Here are examples of each:</p>
<p><strong>Sample "inline" reading markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "Chapter 3 Notes"
published: true
morea_id: reading-notes-3
morea_summary: "Introduction to asymptotic analysis"
morea_type: reading
morea_start_date: "2015-06-15T18:30"
morea_sort_order: 9
morea_labels:
- Notes
---
## Outline
1. Intro to Asymptotic Analysis
2. Big-O
3. Omega
4. Theta
(remaining inline reading material deleted)
</code></pre></div>
<p><strong>Sample "online" reading markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "CLRS 3 - Growth of functions"
published: true
morea_id: reading-cormen-3
morea_summary: "Asymptotic notation, standard notation, and common functions."
morea_type: reading
morea_sort_order: 8
morea_url: http://mitpress.mit.edu/books/introduction-algorithms
morea_start_date: "2015-06-15T18:30"
morea_labels:
- Textbook
- 22 pages
----
</code></pre></div>
<p><strong>Reading Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>reading</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of this reading. The title appears in all of the top-level pages
where ever this entity is referenced.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, this reading will appear in the output. If false, the reading will not appear. Default: true.
<strong>Note:</strong> if a reading is not referenced by at least one module, it will not appear in the output
even if published is true.
</td>
</tr>
<tr>
<td>morea_url</td>
<td>optional</td>
<td>If present, specifies the URL of a reading. To refer to internal pages, the string must start with '/morea/' and continue with the path to the page. To refer to external pages, the string should start with 'http'. If this parameter is absent, then the body text of this file is the reading.
</td>
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in this reading's description.
</td>
</tr>
<tr>
<td>morea_sort_order</td>
<td>optional</td>
<td>If present, an integer used to sort the set of published readings for presentation from low to high
when listed as part of the module. Defaults to zero.
</td>
</tr>
<tr>
<td>morea_start_date</td>
<td>optional</td>
<td>If present, a string that indicates the date (and potentially the time) where this reading should be placed on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. You can specify a start date without an end date, and this typically indicates the "Due date" for this reading.
</td>
</tr>
<tr>
<td>morea_end_date</td>
<td>optional</td>
<td>If present, a string that indicates (along with the start date) the duration associated with this reading on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. If you specify an end date, you should specify the start date as well.
</td>
</tr>
</table>
<p><strong>Reading body text</strong></p>
<p>When the morea_url keyword is provided to specify the URL, then no body text need appear. When the
morea_url keyword is absent, then the body text should be the intended reading.</p>
<h3>Experience</h3>
<p>Each experience represents an active learning opportunity associated with the module.
Experiences appear as the body text of the file.</p>
<p><strong>Sample experience markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "Asymptotic concepts"
published: true
morea_id: experience-asymptotic-concepts
morea_type: experience
morea_summary: "Practice analysis of functions"
morea_start_date: "2015-06-15T18:30"
morea_sort_order: 1
morea_labels:
- In class
---
## Asymptotic Concepts
#### 5 points
**1\. (1 pt)** We can extend asymptotic notation to the case of two parameters n and m that can go to infinity independently at different rates. For example, we denote by O(g(n,m)) the set of functions:
> O(_g_(_n_,_m_)) = {_f_(_n_,_m_) : there exists positive constants _c_, _n_0
and _m_0 such that 0 ≤ _f_(_n_,_m_) ≤ _c__g_(_n_,_m_) for all _n_ ≥ _ _n0 or
_m_ ≥ _m_0}
Give a corresponding definition for Θ(_g_(_n_,_m_)).
---
(remaining experience material deleted)
</code></pre></div>
<p><strong>Experience Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>experience</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of this experience. The title appears in all of the top-level pages
where ever this entity is referenced.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, this experience will appear in the output. If false, the experience will not appear. Default: true.
<strong>Note:</strong> if an experience is not referenced by at least one module, it will not appear in the output
even if published is true.
</td>
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in this experience's description.
</td>
</tr>
<tr>
<td>morea_sort_order</td>
<td>optional</td>
<td>If present, an integer used to sort the set of published experiences for presentation from low to high
when listed as part of the module. Defaults to zero.
</td>
</tr>
<tr>
<td>morea_start_date</td>
<td>optional</td>
<td>If present, a string that indicates the date (and potentially the time) where this experience should be placed on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. You can specify a start date without an end date, and this typically indicates the "Due date" for this experience.
</td>
</tr>
<tr>
<td>morea_end_date</td>
<td>optional</td>
<td>If present, a string that indicates (along with the start date) the duration associated with this experience on the calendar on the Schedule page. Example: "2015-06-25" indicates June 25, 2015, and "2015-06-15T18:30" indicates 6:30pm on June 15, 2015. If you specify an end date, you should specify the start date as well.
</td>
</tr>
</table>
<p><strong>Experience body text</strong></p>
<p>The body text should describe the experience in markdown format.</p>
<h3>Assessment</h3>
<p>Each assessment represents the results of some activity intended to determine whether or not the students
have acquired the knowledge and/or capabilities intended by the module's readings and experiences.</p>
<p>Assessments appear as the body text of the file, typically as charts. We recommend that
you publish the assessment results in a manner that preserves student anonymity.</p>
<p>For each assessment, you can provide a list of outcomes that the assessment checked. This list
of outcomes will be listed with the assessment, and the assessment will appear with the outcome.</p>
<p>Publishing assessment results has a number of benefits:</p>
<ul>
<li>Students get a sense for both how they are performing relative to others during the course.</li>
<li>Students understand how the educator is attempting to assess the learning associated with the module.</li>
<li>Assessment results become part of the "public record" associated with the module, facilitating future
modification and improvement of the assessment technique.</li>
</ul>
<p>To present assessment results as charts, you can include Javascript directly in the markdown file, as illustrated in the following example:</p>
<p><strong>Sample assessment markdown file contents</strong></p>
<div class="highlight"><pre><code class="language-text" data-lang="text">---
title: "Ability to recall asymptotic concepts"
published: true
morea_id: assessment-asymptotic-concepts
morea_type: assessment
morea_sort_order: 1
morea_outcomes_assessed:
- outcome-technical-writing
morea_labels:
- "Bloom: Remember"
---
Assessed ability to remember asymptotic concepts through an in-class multiple choice exam:
<link rel="stylesheet" href="http://cdn.oesmith.co.uk/morris-0.4.3.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/raphael/2.1.0/raphael-min.js"></script>
<script src="http://cdn.oesmith.co.uk/morris-0.4.3.min.js"></script>
<div class="well">
<div id="assessment" style="height: 250px;"></div>
</div>
<script>
Morris.Bar({
element: 'assessment',
hideHover: false,
data: [
{ y: 'Very satisfactory (%)', num: 15 },
{ y: 'Satisfactory (%)', num: 55 },
{ y: 'Unsatisfactory (%)', num: 25 },
{ y: 'Absent (%)', num: 5 },
],
xkey: 'y',
ykeys: ['num'],
resize: true,
labels: ['Students']
});
</script>
</code></pre></div>
<p><strong>Assessment Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>assessment</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of this assessment. The title appears in all of the top-level pages
where ever this entity is referenced.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, this assessment will appear in the output. If false, the assessment will not appear. Default: true.
<strong>Note:</strong> if an assessment is not referenced by at least one module, it will not appear in the output
even if published is true.
</td>
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in this assessment's description.
</td>
</tr>
<tr>
<td>morea_sort_order</td>
<td>optional</td>
<td>If present, an integer used to sort the set of published assessment for presentation from low to high
when listed as part of the module. Defaults to zero.
</td>
</tr>
<tr>
<td>morea_outcomes_assessed</td>
<td>optional</td>
<td>If present, a list of outcome morea_ids which are checked by this assessment.
</td>
</tr>
</table>
<p><strong>Assessment body text</strong></p>
<p>The body text should describe the assessment in markdown format.</p>
<h3>Prerequisite</h3>
<p>As of Morea 2.0, it is possible to define <em>Prerequisite</em> modules, or modules from another Morea site whose material should be mastered prior to starting this module.</p>
<p>The following image illustrates the top part of a Module definition page specifying three prerequisite modules from three prior courses:</p>
<p><img style="border:1px solid gray" src="images/morea-2.0/prerequisite-modules.png" class="img-responsive"></p>
<p>As with all other "tiles" in Morea sites, these can be clicked to go to the corresponding module from the external site.</p>
<p>There are two steps to using Prerequisite modules. First, you must define them, and second, you must reference them in another module as a Prerequisite.</p>
<p><strong>Sample prerequisite markdown file contents</strong></p>
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="nn">---</span>
<span class="l-Scalar-Plain">title</span><span class="p-Indicator">:</span> <span class="s">"Algorithms"</span>
<span class="l-Scalar-Plain">published</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">true</span>
<span class="l-Scalar-Plain">morea_id</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">141-algorithms</span>
<span class="l-Scalar-Plain">morea_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://courses.ics.hawaii.edu/ReviewICS141/modules/algorithms/</span>
<span class="l-Scalar-Plain">morea_icon_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://courses.ics.hawaii.edu/ReviewICS141/morea/algorithms/algorithms.png</span>
<span class="l-Scalar-Plain">morea_type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">prerequisite</span>
<span class="l-Scalar-Plain">morea_labels</span><span class="p-Indicator">:</span>
<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">ICS 141</span>
<span class="nn">---</span>
<span class="l-Scalar-Plain">Algorithms, computational complexity, asymptotic notations, pseudocode, greedy algorithms, easy vs. hard problems.</span></code></pre></figure>
<p><strong>Prerequisite Front Matter keywords and values</strong></p>
<table class="table table-condensed table-striped table-bordered">
<tr><th>Keyword</th><th>Required?</th><th>Value</th></tr>
<tr>
<td>morea_type</td>
<td>required</td>
<td>prerequisite</td>
</tr>
<tr>
<td>morea_id</td>
<td>required</td>
<td>A symbol (letters, numbers, hyphens, underscores) identifying this Morea entity. Morea IDs must
be unique. The Morea compiler will terminate with an error if it encounters two markdown files containing the same
Morea ID.</td>
</tr>
<tr>
<td>title</td>
<td>required</td>
<td>A string indicating the title of this prerequisite. The title appears whereever this entity is referenced.
</td>
</tr>
<tr>
<td>morea_url</td>
<td>required</td>
<td>The URL to the location where this module page can be retrieved.
</td>
</tr>
<tr>
<td>morea_icon_url</td>
<td>required</td>
<td>The URL to the location where the icon associated with this module page can be retrieved.
</td>
</tr>
<tr>
<td>published</td>
<td>optional</td>
<td>If true, this prequisite will be defined. If false, it will not exist. Default: true.
</td>
</tr>
<tr>
<td>morea_labels</td>
<td>optional</td>
<td>If present, a list of strings that appear as <a href="http://getbootstrap.com/components/#badges">badges</a>
in this assessment's description.
</td>
</tr>
</table>
<p><strong>Prequisite body text</strong></p>
<p>The body text should describe the prerequisite in markdown format. It will appear in the tile, so should be relatively concise.</p>
<h1>Content development</h1>
<p>The material in this section assumes that you have set up your local environment according to
the instructions in the <a href="/quickstart.html">QuickStart page</a>.</p>
<h2>Develop by duplicating modules</h2>
<p>Development of curriculum content seems to be easiest by organizing module material by
directories. Then, to create a new module, just:</p>
<ol>
<li>Duplicate an existing module directory using your operating system commands.</li>
<li>Edit the module definition markdown file. Define a new unique ID for that module, and change
the references to outcome IDs, reading IDs, experience IDs, and assessment IDs appropriately.</li>
<li>Edit the markdown files within the new directory files to define the outcomes, readings,
experiences, and assessments associated with the new module.</li>
<li>Check to make sure the new module displays correctly in your local browser and that the sort order
numbers result in the correct ordering on all pages.</li>
</ol>
<h2>Edit>Compile>Review>Publish</h2>
<p>Development of course content with Morea follows this general sequence:</p>
<ol>
<li>Edit: Modify the files in the morea/ directory.</li>
<li>Compile: Invoke the "Morea compiler" (i.e. jekyll) using the <a href="https://github.com/morea-framework/scripts/blob/master/morea-run-local.sh">morea-run-local.sh</a> script</li>
<li>Review: Fix any errors that occur, or if no errors occur, then review the results at http://localhost:4000.</li>
<li>Publish: When satisfied with your content, publish it using the <a href="https://github.com/morea-framework/scripts/blob/master/morea-publish.sh">morea-publish.sh</a> script.</li>
</ol>
<h2>Edit phase</h2>
<p>Just edit the files using any programming text editor (vi, emacs, sublime, etc.) Don't use
a word processor such as Word.</p>
<h2>Compile phase</h2>
<p>The morea-run-local script invokes the Jekyll compiler in "watch" mode, which means it will automatically
recompile the markdown files whenever it notices that they have been edited. So, for example, this is what happens
when morea-run-local is invoked in the basic-template system:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">[~/projecthosting/github/morea-framework/basic-template]-> ./morea-run-local.sh
+ jekyll serve --source /Users/johnson/projecthosting/github/morea-framework/basic-template/master/src --destination /Users/johnson/projecthosting/github/morea-framework/basic-template/master/src/_site --baseurl '' --watch
Configuration file: /Users/johnson/projecthosting/github/morea-framework/basic-template/master/src/_config.yml
Source: /Users/johnson/projecthosting/github/morea-framework/basic-template/master/src
Destination: /Users/johnson/projecthosting/github/morea-framework/basic-template/master/src/_site
Generating...
Starting Morea page processing...
Processing file: assessment.md
Processing file: experience.md
Processing file: module.md
Processing file: outcome.md
Processing file: reading-1.md
Processing file: reading-2.md
Processing file: assessment.md
Processing file: experience.md
Processing file: module.md
Processing file: assessment.md
Processing file: experience.md
Processing file: logo.png
Processing file: module.md
Processing file: outcome-1.md
Processing file: outcome-2.md
Processing file: reading-1.md
Processing file: reading-2.md
Processing file: footer.md
Processing file: home.md
Processing file: module.md
Warning: module.md missing optional front matter: morea_icon_url (set to /modules/default-icon.png)
Warning: module.md missing optional front matter: morea_icon_url (set to /modules/default-icon.png)
Warning: module.md missing optional front matter: morea_outcomes, morea_readings, morea_experiences, morea_assessments, morea_icon_url (set to /modules/default-icon.png)
Summary:
20 total, 19 published, 0 unpublished, 19 markdown, 1 other
4 modules, 3 outcomes, 4 readings, 3 experiences, 3 assessments
0 errors, 7 warnings
done.
Auto-regeneration: enabled
Server address: http://0.0.0.0:4000
Server running... press ctrl-c to stop.
</code></pre></div>
<p>This normal output shows the markdown files found by Morea, followed by any "warnings" (non-fatal issues) discovered during
processing of the markdown, followed by a summary of processing. At the very end, it indicates that the server
is running and that you can retrieve the site at http://localhost:4000.</p>
<p>If you edit the content associated with a file and save it out, then the compiler will be automatically invoked
and you will see more output appear similar to the above. If you decide to install a browser
plugin like <a href="http://livereload.com/">LiveReload</a>, then the browser page displaying your output will be
refreshed automatically each time you save your source files. This is highly recommended.</p>
<p>Now let's see what happens when we make an error creating our content. For example, let's put a typo into
the Foo module definition file so that we reference "outcome12" rather than "outcome1". Here's what results:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">Starting Morea page processing...
Processing file: assessment.md
Processing file: experience.md
Processing file: module.md
Processing file: outcome.md
Processing file: reading-1.md
Processing file: reading-2.md
Processing file: assessment.md
Processing file: experience.md
Processing file: module.md
Processing file: assessment.md
Processing file: experience.md
Processing file: logo.png
Processing file: module.md
Processing file: outcome-1.md
Processing file: outcome-2.md
Processing file: reading-1.md
Processing file: reading-2.md
Processing file: footer.md
Processing file: home.md
Processing file: module.md
Warning: module.md missing optional front matter: morea_icon_url (set to /modules/default-icon.png)
Warning: module.md missing optional front matter: morea_icon_url (set to /modules/default-icon.png)
Warning: module.md missing optional front matter: morea_outcomes, morea_readings, morea_experiences, morea_assessments, morea_icon_url (set to /modules/default-icon.png)
Error: module.md references undefined morea_id: outcome12
Warning: module.md missing optional front matter: morea_outcomes, morea_readings, morea_experiences, morea_assessments, morea_icon_url (set to /modules/default-icon.png)
Summary:
20 total, 19 published, 0 unpublished, 19 markdown, 1 other
4 modules, 3 outcomes, 4 readings, 3 experiences, 3 assessments
1 errors, 7 warnings
Errors found. Exiting.
>
</code></pre></div>
<p>Instead of "0 errors, 7 warnings", the compiler reports "1 errors, 7 warnings" and exits back to the
command line. At this point, find the place(s) in the output where the error is reported. In this case,
you'll find:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text"> Error: module.md references undefined morea_id: outcome12
</code></pre></div>
<p>This tells you name of the file with the error and the problem: in this case, a reference to an
undefined Morea ID. Fix the problem and reinvoke morea-run-local.sh to see if the error goes away.</p>
<h2>Publish phase</h2>
<p>When you are ready to publish your content to GitHub so it can be seen publicly, invoke the
<a href="https://github.com/morea-framework/scripts/blob/master/morea-publish.sh">morea-publish.sh</a> script, providing it with a commit message. For example:</p>