Termbank
  1. C
    1. Checking Daemon
      Exercises System
    2. Celery Worker
      Checking Daemon
    3. Content Graph
      Content Courses
    4. Content Page
      Content
    5. Course
      Courses
    6. Course Instance
      Courses
    7. Course Prefix
      Courses System
  2. E
    1. Embedded Content
      Content Exercises
    2. Enrollment
      Courses System
  3. F
    1. Feedback
      Content Feedback
    2. File
      Media
    3. File Upload Exercise
      Exercises
    4. Front Page
      Content Courses
  4. H
    1. Hint
      Exercises
  5. I
    1. Instance
      Course Instance
    2. Image
      Media
  6. L
    1. Lecture Page
      Content
    2. Legacy Checker
  7. M
    1. Media File
      File
    2. Markup
      Content
    3. Media
      Media
  8. P
    1. PySenpai
  9. R
    1. Regex
    2. Repeated Exercise Generator
    3. Responsible Teacher
      Courses System
    4. Revision
      System
  10. S
    1. Slug
      System
    2. Staff
      Courses System
    3. Statistics
      Exercises
  11. T
    1. Teacher Toolbox
      System
    2. Term
      Content
    3. Textfield Exercise
    4. Triggerable Highlight
      Exercises
Completed: / exercises

Basic Course Creation Workflow

This page describes the basic workflow for creating new content in Lovelace. All phases are described in more detail in their respective chapters in the guide.

1. Course and Instance Model

Lovelace manages courses in two layers:
courses
and
course instances
. Course is the base course which contains basic details such as course code and responsible teacher. The base course is an abstract root node for course instances. A course instance is the equivalent of a course in WebOodi, i.e. it is a singular period of instruction where students can sign up, and typically teachers will have a new one every year.
When teachers manage courses in Lovelace, they usually manage course instances. You can find more details about course instances -- WARNING: BROKEN LINK --here.

2. Opening the Admin Panel

Lovelace uses Django Admin Site to manage content. It is a bit crude, but clear enough. Open it from the user menu on the top-right by selecting Teacher tools.
Opening the admin panel

3. Creating a Course Instance

You can manage your
course instances
by choosing Course Instances from the admin site menu. For now we're going to disregard the last portion of the form (since we don't have content yet!), and focus on the basic information:
Course instance fields explained
First we need a name for the instance. Course instance names are unique across the entire system. Typically they should be named after the course and include timing information, e.g. "Introduction to Donkeys Autumn 2018" - students will be using this title to figure out which instance they should
enroll
to. If the course is only given in one language, remember to use the name_fi field - regardless of the actual language.
After giving your instance a name, link to a course from the course dropdown menu. You can only create instances for courses where you are the
responsible teacher
. The rest of the fields are optional but can be filled at this point if you want. The email address here should be the primary contact email for your course (e.g. a list that as all members of the teaching staff as recipients). We're going to leave the
front page
unset for now since there's no content to show.
If start and end times are given, the course instance is considered active within that time span. You can make the course always active by checking "Force this instance active". Starting date is also used for sorting course instances in the Lovelace course index page. You can also choose whether students can see this instance. This is useful for hiding courses that are not set up yet, and also to clean up old instances from the course index.
Finally you can choose whether students can freely sign up for the course, or if they need to be accepted by you from the enrollment management interface.

4. Creating Pages

Top level
content pages
are called
Lecture pages
in the system. These are pages that are capable of
embedding
other types of pages. Create a new lecture page. When naming pages, two things should be kept in mind: names are unique across the entire system, and Finnish is always the primary field to use if you plan on giving your course in only one language.
Other types of content are linked to lecture pages through links in the page
markup
. More information about markup can be found from here. For now let's just write something in the content field. The first page will be your course front page.
You should also create a second page for the next step.

5. Linking Pages to Course Instances

Go back to managing your
course instance
. You can select your freshly created
front page
as the course front page from the dropdown menu. After that, in the Instance outline section there's a box for selecting
contents
which should be empty if this is your first course. Click the green plus on the right of the box to create a new content graph - an object that links content pages to your course index. This will open a new window with a form for creating a
content graph
.
Content graph fields explained
The most important field are Content and Ordinal number - the former determines the which content page to show while the latter determines the order of links in the course index. If you choose a Parentnode, the page will be shown in the index as a sub page of the parent page (indented).
You can set a deadline for the entire page. This affects any exercises that have been embedded into the page. If the deadline has passed, students will be shown a message about it with every incompleted exercise on the page. Here you can also choose whether to show this content to students by checking/unchecking the box.
After you press save, the content will be shown in the contents box with its ordinal number and
revision
(which should be "newest"). This box will eventually contain more items - including items that may belong to different courses - but only the ones that are selected will actually be linked to the course instance. You can change these selections by clicking while holding down Ctrl.
If you set a front page from the front page field in the course instance form and save the instance, the front page will automatically be added to the contents box with the special ordinal number 0.

6. Creating Pages with Embedded Content

Most of the time you want to include pictures, files, videos and of course exercises in your pages. Content is
embedded
by using
markup
in the page content. An important point to remember is that the embedded content must exist at the time you save the parent content. This is in part due to implementation details, and in part to catch typos in link names. A typical workflow is to write the content in a separate text editor, then create the embedded objects and finally create the parent page.
Embedded contents include the following categories in the admin interface:
When creating embedded objects, a recommended naming scheme is to include a
course prefix
. The amount of embedded content is vastly higher than the amount of pages in courses across the system, and course prefixes help avoid name conflicts. They also make it easier to distinguish between contents of different courses for teachers who have more than one.
Furthermore, when naming files, images and videos it is recommended to use a notation similar to the
slugs
that are generated from page names: all lowercase with all non-alphanumeric characters replaced by dashes. For instance, the course instance explanation image is called llguide-course-instance-basic.
You can find more information about the content model from -- WARNING: BROKEN LINK --here.
?
The checking daemon is a separate multi-threaded program that is invoked whenever Lovelace needs to execute code on the command line. The most common use case is to evaluate student programs by running checking programs. When a task is sent to the checker daemon, copies of all required files are put into a temporary directory where the test will then run. The daemon also does necessary security operations to prevent malicious code from doing any actual harm.
Content graphs are objects that connect content pages to a course instance's table of contents. Content graphs have several context attributes which define how the content is linked to this particular course instance. A content graph's ordinal number and parent node affect how it is displayed in the table of contents. You can also set a deadline which will be applied to all exercises contained within the linked content page. Content graphs also define which revision of the content to show - this is used when courses are archived.
In Lovelace, content page refers to learning objects that have text content written using a markup language. All types of content pages are treated similarly inside the system and they are interchangeable. Content pages include lecture pages, and all exercise types.
  1. Description
  2. Relations
In Lovelace, course refers to an abstract root course, not any specific instance of instruction. Courses are used for tying together actual instance of instruction (called course instances in Lovelace). In that sense they are like courses in the study guide, while course instances are like courses in WebOodi. The most important attrbutes of a course are its responsible teacher and its staff group - these define which users have access to edit content that is linked to the course.
  1. Description
  2. Relations
  3. Cloning and Archiving
In Lovelace, a course instance refers to an actual instace of instruction of a course. It's comparable to a course in WebOodi. Students can enroll to a course instance. Almost everything is managed by instance - student enrollments, learning objects, student answers, feedback etc. This way teachers can easily treat each instance of instruction separately. Course instances can also be archived through a process called freezing.
Course prefixes are recommended because content page and media names in Lovelace are unique across all courses. You should decide a prefix for each course and use that for all learning objects that are not included in the course table of contents. The prefix will also make it easier to manage learning objects of multiple courses - especially for your friendly superuser who sees everyhing in the admin interface...
  1. Description
  2. Examples
Embedded content refers to learning objects that have been embedded to other learning objects through links written in the content of the parent object. Embedded content can be other content pages or media. When saving a content page, all embedded objects that are linked must exist. A link to embedded content is a reference that ties together course instance, embedded content and the parent content.
Enrollment is the method which connects students to course instances. All students taking a course should enroll to it. Enrollment is used for course scoring and (once implemented) access to course content. Enrollments are either automatically accepted, or need to be accepted through the enrollment management interface.
Lovelace has a built-in feedback system. You can attach any number of feedback questions to any content page, allowing you to get either targeted feedback about single exercises, or more general feedback about entire lecture pages. Unlike almost everything else, feedback questions are currently not owned by any particular course. However, feedback answers are always tied to the page the feedback is for, and also to the course instance where the feedback was given.
  1. Description
  2. Archiving
  3. Embedding
In Lovelace file normally refers to a media file, managed under Files in the admin site. A file has a handle, actual file contents (in both languages) and a download name. The file handle is how the file is referened throughout the system. If a media file is modified by uploading a new version of the file, all references will by default fetch the latest version. The download name is the name that is displayed as the file header when it's embedded, and also as the default name in the download dialog. Files are linked to content through reference objects - one reference per course instance.
Media files are currently stored in the public media folder along with images - they can be addressed directly via URL.
  1. Description
  2. Legacy Checkers
File upload exercises are at the heart of Lovelace. They are exercises where students return one or more code files that are then evaluated by a checking program. File upload exercises can be evaluated with anything that can be run from the Linux command line, but usually a bit more sophisticated tools should be used (e.g. PySenpai). File upload exercises have a JSON format for evaluations returned by checking programs. This evaluation can include messages, hints and highlight triggers - these will ideally help the student figure out problems with their code.
Front page of a course instance is shown at the instance's index page, below the course table of contents. Front page is linked to a course instance just like any other page, but it uses the special ordinar number of 0 which excludes it from the table of contents. Any page can act as the course front page.
Hints are messages that are displayed to students in various cases of answering incorrectly. Hints can be given upon making incorrect choices in choice-type exercises, and they can also be given after a certain number of attempts. In textfield exercises you can define any number of catches for incorrect answers, and attach hints to each. Hints are shown in a hint box in the exercise layout - this box will become visible if there is at least one hint to show.
  1. Description
  2. Archiving
  3. Embedding
Images in Lovelace are managed as media objects similar to files. They have a handle that is used for referencing, and the file itself separately. Images should be always included by using reference. This way if the image is updated, all references to it always show the latest version.
Images stored on disc are accessible directly through URL.
Lecture pages are content pages that do not have any exercise capabilities attached to them. A course instance's table of contents usually consists entirely of lecture pages. Other types of content pages (i.e. exercises) are usually embedded within lecture pages.
Legacy checker is a name for checkers that were used in previous versions of Lovelace and its predecessor Raippa. They test the student submission against a reference, comparing their outputs. If the outputs match (exactly), the submission passes. Otherwise differences in output are highlighted. It is possible to use wrapper programs to alter the outputs, or output different things (e.g. testing return values of individual functions). Legacy checkers should generally be avoided because they are very limiting and often frustrating for students. Legacy checking is still occasionally useful for comparing compiler outputs etc.
Lovelace uses its own wiki style markup for writing content. Beyond basic formatting features, the markup is also used to embed content pages and media, mark highlightable sections in text and create hover-activated term definition popups.
In Lovelace, media refers to embeddable files etc. These come in there categories: images, files and video links. Like content pages, media objects are managed by reference using handles. Unlike other types of files, media files are publicly accessible to anyone who can guess the URL.
PySenpai is a library/framework for creating file upload exercise checking programs. It uses a callback-based architecture to create a consistent and highly customizable testing process. On the one hand it provides reasonable defaults for basic checking programs making them relatively straightforward to implement. On the other hand it also supports much more complex checking programs. Currently PySenpai supports Python, C, Y86 Assembly and Matlab.
Regular expression's are a necessary evil in creating textfield and repeated template exercises. Lovelace uses Python regular expressions in single line mode.
A generator acts as a backend for repeated template exercises, and provides the random values and their corresponding answers to the frontend. Generators can be written in any programming language that can be executed on the Lovelace server. Generators need to return a JSON document by printing it to stdout.
Responsible teacher is the primary teacher in charge of a course. Certain actions are available only to responsible teachers. These actions include managing enrollments and course instances.
Lovelace uses Django Reversion to keep track of version history for all learning objects. This can be sometimes useful if you need to restore a previous version after mucking something up. However the primary purpose is to have access to historical copies of learning objects for archiving purposes. When a course instance is archived, it uses the revision attribute of all its references to set which historical version should be fetched when the learning object is shown. Student answers also include the revision number of the exercise that was active at the time of saving the answer.
Slug is the lingo word for names used in urls. Slugs are automatically generated for courses, course instances and content pages. Slugs are all-lowercase with all non-alphanumeric characters replaced with dashes. Similar naming scheme is recommended for other types of learning objects as well although they do not use generated slugs.
Staff members are basically your TAs. Staff members can see pages hidden from normal users and they can edit and create content (within the confines of the courses they have been assigned to). They can also view answer statistics and evaluate student answers in manually evaluated exercises. Staff members are assigned to courses via staff group.
Lovelace has answer statistics for all exercises. Statistics are collected per instance, and allow you to review how many times an exercise has been answered, what's the success rate etc. All of this can be helpful in identifying where students either have difficulties, or the exercise itself is badly designed. For some types of exercises, there's also more detailed information about answers that have been given. Statistics can be accessed from the left hand toolbox for each exercise.
Teacher toolbox is located on the left hand side of each exercise. It has options to view statistcs, view feedback about the exercise and edit the exercise. For file upload exercises there is also an option to download all answers as a zip file. Do note that this takes some time.
  1. Description
  2. Examples
Terms are keywords that are linked to descriptions within your course. They will be collected into the course term bank, and the keyword can also be used to make term hint popups on any content page. Terms can include multiple tabs and links to pages that are relevant to the term. For instance, this term has a tab for examples, and a link to the page about terms.
Textfield exercises are exercises where the student gives their answer by writing into a text box. This answer is evaluated against predefined answers that can be either correct (accepting the exercise) or incorrect (giving a related hint). Almost always these answers are defined as regular expressions - exact matching is simply far too strict.
  1. Description
  2. Markup
  3. Triggering
Triggerable highlights can be used in content pages to mark passages that can be highlighted by triggers from file upload exercise evaluation responses. When a highlight is triggered the passage will be highlighted. This feature is useful for drawing student attention to things they may have missed. Exercises can trigger highlights in their own description, or in their parent page. It is usually a good idea to use exercise specific prefixes for highlight trigger names.